strix/domo
strix/domo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix: remove single bits as they're only making the protocol harder to interpret

Browse source
This commit is contained in:
Strix 2023-10-15 18:06:19 +02:00
parent 7aee04e629
commit cfae325be4
No known key found for this signature in database
GPG key ID: 49B2E37B8915B774
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
doc/proto.md
View file

@ -52,19 +52,19 @@ The master will not track the broken packet's `packet_id`, so the slave can send
Domo has a data framework reliant on data types. Domo has a data framework reliant on data types.
These define what kind of data the property holds. These define what kind of data the property holds.
| `data_type` | physical type (rust types) | size | virtual type | description | | `prop_data_type` | physical type (rust types) | size | virtual type | description |
|-------------|----------------------------|-----------|---------------------|------------------------------------------------| |------------------|----------------------------|-----------|---------------------|-----------------------------------------------------------------------------|
| `0x0*` | | | | **Basic** | | `0x0*` | | | | **Basic** |
| `0x00` | `None` | 0 bytes | Nothing | Nothing, mostly used internally or as example. | | `0x00` | `None` | 0 bytes | Nothing | Nothing, mostly used internally or as example. |
| `0x01` | `bool` | 1 bit | Switch | A simple switch with two states. | | `0x01` | `bool` | 1 byte | Switch | A simple switch with two states. `0x00` = off, `0x01` = on, `0x02` = toggle |
| `0x02` | `u8` | 1 byte | Slider | A simple slider with u8 precision. | | `0x02` | `u8` | 1 byte | Slider | A simple slider with u8 precision. |
| `0x03` | `[u8; 256]` | 256 bytes | Text | A simple bit of text. | | `0x03` | `[u8; 256]` | 256 bytes | Text | A simple bit of text. |
| `0x1*` | | | | **Cosmetic** | | `0x1*` | | | | **Cosmetic** |
| `0x10` | `[u8; 3]` | 3 bytes | Color | An RGB value. | | `0x10` | `[u8; 3]` | 3 bytes | Color | An RGB value. |
| `0x9*` | | | | **Time & Space** | | `0x9*` | | | | **Time & Space** |
| `0x90` | `u64` | 8 bytes | Seconds | A simple value that is in seconds. | | `0x90` | `u64` | 8 bytes | Seconds | A simple value that is in seconds. |
| `0xF*` | | | | **Domo types** | | `0xF*` | | | | **Domo types** |
| `0xF0` | `[u8; 4]` | 4 bytes | Domo node reference | A reference to a node. | | `0xF0` | `[u8; 4]` | 4 bytes | Domo node reference | A reference to a node. |
# Commands # Commands
@ -120,11 +120,11 @@ there is no extra data required.
#### Command data #### Command data
| offset | size | name | description | reserved | example | | offset | size | name | description | reserved | example |
|--------|-----------|-----------------|---------------------------------------------|----------|---------| |--------|----------|-----------------|--------------------------------------------------------------------|----------|---------|
| `0x14` | 32 bytes | `property_name` | The name of the property as a UTF-8 string. | no | "Power" | | `0x14` | 32 bytes | `property_name` | The name of the property as a UTF-8 string. | no | "Power" |
| `0x34` | 1 byte | `data_type` | The type of data; see "Data types". | no | `0x01` | | `0x34` | 1 byte | `data_type` | The type of data; see "Data types". | no | `0x01` |
| `0x35` | **1 bit** | `read_only` | Whether the property is readonly. | no | `0b0` | | `0x35` | 1 byte | `read_only` | Whether the property is readonly. <br/>(`0x00` = no, `0x01` = yes) | no | `0x00` |
### `0x04` - Remove property ### `0x04` - Remove property