Skip to content

6 Setting up a Habitat Payload Document

Jump to bottom
Mark Jessop edited this page May 14, 2022 · 3 revisions

For a Horus Binary payload to appears on the HabHub Tracker a 'Payload Configuration Document' needs to be created, to allow the Habitat database to parse the telemetry being submitted.

Note - The SondeHub-Amateur Tracker (as distinct from the HabHub Tracker) does not require any configuration, and telemetry should appear on it automatically.

Telemetry uploaded to Habitat database is generally in one of the following formats:

Horus Binary v1 Format (22 byte packets)

The UKHAS-compliant sentence uploaded to Habitat by the decoder takes the form:

$$CALLSIGN,sequence_no,HH:MM:SS,latitude,longitude,altitude,speed,sats,temp,batt_voltage*CRC16

e.g.

$$4FSKTEST,700,06:42:14,-34.00000,138.00000,100,0,10,40,3.10*E4E6

Horus Binary v2 Format (32 byte packets)

Due to the presence of user-customisable data, the UKHAS-compliant sentence generated by the decoder will vary depending on the packet contents. However, the default telemetry format (based on the default Horus V2 fields from the RS41ng firmware) looks like:

$$CALLSIGN,sequence_no,HH:MM:SS,latitude,longitude,altitude,speed,sats,temp,batt_voltage,ascent_rate,ext_temp,ext_humidity,ext_pressure*CRC16

e.g.

$$HORUS-V2,630,01:29:44,-34.35389,139.96246,16244,66,10,-9,1.31,2.74,-43.8,0,109.6*ABCD

Creating a Payload Document

  • Visit: http://habitat.habhub.org/genpayload/
  • In the 'payload configuration documents' section, click 'Start from Existing'
  • In the 'Search Prefix' entry box, enter either 'Horus Binary v1 - REFERENCE' or 'Horus Binary v2 - REFERENCE' as appropriate. This will filter for just the 'reference' payload documents for the two different formats.
  • Select the filtered payload document from the list.
  • To modify the payload document for your own callsign:
    • Payload Name: Change just the 'REFERENCE' portion of this to match your allocated callsign.
    • Under the 'Parser Configuration' section click the 'Edit' button on the right.
    • Modify the 'Callsign' field to match your allocated callsign. You should not need to modify any other fields. At the bottom of this page, click 'Save', which will take you back to the payload configuration page.
    • Click 'Save' at the bottom.

Testing your Payload Document

Turn your payload on and try uploading telemetry! If all is working, then your payload will appear on the HabHub tracker!

If it does not, one way to debug what is going on is the 'Habitat Parser Logtail', available here: http://habitat.habhub.org/logtail/ This will show the raw output from the parser as it tries to parse each incoming telemetry sentence. While uploading, watch this for any errors.

If you encounter further issues, you can often seek assistance on IRC, in the #highaltitude channel on libera.chat

Clone this wiki locally