Wireless Digital Video:Configuration file

From Wireless Digital Video
Jump to: navigation, search

Configuration file

Important note for Microsoft Windows users: This file requires to be opened with Microsoft WordPad. Please do not use Notepad.

  • All devices support a configuration file on the boot partition with file name widv.txt. This is a regular text file that can be edited by the user to change the device's configuration.
  • Example:
;
; WiDV Two
; Configuration file
; 
; Wireless Digital Video S.L.
; http://www.wirelessdv.com/
;
; Lines starting with ';' are ignored.

[wireless]
country = US
channel = 8
auto_link = 1
channel_change_mode = automatic 

[video]
resolution = HD
fps = 49

[serial]
baudrate = 115200
logger = 0

[security]
password_video = replace_me_with_at_least_32_characters_with_no_spaces

[ethernet]
ip = 192.168.1.2
netmask = 255.255.255.0
gateway = 192.168.1.1
dns = 8.8.8.8
tcp_serial = 9090

[rtsp]
port = 8080
max_clients = 4

[joystick]
enable = 1

[video_ip]
enable = 1
passphrase = ReplaceMeWithAPassphraseAtLeast12CharactersLong
device = usb

Options

Current supported options:

Section [wireless]

  • country:
    • Users can set their country's location so the 802.11b/g regulations applies accordingly. A list of valid 2 letters country list can be found here.
  • channel:
    • 802.11b/g channel number that the device will start using after booting. It is recommended to set the same channel number on your transmitter and receiver so they find each other while booting.
    • Setting channel to 0 will force the device to boot on the same channel that it was using before shutting it down.
  • auto_link:
    • By setting auto_link to 1, the receiver will try to automatically link to the transmitter after booting, entering in Master mode. If you configure your transmitter and receiver to start on the same channel, setting auto_link to 1 will save you from having to link them to Master mode manually. This is useful if you always wish to link to the same transmitter, which is the most common scenario.
    • This setting will be disabled if the user changes the channel manually using the OSD Menu.
    • This setting will be disabled if diversity is active to avoid all receivers trying to link to the transmitter at the same time.
    • When auto_link is not active manual linking is required by using the OSD Menu. More information about Link modes can be found here.
    • Setting auto_link to 'always' will force the receiver to never disable auto_link.
    • This setting only applies to the receiver.
  • channel_change_mode:
    • By default when the transmitter boots and it has been linked against a receiver, they use an automatic channel change mechanism to avoid interference with other channels. Setting this to 'manual' will disable the automatic channel change feature. More information can be found on the channel section.
    • This setting only applies to the transmitter.

Section [video]

  • resolution:
    • Set to "HD" for 1280x720 video resolution. Set to "FullHD" for 1920x1080 video resolution. FullHD resolution will use higher bandwidth affecting the wireless range. This option only has effect on the transmitter. The receiver detects resolution automatically.
  • fps:
    • Video framerate. It accepts any value from 20 to 49. This option only has effect on the transmitter. The receiver detects framerate automatically.

Section [serial]

  • baudrate:
    • Baud rate to use for communication through the serial port with any external serial device. Supported values are: 1200, 2400, 4800, 9600, 19200, 38400, 57600 and 115200.
  • logger:
    • Set to 1 to store all the incoming serial traffic from the transmitter's serial port into the local SD Card. If you enable this setting on the receiver, you will also save all the received serial traffic from the transmitter's serial port into the receiver's SD Card. This can be seen as black box or flight recorder while flying as all the telemetry connected on the transmitter's serial port is being stored on the receiver. More information can be found here.

Section [security]

Security option is only available on WiDV Professional version.

  • password_video:
    • This password will be used to encrypt all video transmission between your transmitter and receiver . This will make all the communication between your devices secure, guaranteeing that no one else is able to see your video signal. It is important that you configure the same password on your transmitter and receiver, otherwise they will never be able to establish contact.
    • The length of the password is 32 characters minimum and 64 characters maximum.

Section [Ethernet]

These settings are only available on WiDV Professional version.

  • ip:
    • IP address that should be assigned to the device's ethernet port.
  • netmask:
    • Netmask address that should be assigned to the device's ethernet port.
  • gateway:
    • Gateway address that should be assigned to the device's ethernet port.
  • dns:
    • DNS address to use by the device.
  • tcp_serial:
    • TCP port for incoming connections. This port can be used for ground station applications like Mission Planner, APM Planners, ...

Section [rtsp] - Real Time Streaming Protocol

RTSP server is only available on WiDV Professional version.

  • port:
    • TCP port where the RTSP daemon will listen for incoming connections. Default port is 8080.
  • max_clients:
    • Maximum number of RTSP clients that the receiver will allow to connect simultaneously.

Section [josytick]

Joysticks are only supported on WiDV Professional version.

  • enable:
    • Set to 1 to enable the transmitter to send Mavlink radio control and hearbeat messages using the transmitter's serial port. This option only has effect on the transmitter. The receiver detects joysticks automatically. Ensure that the baudrate from the serial section matches the serial's port baudrate of your flight controller. APM and Pixhawk use 57600 baud as detault on the telemetry port.

Section [video_ip]

Video over IP is only supported on WiDV Professional version.

  • enable:
    • Set to 1 to enable video over IP. This is used by the 4G LTE usb dongle, more information available here.
  • passphrase:
    • Secret passphrase to use when video over IP is enabled.
  • device:
    • Valid options are usb and ethernet. Set to usb when the device is using the 4G LTE USB dongle. Set to ethernet when the device is using its Ethernet port for video over IP. When using the ethernet option is mandatory to enable the [ethernet] section as shown above.


Any question regarding any of these settings, do not hesitate to contact us.


Note: The list of supported options might increase as new firmware releases are available.