net.happybrackets.device.sensors

Class Sensor

java.lang.Object

net.happybrackets.device.sensors.Sensor

Direct Known Subclasses:

Accelerometer, AccelerometerSimulator, Gyroscope, GyroscopeSimulator, HTS221, LPS25H, LSM6DS33, LSM9DS1, Magnetometer, MagnetometerSimulator, MiniMU

public abstract class Sensor
extends java.lang.Object

Abstract base class for types of things that are sensors. Enables adding and removing of sensor listeners, and getting sensor name. See a real Sensor implementation such as MiniMU for more details. Created by ollie on 1/06/2016.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	simulatedOnly
protected boolean	validLoad Add a validLoad flag.

Constructor Summary

Constructors

Constructor and Description
Sensor()

Method Summary

Modifier and Type	Method and Description
void	addListener(SensorUpdateListener listener) Add a @SensorUpdateListener that will listen to this @Sensor.
void	addNonResettableListener(SensorUpdateListener listener) Add a @SensorUpdateListener that will listen to this @Sensor.
void	addNonResettableValueChangedListener(SensorValueChangedListener listener) Add a @SensorValueChangedListener that will listen to this @Sensor.
void	addValueChangedListener(SensorValueChangedListener listener) Add a @SensorValueChangedListener that will listen to this @Sensor.
void	clearListeners() Clear all listeners listening to this @Sensor.
static Sensor	getSensor(java.lang.Class sensorClass) Return a sensor if it has been constructed.
abstract java.lang.String	getSensorName() Returns the sensor name, typically the make/model of the hardware sensor that this class refers to.
static boolean	isSimulatedOnly() Flag to indicate this is just a simulator
boolean	isValidLoadedSensor() returns true if the sensor was loaded correctly.
protected void	notifyListeners() Notify all listeners that the sensor has updated
void	reloadSimulation() Override this on any classes you need to do something as a simulated sensor
void	removeListener(SensorUpdateListener listener) Remove the given @SensorUpdateListener.
void	removeListener(SensorValueChangedListener listener) Remove the given @SensorValueChangedListener.
void	resetToDefault() Override this function on any sensors that have resolution or the likes set
protected double	roundValue(double val, int rounding) Round the double value to the number of decimal places defined by rounding If rounding is less than zero, we will leave value as is
static float	scaleValue(double sensor_min, double sensor_max, double scaled_min, double scaled_max, double sensor_value) Return a scaled value for a sensor based on known maximum and minimum values A continuous function that satisfies this the following sensor_value(sensor_min) = scaled_min sensor_value(sensor_max) = scaled_max
static void	setSimulatedOnly(boolean simulated) Set from inside IDE to indicate we are just simulating a sensor
protected void	setValidLoad(boolean valid) This needs to be set inside sensor to indicate it had a valid load
protected static void	storeSensor(Sensor sensor) Store the sensor into our loadedSensors

Methods inherited from class java.lang.Object

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

Field Detail

validLoad

protected boolean validLoad

Add a validLoad flag. Every sensor will need to set it when it determines that the load is valid

simulatedOnly

protected static boolean simulatedOnly

Constructor Detail

Sensor

public Sensor()

Method Detail

isSimulatedOnly

public static boolean isSimulatedOnly()

Flag to indicate this is just a simulator

Returns:

true if only a simulator

scaleValue

public static float scaleValue(double sensor_min,
                               double sensor_max,
                               double scaled_min,
                               double scaled_max,
                               double sensor_value)

Return a scaled value for a sensor based on known maximum and minimum values A continuous function that satisfies this the following sensor_value(sensor_min) = scaled_min sensor_value(sensor_max) = scaled_max

Parameters:

sensor_min - the minimum value sensor would normally return

sensor_max - the maximum value our sensor would normally return

scaled_min - the value we want returned as our minimum for sensor minimum value

scaled_max - the value we want returned as our maximum for our sensor maximum value

sensor_value - the actual value of the sensor

Returns:

our scaled value

setSimulatedOnly

public static void setSimulatedOnly(boolean simulated)

Set from inside IDE to indicate we are just simulating a sensor

Parameters:

simulated - set to true if we are simulating

getSensorName

public abstract java.lang.String getSensorName()

Returns the sensor name, typically the make/model of the hardware sensor that this class refers to.

Returns:

a String representing the sensor's name.

addListener

public void addListener(SensorUpdateListener listener)

Add a @SensorUpdateListener that will listen to this @Sensor. Will be deprecated in 3.0

Parameters:

listener - the listener to add. deprecated use (@link addValueChangedListener) instead

addNonResettableListener

public void addNonResettableListener(SensorUpdateListener listener)

Add a @SensorUpdateListener that will listen to this @Sensor. Will be deprecated in 3.0 These listeners are not removed when device is reset

Parameters:

listener - the listener to add. deprecated use (@link addValueChangedListener) instead

isValidLoadedSensor

public boolean isValidLoadedSensor()

returns true if the sensor was loaded correctly.

Returns:

true if sensor was loaded correctly

setValidLoad

protected void setValidLoad(boolean valid)

This needs to be set inside sensor to indicate it had a valid load

Parameters:

valid - set to true if loaded

addValueChangedListener

public void addValueChangedListener(SensorValueChangedListener listener)

Add a @SensorValueChangedListener that will listen to this @Sensor.

Parameters:

listener - the listener to add.

addNonResettableValueChangedListener

public void addNonResettableValueChangedListener(SensorValueChangedListener listener)

Add a @SensorValueChangedListener that will listen to this @Sensor. These listeners are NOT removed when device is reset

Parameters:

listener - the listener to add.

removeListener

public void removeListener(SensorUpdateListener listener)

Remove the given @SensorUpdateListener.

Parameters:

listener - the listener to remove.

removeListener

public void removeListener(SensorValueChangedListener listener)

Remove the given @SensorValueChangedListener.

Parameters:

listener - the listener to remove.

clearListeners

public void clearListeners()

Clear all listeners listening to this @Sensor.

notifyListeners

protected void notifyListeners()

Notify all listeners that the sensor has updated

resetToDefault

public void resetToDefault()

Override this function on any sensors that have resolution or the likes set

reloadSimulation

public void reloadSimulation()

Override this on any classes you need to do something as a simulated sensor

roundValue

protected double roundValue(double val,
                            int rounding)

Round the double value to the number of decimal places defined by rounding If rounding is less than zero, we will leave value as is

Parameters:

val - the value to round

rounding - the number of decimal places to round to

Returns:

the new rounded value

getSensor

public static Sensor getSensor(java.lang.Class sensorClass)

Return a sensor if it has been constructed.

Parameters:

sensorClass - the class we are looking for

Returns:

The class if it has been stored, otherwise null

storeSensor

protected static void storeSensor(Sensor sensor)

Store the sensor into our loadedSensors

Parameters:

sensor - the sensor we are loading