#include <c++/TouchSensor.H>
Inheritance diagram for TouchSensor:
Public Types | |
enum | Port { S1 = 0, S2, S3, Battery } |
List of sensor identifiers (IDs).Possible Sensor Port Values. More... | |
Public Member Functions | |
TouchSensor (const Sensor::Port port) | |
construct a TouchSensor connected to pad {port} | |
bool | pressed () const |
determine if touch sensor is pressed | |
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. |
The Touch Sensor Class - using a touch sensor in passive mode
At construction time you specify the RCX connector pad to which the touchSensor is attached.
Definition at line 44 of file TouchSensor.H.
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
TouchSensor::TouchSensor | ( | const Sensor::Port | port | ) | [inline] |
construct a TouchSensor connected to pad {port}
port | and input port of the RCX |
Definition at line 51 of file TouchSensor.H.
bool TouchSensor::pressed | ( | ) | const [inline] |
determine if touch sensor is pressed
Definition at line 56 of file TouchSensor.H.
References Sensor::sensor, and TOUCH.
unsigned int Sensor::get | ( | ) | const [inline, inherited] |
Get the current sensor reading.
Reimplemented in LightSensor.
Definition at line 109 of file Sensor.H.
References Sensor::sensor.
Referenced by TemperatureSensor::C(), and Sensor::sample().
void Sensor::mode | ( | bool | makeActive | ) | const [inline, inherited] |
Set the sensor (mode) to active or passive.
makeActive | - T/F - Where true means to go active (voltage is supplied to the connector pad) |
Definition at line 118 of file Sensor.H.
References Sensor::active(), and Sensor::passive().
void Sensor::passive | ( | ) | const [inline, inherited] |
Set the sensor to passive (turn off voltage to connector).
Definition at line 127 of file Sensor.H.
References ds_passive(), and Sensor::sensor.
Referenced by Sensor::mode(), Sensor::off(), and Sensor::Sensor().
void Sensor::active | ( | ) | const [inline, inherited] |
Set the sensor to active (provide voltage to connector).
Definition at line 133 of file Sensor.H.
References ds_active(), and Sensor::sensor.
Referenced by Sensor::mode(), Sensor::on(), and Sensor::Sensor().
void Sensor::on | ( | ) | const [inline, inherited] |
Turn the sensor on (provide voltage to connector).
Reimplemented in RotationSensor.
Definition at line 139 of file Sensor.H.
References Sensor::active().
Referenced by Sensor::strobe().
void Sensor::off | ( | ) | const [inline, inherited] |
Turn the sensor off (turn off voltage to connector).
Reimplemented in RotationSensor.
Definition at line 145 of file Sensor.H.
References Sensor::passive().
Referenced by Sensor::strobe(), and Sensor::~Sensor().
void Sensor::strobe | ( | ) | const [inline, inherited] |
Quickly turn sensor off then back on.
Definition at line 151 of file Sensor.H.
References Sensor::off(), and Sensor::on().
void Sensor::strobe | ( | const int | ms | ) | const [inline, inherited] |
Turn sensor off, wait for {ms} milliSeconds, then then turn it back on.
ms | - Number of milliSeconds to wait between off and back on |
Definition at line 158 of file Sensor.H.
References delay(), Sensor::off(), and Sensor::on().
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.
size | - Number of samples to average (default = 10 samples) | |
wait | - time (in mS) to wait between samples (default = 2mS) |
Reimplemented in LightSensor.
Definition at line 167 of file Sensor.H.
References delay(), and Sensor::get().
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(), LightSensor::get(), RotationSensor::off(), RotationSensor::on(), Sensor::passive(), RotationSensor::pos(), and pressed().
brickOS is released under the
Mozilla Public License.
Original code copyright 1998-2005 by the authors. |