gronod/ha_ecovacs_bumper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix tables in protocol

Browse Source 
Fix tables in protocol
This commit is contained in:
Brian Martin
2019-01-18 01:37:40 -05:00
parent 605b1b5523
commit 10993e678a
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
protocol.md
+13 -10
View File
@@ -56,6 +56,7 @@ the XMPP/device server.
There are a few different endpoints within the API that have been seen and are used in the library: There are a few different endpoints within the API that have been seen and are used in the library:
| Endpoint | Description | | Endpoint | Description |
| ----------------------------- | ----------------------------------------- | | ----------------------------- | ----------------------------------------- |
| /users/user.do | Handles user / account functions | | /users/user.do | Handles user / account functions |
@@ -87,6 +88,7 @@ getProductIotMap - Provides a list of "IOT" products, the devices are referenced
At this point depending on your device you will connect to either an XMPP server, or an MQTT server. This is believed to be based on the "IOT Products" vs "Non-IOT" products. At this point depending on your device you will connect to either an XMPP server, or an MQTT server. This is believed to be based on the "IOT Products" vs "Non-IOT" products.
| "Non-IOT" Products | "IOT" Products | | "Non-IOT" Products | "IOT" Products |
|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Connect to an XMPP server to send commands to devices and receive status results | Connect to an MQTT server to subscribe to status messages and results. A Rest API is utilized to send commands to devices, but can also be used to obtain statuses. | | Connect to an XMPP server to send commands to devices and receive status results | Connect to an MQTT server to subscribe to status messages and results. A Rest API is utilized to send commands to devices, but can also be used to obtain statuses. |
@@ -140,19 +142,19 @@ Commands are sent via POST in the format of:
```json ```json
{ {
"auth": { "auth": {
"realm": EcoVacsAPI.REALM, "realm": "ecouser.net",
"resource": self.resource, "resource": "resource",
"token": self.secret, "token": "token",
"userid": self.uid, "userid": "userid",
"with": "users", "with": "users",
}, },
"cmdName": cmd.name, "cmdName": "cmd.name",
"payload": cmd.args_to_xml(), "payload": "cmd.args",
"payloadType": "x", "payloadType": "x",
"td": "q", "td": "q",
"toId": recipient, "toId": "vacuum.serial",
"toRes": self.vacuum['resource'], "toRes": "vacuum.resource",
"toType": self.vacuum['class'] "toType": "vacuum.class"
} }
``` ```
@@ -259,8 +261,9 @@ HostHang, then proceeds to stop and broadcasts 100 NoError.
**Known error codes** **Known error codes**
|Code|Description| |Code|Description|
|-|-| |-----|-----|
|100|NoError: Robot is operational| |100|NoError: Robot is operational|
|101|BatteryLow: Low battery| |101|BatteryLow: Low battery|
|102|HostHang: Robot is stuck| |102|HostHang: Robot is stuck|