Files
gobot/i2c-hub/backend/Protocol.md

63 lines
1.9 KiB (Stored with Git LFS)
Markdown

### Message ID
| ID | Message Type |
| --- | -------------------- |
| 01 | Push Package |
| 02 | Perform Scan |
| 03 | Scan Result |
| 04 | PackageSlot Update |
| 05 | REQ PackageSlot Info |
| ff | Get Info |
### Device Types
| ID | Type |
| --- | ---- |
| 01 | Hub |
## Message Structure
### Push Package (1) (Host <-> Hub)
| Offset | Description |
| ------ | --------------------- |
| 1 | ID 01 |
| 1 | Length (max 28 bytes) |
| 1 | Type |
| 4 | Address |
| Length | Package Data |
### Perform Scan (2) (Host -> Hub)
| Offset | Description |
| ------ | ---------------------- |
| 00 | ID 02 |
| 01 | Start (01) / Stop (00) |
### Scan Result (3) (Hub -> Host)
| Offset | Description |
| ------ | ---------------------------------- |
| 00 | ID 03 |
| 01 | Scann Running (Yes (01) / No (00)) |
| 02-05 | Address |
| 06 | Type (See Devices Types) |
### Slot Update (4) (Hub -> Host)
| Size | Description |
| ---- | -------------------------------------- |
| 1 | ID 04 |
| 1 | Status (1X/0X Completed, X1/X0 in use) |
| 1 | Slot Number |
| 4 | Device Address |
| 4 | Timestamp |
| 4 | Used Bits |
Total: 16 bytes
### Req Slot Update (5) (Host -> Hub)
| Offset | Descript |
| ------ | -------------------- |
| 00 | ID 05 |
| 01 | Enable Updates (1/0) |
### Get Info (ff) (Hub -> Host) (Host -> Hub, only ID)
| Offset | Description |
| ------ | --------------- |
| 00 | ID ff |
| 01 | Number of Slots |