# Objects
- protocolRef :
object References used to validate MySensors payloads
- labelsCommand :
object Labels used in Mysensors message to identify commands.
- labelsPresentation :
object Labels used in Mysensors message to identify sensor type in presentation commands.
- labelsSet :
object Labels used in Mysensors message to identify sensor type in Set/req commands.
- labelsInternal :
object Labels used in Mysensors message to identify sensor type in Internal commands.
# Functions
- mySensorsToOmaObject(msg) ⇒
object|null Find corresponding OMA object following a MySensors presentation message
- mySensorsToOmaResources(msg) ⇒
object|null Find corresponding OMA resource to incoming MySensors datas
- mySensorsDecoder(packet, protocol) ⇒
object|null Convert incoming MySensors data to Aloes Client pattern - "+prefixedDevEui/+nodeId/+sensorId/+method/+ack/+type"
- mySensorsPatternDetector(packet) ⇒
object|null Check incoming MQTT packet against MySensors Serial API pattern - "+prefixedDevEui/+nodeId/+sensorId/+method/+ack/+type"
- mySensorsEncoder(instance, protocol) ⇒
object|null Convert incoming Aloes Client data to MySensors protocol pattern - "+prefixedDevEui/+nodeId/+sensorId/+method/+ack/+type"
# External
- OmaObjects
Oma Object References.
- OmaResources
Oma Resources References.
- MySensorsAPI
MySensors Serial API
# protocolRef : object
References used to validate MySensors payloads
Kind: global namespace
Properties
| Name | Type | Description |
|---|---|---|
| pattern | string | The pattern used by MySensors MQTT devices. |
| validators | object | Check inputs / build outputs |
| validators.nodeId | array | |
| validators.methods | array | [0, 1, 2, 3, 4]. |
# labelsCommand : object
Labels used in Mysensors message to identify commands.
Kind: global namespace
Properties
| Name | Type | Description |
|---|---|---|
| Type | string | MySensors Type |
| value | number | MySensors Type value ( used by transport ) |
| description | string | MySensors Type description |
# labelsPresentation : object
Labels used in Mysensors message to identify sensor type in presentation commands.
Kind: global namespace
Properties
| Name | Type | Description |
|---|---|---|
| Type | string | MySensors Type |
| value | number | MySensors Type value ( used by transport ) |
| omaObject | number | OMA Object ID |
| description | string | MySensors Type description |
| resources | Array.<string> | MySensors variable subtype used by this type |
# labelsSet : object
Labels used in Mysensors message to identify sensor type in Set/req commands.
Kind: global namespace
Properties
| Name | Type | Description |
|---|---|---|
| Type | string | MySensors subtype |
| value | number | MySensors Subype value ( used by transport ) |
| omaResources | object | OMA Resources attached to labelsPresentation[0].omaObject |
| Unit | string | Sensor value unit |
| description | string | MySensors Subtype description |
| sensorTypes | Array.<string> | MySensors Type(s) using this variable |
# labelsInternal : object
Labels used in Mysensors message to identify sensor type in Internal commands.
Kind: global namespace
Properties
| Name | Type | Description |
|---|---|---|
| Type | string | MySensors subtype |
| value | number | MySensors Subype value ( used by transport ) |
| description | string | MySensors Subtype description |
# mySensorsToOmaObject(msg) ⇒ object | null
Find corresponding OMA object following a MySensors presentation message
Kind: global function
Returns: object | null - sensor
| Param | Type | Description |
|---|---|---|
| msg | object | Decoded MQTT packet. |
# mySensorsToOmaResources(msg) ⇒ object | null
Find corresponding OMA resource to incoming MySensors datas
Kind: global function
Returns: object | null - sensor
| Param | Type | Description |
|---|---|---|
| msg | object | Decoded MQTT packet. |
# mySensorsDecoder(packet, protocol) ⇒ object | null
Convert incoming MySensors data to Aloes Client pattern - "+prefixedDevEui/+nodeId/+sensorId/+method/+ack/+type"
Kind: global function
Returns: object | null - sensor
| Param | Type | Description |
|---|---|---|
| packet | object | Incoming MQTT packet. |
| protocol | object | Protocol paramters ( coming from patternDetector ). |
# mySensorsPatternDetector(packet) ⇒ object | null
Check incoming MQTT packet against MySensors Serial API pattern - "+prefixedDevEui/+nodeId/+sensorId/+method/+ack/+type"
Kind: global function
Returns: object | null - pattern
Mthod: mySensorsPatternDetector
| Param | Type | Description |
|---|---|---|
| packet | object | The MQTT packet. |
# mySensorsEncoder(instance, protocol) ⇒ object | null
Convert incoming Aloes Client data to MySensors protocol pattern - "+prefixedDevEui/+nodeId/+sensorId/+method/+ack/+type"
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 (opens new window)
# OmaResources
Oma Resources References.
Kind: global external
See: https://aloes.io/app/api/omaResources (opens new window)
# MySensorsAPI
MySensors Serial API
Kind: global external
See: https://www.mysensors.org/download/serial_api_20 (opens new window)
← Readme