TemperatureSensor Class Reference

Temperature-sensor interface. More...

#include <c++/TemperatureSensor.H>

Inheritance diagram for TemperatureSensor:

[legend]Collaboration diagram for TemperatureSensor:


Public Types
enum	Port { S1 = 0, S2, S3, Battery }
	List of sensor identifiers (IDs). Possible Sensor Port Values. More...
Public Member Functions
	TemperatureSensor (const Sensor::Port port)
	Construct a temperature sensor.
	~TemperatureSensor ()
	Destroy this instance of TemperatureSensor.
float	C () const
	Get the current temperature in Celsius.
float	F () const
	Get the current temperature in F.
int	tenths () const
	Get the current temperature in C * 10, as an int.
int	degrees () const
	Get the current temperature in C, as an int.
unsigned int	get () const
	Get the current sensor reading.
void	mode (bool makeActive) const
	Set the sensor (mode) to active or passive.
void	passive () const
	Set the sensor to passive (turn off voltage to connector).
void	active () const
	Set the sensor to active (provide voltage to connector).
void	on () const
	Turn the sensor on (provide voltage to connector).
void	off () const
	Turn the sensor off (turn off voltage to connector).
void	strobe () const
	Quickly turn sensor off then back on.
void	strobe (const int ms) const
	Turn sensor off, wait for {ms} milliSeconds, then then turn it back on.
unsigned int	sample (unsigned int size=10, int wait=2) const
	Get the average of {size} samples, waiting {wait} mSec between each sample.
Protected Attributes
volatile unsigned int &	sensor
	The address of our sensor value.

Detailed Description

Temperature-sensor interface.

This is class deals with temperature sensors

The methods include: TemperatureSensor(sensor port) C() returns a float which is the temperature in C. The sensor appears to have a resolution of ~1/8 degree. F() returns a float which is the temperature in F. tenths() returns an int which is the temperature in C * 10 degrees() returns an int which is the temperature in C

It also includes all methods in Sensor

N.B. the transform from sensor reading to temperature is done using a simple linear regression compared to my outdoor thermometer over the range of -20 to +30 C. I can not vouch for the accuracy or precision of these numbers! So if you have a well calibrated temperature monitor, and you can check my conversions, please let me know the results, and I can clean up the regression parameters.

Definition at line 53 of file TemperatureSensor.H.

Member Enumeration Documentation

enum Sensor::Port [inherited]

List of sensor identifiers (IDs). Possible Sensor Port Values.
S1, S2, S3 are connector pads 1, 2 and 3 on the RCX.
Battery is the internal sensor allowing a program to read the current battery voltage in milliVolts

See also:
Battery

Enumeration values:

S1 RCX sensor port 1.

S2 RCX sensor port 2.

S3 RCX sensor port 3.

Battery RCX battery sensor.

Definition at line 67 of file Sensor.H.

Constructor & Destructor Documentation

TemperatureSensor::TemperatureSensor ( const Sensor::Port port ) [inline]

Construct a temperature sensor.
At time of construction identify where it is connected.
Parameters:

port The port to be associated with this instance

See also:
Sensor::Port

Definition at line 62 of file TemperatureSensor.H.

TemperatureSensor::~TemperatureSensor ( ) [inline]

Destroy this instance of TemperatureSensor.

Definition at line 67 of file TemperatureSensor.H.

Member Function Documentation

void Sensor::active ( ) const [inline, inherited]

Set the sensor to active (provide voltage to connector).

See also:
Sensor::passive, Sensor::on, Sensor::off, Sensor::mode

Definition at line 133 of file Sensor.H.
References ds_active(), and Sensor::sensor.
Referenced by Sensor::mode(), Sensor::on(), and Sensor::Sensor().

float TemperatureSensor::C ( ) const [inline]

Get the current temperature in Celsius.

Returns:
float - the current temperature in C

Definition at line 74 of file TemperatureSensor.H.
References Sensor::get().
Referenced by degrees(), F(), and tenths().

int TemperatureSensor::degrees ( ) const [inline]

Get the current temperature in C, as an int.

Returns:
int - the current temperature in C

Definition at line 97 of file TemperatureSensor.H.
References C().

float TemperatureSensor::F ( ) const [inline]

Get the current temperature in F.

Returns:
float - the current temperature in F

Definition at line 83 of file TemperatureSensor.H.
References C().

unsigned int Sensor::get ( ) const [inline, inherited]

Get the current sensor reading.

Returns:
unsigned int - The current raw sensor value

See also:
Sensor::sample

Reimplemented in LightSensor.
Definition at line 109 of file Sensor.H.
References Sensor::sensor.
Referenced by C(), and Sensor::sample().

void Sensor::mode ( bool makeActive ) const [inline, inherited]

Set the sensor (mode) to active or passive.

Parameters:

makeActive - T/F - Where true means to go active (voltage is supplied to the connector pad)

See also:
Sensor::off, Sensor::on, Sensor::active, Sensor::passive

Definition at line 118 of file Sensor.H.
References Sensor::active(), and Sensor::passive().

void Sensor::off ( ) const [inline, inherited]

Turn the sensor off (turn off voltage to connector).

See also:
Sensor::on, Sensor::active, Sensor::passive, Sensor::mode

Reimplemented in RotationSensor.
Definition at line 145 of file Sensor.H.
References Sensor::passive().
Referenced by Sensor::strobe(), and Sensor::~Sensor().

void Sensor::on ( ) const [inline, inherited]

Turn the sensor on (provide voltage to connector).

See also:
Sensor::off, Sensor::active, Sensor::passive, Sensor::mode

Reimplemented in RotationSensor.
Definition at line 139 of file Sensor.H.
References Sensor::active().
Referenced by Sensor::strobe().

void Sensor::passive ( ) const [inline, inherited]

Set the sensor to passive (turn off voltage to connector).

See also:
Sensor::active, Sensor::on, Sensor::off, Sensor::mode

Definition at line 127 of file Sensor.H.
References ds_passive(), and Sensor::sensor.
Referenced by Sensor::mode(), Sensor::off(), and Sensor::Sensor().

unsigned int Sensor::sample ( unsigned int size = 10,

int wait = 2

) const [inline, inherited]

Get the average of {size} samples, waiting {wait} mSec between each sample.

Parameters:

size - Number of samples to average (default = 10 samples)

wait - time (in mS) to wait between samples (default = 2mS)

Returns:
unsigned int - The average of the sampled values

See also:
Sensor::get

Reimplemented in LightSensor.
Definition at line 167 of file Sensor.H.
References delay(), and Sensor::get().

void Sensor::strobe ( const int ms ) const [inline, inherited]

Turn sensor off, wait for {ms} milliSeconds, then then turn it back on.

Parameters:

ms - Number of milliSeconds to wait between off and back on

See also:
Sensor::on, Sensor::off, Sensor::active, Sensor::passive, Sensor::mode

Definition at line 158 of file Sensor.H.
References delay(), Sensor::off(), and Sensor::on().

void Sensor::strobe ( ) const [inline, inherited]

Quickly turn sensor off then back on.

See also:
Sensor::on, Sensor::off, Sensor::active, Sensor::passive, Sensor::mode

Definition at line 151 of file Sensor.H.
References Sensor::off(), and Sensor::on().

int TemperatureSensor::tenths ( ) const [inline]

Get the current temperature in C * 10, as an int.

Returns:
int - the current temperature in C * 10

Definition at line 90 of file TemperatureSensor.H.
References C().

Member Data Documentation

volatile unsigned int& Sensor::sensor [protected, inherited]

The address of our sensor value.

Definition at line 181 of file Sensor.H.
Referenced by Sensor::active(), Sensor::get(), Sensor::passive(), and Sensor::Sensor().

The documentation for this class was generated from the following file:

include/c++/TemperatureSensor.H

brickOS is released under the Mozilla Public License.
Original code copyright 1998-2002 by the authors.

Generated on Mon Feb 16 21:02:08 2004 for brickOS C++ by

1.3.5

TemperatureSensor Class Reference

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation