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

format updates

Browse Source
This commit is contained in:
Brian Martin
2019-02-18 21:45:09 -05:00
parent 6b23d8553e
commit f1257b80d0
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
protocol.md
+10 -10
View File
@@ -58,14 +58,13 @@ There are a few different endpoints within the API that have been seen and are u
| Endpoint | Description | | Endpoint | Description |
| ----------------------------- | ----------------------------------------- | | - | - |
| /users/user.do | Handles user / account functions | | /users/user.do | Handles user / account functions |
| /iot/devmanager.do | Provides a RestAPI that handles sending commands to "IOTMQ" devices | | /iot/devmanager.do | Provides a RestAPI that handles sending commands to "IOTMQ" devices |
| /pim/product/getProductIotMap | Provides a listing of "IOT" Products | | /pim/product/getProductIotMap | Provides a listing of "IOT" Products |
1. POST portal-na.ecouser.net/api/users/user.do loginByItToken - trades the
4. POST portal-na.ecouser.net/api/users/user.do loginByItToken - trades the
authCode from the previous call for yet another token authCode from the previous call for yet another token
5. POST ne-na.ecouser.net:8018/notify_engine.do - not sure what this is 5. POST ne-na.ecouser.net:8018/notify_engine.do - not sure what this is
for; my script skips this and seems to work fine for; my script skips this and seems to work fine
@@ -79,7 +78,7 @@ getProductIotMap - Provides a list of "IOT" products, it isn't clear what the ap
At this point depending on your device you will connect to either an XMPP server, or an MQTT server. At this point depending on your device you will connect to either an XMPP server, or an MQTT server.
| "IOT XMPP" Products | "IOT MQ" Products | | "IOT XMPP" Products | "IOT MQ" 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. |
@@ -93,7 +92,7 @@ elements that appear to be commands.
The Android App uses the following XMPP messaging servers: The Android App uses the following XMPP messaging servers:
|Country|URL| |Country|URL|
|------|--------| | - | - |
|CH|msg.ecouser.net| |CH|msg.ecouser.net|
|TW, MY, JP, SG, TH, HK, IN, KR|msg-as.ecouser.net| |TW, MY, JP, SG, TH, HK, IN, KR|msg-as.ecouser.net|
|US|msg-na.ecouser.net| |US|msg-na.ecouser.net|
@@ -115,7 +114,7 @@ iot/atr/+/{deviceID}/{deviceClass}/{deviceResource}/+
It is believed the MQTT servers mirror the XMPP servers, but only the NA and WW have been tested so far. It is believed the MQTT servers mirror the XMPP servers, but only the NA and WW have been tested so far.
|Country|URL| |Country|URL|
|------|--------| |-|-|
|US|mq-na.ecouser.net| |US|mq-na.ecouser.net|
|"World-wide"|mq-ww.ecouser.net| |"World-wide"|mq-ww.ecouser.net|
@@ -147,6 +146,8 @@ Commands are sent via POST in the format of:
} }
``` ```
## Commands
### Cleaning ### Cleaning
**Command** **Command**
@@ -180,7 +181,6 @@ Commands are sent via POST in the format of:
- `WireCharging` currently charging by cable - `WireCharging` currently charging by cable
### Battery State ### Battery State
Battery charge level. 080 = 80% charged. State is broadcast Battery charge level. 080 = 80% charged. State is broadcast
@@ -277,7 +277,7 @@ 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 off the floor| |102|HostHang: Robot is off the floor|
@@ -312,8 +312,8 @@ Different sid "Sound IDs" will play different sounds. If the vacuum has Voice R
`<ctl td="PlaySound" sid="0" />` `<ctl td="PlaySound" sid="0" />`
|SID |Description | | SID | Description |
|-----|------------------------------------------------------------| |-|-|
| 0 | Startup Music Chime | | 0 | Startup Music Chime |
| 3 | I Am Suspended | | 3 | I Am Suspended |
| 4 | Check Driving Wheels | | 4 | Check Driving Wheels |