Package berlin.yuna.tinkerforgesensor.logic

Class Sensor

java.lang.Object

berlin.yuna.tinkerforgesensor.logic.Sensor

All Implemented Interfaces:

Comparable<Sensor>

public class Sensor
extends Object
implements Comparable<Sensor>

Constructor Summary

Constructors

Constructor	Description
Sensor(int id, String uid, Stack stack, char position, String parentUid, Class<? extends com.tinkerforge.Device> deviceClass, Class<? extends SensorHandler<?>> handlerClass)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Sensor o)
com.tinkerforge.Device	device()
boolean	equals(Object o)
int	getBrightness()
int	getId()
String	getName()
Optional<Sensor>	getParent()
String	getParentUid()
int	getPort()
char	getPosition()
Stack	getStack()
String	getUid()
SensorHandler<?>	handler()	A Sensor is just a wrapper of SensorHandler which can be identical used directly
boolean	hasFrequency()
int	hashCode()
boolean	hasHighContrast()
boolean	hasInfoLed()	Sets info led to LedStatusType.LED_ON used by Sensors like ImuBrick ImuBrickV2 Accelerometer AccelerometerV2 LedRGBV2 LightColor LightColorV2 MasterBrick
boolean	hasStatusLed()
IsSensor	is()
boolean	is(Class<?>... types)
boolean	isBrick()
void	isBrick(boolean brick)
Sensor	send(Object object)
Sensor	sendColor(Color color)	Used for sensors like {@link {@link ButtonRGB }} LedRGBV2
Sensor	sendColor(Number color)	Used for sensors like {@link {@link ButtonRGB }} LedRGBV2
Sensor	sendSound(int durationMs)	Sends a sound - see sendSound(int, int) and setFrequency(int) used by like Speaker (600Hz - 7100Hz) SpeakerV2 (50Hz - 15000Hz)
Sensor	sendSound(int durationMs, boolean wait)	Sends a sound - see sendSound(int, int) and setFrequency(int) used by like Speaker (600Hz - 7100Hz) SpeakerV2 (50Hz - 15000Hz)
Sensor	sendSound(int durationMs, int frequency)	Sends a sound used by like Speaker (600Hz - 7100Hz) SpeakerV2 (50Hz - 15000Hz)
Sensor	sendSound(int durationMs, int frequency, boolean wait)	Sends a sound used by like Speaker (600Hz - 7100Hz) SpeakerV2 (50Hz - 15000Hz)
Sensor	sendSound(int durationMs, int frequency, int volume)	Sends a sound used by like Speaker (600Hz - 7100Hz) (no volume) SpeakerV2 (50Hz - 15000Hz) (volume: 0-10)
Sensor	setBrightness(int brightness)	Sets SensorHandler.CONFIG_BRIGHTNESS (0-7) for sensors used by like DisplaySegment, DisplaySegmentV2
Sensor	setFrequency(int frequency)	Sets SensorHandler.CONFIG_FREQUENCY for sensors used by like Speaker (600Hz - 7100Hz) Speaker (50Hz - 15000Hz)
Sensor	setHighContrast(boolean highContrast)	Sets SensorHandler.CONFIG_HIGH_CONTRAST for color inputs of sendColor(Color) used by like ButtonRGB LedRGBV2
Sensor	setInfoLedOff()	Sets info led to LedStatusType.LED_OFF used by Sensors like ImuBrick ImuBrickV2 Accelerometer AccelerometerV2 LedRGBV2 LightColor LightColorV2 MasterBrick
Sensor	setInfoLedON()	Sets info led to LedStatusType.LED_OFF used by Sensors like ImuBrick ImuBrickV2 Accelerometer AccelerometerV2 LedRGBV2 LightColor LightColorV2 MasterBrick
Sensor	setLedState(int ledId, int ledState)	Set the state of an specific led used by like ButtonDualV2
Sensor	setLedState(int ledId, LedStatusType ledState)	Set the state of an specific led used by like ButtonDualV2
void	setPort(int port)
Sensor	setStatusLed(LedStatusType type)	Sets status led to LedStatusType.LED_ON
Sensor	setStatusLedDefault()	Sets status led to LedStatusType.LED_STATUS
Sensor	setStatusLedHeartbeat()	Sets status led to LedStatusType.LED_HEARTBEAT
Sensor	setStatusLedOff()	Sets status led to LedStatusType.LED_OFF
Sensor	setStatusLedOn()	Sets status led to LedStatusType.LED_ON
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Sensor

public Sensor(int id,
              String uid,
              Stack stack,
              char position,
              String parentUid,
              Class<? extends com.tinkerforge.Device> deviceClass,
              Class<? extends SensorHandler<?>> handlerClass)

Method Detail

send

public Sensor send(Object object)

hasHighContrast

public boolean hasHighContrast()

Returns:

true if the sensor uses SensorHandler.CONFIG_HIGH_CONTRAST see setHighContrast(boolean)

setHighContrast

public Sensor setHighContrast(boolean highContrast)

Sets SensorHandler.CONFIG_HIGH_CONTRAST for color inputs of sendColor(Color) used by like ButtonRGB LedRGBV2

Parameters:

highContrast - sets SensorHandler.CONFIG_HIGH_CONTRAST

Returns:

self Sensor

hasFrequency

public boolean hasFrequency()

Returns:

true if the sensor uses SensorHandler.CONFIG_FREQUENCY see setFrequency(int)

setFrequency

public Sensor setFrequency(int frequency)

Sets SensorHandler.CONFIG_FREQUENCY for sensors used by like Speaker (600Hz - 7100Hz) Speaker (50Hz - 15000Hz)

Parameters:

frequency - sets SensorHandler.CONFIG_FREQUENCY

Returns:

self Sensor

getBrightness

public int getBrightness()

Returns:

SensorHandler.CONFIG_BRIGHTNESS value see SensorHandler.setBrightness(int)

setBrightness

public Sensor setBrightness(int brightness)

Sets SensorHandler.CONFIG_BRIGHTNESS (0-7) for sensors used by like DisplaySegment, DisplaySegmentV2

Parameters:

brightness - sets SensorHandler.CONFIG_BRIGHTNESS

Returns:

self Sensor

sendColor

public Sensor sendColor(Color color)

Used for sensors like {@link {@link ButtonRGB }} LedRGBV2

Parameters:

color - value to set for the sensor

Returns:

self Sensor

sendColor

public Sensor sendColor(Number color)

Used for sensors like {@link {@link ButtonRGB }} LedRGBV2

Parameters:

color - value to set for the sensor

Returns:

self Sensor

hasStatusLed

public boolean hasStatusLed()

Returns:

true if this Sensor has a status led

setStatusLed

public Sensor setStatusLed(LedStatusType type)

Sets status led to LedStatusType.LED_ON

Returns:

self Sensor

setStatusLedOn

public Sensor setStatusLedOn()

Sets status led to LedStatusType.LED_ON

Returns:

self Sensor

setStatusLedOff

public Sensor setStatusLedOff()

Sets status led to LedStatusType.LED_OFF

Returns:

self Sensor

hasInfoLed

public boolean hasInfoLed()

Sets info led to LedStatusType.LED_ON used by Sensors like ImuBrick ImuBrickV2 Accelerometer AccelerometerV2 LedRGBV2 LightColor LightColorV2 MasterBrick

Returns:

self Sensor

setInfoLedON

public Sensor setInfoLedON()

Sets info led to LedStatusType.LED_OFF used by Sensors like ImuBrick ImuBrickV2 Accelerometer AccelerometerV2 LedRGBV2 LightColor LightColorV2 MasterBrick

Returns:

self Sensor

setInfoLedOff

public Sensor setInfoLedOff()

Sets info led to LedStatusType.LED_OFF used by Sensors like ImuBrick ImuBrickV2 Accelerometer AccelerometerV2 LedRGBV2 LightColor LightColorV2 MasterBrick

Returns:

self Sensor

setStatusLedDefault

public Sensor setStatusLedDefault()

Sets status led to LedStatusType.LED_STATUS

Returns:

self Sensor

setStatusLedHeartbeat

public Sensor setStatusLedHeartbeat()

Sets status led to LedStatusType.LED_HEARTBEAT

Returns:

self Sensor

setLedState

public Sensor setLedState(int ledId,
                          LedStatusType ledState)

Set the state of an specific led used by like ButtonDualV2

Returns:

self Sensor

setLedState

public Sensor setLedState(int ledId,
                          int ledState)

Set the state of an specific led used by like ButtonDualV2

Returns:

self Sensor

sendSound

public Sensor sendSound(int durationMs)

Sends a sound - see sendSound(int, int) and setFrequency(int) used by like Speaker (600Hz - 7100Hz) SpeakerV2 (50Hz - 15000Hz)

Parameters:

durationMs - time to send the sound

Returns:

self Sensor

sendSound

public Sensor sendSound(int durationMs,
                        boolean wait)

Sends a sound - see sendSound(int, int) and setFrequency(int) used by like Speaker (600Hz - 7100Hz) SpeakerV2 (50Hz - 15000Hz)

Parameters:

durationMs - time to send the sound

wait - waits until the sound is done

Returns:

self Sensor

sendSound

public Sensor sendSound(int durationMs,
                        int frequency)

Sends a sound used by like Speaker (600Hz - 7100Hz) SpeakerV2 (50Hz - 15000Hz)

Parameters:

durationMs - time to send the sound

frequency - frequency for the sound

Returns:

self Sensor

sendSound

public Sensor sendSound(int durationMs,
                        int frequency,
                        boolean wait)

Sends a sound used by like Speaker (600Hz - 7100Hz) SpeakerV2 (50Hz - 15000Hz)

Parameters:

durationMs - time to send the sound

frequency - frequency for the sound

wait - waits until the sound is done

Returns:

self Sensor

sendSound

public Sensor sendSound(int durationMs,
                        int frequency,
                        int volume)

Sends a sound used by like Speaker (600Hz - 7100Hz) (no volume) SpeakerV2 (50Hz - 15000Hz) (volume: 0-10)

Parameters:

durationMs - time to send the sound

frequency - frequency for the sound

volume - for the sound

Returns:

self Sensor

handler

public SensorHandler<?> handler()

A Sensor is just a wrapper of SensorHandler which can be identical used directly

Returns:

self Sensor

getId

public int getId()

getUid

public String getUid()

getName

public String getName()

getStack

public Stack getStack()

device

public com.tinkerforge.Device device()

getPosition

public char getPosition()

getParentUid

public String getParentUid()

getPort

public int getPort()

setPort

public void setPort(int port)

isBrick

public boolean isBrick()

isBrick

public void isBrick(boolean brick)

getParent

public Optional<Sensor> getParent()

is

public IsSensor is()

is

public boolean is(Class<?>... types)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Sensor o)

Specified by:

compareTo in interface Comparable<Sensor>