communication:habpack
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| communication:habpack [2018/04/28 23:33] – m0dny | communication:habpack [2018/05/08 12:07] (current) – m0dny | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Habpack Binary Protocol ====== | ====== Habpack Binary Protocol ====== | ||
| - | This page details the msgpack based binary protocol. Habpack uses msgpack to encode the binary data, and defines how msgpack is used to encode telemetry, and defines IDs for telemetry fields | + | This page details the [[https://msgpack.org/ |
| + | |||
| + | Encoders should pick the smallest type within the correct family. eg. ' | ||
| + | |||
| + | This means that using integers can scale the storage required to the value being transmitted, | ||
| ===== Basic Structure ===== | ===== Basic Structure ===== | ||
| Line 16: | Line 20: | ||
| ===== Telemetry field IDs ===== | ===== Telemetry field IDs ===== | ||
| - | This lists the IDs that habpack uses. There are reserved IDs to send data which is not already in the list of fields | ||
| - | |||
| - | * 0: callsign (as a string, or an integer ID) | ||
| - | * 1: count | ||
| - | * 2: time (as a string, or integer seconds past midnight UTC) | ||
| - | * 3: position (use a 3 element array: [lat, long, alt]. 1e-7 of a degree; meters) | ||
| - | * 4: satellites | ||
| - | * 5: lock type | ||
| - | * 10: internal temperature | ||
| - | * 11: external temperature | ||
| - | * 40: battery voltage (mV) | ||
| - | * 50: total uplinked messages | ||
| - | |||
| - | As msgpack handles datatypes, arrays can be used to send multiple entries for one field. For example, if there are two external temperature sensors, this can be sent as 11: | ||
| - | |||
| - | ===== Phil's Spec Proposal (March 2018) ===== | ||
| - | |||
| - | Encoders should pick the smallest type within the correct family. eg. ' | ||
| - | |||
| - | This means that using integers can scale the storage required to the value being transmitted, | ||
| - | |||
| A list of reserved Map IDs is suggested below to standardise parsing of commonly used telemetry fields without requirement of a payload-doc, | A list of reserved Map IDs is suggested below to standardise parsing of commonly used telemetry fields without requirement of a payload-doc, | ||
| Line 53: | Line 36: | ||
| * 13: relative humidity (float or unsigned integer as relative humidity percentage) | * 13: relative humidity (float or unsigned integer as relative humidity percentage) | ||
| * 14: absolute humidity (float as g/m^3, or unsigned integer as milligrams/ | * 14: absolute humidity (float as g/m^3, or unsigned integer as milligrams/ | ||
| - | Radio: | + | Calling Beacon: |
| * 20: downlink frequency, for use in calling channel (unsigned integer as Hz) | * 20: downlink frequency, for use in calling channel (unsigned integer as Hz) | ||
| * 21: ID of common downlink LoRa Mode (unsigned integer) | * 21: ID of common downlink LoRa Mode (unsigned integer) | ||
| + | * 22: custom downlink LoRa: Implicit (unsigned integer) | ||
| + | * 23: custom downlink LoRa: Error Coding (unsigned integer) | ||
| + | * 24: custom downlink LoRa: Bandwidth (unsigned integer) | ||
| + | * 25: custom downlink LoRa: Spreading Factor (unsigned integer) | ||
| + | * 26: custom downlink LoRa: Low Datarate Optimise (unsigned integer) | ||
| + | Uplink: | ||
| * 30: total uplinked messages (unsigned integer) | * 30: total uplinked messages (unsigned integer) | ||
| Landing/ | Landing/ | ||
| Line 65: | Line 54: | ||
| * 62: Multi-position array of positions (each: 2 or 3 element array of signed integers: [lat, long, < | * 62: Multi-position array of positions (each: 2 or 3 element array of signed integers: [lat, long, < | ||
| - | 6, | + | |
| + | As msgpack handles datatypes, arrays can be used to send multiple entries for one field. For example, if there are two external temperature sensors, this can be sent as 11: | ||
| ==== Current RPi Decoder Implementation ==== | ==== Current RPi Decoder Implementation ==== | ||
| Line 73: | Line 63: | ||
| eg. " | eg. " | ||
| - | Multi-position: | + | ==== LoRa Calling Beacon |
| - | These fields will be binary-encoded as base64 and the resulting string appended as a single extra RTTY field. | + | |
| - | + | ||
| - | ==== LoRa Modes (Field 21) ==== | + | |
| * **0**: Explicit, FEC: 4/8, BW: 20.8KHz, SF: 11, LDO: On | * **0**: Explicit, FEC: 4/8, BW: 20.8KHz, SF: 11, LDO: On | ||
| Line 105: | Line 92: | ||
| * Used for Fast (SSDV) repeater network | * Used for Fast (SSDV) repeater network | ||
| * Approx baudrate: 4500 | * Approx baudrate: 4500 | ||
| + | |||
| + | ==== LoRa Calling Beacon Custom Fields (Fields 22-26) ==== | ||
| + | |||
| + | * 22: custom downlink LoRa: Implicit (unsigned integer) | ||
| + | * 0: Explicit Mode | ||
| + | * 1: Implicit Mode | ||
| + | * 23: custom downlink LoRa: Error Coding (unsigned integer) | ||
| + | * 5: 4/5 | ||
| + | * 6: 4/6 | ||
| + | * 7: 4/7 | ||
| + | * 8: 4/8 | ||
| + | * 24: custom downlink LoRa: Bandwidth (unsigned integer) | ||
| + | * 0: 7.8KHz | ||
| + | * 1: 10.4Khz | ||
| + | * 2: 15.6KHz | ||
| + | * 3: 20.8KHz | ||
| + | * 4: 31.25KHz | ||
| + | * 5: 41.7Khz | ||
| + | * 6: 62.5KHz | ||
| + | * 7: 125KHz | ||
| + | * 8: 250KHz | ||
| + | * 9: 500KHz | ||
| + | * 25: custom downlink LoRa: Spreading Factor (unsigned integer) | ||
| + | * 6: SF6 | ||
| + | * 7: SF7 | ||
| + | * 8: SF8 | ||
| + | * 9: SF9 | ||
| + | * 10: SF10 | ||
| + | * 11: SF11 | ||
| + | * 12: SF12 | ||
| + | * 26: custom downlink LoRa: Low Datarate Optimise (unsigned integer) | ||
| + | * 0: LDO Off | ||
| + | * 1: LDO On | ||
communication/habpack.1524958387.txt.gz · Last modified: 2018/04/28 23:33 by m0dny