Use correct method to read config
[inav.git] / docs / OSD.md
blobb3526d0d761468412e5701f247d6d4dadcc6e8b7
1 # On Screen Display
3 The On Screen Display, or OSD, is a feature that overlays flight data over the video image. This can be done on the flight controller, using the analogue MAX7456 chip. Digital systems take the OSD data, via MSP DisplayPort, send it to the video receiver; which combines the data with the image. You can specify what elements are displayed, and their locations on the image. Most systems are character based, and use the MAX7456 analogue setup, or MSP DisplayPort. However, there are some different systems which are also supported. Such as the canvas based FrSKY PixelOSD on analogue. Canvas OSDs draw shapes on the image. Whereas character based OSDs use font characters to display the data.
5 ## Features and Limitations
6 Not all OSDs are created equally. This table shows the differences between the different systems available.
8 | OSD System    | Character grid | Character | Canvas | MSP DisplayPort | All elements supported  |
9 |---------------|----------------|-----------|--------|-----------------|-------------------------|
10 | Analogue PAL  | 30 x 16        | X         |        |                 | YES                     |
11 | Analogue NTSC | 30 x 13        | X         |        |                 | YES                     |
12 | PixelOSD      | As PAL or NTSC |           | X      |                 | YES                     |
13 | DJI OSD       | 30 x 16        | X         |        |                 | NO - BF Characters only |
14 | DJI WTFOS     | 60 x 22        | X         |        | X               | YES                     |
15 | HDZero        | 50 x 18        | X         |        | X               | YES                     |
16 | Avatar        | 53 x 20        | X         |        | X               | YES                     |
17 | DJI O3        | 53 x 20 (HD)   | X         |        | X       (partial)     | NO - BF Characters only |
19 ## OSD Elements
20 Here are the OSD Elements provided by INAV.
22 | ID  | Element                                          | Added  |
23 |-----|--------------------------------------------------|--------|
24 | 0   | OSD_RSSI_VALUE                                   | 1.0.0  |
25 | 1   | OSD_MAIN_BATT_VOLTAGE                            | 1.0.0  |
26 | 2   | OSD_CROSSHAIRS                                   | 1.0.0  |
27 | 3   | OSD_ARTIFICIAL_HORIZON                           | 1.0.0  |
28 | 4   | OSD_HORIZON_SIDEBARS                             | 1.0.0  |
29 | 5   | OSD_ONTIME                                       | 1.0.0  |
30 | 6   | OSD_FLYTIME                                      | 1.0.0  |
31 | 7   | OSD_FLYMODE                                      | 1.0.0  |
32 | 8   | OSD_CRAFT_NAME                                   | 1.0.0  |
33 | 9   | OSD_THROTTLE_POS                                 | 1.0.0  |
34 | 10  | OSD_VTX_CHANNEL                                  | 1.0.0  |
35 | 11  | OSD_CURRENT_DRAW                                 | 1.0.0  |
36 | 12  | OSD_MAH_DRAWN                                    | 1.0.0  |
37 | 13  | OSD_GPS_SPEED                                    | 1.0.0  |
38 | 14  | OSD_GPS_SATS                                     | 1.0.0  |
39 | 15  | OSD_ALTITUDE                                     | 1.0.0  |
40 | 16  | OSD_ROLL_PIDS                                    | 1.6.0  |
41 | 17  | OSD_PITCH_PIDS                                   | 1.6.0  |
42 | 18  | OSD_YAW_PIDS                                     | 1.6.0  |
43 | 19  | OSD_POWER                                        | 1.6.0  |
44 | 20  | OSD_GPS_LON                                      | 1.6.0  |
45 | 21  | OSD_GPS_LAT                                      | 1.6.0  |
46 | 22  | OSD_HOME_DIR                                     | 1.6.0  |
47 | 23  | OSD_HOME_DIST                                    | 1.6.0  |
48 | 24  | OSD_HEADING                                      | 1.6.0  |
49 | 25  | OSD_VARIO                                        | 1.6.0  |
50 | 26  | OSD_VARIO_NUM                                    | 1.6.0  |
51 | 27  | OSD_AIR_SPEED                                    | 1.7.3  |
52 | 28  | OSD_ONTIME_FLYTIME                               | 1.8.0  |
53 | 29  | OSD_RTC_TIME                                     | 1.8.0  |
54 | 30  | OSD_MESSAGES                                     | 1.8.0  |
55 | 31  | OSD_GPS_HDOP                                     | 1.8.0  |
56 | 32  | OSD_MAIN_BATT_CELL_VOLTAGE                       | 1.8.0  |
57 | 33  | OSD_SCALED_THROTTLE_POS                          | 1.8.0  |
58 | 34  | OSD_HEADING_GRAPH                                | 1.8.0  |
59 | 35  | OSD_EFFICIENCY_MAH_PER_KM                        | 1.9.0  |
60 | 36  | OSD_WH_DRAWN                                     | 1.9.0  |
61 | 37  | OSD_BATTERY_REMAINING_CAPACITY                   | 1.9.0  |
62 | 38  | OSD_BATTERY_REMAINING_PERCENT                    | 1.9.0  |
63 | 39  | OSD_EFFICIENCY_WH_PER_KM                         | 1.9.0  |
64 | 40  | OSD_TRIP_DIST                                    | 1.9.1  |
65 | 41  | OSD_ATTITUDE_PITCH                               | 2.0.0  |
66 | 42  | OSD_ATTITUDE_ROLL                                | 2.0.0  |
67 | 43  | OSD_MAP_NORTH                                    | 2.0.0  |
68 | 44  | OSD_MAP_TAKEOFF                                  | 2.0.0  |
69 | 45  | OSD_RADAR                                        | 2.0.0  |
70 | 46  | OSD_WIND_SPEED_HORIZONTAL                        | 2.0.0  |
71 | 47  | OSD_WIND_SPEED_VERTICAL                          | 2.0.0  |
72 | 48  | OSD_REMAINING_FLIGHT_TIME_BEFORE_RTH             | 2.0.0  |
73 | 49  | OSD_REMAINING_DISTANCE_BEFORE_RTH                | 2.0.0  |
74 | 50  | OSD_HOME_HEADING_ERROR                           | 2.0.0  |
75 | 51  | OSD_COURSE_HOLD_ERROR                            | 2.0.0  |
76 | 52  | OSD_COURSE_HOLD_ADJUSTMENT                       | 2.0.0  |
77 | 53  | OSD_SAG_COMPENSATED_MAIN_BATT_VOLTAGE            | 2.0.0  |
78 | 54  | OSD_MAIN_BATT_SAG_COMPENSATED_CELL_VOLTAGE       | 2.0.0  |
79 | 55  | OSD_POWER_SUPPLY_IMPEDANCE                       | 2.0.0  |
80 | 56  | OSD_LEVEL_PIDS                                   | 2.0.0  |
81 | 57  | OSD_POS_XY_PIDS                                  | 2.0.0  |
82 | 58  | OSD_POS_Z_PIDS                                   | 2.0.0  |
83 | 59  | OSD_VEL_XY_PIDS                                  | 2.0.0  |
84 | 60  | OSD_VEL_Z_PIDS                                   | 2.0.0  |
85 | 61  | OSD_HEADING_P                                    | 2.0.0  |
86 | 62  | OSD_BOARD_ALIGN_ROLL                             | 2.0.0  |
87 | 63  | OSD_BOARD_ALIGN_PITCH                            | 2.0.0  |
88 | 64  | OSD_RC_EXPO                                      | 2.0.0  |
89 | 65  | OSD_RC_YAW_EXPO                                  | 2.0.0  |
90 | 66  | OSD_THROTTLE_EXPO                                | 2.0.0  |
91 | 67  | OSD_PITCH_RATE                                   | 2.0.0  |
92 | 68  | OSD_ROLL_RATE                                    | 2.0.0  |
93 | 69  | OSD_YAW_RATE                                     | 2.0.0  |
94 | 70  | OSD_MANUAL_RC_EXPO                               | 2.0.0  |
95 | 71  | OSD_MANUAL_RC_YAW_EXPO                           | 2.0.0  |
96 | 72  | OSD_MANUAL_PITCH_RATE                            | 2.0.0  |
97 | 73  | OSD_MANUAL_ROLL_RATE                             | 2.0.0  |
98 | 74  | OSD_MANUAL_YAW_RATE                              | 2.0.0  |
99 | 75  | OSD_NAV_FW_CRUISE_THR                            | 2.0.0  |
100 | 76  | OSD_NAV_FW_PITCH2THR                             | 2.0.0  |
101 | 77  | OSD_FW_MIN_THROTTLE_DOWN_PITCH_ANGLE             | 2.0.0  |
102 | 78  | OSD_DEBUG                                        | 2.0.0  |
103 | 79  | OSD_FW_ALT_PID_OUTPUTS                           | 2.0.0  |
104 | 80  | OSD_FW_POS_PID_OUTPUTS                           | 2.0.0  |
105 | 81  | OSD_MC_VEL_X_PID_OUTPUTS                         | 2.0.0  |
106 | 82  | OSD_MC_VEL_Y_PID_OUTPUTS                         | 2.0.0  |
107 | 83  | OSD_MC_VEL_Z_PID_OUTPUTS                         | 2.0.0  |
108 | 84  | OSD_MC_POS_XYZ_P_OUTPUTS                         | 2.0.0  |
109 | 85  | OSD_3D_SPEED                                     | 2.1.0  |
110 | 86  | OSD_IMU_TEMPERATURE                              | 2.1.0  |
111 | 87  | OSD_BARO_TEMPERATURE                             | 2.1.0  |
112 | 88  | OSD_TEMP_SENSOR_0_TEMPERATURE                    | 2.1.0  |
113 | 89  | OSD_TEMP_SENSOR_1_TEMPERATURE                    | 2.1.0  |
114 | 90  | OSD_TEMP_SENSOR_2_TEMPERATURE                    | 2.1.0  |
115 | 91  | OSD_TEMP_SENSOR_3_TEMPERATURE                    | 2.1.0  |
116 | 92  | OSD_TEMP_SENSOR_4_TEMPERATURE                    | 2.1.0  |
117 | 93  | OSD_TEMP_SENSOR_5_TEMPERATURE                    | 2.1.0  |
118 | 94  | OSD_TEMP_SENSOR_6_TEMPERATURE                    | 2.1.0  |
119 | 95  | OSD_TEMP_SENSOR_7_TEMPERATURE                    | 2.1.0  |
120 | 96  | OSD_ALTITUDE_MSL                                 | 2.1.0  |
121 | 97  | OSD_PLUS_CODE                                    | 2.1.0  |
122 | 98  | OSD_MAP_SCALE                                    | 2.2.0  |
123 | 99  | OSD_MAP_REFERENCE                                | 2.2.0  |
124 | 100 | OSD_GFORCE                                       | 2.2.0  |
125 | 101 | OSD_GFORCE_X                                     | 2.2.0  |
126 | 102 | OSD_GFORCE_Y                                     | 2.2.0  |
127 | 103 | OSD_GFORCE_Z                                     | 2.2.0  |
128 | 104 | OSD_RC_SOURCE                                    | 2.2.0  |
129 | 105 | OSD_VTX_POWER                                    | 2.2.0  |
130 | 106 | OSD_ESC_RPM                                      | 2.3.0  |
131 | 107 | OSD_ESC_TEMPERATURE                              | 2.5.0  |
132 | 108 | OSD_AZIMUTH                                      | 2.6.0  |
133 | 109 | OSD_CRSF_RSSI_DBM                                | 2.6.0  |
134 | 110 | OSD_CRSF_LQ                                      | 2.6.0  |
135 | 111 | OSD_CRSF_SNR_DB                                  | 2.6.0  |
136 | 112 | OSD_CRSF_TX_POWER                                | 2.6.0  |
137 | 113 | OSD_GVAR_0                                       | 2.6.0  |
138 | 114 | OSD_GVAR_1                                       | 2.6.0  |
139 | 115 | OSD_GVAR_2                                       | 2.6.0  |
140 | 116 | OSD_GVAR_3                                       | 2.6.0  |
141 | 117 | OSD_TPA                                          | 2.6.0  |
142 | 118 | OSD_NAV_FW_CONTROL_SMOOTHNESS                    | 2.6.0  |
143 | 119 | OSD_VERSION                                      | 3.0.0  |
144 | 120 | OSD_RANGEFINDER                                  | 3.0.0  |
145 | 121 | OSD_PLIMIT_REMAINING_BURST_TIME                  | 3.0.0  |
146 | 122 | OSD_PLIMIT_ACTIVE_CURRENT_LIMIT                  | 3.0.0  |
147 | 123 | OSD_PLIMIT_ACTIVE_POWER_LIMIT                    | 3.0.0  |
148 | 124 | OSD_GLIDESLOPE                                   | 3.0.1  |
149 | 125 | OSD_GPS_MAX_SPEED                                | 4.0.0  |
150 | 126 | OSD_3D_MAX_SPEED                                 | 4.0.0  |
151 | 127 | OSD_AIR_MAX_SPEED                                | 4.0.0  |
152 | 128 | OSD_ACTIVE_PROFILE                               | 4.0.0  |
153 | 129 | OSD_MISSION                                      | 4.0.0  |
154 | 130 | OSD_SWITCH_INDICATOR_0                           | 5.0.0  |
155 | 131 | OSD_SWITCH_INDICATOR_1                           | 5.0.0  |
156 | 132 | OSD_SWITCH_INDICATOR_2                           | 5.0.0  |
157 | 133 | OSD_SWITCH_INDICATOR_3                           | 5.0.0  |
158 | 134 | OSD_TPA_TIME_CONSTANT                            | 5.0.0  |
159 | 135 | OSD_FW_LEVEL_TRIM                                | 5.0.0  |
160 | 136 | OSD_GLIDE_TIME_REMAINING                         | 6.0.0  |
161 | 137 | OSD_GLIDE_RANGE                                  | 6.0.0  |
162 | 138 | OSD_CLIMB_EFFICIENCY                             | 6.0.0  |
163 | 139 | OSD_NAV_WP_MULTI_MISSION_INDEX                   | 6.0.0  |
164 | 140 | OSD_GROUND_COURSE                                | 6.0.0  |
165 | 141 | OSD_CROSS_TRACK_ERROR                            | 6.0.0  |
166 | 142 | OSD_PILOT_NAME                                   | 6.0.0  |
167 | 143 | OSD_PAN_SERVO_CENTRED                            | 6.0.0  |
168 | 144 | OSD_MULTI_FUNCTION                               | 7.0.0  |
169 | 145 | OSD_ODOMETER                                     | 7.0.0  |
170 | 146 | OSD_PILOT_LOGO                                   | 7.0.0  |
172 # Pilot Logos
174 From INAV 7.0.0, pilots can add their own logos to the OSD. These can appear in 2 places: the power on/arming screens or as an element on the standard OSD. Please note that the power on/arming screen large pilot logos are only available on HD systems.
176 To use the pilot logos, you will need to make a custom font for your OSD system. Base fonts and information can be found in the [OSD folder](https://github.com/iNavFlight/inav-configurator/tree/master/resources/osd) in the Configurator resources. Each system will need a specific method to create the font image files. So they will not be covered here. There are two pilot logos.
178 <img alt="Default small INAV Pilot logo" src="https://github.com/iNavFlight/inav-configurator/raw/master/resources/osd/digital/default/24x36/469_471.png" align="right" />The small pilot logo appears on standard OSD layouts, when you add the elemement to the OSD screen. This is a 3 character wide symbol (characters 469-471).
180 <img alt="Default large INAV Pilot logo" src="https://github.com/iNavFlight/inav-configurator/raw/master/resources/osd/digital/default/24x36/472_511.png" align="right" />The large pilot logo appears on the power on and arming screens, when you enable the feature in the CLI. To do this, set the `osd_use_pilot_logo` parameter to `on`. This is a 10 character wide, 4 character high symbol (characters 472-511).
182 ## Settings
184 * `osd_arm_screen_display_time` The amount of time the arming screen is displayed.
185 * `osd_inav_to_pilot_logo_spacing` The spacing between two logos. This can be set to `0`, so the original INAV logo and Pilot Logo can be combined in to a larger logo. Any non-0 value will be adjusted to best align the logos. For example, the Avatar system has an odd number of columns. If you set the spacing to 8, the logos would look misaligned. So the even number will be changed to an odd number for better alignment.
186 * `osd_use_pilot_logo` Enable to use the large pilot logo.
188 ## Examples
190 This is an example of the arming screen with the pilot logo enabled. This is using the default settings.
191 ![Arming screen example using default settings with osd_use_pilot_logo set to on](https://user-images.githubusercontent.com/17590174/271817487-eb18da4d-0911-44b2-b670-ea5940f79176.png)
193 This is an example of setting the `osd_inav_to_pilot_logo_spacing` to 0. This will allow a larger, single logo.
194 ![Power on screen example with 0 spacing between logos](https://user-images.githubusercontent.com/17590174/271817352-6206402c-9da4-4682-9d83-790cc2396b00.png)