Package org.sensorhub.api.sensor

Interface ISensorDriver

All Superinterfaces:

ICommandReceiver, IDataProducer, IEventProducer, ISystemDriver

All Known Subinterfaces:

IActuatorDriver, ISensorModule<ConfigType>

public interface ISensorDriver
extends ISystemDriver, IDataProducer, ICommandReceiver

Interface for sensor drivers combining data and control interfaces.

Since:

Mar 23, 2017

Method Summary

Modifier and Type	Method	Description
Map<String,? extends IStreamingDataInterface>	getObservationOutputs()	Retrieves the list of interface to sensor observation outputs
Map<String,? extends IStreamingDataInterface>	getStatusOutputs()	Retrieves the list of interface to sensor status outputs
boolean	isConnected()	Returns the sensor connection status. This method must do whatever it can to really detect the presence of the sensor.

Methods inherited from interface org.sensorhub.api.command.ICommandReceiver

getCommandInputs

Methods inherited from interface org.sensorhub.api.data.IDataProducer

getCurrentFeaturesOfInterest, getOutputs

Methods inherited from interface org.sensorhub.api.event.IEventProducer

registerListener, unregisterListener

Methods inherited from interface org.sensorhub.api.system.ISystemDriver

getCurrentDescription, getDescription, getLatestDescriptionUpdate, getName, getParentSystem, getParentSystemUID, getUniqueIdentifier, isEnabled

Method Details

getStatusOutputs

Map<String,? extends IStreamingDataInterface> getStatusOutputs()

Retrieves the list of interface to sensor status outputs

Returns:

Read-only map of output names to data interface objects

getObservationOutputs

Map<String,? extends IStreamingDataInterface> getObservationOutputs()

Retrieves the list of interface to sensor observation outputs

Returns:

Read-only map of output names to data interface objects

isConnected

boolean isConnected()

Returns the sensor connection status.
This method must do whatever it can to really detect the presence of the sensor. Consequently, this method can block for long periods of time.

Returns:

true if sensor is actually connected and can communicate with the driver