Preferences File

The preferences file contains data that are read upon opening wfview. The contents are saved upon pressing the Save Settings button under Settings.

These data include settings for the program’s appearance, radio connection, window position, and more. Editing this file is not recommended; do so at your own risk, and only if you need to do so.

With each release of wfview, we do retire and add settings, so you may see some attributes from prior versions, which are ignored.

Don’t forget that you can reset your preferences easily by pressing “Revert to Default” in the Settings window.

Accessing:

The preference file may be accessed as follows:

macOS: Use the defaults command, specifying the org as org.wfview.org

Linux: Read the plain text file from ~/.config/wfview/wfview.conf

Windows: Configuration is stored in the Windows Registry under “HKEY_CURRENT_USER\SOFTWARE\wfview\wfview”. Please be careful when editing the Windows Registry as incorrect usage of the regedit.exe utility can seriously damage your Windows installation. DO NOT change anything outside the registry key above unless you know what you are doing!

Note: You may specify an alternate settings file using the --settings command-line argument. See here for a list of arguments.

Preference File Sections and Attributes:

Each section is as follows (note that the qt library does not allow wfview to determine the exact order these will appear in the file, and thus, they may be re-ordered by the user for clarity):

[Controls]

These options are from options under the Settings tab:

  • EnablePTT: Set to ‘true’ or ‘false’ to enable or disable the PTT controls of wfview. Does not change the radio’s own PTT lock controls.
  • NiceTS: Set to ‘true’ or ‘false’ to enable or disable the frequency rounding that can occur when tuning the frequency or double-clicking in the spectrum.

[Interface]

Most of these options are from checkboxes under the Settings tab:

  • ConfirmPowerOff: Boolean value to disable the “Are you sure you want to power off” dialog box.
  • ConfirmExit: Boolean value to disable the “Are you sure you want to quit?” dialog box
  • StylesheetPath: Set to the path of a custom stylesheet, relative to /usr/share/wfview/stylesheets
  • UseFullScreen: Set to ‘true’ or ‘false’ to enable full screen on startup.
  • UseSystemTheme: Set to ‘true’ or ‘false’ to enable or disable using the system’s theme (versus a stylesheet — included or user-added)
  • splitter: The position of the draggable plot-to-waterfall vertical space splitter. Probably best not to edit this by hand.
  • windowState: The state of the window (position and maximized status)
  • windowGeometry: The location and size of the window. Remove this variable and the one above if you have difficulty seeing the wfview window, this will restore the default.
  • WFAntiAlias: boolean for waterfall anti-alias
  • WFInterpolate: boolean for interpolation between the waterfall data points and the pixels on the screen
  • WFLength: length of waterfall display. Values should be from 160 to 1023.
  • Meter2Type: Selected type of meter for the secondary meter. Integers represent the meter number per the enumerated types in the source code.
  • plotCeiling: value of the “top” slider
  • plotFloor: value of the “bot” slider
  • WFTheme: Selected color scheme theme for the waterfall
  • underlayMode: The selected mode of plot underlay:
    • 0: none
    • 1: Peak Hold
    • 2: Buffered Peaks
    • 3: Average
  • underlayBufferSize: The size of the buffer. Valid numbers are 2 to 128.

 

[Radio]

These options are specific to serial port access:

  • RigCIVuInt: Use this parameter to manually set the CI-V address of the radio, in unsigned integer format. If set, wfview will not broadcast a request for all radios to identify, instead, it will send a rig ID request only to the specified CI-V address. This is useful if you have a radio that does not respond to broadcast queries on the CI-V bus, or, if you have more than one radio on the same physical CI-V bus (very rare in the post-USB-adapter decades). If unset or set to 0, wfview will automatically find any connected radio (regardless of if that radio is a known model) and attempt to control it. The default value is 0, and is recommended for most users.
  • CIVisRadioModel: Boolean value. When set to “true” causes wfview to assume the radio model is the same as the manual set CI-V above. For older radios that do not answer Rig ID queries, supply the default CI-V address above and then set this parameter to true.
  • SerialPortBaud: Use this attribute to specify a custom baud rate, often needed on older radios. The default is 115200, required by the newer radios that provide spectrum data over serial.
  • SerialPortRadio: Use this attribute to specify a custom path to the serial port. This can be used, for example, to specify a pseudo-terminal if you are using socat to forward serial traffic from a remote host. If unset, or set to “auto”, wfview will automatically find directly-connected supported Icom radios on the linux platform. On other platforms, it will attempt to use the first available serial port.
  • localAFgain: Unsigned char (0-255) used to store the user’s local AF gain (volume). Does not change the volume at the radio, just how loud it sounds at the computer.
  • VirtualSerialPort: String path to the virtual pseudo-terminal created for other programs to use as a serial port.

[Server]

These options are for the built-in OEM-compatible server, useful for placing non-ethernet rigs onto a network.

  • ServerEnabled: true/false whether to enable wfview’s internal server which emulates an Icom rig and allows multiple clients to connect. This is still quite experimental
  • ServerControlPort: The UDP port that clients will make an initial connection to.
  • ServerCivPort: The UDP port that the server announces to clients, 50002 is the default.
  • ServerAudioPort: The UDP port that the server announces to clients, 50003 is the default.
  • ServerNumUsers: The number of users currently configured.
  • ServerUsername_x, ServerPassword_x, serverUserType_x: contain the user information.

[LAN]

These options are for configuring the network access to radios that either have built-in network, are connected to a PC running Icom’s software, or are connected to a host running wfview with the above [Server] enabled.

  • EnableLAN: true or false to enable LAN connection to the radio (rather than USB)
  • AudioInput: Name of audio input device, this is best set via the Settings tab as it must be spelled exactly
  • AudioOutput: Name of audio output device, this is best set via the Settings tab as it must be spelled exactly
  • AudioRXCodec: This is the receive codec that is sent to the radio, 0x01 = single channel uLaw, 0x02 = single channel 8bit PCM, 0x04 = single channel 16bit PCM, 0x08 is two channel 8bit PCM, 0x10 is two channel 16bit PCM and 0x20 is two channel uLaw. It is anticipated that other modes, potentially including compression will be added at some point for wfview-wfview communications.
  • AudioTXCodec: This is the receive codec that is sent to the radio, 0x01 = single channel uLaw, 0x02 = single channel 8bit PCM, 0x04 = single channel 16bit PCM. It is anticipated that other modes, potentially including compression will be added at some point for wfview-wfview communications.
  • AudioRXLatency: Use this to specify the number of milliseconds of latency to be allowed in RX.
  • AudioTXLatency: Use this to specify the number of milliseconds of latency to be allowed in TX.
  • AudioRXSampleRate: This is the sample rate to tell the radio to use for RX audio. 48000 is the default but 8000, 16000 and 24000 are also available. Any other rate will likely be rejected by the radio. Smaller sample rates will reduce the required network bandwidth but may reduce quality.
  • AudioTXSampleRate: This is the sample rate to tell the radio to use for TX audio. 48000 is the default but 8000, 16000 and 24000 are also available. Any other rate will likely be rejected by the radio. Smaller sample rates will reduce the required network bandwidth but may reduce quality.
  • ClientName: This will usually be the “name” of your computer but can be replaced with any other name. This cannot be changed from within wfview, so must be changed by manually editing the file/registry entry.
  • ControlLANPort: This is the “control” port that wfview will use to communicate with the radio and defaults to 50001. Any other required ports are configured by the radio.
  • EnableRigCtlD: true or false to enable an emulation of rigctld within wfview. This is highly experimental and currently only supports a small subset of rigctld commands. This is disabled by default and canot be enabled from within the wfview GUI.
  • RigCtlPort: Port that the internal rigctld emulation should listen on. Default is 4533 so as to not conflict with any other rigctld running on the machine.
  • IPAddress: IP Address of the radio
  • Username: Username configured within Network menu of the radio
  • Password: Password configured for the above user in the radio.
  • ResampleQuality: This is a number from 0-10 which determines the quality of wfview’s internal audio resampler, with 0 being the lowest quality. This is only used if a sample rate of anything other than 48000 is used and the default of 4 has been chosen to be middle-of-the-road in terms of quality and speed.
  • WaterfallFormat: The format of the waterfall data to be provided.
    • 0: do nothing
    • 1: serial-port style (multiple segments)
    • 2: LAN style (single segment)
  • tcpServerPort: Port for raw CI-V access over TCP/IP, such as is used by N1MM+. A value of zero disables this feature.

 

[Memory]

This section contains the 99 memories managed by wfview. Don’t bother making a parser for this format, we will change to CSV in future versions.

[Color Presets]

(in progress)

These lines define the color presets a user has entered. The data are read in as strings, and the expected format is #AARRGGBB, where AA is the alpha channel (0xff = opaque, 0x00 = transparent), and RRGGBB is your standard red green blue HTML color. Colors that are fully transparent (AA = 00) will basically hide an element of the interface. PresetName is used for the preset combo box and must be 10 characters or less. Unicode characters should work although this hasn’t been tested. The presetNum attribute is automatically assigned and should not be changed.

Any color that is not read in properly is reverted to the default wfview colors.

You can see more about these colors in this section of the manual.

Example for the first color preset:

ColorPreset\1\axisColor=#ffffffff
ColorPreset\1\gridColor=#ff000000
ColorPreset\1\meterAverage=#ff3fb7cd
ColorPreset\1\meterLevel=#ff0000ff
ColorPreset\1\meterLowText=#ffeff0f1
ColorPreset\1\meterLowerLine=#ffeff0f1
ColorPreset\1\meterPeakLevel=#ffaaffff
ColorPreset\1\meterPeakScale=#ffff0000
ColorPreset\1\passband=#80006fa7
ColorPreset\1\plotBackground=#ff000000
ColorPreset\1\presetName=Dark
ColorPreset\1\presetNum=0
ColorPreset\1\spectrumFill=#00000000
ColorPreset\1\spectrumLine=#ffffff00
ColorPreset\1\textColor=#ffffffff
ColorPreset\1\tuningLine=#ff55ffff
ColorPreset\1\underlayFill=#96465e96
ColorPreset\1\underlayLine=#9633ff55
ColorPreset\1\wfAxis=#ffffffff
ColorPreset\1\wfBackground=#ff000000
ColorPreset\1\wfGrid=#00000000
ColorPreset\1\wfText=#ffffffff