LightSensor Class Reference

Light-sensor interface (active/passive mode). More...

#include <c++/LightSensor.H>

Inheritance diagram for LightSensor:

[legend]Collaboration diagram for LightSensor:

[legend]List of all members.

Public Types
enum	Port { S1 = 0, S2, S3, Battery }
	List of sensor identifiers (IDs). Possible Sensor Port Values. More...
Public Member Functions
	LightSensor (const Sensor::Port port)
	Instance an active light sensor at {port}.
unsigned int	get () const
	Get the current lightSensor value.
unsigned int	sample (unsigned int size=10, int wait=2) const
	Get the average of {size} samples, waiting {wait} mSec between each sample.
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.
Protected Attributes
volatile unsigned int &	sensor
	The address of our sensor value.

---

Detailed Description

Light-sensor interface (active/passive mode).

The LightSensor Class - using a LightSensor in active or passive mode

At construction time you specify the RCX connector pad to which the LightSensor is attached.

This class provides two methods to read the value of the sensor [get, sample]

Note:

access methods from the base class Sensor if you desire access to the raw sensor values or to the power control methods.

See also:

The other sensor classes: Sensor, RotationSensor, and TouchSensor

Definition at line 46 of file LightSensor.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

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

Instance an active light sensor at {port}. Parameters: port  The connector pad (1, 2 or 3) to which the light sensor is attached Definition at line 53 of file LightSensor.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().

unsigned int LightSensor::get (   )  const [inline]

Get the current lightSensor value. NOTE: ultimately, this will be scaled to fall between 0 and 100. Returns: unsigned int - the current light sensor reading See also: LightSensor::sample Reimplemented from Sensor. Definition at line 61 of file LightSensor.H. References LIGHT. Referenced by 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 LightSensor::sample (  unsigned int  size = 10, int  wait = 2 )  const [inline]

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: LightSensor::get Reimplemented from Sensor. Definition at line 69 of file LightSensor.H. References delay(), and 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().

---

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++/LightSensor.H

---

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

---

Generated on Mon Feb 16 21:02:34 2004 for brickOS Kernel Developer by 1.3.5