User Guide 2.0
ShikOfTheRa edited this page May 21, 2021
·
10 revisions
- GUI - controls
- GUI - configuration options
- GUI - configurable screen layouts
- GUI - screen elements available for display
- GUI - FC emulator
- OSD - accessing the built in OSD menu
- OSD - additional configuration settings
- LINKS - helpful FPV community reference info
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
Change Font
- Select one of the bundled fonts ready for upload.
Upload Font
- Uploads current loaded fontfile from the GUI into the OSD
Edit Font
- Edit / save / load a custom font file
Logo editor
- Create your own custom pilot icon!
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
- Play pre-recorded serial captures - for flight replay / troubleshooting
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. e.g. Ardupilot / PX4 / etc.
- Note increasing the value in the GUI increases the OSD value displayed.
- Verify voltage is correct in the aircraft as it may be influenced by the variations in the 5v supply between USB programmer and the aircraft
- The value is random and will likely differ between hardware due to how the hardware functions
- Battery icon - shows static or remaining capacity battery icon
- 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.
- Autorange RSSI - set RSSI Max to zero to enable RSSI autorange. Min will be zero, Max will be max recorded RSSI value
- !!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 enabled in screen layout.
- Display pilot icon – disables pilot icon instead of text.
Display
- Timer 1 - Choose on time, fly time, dual on / fly time or estimated time remaining (requires Amperage draw / battery alarm capacity)
- Timer 2 - Choose on time, fly time, dual on / fly time or estimated time remaining (requires Amperage draw / battery alarm capacity)
- Metric or Imperial for units of display and measurements
- Text alarms – enable/disable prominent alarm messages such as “Low Voltage”
- Throttle display type - shows PWM throttle value or %
- Vario indicator size – single character or multiple rows for increased resolution
- Map mode – display aircraft, home or both positions as a map relative to launch
- GPS Display type - enables masking of major GPS digits with false values for privacy.
- GPS time zone - enables correction from UTC if required.
- Flight date/time – displays date and time at arming for record of flight. Where supported
- High res altitude – displays altitude in xx.x format when lower than threshold
- Flight mode display – displays mode in icon or test format – MSP based FC only
- Brightness – reduce opacity of black and white OSD text
Other
- Analog sensor type – 1.1v is more accurate, but mandatory to use 5v for > 4s or if using direct analog RSSI or current sensors
- Video signal - select AUTODETECT, NTSC or PAL to match your Camera. PAL enables larger screen element area.
- Statistics – show statistics for full flight or since armed
- Fixedwing alt/heading - enables use of BARO and MAG data instead of GPS. GPS is default and previously always used for OSD
- Automatic antenna tracker - enables use of Virtualpilot Sentinel antenna trackers. First line of OSD is unavailable for OSD data
- Custom development - for developer specified use
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
GPS OSD
- Transmitter type – select transmitter channel ordering for GPS OSD if using RC input
- Transmitter reverse – channel reversing if needed for GPS OSD if using RC input
- RC source – for Aeromax OSD users – specify RC channel input type – PWM or PPM
Mavlink
- Mavlink system id – must match id of FC. Default is 1
- Mavlink alarm threshold – display mavlink alarms up to the value specified. E.g. only emergency or info - all
- Mavlink autoconfigure – attempts to autoconfigure FC for optimum settings – APM only
- Transmitter type – select transmitter channel ordering for GPS OSD if using RC input
- Transmitter reverse – channel reversing if needed for GPS OSD if using RC input
HUD
- Sidebar height – adjust height of HUD sidebars
- Sidebar width – adjust separation of sidebars
- AHI minor – enable smaller AHI secondary bars
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)
Custom
- 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
- AUX sensor calibration – temperature probe or airspeed sensor
VTX
- Adjust VTX values for supported FC
- Elements are enabled / disabled on the screen editor
- 1, 2 or 3 layouts can be uploaded to OSD
- OSD supports using an RC channel (3 screens) or older OSD switch (2 Screens)
- 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
- NOTE PAL users can optionally specify PAL in "other" tab for a larger screen area. Not usually required.
SAVE settings to file
- Saves the settings to file for backup
LOAD settings from file
- Loads settings from a previously backed up file
Copy
- Copies settings from currently selected screen preview - switches and positions
Paste
- Pastes copied settings to currently selected screen preview - switches and positions
- ADSB : Distance/altitude/direction to nearest ADSB aircraft. (MAVLINK) Alternatively buddyflight.
- AHI-horizon : Artificial horizon
- AHI-sidebars : Graphical Speed and Altitude indicators
- AIR speed : Air speed from FC
- Altitude : Barometric altitude relative to launch location. GPS if not available
- Amps : Instantaneous current draw - choice of sources
- Angle to home : Heading angle in degrees to launch location
- AP status : Status field - RTH / Waypoints. AUTOTRIM /AUTOTUNE (iNAV/MAVLINK)
- Armed Status : Armed / disarmed status. Also 2 line centered FC message (MAVLINK)
- Avg Efficiency : Milliamp hours used per minute of flight time
- Battery status : Battery capacity remaining (%) from FC (MAVLINK) or calculated (others)
- Call Sign : User callsign
- Cell voltage : Individual cell value calculated from main battery voltage
- Climb Rate : Rate of climb (numerical vario)
- Compass : Visual heading compass
- Custom : For development / user specific features
- Direction to home : Arrow pointing to launch location
- Distance : Distance to launch location
- Efficiency : Instantaneous Watts per kmh / mph
- Glidescope : Grahical glidescope indicator landing assit
- GPS - DOP : GPS DOP value
- GPS altitude : GPS altitude relative to launch location
- GPS time : GPS time in UTC HH:MM:SS
- Heading : Current heading angle in degrees
- Latitude : GPS latitude in DDD.MMMMM
- Longitude : GPS longitude in DDD.MMMMM
- mAh : Milliamp hours consumed
- Map Mode center : Enable map mode
- Map Mode distance : Map scale when in map / radar modes
- Max Distance : Max distance from launch during flight
- MAX Speed : Max speed during flight
- Mode : Flight mode. Text or graphical icon
- PID tuning : RPY values for inflight tuning (BF / iNav)
- Pitch Angle : FC pitch angle in degrees
- Roll Angle : FC roll angle in degrees
- RSSI : RSSI % value - choice of sources
- Sensor : Sensors active - (iNAV/BF/MSP)
- Speed : Speed in relation to ground
- Temperature : Temperature from direct attached OSD sensor or FC (MAVLINK autodetect)
- Throttle : Throttle position. % or PWM value
- Timer 1 : Selectable timer - on / flight / remaining
- Timer 2 : Selectable timer - on / flight / remaining
- Total Distance : Total distance recorded during flight
- Vario : Graphical vario indicator
- Voltage - main : Main battery Voltage - choice of sources
- Voltage - video : Video battery voltage from OSD directly connected input
- VTX : VTX channel/power/band (KISS and hardware OSD VTX)
- Watts : Instantaneous power consumption in Watts
- WIND Speed : Wind speed from FC (MAVLINK).Wind direction (MAVLINK/iNav/BF/MSP)
- Use this to simulate a MSP class flight controller connected to your OSD (Betaflight, iNav, MSP based)
- Primarily used for testing and OSD development
- Use this to simulate any serial stream to your OSD
- This is very useful for testing Ardupilot by replaying TLOG files
- Primarily used for testing and OSD development
- 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
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
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
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
Wiki - prime source of information
