User Guide 1.7 - 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
Unless specified the default baudrate is 115200
The default for Mavlink based systems (APM/PIXHAWK) is 57600
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
Write
Updates the OSD with values set in the GUI (excludes screen layouts)
Default
Resets the board to OSD default settings
Restart
Restarts the OSD - recommended after saving changes
GUI - configuration options
Voltage
Display Voltage - select if you wish to display voltage on OSD
Use FC main voltage - select this if you wish to use the Flight controllers voltage. If not selected, it will use the OSD voltage from the hardware pins connection (default).
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.
Battery cells - set this to the correct number of battery cells. It is only used for the battery capacity status icon.
Voltage alarm - set this to the voltage at which you require the battery voltage to start to flash.
Amperage
Display Amps - select this if you wish to display the instantaneous Amps draw
Display mAh - select this if you wish to display the cumulative mAh consumed during flight
If neither FC or Virtual are selected, the OSD will use analogue input on OSD
Use virtual sensor - select this instead of default hardware sensor to use a software estimation of calibrated current draw against throttle position.
Use FC Amperage - select this instead of deafault hardware sensor to Amerage values from Flight Controller .
Amps adjust - use this to adjust the Amps drawn value. It is recommended to adjust for accuracy against an Ampmeter around 50%
Zero adjust - use this to adjust the Amps drawn when the copter is idle
throttle with a Multicopter
x100 mAh Alarm - use this to set alarm warning for bat capacity. 10 = 1000mah
Amp Alarm - use this to set alarm warning for Current draw
CAL Button - use this if you have a HW current sensor to set correct values
!!NOTE !! - remember to select 5v reference if using analog RSSI
!! NOTE !! See guide for how to calibrate
RSSI
Display RSSI - select this if you wish to display RSSI on the OSD.
If neither FC or PWM are selected, the OSD will use ANALOGUE RSSI from a RX directly connected to the OSD
Use FC - select this if you wish to to use the RSSI value from the Flight Controller instead of the OSD. The FC must configured to support this
Use PWM - select this if you wish to use the PWM RSSI value from a RX connected directly to the OSD
To use an RC channel, select "Use PWM" and configure RCRSSI in config.h
RSSI alarm - set this to the value at which you require the RSSI value to start to flash
SET (Min) - click this to calibrate RSSI minimum value with TX turned off
SET (Max) - click this to calibrate RSSI maximum value with TX turned on
!!NOTE !! - remember to select 5v reference if using analog RSSI
!! NOTE !! See guide for how to calibrate
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
Display Callsign
You must select this if you wish to use callsign display
Enter the callsign in the Box. Use UPPER CASE and NUMERIC only
Further configuration options are available in config.h
Other
Select Metric or Imperial units for display and measurements
Select NTSC or PAL to match your Camera
Display Throttle value - shows throttle value
Throttle display type - shows PWM throttle value or %
Battery Health icon - shows battery icon as a fuel gauge
Reset stats after arm - enable this only if you want to show measurements over a single flight instead of whilst battery connected
Display Heading - displays heading in -180 +180 degrees
- Heading 360 - displays heading in alternative 0-360 degrees
Alarms
Distance Alarm - use this to set alarm warning for max altitude. Value is 100
Altitude Alarm - use this to set alarm warning for max altitude. Value is 10
Speed Alarm - use this to set alarm warning for max speed
Timer Alarm - use this to set alarm warning for timer (in minutes)
LAYOUT
Using FC OSD switch - choose to enable screen switching by FC OSD switch function
Using RC channel - choose to enable screen switching by a RC channel
OSD ch - in RC channel mode specifies channel used to switch screen
GUI - configurable screen layouts
Understanding the concept of how it works
Any 3 can be uploaded to OSD
Use the layout editor to create a layout that is available to the OSD to use
Fields can be enabled or disabled
Fields can be moved around
The layout defines the fields available to view
GUI tab switches or OSD menu can be used to optionally turn on/off fields available. Turning off disables field on OSD layouts irrespective of the layout settings
Controls and what they do
UP/DOWN/LEFT/RIGHT
Click buttons to move the selected field
TOGGLE
Enables/disables the field on the selected layout. Current status displayed
TX LOW/MID/HIGH channel control
Will be enabled when using RC channel enabled in Layout tab
Layout assigned to Low / Mid High switch setting
Layouts can be changed using drop down arrow
Approximate simulated layout can be displayed by selecting the radio button associated with the TX switch position
OSD SWITCH control
Will be enabled when using FC OSW SW enabled in Layout tab
Layout assigned to normal / OSD Switch setting
Layouts can be changed using drop down arrow
Approximate simulated layout can be displayed by selecting the radio button associated with the TX switch position
WRITE to OSD
Click this to upload to layouts and settings to OSD
SAVE Layout
Click this to save any edits made to HUD layouts
SAVE settings to file
Saves the HUD layouts to file for backup
LOAD settings from file
Loads HUD layouts from a previously backed up file
Enable SWITCHES
Click this to set all display switches on - useful when OSD disconnected and to assist in planning layouts
NOTE - when complete, select EXIT to avoid saving switch settings
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
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 - additional configuration settings
config.h
Further settings are available in config.h due to :