This repository has been archived by the owner on Sep 27, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Wireless Communication Microcontroller API
Anthony Randell edited this page Feb 24, 2017
·
13 revisions
This page contains the commands used when communicating to and from the Wireless Communication Modules.
More details about the communication protocol can be found via the API Documentation Home Page.
Request Message:
- Payload size: 1 byte
| Byte | Description | Valid Range |
|---|---|---|
| 0 | Null Byte | 0x00 |
Response Message:
- Payload size: 1 byte
| Byte | Description | Valid Range |
|---|---|---|
| 0 | Null Byte | 0x00 |
Request Message:
- Payload Size: 2 bytes
| Byte | Title | Description | Valid Range |
|---|---|---|---|
| 0 | Register | Parameter being modified | See RFM69HCW Manual |
| 1 | Value | New configuration value | Varies |
Response Message:
- Payload Size: 2 bytes
| Byte | Title | Description | Valid Range |
|---|---|---|---|
| 0 | Register | Parameter that was modified | See RFM69HCW Manual |
| 1 | Value | New Configuration Value | Varies |
Request Message:
- Payload Size: 1 byte
| Byte | Title | Description | Valid Range |
|---|---|---|---|
| 0 | Register | Parameter to read | See RFM69HCW Manual |
Response Message:
- Payload Size: 2 bytes
| Byte | Title | Description | Valid Range |
|---|---|---|---|
| 0 | Register | Parameter that was read | See RFM69HCW Manual |
| 1 | Value | Value in Register | Varies |
Request Message:
- Payload Size: 1 byte
| Byte | Description | Valid Range |
|---|---|---|
| 0 | Null Byte | 0x00 |
Response Message:
- Payload Size: 64 bytes
| Byte | Title | Description | Valid Range |
|---|---|---|---|
| 0 | Message Available | True/False (1 or 0) | |
| 1 to 61 | Message | Payload of incoming wireless message | Any |
| 62 to 63 | RSSI | Signal strength | 0 to -114 (dBm) |
Request Message:
- Payload Size: 61 bytes (contents of message)
| Byte | Title | Description | Valid Range |
|---|---|---|---|
| 0 to 60 | Message | Payload to send over wireless | Any |
Response Message:
- Payload Size: 1 bytes
| Byte | Title | Description | Valid Range |
|---|---|---|---|
| 0 | TX Status | Whether or not the message was sent successfully | True or False |
Request Message:
- Not applicable. A general error message is sent when a request has not been understood by the module (such as a CRC16 failure) or some other error occurred preventing a normal reply to a message.
Response Message:
- Payload Size: 1 byte
The table below explains the individual bit meanings of the single byte of the payload.
| Bit | Description | Valid Range |
|---|---|---|
| 7 (MSB) | Timeout | 0 or 1 |
| 6 | Not Used | 0 or 1 |
| 5 | Not Used | 0 or 1 |
| 4 | Not Used | 0 or 1 |
| 3 | Not Used | 0 or 1 |
| 2 | Not Used | 0 or 1 |
| 1 | Not Used | 0 or 1 |
| 0 (LSB) | CRC Error | 0 or 1 |