SensorHandler
Main class for handling sensors. This class allows get, watch, etc. of sensors.
Constructor Summary
Public Constructor | ||
public |
|
Member Summary
Public Members | ||
public |
|
|
public |
|
|
public |
sensors: {} |
Method Summary
Public Methods | ||
public |
addSensorEvent(sensorName: string, eventName: string, handle: function): boolean Adds sensor event. |
|
public |
Get sensor once. |
|
public |
getMappedSensorNames(): array Gets usable sensor names |
|
public |
removeSensorEvent(sensorName: string, eventName: string, handle: function): boolean Removes sensor event. |
|
public |
Stops watching sensor. |
|
public |
stopAll(): promise Stops watching all. |
|
public |
updateSensorListeners(handle: Function) Update registered sensor listeners. |
|
public |
Watch sensor from RawSensorWatcher. |
|
public |
watchAll(): promise Watches all available sensors. |
Private Methods | ||
private |
_SensorState(): SensorState Current state of sensor |
|
private |
_getDefaultDataEvent(sensorName: String): Function Data event used when no event to handle sensor data is provided. |
|
private |
_getSensorCreationCount(sensorName: String): Number Gets number of times sensor created |
|
private |
_incSensorCreationCount(sensorName: String): Number Increment sensor creation count |
|
private |
_setSensorState(sensorName: string, settings: object): * Sets sensor state. |
Public Constructors
public constructor() source
Public Members
public rawSensorWatcher: * source
public sensorCreationCounts: {} source
public sensors: {} source
Public Methods
public addSensorEvent(sensorName: string, eventName: string, handle: function): boolean source
Adds sensor event. Multiple at same time ok.
public get(sensorName: string): * source
Get sensor once. Should stop watching sensor if newly made.
Params:
Name | Type | Attribute | Description |
sensorName | string |
Return:
* |
public removeSensorEvent(sensorName: string, eventName: string, handle: function): boolean source
Removes sensor event. Only removes handle specified.
public stop(sensorName: string): promise source
Stops watching sensor.
Params:
Name | Type | Attribute | Description |
sensorName | string |
Return:
promise |
public updateSensorListeners(handle: Function) source
Update registered sensor listeners. Pass handle with one argument. MUST return. Dynamic updating during watching may result in bugs.
Params:
Name | Type | Attribute | Description |
handle | Function | handle taking object map of registered SensorListeners |
public watch(sensorName: string, options: object): promise source
Watch sensor from RawSensorWatcher. Ignores duplicates. options: { events: { data: function(data){} } }
Return:
promise | promise resolving SensorState |
public watchAll(): promise source
Watches all available sensors.
Return:
promise | Resolves array of SensorStates. However allows for failing returning null. |
Private Methods
private _getDefaultDataEvent(sensorName: String): Function source
Data event used when no event to handle sensor data is provided. Stringifies data and logs.
Params:
Name | Type | Attribute | Description |
sensorName | String |
private _getSensorCreationCount(sensorName: String): Number source
Gets number of times sensor created
Params:
Name | Type | Attribute | Description |
sensorName | String |