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 18:18] – 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, | ||
| Core: | Core: | ||
| * 0: callsign (string or unsigned integer) (integer converted to string representation for habitat upload) | * 0: callsign (string or unsigned integer) (integer converted to string representation for habitat upload) | ||
| - | * 1: count (unsigned integer) | + | * 1: sentence id (unsigned integer) |
| - | * 2: time (string or unsigned integer seconds past midnight UTC, or unsigned integer unix epoch seconds) | + | * 2: time (unsigned integer seconds past midnight UTC, or unsigned integer unix epoch seconds) |
| * 3: position (2 or 3 element array of signed integers: [lat, long, < | * 3: position (2 or 3 element array of signed integers: [lat, long, < | ||
| - | * 4: number of satellites (unsigned integer) | + | * 4: number of gnss satellites (unsigned integer) |
| - | * 5: lock type [0: none, 1: time, 2: 2D, 3: 3D, 4: 3D+SBAS] (unsigned integer) | + | * 5: gnss lock [0: none, 1: time, 2: 2D, 3: 3D, 4: 3D+SBAS] (unsigned integer) |
| * 6: voltage (float as Volts or signed integer as milli-volts) | * 6: voltage (float as Volts or signed integer as milli-volts) | ||
| Environmental: | Environmental: | ||
| 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: downlink LoRa Mode (unsigned integer) | + | * 21: ID of common |
| + | * 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/ | ||
| - | * 40: predicted time (string or unsigned integer seconds past midnight UTC, or unsigned integer unix epoch seconds) | + | * 40: predicted time (unsigned integer seconds past midnight UTC, or unsigned integer unix epoch seconds) |
| * 41: predicted position (2 or 3 element array of signed integers: [lat, long, < | * 41: predicted position (2 or 3 element array of signed integers: [lat, long, < | ||
| Multi-position: | Multi-position: | ||
| 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 Modes (Field 21) ==== |
| - | These fields will be binary-encoded as base64 and the resulting string appended as a single extra RTTY field. | + | |
| + | * **0**: Explicit, FEC: 4/8, BW: 20.8KHz, SF: 11, LDO: On | ||
| + | * Used for telemetry | ||
| + | * Approx baudrate: 60 | ||
| + | * **1**: Implicit, FEC: 4/5, BW: 20.8KHz, SF: 6, LDO: Off | ||
| + | * Used for SSDV | ||
| + | * Approx baudrate: 1400 | ||
| + | * **2**: Explicit, FEC: 4/8, BW: 62.5KHz, SF: 8, LDO: Off | ||
| + | * Used for repeater network | ||
| + | * Approx baudrate: 2000 | ||
| + | * **3**: Explicit, FEC: 4/6, BW: 250KHz, SF: 7, LDO: Off | ||
| + | * Used for high speed images in 868MHz band | ||
| + | * Approx baudrate: 8000 | ||
| + | * **4**: Implicit, FEC: 4/5, BW: 250KHz, SF: 6, LDO: Off | ||
| + | * Fastest mode within IR2030 in 868MHz band | ||
| + | * Approx baudrate: 16828 | ||
| + | * **5**: Explicit, FEC: 4/8, BW: 41.7KHz, SF: 11, LDO: Off | ||
| + | * Used for Calling mode | ||
| + | * Approx baudrate: 200 | ||
| + | * **6**: Implicit, FEC: 4/5, BW: 41.7KHz, SF: 6, LDO: Off | ||
| + | * Used for Uplink on 868 | ||
| + | * Approx baudrate: 2800 | ||
| + | * **7**: Explicit, FEC: 4/5, BW: 20.8KHz, SF: 7, LDO: Off | ||
| + | * Used for Telnet-style comms with HAB on 434 | ||
| + | * Approx baudrate: 2800 | ||
| + | * **8**: Implicit, FEC: 4/5, BW: 62.5KHz, SF: 6, LDO: Off | ||
| + | * Used for Fast (SSDV) repeater network | ||
| + | * Approx baudrate: 4500 | ||
| - | ==== LoRa Modes (Field 21) ==== | + | ==== LoRa Calling Beacon Custom Fields |
| - | 0: EXPLICIT_MODE, | + | * 22: custom downlink LoRa: Implicit (unsigned integer) |
| - | * Used for telemetry | + | * 0: Explicit Mode |
| - | * Approx baudrate: 60 | + | * 1: Implicit Mode |
| - | 1: IMPLICIT_MODE, | + | |
| - | * Used for SSDV | + | * 5: 4/5 |
| - | * Approx baudrate: 1400 | + | * 6: 4/6 |
| - | 2: EXPLICIT_MODE, | + | * 7: 4/7 |
| - | * Used for repeater network | + | * 8: 4/8 |
| - | * Approx baudrate: 2000 | + | * 24: custom downlink LoRa: Bandwidth (unsigned integer) |
| - | 3: EXPLICIT_MODE, | + | * 0: 7.8KHz |
| - | * Used for high speed images in 868MHz band | + | * 1: 10.4Khz |
| - | * Approx baudrate: 8000 | + | * 2: 15.6KHz |
| - | 4: IMPLICIT_MODE, | + | * 3: 20.8KHz |
| - | * Fastest mode within IR2030 in 868MHz band | + | |
| - | * Approx baudrate: 16828 | + | * 5: 41.7Khz |
| - | 5: EXPLICIT_MODE, | + | * 6: 62.5KHz |
| - | * Used for Calling mode | + | * 7: 125KHz |
| - | * Approx baudrate: 200 | + | * 8: 250KHz |
| - | 6: IMPLICIT_MODE, | + | * 9: 500KHz |
| - | * Used for Uplink on 868 | + | * 25: custom downlink LoRa: Spreading Factor (unsigned integer) |
| - | * Approx baudrate: 2800 | + | |
| - | 7: EXPLICIT_MODE, | + | * 7: SF7 |
| - | * Used for Telnet-style comms with HAB on 434 | + | * 8: SF8 |
| - | * Approx baudrate: 2800 | + | * 9: SF9 |
| - | 8: IMPLICIT_MODE, | + | * 10: SF10 |
| - | * Used for Fast (SSDV) repeater network | + | * 11: SF11 |
| - | * Approx baudrate: 4500 | + | * 12: SF12 |
| + | * 26: custom downlink LoRa: Low Datarate Optimise | ||
| + | * 0: LDO Off | ||
| + | * 1: LDO On | ||
communication/habpack.1524939513.txt.gz · Last modified: 2018/04/28 18:18 by m0dny