Files
gobot/i2c-hub/backend/Protocol.md
2025-01-12 00:16:00 +01:00

69 lines
2.3 KiB (Stored with Git LFS)
Markdown

### Message ID
| ID | Message Type | Direction |
| --- | -------------------- | ------------ |
| 81 | Push Package | Host <-> Hub |
| 82 | Perform Scan | Host -> Hub |
| 83 | Scan Result | Host <- Hub |
| 84 | PackageSlot Update | Host <- Hub |
| 85 | REQ PackageSlot Info | Host -> Hub |
| fe | Header Beat | Host <- Hub |
| ff | Get Info | Host <-> Hub |
### Device Types
| ID | Type |
| --- | ---- |
| 01 | Hub |
## Message Structure
### Push Package (1) (Host <-> Hub)
| Offset | Description |
| ------ | -------------------------------------- |
| 1 | ID 81 |
| 1 | Length (max 28 bytes) |
| 1 | Type (......XX), RPCNumber (XXXX....)y |
| 4 | Address |
| Length | Package Data |
### Perform Scan (2) (Host -> Hub)
| Offset | Description |
| ------ | ---------------------- |
| 00 | ID 82 |
| 01 | Start (01) / Stop (00) |
### Scan Result (3) (Hub -> Host)
| Size | Description |
| ---- | ---------------------------------- |
| 1 | ID 83 |
| 1 | Scann Running (Yes (01) / No (00)) |
| 4 | Address |
| 1 | Type (See Devices Types) |
### Slot Update (4) (Hub -> Host)
| Size | Description |
| ---- | -------------------------------------- |
| 1 | ID 84 |
| 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 85 |
| 01 | Enable Updates (1/0) |
### Heart Beat (fe) (Hub -> Host)
| Sizes | Description |
| ----- | ----------- |
| 1 | ID ff |
### Get Info (ff) (Hub -> Host) (Host -> Hub, only ID)
| Sizes | Description |
| ----- | --------------- |
| 1 | ID ff |
| 1 | Number of Slots |