ch.aplu.ev3

Class I2CSensor

java.lang.Object

ch.aplu.ev3.Part

ch.aplu.ev3.Sensor

ch.aplu.ev3.I2CSensor

Direct Known Subclasses:

ArduinoLink, OpticalDistanceSensor, PrototypeSensor, SuperProSensor, TemperatureSensor

public class I2CSensor
extends Sensor

A sensor wrapper to allow easy access to I2C sensors.

Constructor Summary

Constructors

Constructor and Description
I2CSensor(SensorPort port) Creates a sensor instance of given type connected to the given port using the default address (0x02) and the default sensor type (LOWSPEED_9V).
I2CSensor(SensorPort port, int sensorType) Creates a sensor instance of given type connected to the given port using the default address (0x02) and the give sensor type.
I2CSensor(SensorPort port, int deviceAddress, int sensorType) Creates a sensor instance of given type connected to the given port the given device address and the given sensor type.

Method Summary

Methods

Modifier and Type	Method and Description
void	getData(int register, byte[] buf, int len) Retrieves data from the sensor and waits for the result.
void	getData(int register, byte[] buf, int offset, int len) Retrieves data from the sensor and waits for the result.
lejos.hardware.sensor.I2CSensor	getLejosI2CSensor() Returns the reference of the the underlying lejos.hardware.sensor.I2CSensor.
java.lang.String	getProductID() Returns the product identifier (if available).
java.lang.String	getVersion() Returns the sensor version number (if available).
void	sendData(int register, byte value) Sets a single byte in the I2C sensor.
void	sendData(int register, byte[] buf, int len) Send multiple values with a I2C write transaction.
void	sendData(int register, byte[] buf, int offset, int len) Send multiple values with a I2C write transaction.

Methods inherited from class ch.aplu.ev3.Sensor

getLejosPort

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

I2CSensor

public I2CSensor(SensorPort port)

Creates a sensor instance of given type connected to the given port using the default address (0x02) and the default sensor type (LOWSPEED_9V).

Parameters:

port - the port where the sensor is plugged-in

I2CSensor

public I2CSensor(SensorPort port,
         int sensorType)

Creates a sensor instance of given type connected to the given port using the default address (0x02) and the give sensor type.

Parameters:

port - the port where the sensor is plugged-in

sensorType - the type of the sensor

I2CSensor

public I2CSensor(SensorPort port,
         int deviceAddress,
         int sensorType)

Creates a sensor instance of given type connected to the given port the given device address and the given sensor type.

Parameters:

port - the port where the sensor is plugged-in

deviceAddress - in standard Lego/NXT format (range 0x02-0xFE).

sensorType - the type of the sensor

Method Detail

getData

public void getData(int register,
           byte[] buf,
           int len)

Retrieves data from the sensor and waits for the result. Data is read from registers in the sensor, usually starting at 0x00. Just supply the register to start reading at, and the length of bytes to read (16 maximum).

Parameters:

register - the starting register used

buf - the buffer where data are returned

len - the length of data to read (minimum 1, maximum 16)

getData

public void getData(int register,
           byte[] buf,
           int offset,
           int len)

Retrieves data from the sensor and waits for the result. Data is read from registers in the sensor, usually starting at 0x00. Just supply the register to start reading at, and the length of bytes to read (16 maximum).

Parameters:

register - the starting register used

buf - the buffer where data are returned

offset - offset of the start of the data

len - the length of data to read (minimum 1, maximum 16)

sendData

public void sendData(int register,
            byte value)

Sets a single byte in the I2C sensor.

Parameters:

register - the data register in the I2C sensor

value - the data sent to the sensor

sendData

public void sendData(int register,
            byte[] buf,
            int len)

Send multiple values with a I2C write transaction.

Parameters:

register - the starting register in the I2C sensor

buf - the buffer where data are supplied

len - the length the buffer (minimum 1, maximum 16)

sendData

public void sendData(int register,
            byte[] buf,
            int offset,
            int len)

Send multiple values with a I2C write transaction.

Parameters:

register - the starting register in the I2C sensor

buf - the buffer where data are supplied

len - the length the buffer (minimum 1, maximum 16)

offset - offset of the start of the data

getProductID

public java.lang.String getProductID()

Returns the product identifier (if available).

Returns:

the product identifier (PID)

getVersion

public java.lang.String getVersion()

Returns the sensor version number (if available).

Returns:

the sensor version number

getLejosI2CSensor

public lejos.hardware.sensor.I2CSensor getLejosI2CSensor()

Returns the reference of the the underlying lejos.hardware.sensor.I2CSensor.

Returns:

the reference of the lejos.hardware.sensor.I2CSensor