diff options
Diffstat (limited to 'diller/README.md')
| -rw-r--r-- | diller/README.md | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/diller/README.md b/diller/README.md index b2d96f8..b454862 100644 --- a/diller/README.md +++ b/diller/README.md @@ -4,18 +4,18 @@ Is registration required? Can't the firmware just send an update without a value # MQTT -## Device / Sensor hierarchy - - /<device id> - /sensor - /<sensor id> - /value - /type (retained) - /name (retained) - /description (retained) - /type TODO: remove? - /status TODO: remove? type specified what the message looks like - /firmware For updating the device's firmware +## Device / Property hierarchy + + /<device id> + /property + /<property id> + /value + /type (retained) + /name (retained) + /description (retained) + /type TODO: remove? + /status TODO: remove? type specified what the message looks like + /firmware For updating the device's firmware # Diller serial API @@ -25,13 +25,13 @@ Request: Update or query network settings. If no paramters are given, no changes are done. If ip is set to a blank string, it will use DHCP. - network [ip=..] [gateway=..] [netmask=..] + network [ip=..] [gateway=..] [netmask=..] Response: The command will always return the current values. - - ok ip=.. gateway=.. netmask=.. netmask=.. + + ok ip=.. gateway=.. netmask=.. netmask=.. ## Wlan settings @@ -39,21 +39,21 @@ Request: Update or query wlan settings. If no paramters are given, no changes are done. - wlan [ssid=..] [password=..] + wlan [ssid=..] [password=..] Response: The command will always return the current values. - - ok ssid=.. + + ok ssid=.. ## Set property value -TODO: Implement description? A longer string describing the sensor. +TODO: Implement description? A longer string describing the property. Request: - set-property id=.. [value=..] [name=..] + set-property id=.. [value=..] [name=..] Type examples: @@ -64,7 +64,7 @@ Type examples: Response: - ok + ok The value might not be updated directly, but may be buffered on the device if it is not yet connected. @@ -72,23 +72,23 @@ The value might not be updated directly, but may be buffered on the device if it Request: - reset + reset Response - ok + ok # Example session - require('main').main(); + require('main').main(); Get the current network configuration to update the Arduino's LCD display - > network - < ok ip=1.3.3.7 netmask=255.255.255.0 gateway=1.3.3.1 ssid=awesome + > network + < ok ip=1.3.3.7 netmask=255.255.255.0 gateway=1.3.3.1 ssid=awesome Register the properties. This is done on every boot to keep the server in sync with the firmware's features. Old properties will not be removed. - > set-property id=temp-0 value=12.3 type=temperature name=Water - < ok + > set-property id=temp-0 value=12.3 type=temperature name=Water + < ok |