diff options
Diffstat (limited to 'diller/README.md')
| -rw-r--r-- | diller/README.md | 53 |
1 files changed, 22 insertions, 31 deletions
diff --git a/diller/README.md b/diller/README.md index 322ec45..72d5778 100644 --- a/diller/README.md +++ b/diller/README.md @@ -14,69 +14,60 @@ Is registration required? Can't the firmware just send an update without a value /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 registration flow - - sub: /registration/<random id> - pub: /registration {} - # Diller serial API ## Network settings Request: -Update network settings. If no paramters are given, no changes are done. +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=..] [ssid=..] + network [ip=..] [gateway=..] [netmask=..] Response: -The command will always return the current values. If the ssid was recently set, the ip, gateway and netmask fields may be missing. +The command will always return the current values. - ok ip=.. gateway=.. netmask=.. ssid=.. + ok ip=.. gateway=.. netmask=.. netmask=.. -## Register property +## Wlan settings Request: - register-property id=.. type=.. name=.. description=.. +Update or query wlan settings. If no paramters are given, no changes are done. -Type examples: - -* `temperature` -* `switch` - boolean switches -* `humidity` -* `rtc` + wlan [ssid=..] [password=..] Response: - ok - -## Publish property value - -Request: - - set-property id=.. [value=..] [name=..] [description=..] +The command will always return the current values. + + ok ssid=.. -Response: +## Set property value - ok +TODO: Implement description? A longer string describing the sensor. -The value might not be updated directly, but may be buffered on the device if it is not yet connected. +Request: -## Publish raw MQTT message + set-property id=.. [value=..] [name=..] -Request: +Type examples: - publish topic=.. [qos=..] [retain=..] - <next lines are payload. Double EOL completes payload> +* `temperature` +* `switch` - boolean switches +* `humidity` +* `rtc` Response: ok +The value might not be updated directly, but may be buffered on the device if it is not yet connected. + ## Reset the device Request: |