rcrf-wifi/readme.md
2024-07-01 19:33:52 +02:00

40 lines
960 B
Markdown

## tx
register command is the first command after connecting.
### tx sends commands
register: `<clientID>;4675;<current epoch>\n`
command: `<clientID>;d;<x_value>,<y_value>\n`
request boats: `<clientID>;boats\n`
### tx recieves data
list of boats: `boats:<boatID>;<boat_name>;<boat_status>[;<boatID>;<boat_name>;<boat_status>[...]]\n`
> web-tx: exits controll mode and enter boat select mode
error: `FAIL\n`
## rx
register command is the first command after connecting.
### rx sends commands
register: `<boatId>;3440;<boat_name>\n`
report status: `status:<boat_status>\n`
### rx recieves data
channel data: `d:<x_value>,<y_value>\n`
set status: `status:<boat_status>\n`
get status: `status\n`
## data types
clientID, boatID: 4 digit unsigned number
x_value, y_value: 8 bit signed number
boat_name: max 20 char len string (' ' (0x20) through '~' (0x7E) exept ':' (0x3A) or ';' (0x3B))
boat_status: "available" | "inctrl" | "locked"