MonoBrick EV3 Firmware: MonoBrickFirmware.Sensors.I2CSensor Class Reference

MonoBrick EV3 Firmware

Base class for all I2C sensors. This should be used when implementing a new I2C sensor More...

Inheritance diagram for MonoBrickFirmware.Sensors.I2CSensor:

Public Member Functions
	I2CSensor (SensorPort port, byte address, I2CMode mode)

abstract string	ReadAsString ()
	Reads the sensor value as a string. More...

abstract void	SelectNextMode ()
	Selects the next mode. More...

abstract string	GetSensorName ()
	Gets the name of the sensor. More...

abstract void	SelectPreviousMode ()
	Selects the previous mode. More...

abstract int	NumberOfModes ()
	Numbers the of modes. More...

abstract string	SelectedMode ()
	.m.-, More...

Public Attributes
const int	BufferSize = 30

Protected Member Functions
void	Reset ()

void	SetMode ()

bool	Initialise ()

byte[]	ReadRegister (byte register)
	Reads a 8 byte register from the sensor More...

byte[]	ReadRegister (byte register, byte rxLength)
	Reads a register from the sensor More...

void	WriteRegister (byte register, byte data)
	Writes a byte to a register. More...

void	WriteRegister (byte register, byte[] data)

byte[]	WriteAndRead (byte register, byte[] data, int rxLength)
	Write and read an array of bytes to the sensor More...

Protected Attributes
byte	I2CAddress = 0x00

const int	NumberOfSensorPorts = SensorManager.NumberOfSensorPorts

SensorPort	port

I2CMode	mode

Properties
UARTMode	uartMode `[get, set]`

SensorPort	Port `[get]`

Properties inherited from MonoBrickFirmware.Sensors.ISensor
SensorPort	Port `[get]`
	Sensor port More...

Detailed Description

Base class for all I2C sensors. This should be used when implementing a new I2C sensor

Member Function Documentation

abstract string MonoBrickFirmware.Sensors.I2CSensor.GetSensorName ( )

pure virtual

Gets the name of the sensor.

Returns: The sensor name.

Implements MonoBrickFirmware.Sensors.ISensor.

Implemented in MonoBrickFirmware.Sensors.NXTUltraSonicSensor, MonoBrickFirmware.Sensors.HiTecTiltSensor, MonoBrickFirmware.Sensors.HiTecColorSensor, and MonoBrickFirmware.Sensors.HiTecCompassSensor.

abstract int MonoBrickFirmware.Sensors.I2CSensor.NumberOfModes ( )

pure virtual

Numbers the of modes.

Returns: The number of modes

Implements MonoBrickFirmware.Sensors.ISensor.

Implemented in MonoBrickFirmware.Sensors.NXTUltraSonicSensor, MonoBrickFirmware.Sensors.HiTecTiltSensor, MonoBrickFirmware.Sensors.HiTecColorSensor, and MonoBrickFirmware.Sensors.HiTecCompassSensor.

abstract string MonoBrickFirmware.Sensors.I2CSensor.ReadAsString ( )

pure virtual

Reads the sensor value as a string.

Returns: The value as a string

Implements MonoBrickFirmware.Sensors.ISensor.

Implemented in MonoBrickFirmware.Sensors.NXTUltraSonicSensor, MonoBrickFirmware.Sensors.HiTecTiltSensor, MonoBrickFirmware.Sensors.HiTecColorSensor, and MonoBrickFirmware.Sensors.HiTecCompassSensor.

byte [] MonoBrickFirmware.Sensors.I2CSensor.ReadRegister ( byte register )

inlineprotected

Reads a 8 byte register from the sensor

Returns: The bytes that was read

Parameters

register Register to read

byte [] MonoBrickFirmware.Sensors.I2CSensor.ReadRegister	(	byte	register,
		byte	rxLength
	)

inlineprotected

Reads a register from the sensor

Returns: The bytes that was read

Parameters

register	Register to read
rxLength	The number of bytes to read

abstract string MonoBrickFirmware.Sensors.I2CSensor.SelectedMode ( )

pure virtual

.m.-,

Returns: The mode.

Implements MonoBrickFirmware.Sensors.ISensor.

Implemented in MonoBrickFirmware.Sensors.NXTUltraSonicSensor, MonoBrickFirmware.Sensors.HiTecTiltSensor, MonoBrickFirmware.Sensors.HiTecColorSensor, and MonoBrickFirmware.Sensors.HiTecCompassSensor.

abstract void MonoBrickFirmware.Sensors.I2CSensor.SelectNextMode ( )

pure virtual

Selects the next mode.

Implements MonoBrickFirmware.Sensors.ISensor.

Implemented in MonoBrickFirmware.Sensors.NXTUltraSonicSensor, MonoBrickFirmware.Sensors.HiTecTiltSensor, MonoBrickFirmware.Sensors.HiTecColorSensor, and MonoBrickFirmware.Sensors.HiTecCompassSensor.

abstract void MonoBrickFirmware.Sensors.I2CSensor.SelectPreviousMode ( )

pure virtual

Selects the previous mode.

Implements MonoBrickFirmware.Sensors.ISensor.

Implemented in MonoBrickFirmware.Sensors.NXTUltraSonicSensor, MonoBrickFirmware.Sensors.HiTecTiltSensor, MonoBrickFirmware.Sensors.HiTecColorSensor, and MonoBrickFirmware.Sensors.HiTecCompassSensor.

byte [] MonoBrickFirmware.Sensors.I2CSensor.WriteAndRead	(	byte	register,
		byte[]	data,
		int	rxLength
	)

inlineprotected

Write and read an array of bytes to the sensor

Returns: The bytes that was read

Parameters

register	Register to write to.
data	Byte array to write
rxLength	Length of the expected reply

void MonoBrickFirmware.Sensors.I2CSensor.WriteRegister	(	byte	register,
		byte	data
	)

inlineprotected

Writes a byte to a register.

Parameters

register	Register to write to
data	Data byte to write

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

Sensors/I2CSensor.cs