# Objects
- protocolRef :
object References used to validate payloads
# Functions
- aloesLightToOmaObject(msg) ⇒
object|null Find corresponding OMA Object following a AloesLight presentation message
- aloesLightToOmaResources(msg) ⇒
object|null Find corresponding OMA Resources to incoming AloesLight datas
- aloesLightDecoder(packet, protocol) ⇒
object|null Convert incoming AloesLight data to Aloes Client
pattern : '+prefixedDevEui/+method/+omaObjectId/+sensorId/+omaResourceId'
- aloesLightPatternDetector(packet) ⇒
object|null Check incoming MQTT packet against AloesLight API
- aloesLightEncoder(instance, protocol) ⇒
object|null Convert incoming Aloes Client data to AloesLight protocol
# External
- OmaObjects
Oma Object References.
- OmaResources
Oma Resources References.
# protocolRef : object
References used to validate payloads
Kind: global namespace
Properties
| Name | Type | Description |
|---|---|---|
| pattern | string | The pattern used by Aloes Light devices. |
| validators | object | Check inputs / build outputs |
| validators.prefixedDevEui | array | |
| validators.nodeId | array | |
| validators.methods | array | [0, 1, 2, 3, 4]. |
# aloesLightToOmaObject(msg) ⇒ object | null
Find corresponding OMA Object following a AloesLight presentation message
Kind: global function
Returns: object | null - composed instance
| Param | Type | Description |
|---|---|---|
| msg | object | Decoded MQTT packet. |
# aloesLightToOmaResources(msg) ⇒ object | null
Find corresponding OMA Resources to incoming AloesLight datas
Kind: global function
Returns: object | null - composed instance
| Param | Type | Description |
|---|---|---|
| msg | object | Decoded MQTT packet. |
# aloesLightDecoder(packet, protocol) ⇒ object | null
Convert incoming AloesLight data to Aloes Client
pattern : '+prefixedDevEui/+method/+omaObjectId/+sensorId/+omaResourceId'
Kind: global function
Returns: object | null - composed instance
| Param | Type | Description |
|---|---|---|
| packet | object | Incoming MQTT packet. |
| protocol | object | Protocol paramters ( coming from patternDetector ). |
# aloesLightPatternDetector(packet) ⇒ object | null
Check incoming MQTT packet against AloesLight API
Kind: global function
Returns: object | null - pattern
| Param | Type | Description |
|---|---|---|
| packet | object | The MQTT packet. |
# aloesLightEncoder(instance, protocol) ⇒ object | null
Convert incoming Aloes Client data to AloesLight protocol
Kind: global function
Returns: object | null - packet
Throws:
Error'Wrong protocol input'
| Param | Type | Description |
|---|---|---|
| instance | object | Sensor instance. |
| protocol | object | Protocol parameters ( coming from patternDetector ). |
# OmaObjects
Oma Object References.
Kind: global external
See: https://aloes.io/app/api/omaObjects
# OmaResources
Oma Resources References.
Kind: global external
See: https://aloes.io/app/api/omaResources
← Readme