Onboard OSD functionality was introduced with the ChibiOS port to ArduCopter 3.6x, ArduPlane 3.9x and ArduRover 3.5x firmware versions. Mainly aiming at aio-boards with onboard MAX7456-type chips, it enables overlay of FC data using the onboard video system. Once enabled, it uses various panel items that can individually be set active and positioned on the screen using respective parameters. It allows to setup multiple screen layouts and switch between those using a spare RC channel.
Being an integral library of ArduPilot firmware, the OSD code provides the prerequisites to be redirected to various backends other than MAX-type chipsets, including testing on SITL setups without actual autopilot- or video-hardware needed.
To enable the OSD overlay on MAX7456-type chips, set parameter:
OSD_TYPE to 1, reboot and reload parameters.
This exposes the whole OSD parameter group.
To set a RC channel for screen switching, use parameter
To set the units used to display, use parameter
0= Metric (meters,kilometers,meters/sec,kilometers/hour,degs in C)
1= Imperial (feet, miles, feet/sec, miles/hour, degs in F)
2= ArduPilot Native (meters,kilometers,meters/sec,degs in C)
3= Aviation (feet, nautical mile, feet/min, knots, degs in C)
To set vertical and horizontal display offset (space at top and left side of screen), use parameters
Several options can be set using OSD_OPTIONS (bitmask selection):
- bit0 = Enable use of compact number+decimal point fonts
- bit1 = Invert wind direction indicator (to point to the direction its blowing from instead of toward)
- bit2 = Invert horizon roll direction
Several font sets are included and can be changed during runtime (and those who can build the software can customize or add additional font sets….see libraries/AP_OSD/fonts/README.md)
0= Clarity (default). A clearly visible large font
1= Clarity Medium. Good visibility, less dominant than clarity default
2= Betaflight. bf- / inav-osd default style
3= Bold. A bolder version of Betaflight
4= Digital. 80’s LED clock radio style
In firmware 4.1 and above, onboard font options might be limited on 1 MB boards to save memory for other features. However, font upload from SD card is supported. This allows the user to choose from up to 10 font files (named “font0.bin” - “font9.bin”) placed in the root directory of your SD card. Additionally, this allows the user to easily add individualized and/or customized language charsets for the onboard OSD without the need to compile individual firmware. Runtime font changing using the parameter OSD_FONT is unaffected.
MAVftp might be a convenient option to upload files to your SD card without having to physically remove it from your flight controller. Font files, font editor, and utlities to convert to a .bin file from .mcm are here. If downloading the editor or a font’s .bin file from this site, be sure to use the
Download` button, rather than selecting ``Raw, and then right click saving, as you would the .mcm or .py files.
Screens and screen switching¶
For multiple screen layouts, each parameter’s “OSD” part is trailed by a number, starting with “1”
OSD1_PARAMETER- This number addresses the respective screen layout number, allowing to set individual items active on one screen but have them switched off on another screen. OSD settings default to 4 screens optionally available.
- Set parameters
OSDn_CHAN_MAXto adjust RC channel pwm limits to use for switching to a respective screen.
There are different switch-method options to meet individual RC systems switch layout requirements. These can be set by parameter: OSD_SW_METHOD. The options are:
- 0 = switches to next screen if the set RC channel’s (OSD_CHAN) value is changed
- 1 = directly selects a screen based on the set pwm limits for each respective screen. RC channel value must change for new pwm value to be recognized.
- 2 = toggles screens on a low to high transition of set RC channel. keeps toggling to next screen every 1s while channel value is kept high
Each OSD panel item uses a set of three variables to be set:
OSDn_ITEM_ENABLE- activates the respective item when set to 1.
OSDn_ITEM_Yset the horizontal and vertical position of the item, starting with
X = 0and
Y = 0in the upper left corner of your screen.
The typical MAXChip based OSD screen has a visible matrix of 30 horizontal x 13 vertical chars in NTSC standard, while PAL standard has 16 vertical chars. The OSD code enables auto-detection of NTSC vs. PAL to match input signal properties.
ArduPilot calculates an sensor-less airspeed estimate that is used if no sensor is present or fails. ARSPD_TYPE must be set to zero in order to display this value as the airspeed item, if no sensor is present.
This panel allows to display your amateur radio callsign (or any other individual character string) on your onboard OSD screen. It will read the character string from a file named “callsign.txt” placed in the root of your SD card. Mind that the default ardupilot charsets require to use capital letters for correct display. Using MAVftp is a convenient option to upload the file to your SD card without having to physically remove it from your flightcontroller.
You will find this feature in firmware 4.1 and later
User Programmable Warnings¶
Several user defined warnings can be set which will flash the respective osd panel item when warning level is reached or exceeded
Testing OSD with SITL¶
OSD functionality can be tested without autopilot- or video-hardware using a Software In The Loop (SITL) simulator setup. Follow the SITL-Instructions to setup a simulation environment. Run the simulator on current source code.
A graphical OSD simulation in a separate window can be opened by adding the following option to sim_vehicle.py:
The simulated OSD can now be set and configured via parameters.
To see all available options type: