Parameter Syntax

Parameter Syntax

DISPLAX Service – Parameter Syntax

Overview

When using DISPLAX Service from the command line, the same syntax is used to view a parameter’s current value or change that parameter. This unified syntax makes it easy to manage device settings locally or remotely in a consistent way.


General Command Syntax

To read or modify a parameter, use the following format:

displaxservice -a IP_ADDRESS --PARAMETER

Parameter Definitions

IP_ADDRESS

The IP address of the computer connected to the touch device you want to control.

  • Use 127.0.0.1 to control devices connected to the local computer

  • Use a valid local network IP address to control devices connected to a remote computer

Examples:

  • Localhost: 127.0.0.1

  • Remote host: 192.168.1.50


PARAMETER

The specific setting or option you want to:

  • View (check its current value), or

  • Modify (change its value)

The same parameter name is used for both actions.


Example Usage

View a Parameter Value

displaxservice -a 127.0.0.1 --example-parameter

This command returns the current value of the parameter.


Change a Parameter Value

displaxservice -a 127.0.0.1 --example-parameter value
or
displaxservice -a 127.0.0.1 --shield 1

This command updates the parameter value on the selected device.


Getting the List of Available Parameters

Before changing any settings, it is recommended to retrieve the list of supported parameters for a specific device. This ensures compatibility and prevents incorrect commands.

Refer to the DISPLAX Service help command to display all available parameters and their descriptions.


Best Practices

  • Always verify the target IP address before running commands.

  • Use localhost (127.0.0.1) when working on the same machine.

  • Check parameter availability before attempting to modify values.

  • Document parameter changes for troubleshooting and rollback purposes.


    • Related Articles

    • Parameters that can be used

      DISPLAX Service – Available Device Parameters Overview DISPLAX Service allows you to retrieve a complete list of available parameters and command options supported by a specific connected device. This ensures you only use parameters that are valid ...
    • Allow Network Connections

      DISPLAX Service – Allow Network Connections Overview DISPLAX Service can be configured to accept or block connections from other devices on the network. This setting controls whether remote hosts are allowed to connect to DISPLAX Service for ...
    • What is DISPLAX Service?

      DISPLAX Service Overview DISPLAX Service is a background process (agent/daemon) installed alongside DISPLAX Connect that enables low-level communication with your DISPLAX Touch Controllers. It acts as a command-line interface, allowing advanced ...
    • Connect to a host

      DISPLAX Service – Connect to a Host Overview To view or modify settings on a touch device using DISPLAX Service, you must first connect to the host computer where the device is attached. This applies to both local devices (connected to the same ...
    • Enable or Disable Network Host Discovery

      DISPLAX Service – Enable or Disable Network Host Discovery Overview DISPLAX Service includes a network discovery feature that allows it to find and list other DISPLAX-enabled hosts on the same network. This is commonly used for remote management, ...