User guide 1.8 - ShikOfTheRa/scarab-osd GitHub Wiki
User Guide - Index
GUI - controls
GUI - configuration options
GUI - configurable screen layouts
GUI - FC emulator
OSD - accessing the built in OSD menu
OSD - additional configuration settings
LINKS - helpful FPV community reference info
GUI - controls
Controls and communication
Comm port
Select the communications port for the OSD
Baud Rate
The default baudrate is normally 115200
Use 57600 for Mavlink based systems such as Ardupilot/APM/PX4
Passthrough
If connecting through a supporting FC, enable this
Select the appropriate UART the OSD is connected to
FONT Tools
Edit Font
Editor for currently loaded font file
Write Font
Uploads fontfile from the GUI into the OSD
Load Font
Browse for an alternative font file to load into the GUI
OSD Controls
Read
Reads values from OSD into the GUI (including screen layouts)
Write
Updates the OSD with values set in the GUI (including screen layouts)
Default
Resets the board to OSD default settings
Restart
Restarts the OSD - sometimes required after saving changes
GUI - configuration options
Voltage
Voltage source β select the source of voltage β from FC or direct to OSD
Auto Detect β Use battery cell count β this uses configured fixed cell count and alarm values for the battery state gauge and alarms.
Auto Detect β Autodetect cell count / alarm β this autodetects the number of cells and determines alarm voltage based upon the autodetect cell alarm voltage.
Voltage adjust - use this to adjust the displayed voltage to match the actual battery voltage. Note if voltage is taken from the flight controller this adjustment is not applicable.
Voltage alarm - if not using autodetect, set this to the voltage at which you require the battery voltage to start to flash.
Amperage
Amperage β direct connect - select this for Amperage values from sensor connected directly to OSD.
Amperage β use FC - select this for Amperage values from FC.
Amperage β use virtual - select this to use a software estimation of calibrated current draw against throttle position.
Amps zero adjust - use this to set the correct idle / zero current draw displayed
Amps adjust - use this to set the correct current draw displayed at mid throttle
mAh Alarm - use this to set alarm warning for bat capacity. Zero is disabled
Amp Alarm - use this to set alarm warning for Current draw. Zero is disabled
!! NOTE !! - remember to select 5v reference if using direct Amperage
!! NOTE !! - see guide for how to calibrate
RSSI
RSSI source β direct analog β use analogue voltage connected to OSD.
RSSI source β direct RSSI β use PWM RX signal connected to OSD.
RSSI source β from FC β use RSSI value from FC.
RSSI source β RC channel β use RX channel from FC.
RSSI channel β channel when using source = RC channel.
RSSI alarm - set this to the value at which you require the RSSI value to start to flash
Min - minimum value with TX turned off.
Max - maximum value with TX turned on.
!!NOTE !! - remember to select 5v reference if using direct analog RSSI
!! NOTE !! See guide for how to calibrate
Display Callsign
Disabled - do not show callsign
Show permanently - always on when enabled in screen layout.
Display every 4 seconds every minute - when enabledin screen layout.
Reference Voltage
You must select this if you wish to use > 4s
You must select this if you wish to use HW current sensor or Analogue RSSI
!!NOTE!! This requires a smooth power supply to the OSD when enabled
Other
Video signal - select AUTODETECT, NTSC or PAL to match your Camera
Transmitter type β select transmitter channel ordering for APM/PX4/MAVLINK
Mavlink system id β must match id of FC. Default is 1
Test alarms β enable/disable prominent alalrm messages such as βLow Voltageβ
Throttle display type - shows PWM throttle value or %
Vario indicator size β single character or multiple rows for increased resolution
Metric or Imperial for units of display and measurements
Transmitter reverse β channel reversing if needed for APM/PX4/MAVLINK
Battery Health icon - shows static or remaining capacity battery icon
Statistics β show statistics for full flight or since armed
Map mode β display aircraft, home or both positions as a map relative to launch
Analog sensor type β 1.1v is more accurate, but mandatory to use 5v for > 4s or if using direct analog RSSI or current sensors
Audio vario deadband β if not zero, creates an area of no sound around horizontal flight
Audio vario throttle switch β if throttle is above this value, audio vario is suppressed as under power. 1000 always off, 2000 always on
GPS
Display type - enables masking of major GPS digits with false values. Replace these with co-ordinates of the area to find downed aircraft
Fixedwing BARO/ALT - enables use of BARO and MAG data instead of GPS. GPS is default and previously always used for OSD
LAYOUT
OSD screen switch - choose to enable screen switching by FC OSD switch function (2 layouts) or RC channel (3 layouts)
RC channel β channel used for Screen switch if enabled
HUD
Sidebar height β adjust height of HUD sidebars
Sidebar width β adjust separation of sidebars
Alarms
Setting to 0 disables alarm
Distance Alarm - use this to set alarm warning for max distance
Altitude Alarm - use this to set alarm warning for max altitude
Speed Alarm - use this to set alarm warning for max speed
Timer Alarm - use this to set alarm warning for timer (in minutes)
VTX
Adjust VTX values for supported FC
GUI - configurable screen layouts
Understanding the concept of how it works
This is significantly changed in R1.8 β elements are only enabled / disabled on the screen editor instead of additional menu options
1, 2 or 3 layouts can be uploaded to OSD
FC using OSD switch functionality supports 2 layouts, RC channel supports 3
Use the layout editor to create a layout that is available to the OSD to use
Fields can be enabled or disabled per layout using the editor switches
Fields can be moved around by click / drag of the screen item
Middle mouse click on screen item selects the corresponding switch to enable/disable
Predefined layout templates can be used to help in creating your preferred layouts
SAVE settings to file
Saves the settings to file for backup
LOAD settings from file
Loads settings from a previously backed up file
GUI - Elements
Efficiency - instantaneous Watts per kmh or mph
Avg Efficiency - mAh used per minute of flight time
GUI - FC emulator
Use this to simulate a MSP class flight controller connected to your OSD (Betaflight, Cleanflight, iNav etc.)
Primarily used for OSD development
Firmware Flasher
Easy and quick upload of pre-compiled firmware to OSD!
Select version, Hardware device, FC or OSD variant and aircraft type
Key release notes and information is displayed for reference
Load firmware form online repository
Click flash and watch the progress
Alternative option to flash from a local binary
View and install test releases when available
OSD - accessing the built in OSD menu
To access the inbuilt OSD menu, with the FC DISARMED:
THROTTLE MIDDLE
YAW RIGHT
PITCH FULL
To navigate the OSD:
PITCH/ROLL sticks are used to navigate
YAW stick is used to adjust / change values
OSD - accessing the built in FC menu
Access to the inbuilt FC menu is supported for some FC such as betaflight and iNav. With the FC DISARMED:
THROTTLE MIDDLE
YAW LEFT
PITCH FULL
To navigate the FC menus, stick settings defined by the FC are used
OSD - additional configuration settings
config.h
Further settings are available in config.h due to :