Telemetry

== Messages ==
Telemetry messages (sent from the aircraft to the ground) are defined in the telemetry class of conf/messages.xml.
See also the generated documentation: http://docs.paparazziuav.org/latest/paparazzi_messages.html
== Sending periodic messages ==
The set of periodic messages sent over the downlink channel by an aircraft to the ground station is configurable
with the help of one XML file, located in the conf/telemetry directory. This file is referenced by conf/conf.xml and must follow the
telemetry.dtd syntax. The fixedwing_default.xml and rotorcraft_default.xml are provided as an example and should be suitable for most users.
If a module attribute is specified for a message, it will be included in the telemetry only if the corresponding module is loaded.
It is even possible to create your own telemetry XML definition. By the time you need that, it is highly likely you are already an advanced paparazzi user and know why you would and how you will.
===Add Messages===
This section provides instructions of an example case of how one would add a new message to Paparazzi and send the data to the ground station. The example is a little old and considers the addition of the AIRSPEED message, which is already present in newer versions of paparazzi. The user will have to implement her own message objects instead of the AIRSPEED message.
==== Step 1 ====
In sw/ext/pprzlink/message_definitions/v1.0/messages.xml add an airspeed message:
Where id="54" has to be unique. To find an new ID to use there is a script file located at ${PAPARAZZI_HOME}/sw/tools/find_free_msg_id.out (yes it is really a script). 
 Type: ${PAPARAZZI_SRC}/sw/tools/find_free_msg_id.out 
NOTE: Be sure your Paparazzi source and home environment variables are set correctly in your shell Installation#Launching_the_Software)
Every field in the output is a variable from Paparazzi. The field name is not allowed to contain spaces. The type must be the type of a variable in your code (ie. look in your code). Add your message along with the frequency to be sent over the messaging bus (AKA telemetry messages).
After making the modifications to the messages.xml file, make your paparazzi again (i.e. cd ${PAPARAZZI_HOME} && make) so that your changes to the messages.xml file are reflected in the paparazzi/var/include/messages.h file. This will create a DOWNLINK_SEND_AIRSPEED macro (in ${PAPARAZZI_HOME}/var/include/messages.h). If you do not make paparazzi, this macro will not be created.
==== Step 2 ====
Add a message to your telemetry file (for example conf/telemetry/default_fixedwing.xml). The message name in telemetry file usually match the message name in messages.xml file, but can be different or even group several messages.
The result is a generated file in ${PAPARAZZI_HOME}/var/aircrafts/<AC>/generated/periodic_telemetry.h which consist in a (static) scheduler to that calls specific functions.
==== Step 3 ====
Create a function in your C source file that will send your message(s) (using the generated DOWNLINK_SEND_* macros) and register it to the telemetry system so that it will be send automatically for you. You also need to include the header subsystems/datalink/telemetry.h:
where the second parameter in the register function is the id of the message (use the define PPRZ_MSG_ID_<MESSAGE_NAME>).
Prior to v5.0:
Past Reference for Paparazzi v5.0 or older:
Create a PERIODIC_SEND_AIRSPEED with the following code in the firmware specific telemetry header file (In ap_downlink.h/fbw_downlink.h for fixedwing or telemetry.h for rotorcraft) :
{{Box Code|conf/telemetry/default.xml|
 #ifdef USE_AIRSPEED
 #define PERIODIC_SEND_AIRSPEED(_chan) DOWNLINK_SEND_AIRSPEED (_chan, _dev &adc_airspeed_val,&estimator_airspeed,&v_ctl_auto_airspeed_setpoint,&v_ctl_auto_airspeed_controlled,&v_ctl_auto_groundspeed_setpoint)
 #else
 #define PERIODIC_SEND_AIRSPEED(_chan) {}
 #endif
===Configuring the Downlink Data Rate===
The limited throughput of our RF modems results in a need to carefully choose which data to send, as well as the frequency at which to send it. A sophisticated set of files and parameters have been developed in order to tailor the data downlink behavior automatically, manually, temporarily, or permanently according to any desired parameter. This allows the user to create an almost unlimited possibility of downlink configurations. For example:
* Tailor the data rate to work with very slow modems (9600 baud or slower)
* Reduce the data rate of some messages so that others can be increased:
*: Automatically send GPS data at a very high rate by sacrificing navigation data when not flying (to help GPS/RFI troubleshooting) then automatically reduce the GPS data rate and send normal navigation data when the launch is initiated.
*: Automatically switch to sending only position data upon landing to conserve power and increase the chance of the operator receiving a position packet when recovering a distant aircraft.
*: Manually send selected sensor data at very high speeds (60Hz) for real time tuning.
* Maintain independent telemetry configurations for aircraft with different modems, sensors, or mission profiles.
Any number of configuration files can be created in the conf/telemetry directory and selected from the conf/conf.xml file. The telemetry downlink is divided into two processes, Ap and Fbw each with a possible mode option. Any number of modes could be created, the default is the first in the sequence. A mode contains the list of messages to be sent as well as the period of each message in seconds. In this example, the ATTITUDE message will be sent by the Ap process at 2Hz in the default mode and at 10Hz in the fast attitude mode. The maximum allowed frequency is 60Hz (0.017s) and the maximum period is 1092s.
The mode can be chosen in the airframe file by setting the TELEMETRY_MODE_FBW constant:
 <define name="TELEMETRY_MODE_FBW" value="1"/>
where the (default) first mode is numbered 0.
This mode can also be changed dynamically with a datalink setting or with a set stage in the flight plan.
Note that an (undocumented!) subset of the messages is required to be able to use ground station properly. So it is not advisable to completely remove messages for the Ap process listed in the default mode.
==Specific Messages==
===GPS_SOL===
Specification in telemetry file
 <message name="GPS_SOL" period="2.0"/>
Example from logfile(.data):
 6.742 1 GPS_SOL 232 43 198 8
Meaning of tokens:
 Timestamp, Aircraft-Number, GPS_SOL, Pacc, Sacc, PDOP, numSV
*Pacc = Position accuracy (units: CM)
*Sacc = Speed accuracy (units: CM/sec ?)
*PDOP = Position Dilution_of_precision_(GPS) , if this value is high the value of position will be less accurate
*numSV = number of Space Vehicles (Satellites) used in Nav Solution
===PPRZ_MODE===
Specification in telemetry file
 <message name="PPRZ_MODE" period="5."/>
Example from logfile(.data):
 20.433 2 PPRZ_MODE 0 1 2 0 0 1
Meaning of tokens:
 Timestamp, Aircraft-Number, PPRZ_MODE, ap_mode, ap_gaz, ap_horizontal, if_calib_mode, mcul_status
*ap_mode = (0 = MANUAL, 1 = AUTO1, 2 = AUTO2, 3 = HOME mode (Circle Home waypoint), 4 = NO_GPS (GPS not working), 5 = NB (?)
*ap_gaz = ?
*ap_horizontal = ?
*if_calib_mode = ?
*mcul_status = ?
== Audio-based downlink ==
The audio-based downlink has been removed from current hardware designs however using the old designs it is possible to implement. With the current low prices of a simple video transmitter, data over audio may come in as a welcomed addition. Feel free to experiment and revive this classical feature.
Category:Software Category:User_Documentation Category:Telemetry