User guide 1.6 - ShikOfTheRa/scarab-osd GitHub Wiki


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

    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/)


    MW OSD GUI quick reference guide

    Controls and communication

    Comm settings

  • Toggle between com ports and baud rates. Selected values Are indicated above.
  • Baud Rate

  • Hidden option. Click "Comm settings" to access and change
  • DISK

    Load

  • Loads previously saved configuration file from disk
  • Save

  • Saves current configuration to disk
  • Font Tools

    Edit Font

  • Editor for currently loaded font file
  • Upload

  • Uploads fontfile from the GUI into the OSD
  • Browse

  • 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
  • Reset

  • Resets the board to OSD default settings
  • Restart

  • Restarts the OSD - recommended after saving changes

  • Configuration

    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 !! - remeber to select 5v reference whn using OSD hardware sensor

    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
  • Use PWM - (with RCRSSI configured in config.h) select this if you want to use a RC channel 0-7 for RSSI
  • 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 !! 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

    Other
  • Select Metric or Imperial units for display and measurements
  • Select NTSC or PAL to match your Camera
  • Display Throttle position - shows throttle as a percentage value
  • Display Battery Status - shows battery icon as a fuel guage
  • Reset stats after arm - enable this only if you want to show measurements over a single flight instead of whilst battery connected

    Display
  • Display Flight mode - shows ACRO/HORIZON/RTH/HOLD icon
  • - FM sensors - shows if acc/baro/mag are enabled
  • Display Gimbal - shows icon when gimbal is activated
  • Display Vario - shows climb / descend rate
  • Display BARO ALT - shows the altitude from Barometer
  • Display Timer - displays flight / on timer

    HUD
  • Display Horizon Bar - shows horizon indicator
  • - HB - shows additional horizon elevation indicators
  • Display Sidebars - shows vertical HUD sidebars
  • - SB scrolling - sidebars scroll in direction of change for altitude and speed
  • - SB direction - indicator arrows for alternative indicator of direction of change for altitude and speed


    GPS settings
  • Display GPS - enables sats / direction to home arrow,/ Distance / Speed
  • - GPS co-ords - displays GPS co-ords
  • - GPS altitude - display GPS altitude
  • - MAPMode 0 - disabled
  • - MAPMode 1 - map center = aircraft, relative home position displayed on map
  • - MAPMode 2 - map center = home, relative aircraft position displayed on map
  • - MAPMode 3 - advanced hybrid combination of mapmodes 2 and 3

    Compass
  • Display Compass - displays compass / heading indicator
  • Display Heading - displays heading in -180 +180 degrees
  • - Heading 360 - displays heading in alternative 0-360 degrees
  • Display angle to home - displays angle to home in degrees relative to direction heading

    Time Settings
  • Display GPS time - displays the UTC time from satellite
  • Time zone offset - corrects UTC time to local time in hours
  • Timezone +/- determines if offset is forward or back
  • DST Minutes - corrects for daylight time
  • !! NOTE !! Support MultiWii only - and requires specific load

    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 OSD - choose to use FC OSD switch - or RC channel to switch screens
  • OSD ch - in RC channel mode specifies channel used to switch screen
  • HUD - LOW/MID/HIGH - layouts selected for RC switch option
  • HUD - Default / OSD SW - layouts selected for FC OSD_SWITCH option

    Debug
  • Debug - displays debug values for FC/OSD developers
  • Diagnostic - turns diagnostic values off / on


    Simulator

  • Use this to simulate Multiwii controller connected to your OSD
  • View real time the impact of changes on your OSD
  • View a simulated OSD screen on the computer - no cam / rx / screen needed

    Simulator control
  • Enables the OSD simulator

    Simulate the following
  • Multiwii sensors - mag / baro / gps
  • Multiwii flight modes - acro / horizon / angle / RTH / HOLD
  • Multiwii status - arm /camstab / home / OSD SW
  • Clear flight screen using OSD SW
  • Vario
  • Main battery voltages (simulated from multiwii FC)
  • RSSI (simulated from multiwii FC)
  • GPS data - distance / altitude / speed / satellites / heading home
  • Heading
  • RC command input
  • Pitch and Roll
  • Individual lipo cell status (requires FRSKY sensor / MWC patch)


    Layout Editor

    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.
  • Note that if a feature is disabled by the switches on the GUI or OSD menu, this overrides all screen layouts on the OSD.
  • Up to 256 individual HUD layouts can be created within the GUI
  • The layout defines the fields available to view
  • GUI switches or OSD menu can be used to optionally turn on/off fields available. Turning off disables field on OSD irrespective of the layout settings.

    Buttons and what they do

    +/- HUD:0

  • Shows the current HUD selected for edit
  • Click buttons to select the HUD you wish to edit

    +/- "field" e.g. "Sat Indicator"
  • Shows the current HUD field selected to edit
  • Click buttons to select the HUD field you wish to edit

    Enabled/Disabled
  • Shows if the field is available to display
  • Click buttons to enable or disable

    UP/DOWN/LEFT/RIGHT
  • Click buttons to move the selected field

    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

    ADD
  • Click this to add an extra hud if you want to leave the existing ones unmodified.
  • A fresh permanent HUD will be created identical to HUD0

    WRITE
  • Click this to save any edits made to HUD layouts
  • ALSO updates the OSD
  • NOTE - not needed for ADD unless changes are made to teh added layout

    CANCEL
  • Click this to reload last saved HUD layouts
  • Cancel any current edits.




    Further settings

    Further settings are available in config.h due to : memory constraints to leave enabled permanently rarely used not yet moved to the GUI

    Advanced settings

    Advanced settings are available in def.h. Primarily for developers
  • ⚠️ **GitHub.com Fallback** ⚠️