Skip to main content

Configuration Items

Configuration items are managed with the config command. Each item has a key and a value, and sets application or device behavior for commands that do not override it. An item with no stored value uses its default; config delete restores the default.

Config item names​

app.ThumbnailFormat​

  • Scopes: Application
  • Allowed Values: jpg png
  • Default: png
  • Description: Sets the image format for server-generated thumbnails from H.264/H.265 encoder devices. Thumbnails are 320×180 pixels. When the format is changed, existing thumbnail files in the previous format are automatically deleted.

app.McuUpdateReconnectTimeout​

  • Scopes: Application
  • Allowed Values: An integer number of seconds, 10 to 900
  • Default: 150
  • Description: The maximum time to wait for a device's MCU to (re)appear on the A/V network during a firmware updatemcu operation, both after the MCU network is enabled and after the MCU reboots into its bootloader. If the MCU does not reappear within this window, that device's update fails with a message naming this setting. Increase it on networks where MCUs are slow to rejoin after a reboot.

app.McuUpdateTftpRetries​

  • Scopes: Application
  • Allowed Values: An integer, 1 to 10
  • Default: 3
  • Description: The number of TFTP upload attempts made per device during a firmware updatemcu operation. Each retry re-waits for the MCU to reconnect and re-sends the firmware image; after the final failed attempt the MCU is reset.

app.McuUpdateParallelism​

  • Scopes: Application
  • Allowed Values: An integer, 1 to 16
  • Default: 4
  • Description: The maximum number of devices whose MCUs are updated concurrently within a single firmware updatemcu command. Additional devices in the list queue until a slot frees. Set to 1 to update devices strictly one at a time.

mtv.PreserveSourceVideoOnConnect​

  • Scopes: Application, Device
  • Allowed Values: true false
  • Default: false
  • Description: Determines whether the main stream of a TX device is left streaming, or automatically stopped, when routing a MultiView configuration. When set to true, the existing stream will not be stopped, even if it may cause the TX to go over 10Gb of total bandwidth. When set to false, the main stream will be automatically stopped when the MultiView configuration is routed, to ensure that the command will always execute successfully.

dev.DefaultDisplayMode​

  • Scopes: Application, Device
  • Allowed Values: genlock, fastswitch, genlock_scaling, fast_switched_crop, fast_switched_stretch
  • Default: genlock
  • Description: Sets the default display mode used on an RX device when executing connect commands, if no display mode is specified. This setting has no effect on TX devices.

dev.DefaultResolution​

  • Scopes: Application, Device
  • Allowed Values: Any valid resolution in the form of <width>x<height>@fps (e.g. 1920x1080@60)
  • Default: Source Resolution
  • Description: Sets the default resolution for RX devices when executing connect commands, if no display resolution is specified. Does not apply if the display mode is set to genlock, wall, or multiview. This setting has no effect on TX devices.

dev.RGBVideoQuantization​

  • Scopes: Device
  • Allowed Values: standard limited full auto default
  • Default: default
  • Description: Enables the override of a signal's Quantization range and AVI InfoFrame for RGB source signals with DEFAULT quantization specified in the AVI InfoFrame. Applies only to Fast Switch, Genlock Scaling, and Wall display modes. standard and default pass through the signal as originally specified by the source. limited and full will override both the quantization range of the signal and the value in the AVI InfoFrame of the signal to either LIMITED or FULL, assuming the original signal has an AVI InfoFrame setting of default. auto uses the resolution of the source to automatically set the range to LIMITED or FULL. When set to auto, signals with video (CE) resolutions will be set to LIMITED and signals with PC/Graphics (IT) resolutions will be set to FULL. If a source signal specifies LIMITED or FULL in its AVI InfoFrame, this setting will not have any effect.

dev.YCCVideoQuantization​

  • Scopes: Device
  • Allowed Values: limited full default
  • Default: default
  • Description: Enables the override of a signal's Quantization range and AVI InfoFrame for YCC source signals with DEFAULT quantization specified in the AVI InfoFrame. Applies only to Fast Switch, Genlock Scaling, and Wall display modes. default will pass through the signal as originally specified by the source. limited and full will override both the quantization range of the signal and the value in the AVI InfoFrame of the signal to either LIMITED or FULL, assuming the original signal has an AVI InfoFrame setting of default. If a source signal specifies LIMITED or FULL in its AVI InfoFrame, this setting will not have any effect.

dev.Locked​

  • Scopes: Device
  • Allowed Values: true false
  • Default: false
  • Description: When set to true, the device is locked and protected from any routing or configuration change. While locked, commands that would modify the device, including connect, disconnect, device switch, MultiView routing, USB 2.0 pair/unpair/role changes, preset application, and applying saved settings, are rejected with an error. Locking does not interrupt existing routes; it only prevents new changes. Set to false (or use config delete to restore the default) to unlock. The lock and unlock commands are convenience aliases for setting this item.

dev.Description​

  • Scopes: Device
  • Allowed Values: Any text up to 255 characters
  • Default: EMPTY
  • Description: A text string description of a device, for reference and display in client applications.

dev.InputSource​

  • Scopes: Device
  • Allowed Values: HDMI DisplayPort Auto
  • Default: Auto
  • Description: Sets the Input Source on Devices that support both HDMI and DisplayPort (DN-200 Series).

dev.DeviceIcon​

  • Scopes: Device
  • Allowed Values: See Device icons
  • Default: EMPTY
  • Description: The device's icon in DisplayNet Manager.

app.BidirectionalRS232​

  • Scopes: Application
  • Allowed Values: true false
  • Default: true
  • Description: When true, an RS-232 route established with connect carries data in both directions.

app.BidirectionalInfrared​

  • Scopes: Application
  • Allowed Values: true false
  • Default: true
  • Description: When true, an infrared route established with connect carries data in both directions.

app.LoginTokenExpireDays​

  • Scopes: Application
  • Allowed Values: An integer number of days
  • Default: 30
  • Description: How long a login token remains valid. Reported to REST clients as expires_days in the login response.

app.AggressiveUsbUnpair​

  • Scopes: Application
  • Allowed Values: true false
  • Default: false
  • Description: When true, a usb2 pairing operation unpairs the target extenders from any existing peers first, rather than failing when a peer is already paired.

app.TempThreshold​

  • Scopes: Application
  • Allowed Values: An integer temperature in degrees Celsius
  • Default: 70
  • Description: The device temperature at which DisplayNet reports a device as over-temperature. dev.TempThreshold overrides it for one device.

dev.TempThreshold​

  • Scopes: Device
  • Allowed Values: An integer temperature in degrees Celsius
  • Default: the app.TempThreshold value
  • Description: The over-temperature threshold for a single device.

dev.DeviceIconColor​

  • Scopes: Device
  • Allowed Values: A CSS hex color, e.g. #ff0000
  • Default: EMPTY
  • Description: The colour DisplayNet Manager draws the device icon in.

user.EulaAccepted​

  • Scopes: User
  • Allowed Values: true false
  • Default: false
  • Description: Whether the user has accepted the EULA. DisplayNet Manager shows the EULA at login until it is true.

hostname​

  • Scopes: Server
  • Allowed Values: any valid computer name, less than 15 characters long
  • Default: displaynet
  • Description: Setting this value immediately changes the hostname of the server. Accessibility to the server using the new hostname is dependent on the network environment.

avnetwork_address​

  • Scopes: Server
  • Allowed Values: dhcp link local <address>/<mask> (e.g. 192.168.2.181/24, mask in CIDR)
  • Default: dhcp
  • Description: The network address of the A/V network interface on the server.

controlnetwork_address​

  • Scopes: Server
  • Allowed Values: dhcp link local <address>/<mask> (e.g. 192.168.2.181/24, mask in CIDR)
  • Default: dhcp
  • Description: The network address of the control network interface on the server.

server_properties​

  • Scopes: Server
  • Allowed Values: read-only
  • Description: This read-only setting returns a server properties object detailing several server details (See Server Properties below).

authentication_required​

  • Scopes: Server
  • Allowed Values: true false
  • Default: false
  • Description: When set to true, all clients must log in before any API operations are available. When false, sessions start automatically logged in as the built-in DisplayNet user. See Authentication.

enforce_https​

  • Scopes: Server
  • Allowed Values: true false
  • Default: false
  • Description: When set to true, http (port 80) connections will be redirected to https (port 443). Additionally, the non-secure websocket port (7000) will be disabled. The secure Websocket port (7010) is always enabled.

enforce_ssh​

  • Scopes: Server
  • Allowed Values: true false
  • Default: false
  • Description: When set to true the telnet ports for DisplayNet and SDVoE API access (6970/6980) are disabled. The SSH port (22) is always enabled.

backlight​

  • Scopes: Server
  • Allowed Values: An integer, 0 to 100
  • Default: 100
  • Description: Brightness of the server's front panel display, as a percentage. Has no effect on a server without a front panel; server_properties.HasFrontPanelDisplay reports whether one is fitted.

device_claim_key​

  • Scopes: Server
  • Allowed Values: ValidKey
  • Default: EMPTY
  • Description: When set to a valid value, device claiming is enabled. When changed, all claimed connected devices will be released, and will need to be manually reclaimed with the new key. Changing this setting requires server applypending to restart the Control Server, which disconnects all connected API clients. Readable only by an Admin.

device_claim_key_set​

  • Scopes: Server
  • Allowed Values: read-only
  • Description: Whether a claim key has been stored. Lets a client show claiming state without reading the key itself.

device_claim_enabled​

  • Scopes: Server
  • Allowed Values: read-only
  • Description: Whether claiming is active, meaning a key is set and has been applied. false while a key change is pending.

device_auth_key​

  • Scopes: Server
  • Allowed Values: ValidKey
  • Default: EMPTY
  • Description: The device authentication key used by auth. As with the claim key, a change requires server applypending before devices can be authorized against it. Readable only by an Admin.

device_auth_key_set​

  • Scopes: Server
  • Allowed Values: read-only
  • Description: Whether an authentication key has been stored.

device_auth_enabled​

  • Scopes: Server
  • Allowed Values: read-only
  • Description: Whether device authentication is active, meaning a key is set and has been applied. false while a key change is pending.

Device icons​

DisplayNet Manager uses these values:

  • Receivers:
    • MONITOR_DARK
    • MONITOR_LIGHT
    • PROJECTOR
    • PROJECTOR_ANGLED
  • Transmitters:
    • SET_TOP
    • ALL_IN_ONE
    • AV_RECEIVER
    • BLURAY_PLAYER
    • CONFERENCE_CAM
    • DESKTOP
    • DVD_PLAYER
    • LAPTOP_DARK
    • LAPTOP_LIGHT
    • MINI_PC

Server properties object​

server_properties is read-only, and its value is a JSON object rather than a single setting:

{
  "Hostname": "displaynet",
  "PendingReboot": false,
  "NetworkInterfaces": [
    {
      "Alias": "controlnetwork",
      "InterfaceName": "eth0",
      "Address": "192.168.190.64",
      "Mask": "255.255.255.0",
      "Gateway": "192.168.190.1",
      "Active": true
    },
    {
      "Alias": "avnetwork",
      "InterfaceName": "eth1",
      "Address": "192.168.2.243",
      "Mask": "255.255.255.0",
      "Gateway": null,
      "Active": true
    }
  ],
  "TotalMemory": 8062.9375,
  "FreeMemory": 6999.796875,
  "UsedMemory": 1063.140625,
  "MemoryUsage": 0.13,
  "CPUUsage": 2.0,
  "CPUTemperature": 47.0,
  "Uptime": "up 1 week, 3 days, 19 hours, 41 minutes",
  "HasFrontPanelDisplay": true
}