Skip to content
ShikOfTheRa edited this page Jan 31, 2018 · 16 revisions

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.
  • 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 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
  • 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 :
  • memory constraints to leave enabled permanently
  • rarely used
  • not yet moved to the GUI

    def.h Advanced settings are available in def.h.
  • Primarily for developers

    LINKS - helpful FPV community reference info

    How to - [video guide to the OSD menu from DEET] (http://youtu.be/pd_PXnG_PkI)

    How to - [connecting to CLEANFLIGHT FC from Tr3TopFlyer] (https://drive.google.com/file/d/0B2MInRUrbpWxUjdmdXJIWkRZY0k/view?usp=sharing)

    How to - [flash the MW OSD firmware to your OSD] (https://github.com/ShikOfTheRa/scarab-osd/blob/master/OTHER/DOCUMENTATION/FirmwareFlashing.md)

    How to - [alternative way to access frsky via telemtry from Jindalee10368] (http://vk4ghz.com/mwosd-display-rssi-via-spare-radio-channel/)

  • Clone this wiki locally