SiteManager command-line interface
SiteManager provides a command-line interface for managing displays from a command prompt or terminal. This can be useful when managing displays over SSH connections or other remote connections.
Overview
Almost all console commands produce output in JSON format so that it is relatively easy to parse by machines.
Specifying hosts
Commands that target one or more displays accept the target using [--hosts]{.title-ref} argument, followed by one or more hosts separated by commas. For example, to specify a single host:
sitemanager --hosts 10.77.84.100 --info
To specify multiple hosts, separate the hosts by commas:
sitemanager --hosts "10.77.84.100,10.77.84.101" --info
Note
In the command examples later in the manual this is denoted by [[HOSTS]]{.title-ref}.
Getting and setting values
All commands that read or write the value of a parameter follow the same overall logic:
To get a value
: Specify the parameter name after double dashes: [--\<parameter name>]{.title-ref}. For example:
``` bash
sitemanager --hosts 10.77.84.100 --video.source
```
To set a value
: Specify the parameter name after double dashes followed by its value: [--\<parameter name> \<parameter value>]{.title-ref}. For example:
``` bash
sitemanager --hosts 10.77.84.100 --video.source osd
```
Changes are not saved automatically
Just like modifying parameter values from OSD, any changes made by SiteManager are lost when a display is rebooted unless you save them. Use [--settings.save]{.title-ref} or [--settings.discard]{.title-ref} to save or discard any changes made.
Return values
The following process exit codes are used for SiteManager:
Exit code Description
0 All supplied commands were successfully executed on all specified hosts 1 Catchall for general errors 2 One or more hosts failed 3 One or more hosts were unreachable 4 Parsing error (invalid user input)
More exit codes can be added in future updates.
Scanning displays
To scan displays from the given network and display their basic information, use the [--scan \<subnet>]{.title-ref} command. The subnet is specified in CIDR format. If no subnet is specified, it defaults to 0.0.0.0/0 (search all reachable networks).
sitemanager --scan=<subnet>
Displaying information
To displays static information about a device given its host address, use the [--info]{.title-ref} command.
sitemanager [HOSTS] --info
Device status
Give basic information about a status of a display, use the [--status]{.title-ref} command.
sitemanager [HOSTS] --status
Device information commands
These commands return read-only information about the specified displays and take no value.
| Command | Description |
|---|---|
--status |
Get display status. |
--info |
Get display info. |
--firmware-version |
Get firmware version. |
--syslog |
Get display syslog. |
--temperatures |
Get display temperatures. |
--identify[=<seconds>] |
Identify the display (flash the OSD or a similar visual cue). Optional timeout in seconds, default 5. |
sitemanager [HOSTS] --identify=10
Firmware management
| Command | Description |
|---|---|
--available-updates |
Get updates available for the specified displays. |
--firmware-update <version> |
Update display firmware to the given version. |
--download-firmware <version> |
Download a firmware version to the local cache. |
--import-firmware <file> |
Import a firmware image from a local file into the cache. |
--remove-firmware <version> |
Remove a firmware version from the local cache. |
sitemanager [HOSTS] --firmware-update 2.0.3
Geometry calibration
| Command | Description |
|---|---|
--geometry-calibration |
Perform geometry calibration on the specified displays. |
Power control
| Command | Description |
|---|---|
--power.standby.enabled[=<true\|false>] |
Get or set standby state. |
--power.restart |
Restart the display. |
Applying and discarding settings changes
Just like modifying parameter values from the OSD, any changes you make to settings below are not saved by default and are lost when a display is rebooted. Use these commands to save or discard changes:
| Command | Description |
|---|---|
--settings.save |
Save changed settings. |
--settings.discard |
Discard changed settings. |
--settings.unsaved |
Check for unsaved settings changes. |
Network settings
| Command | Description |
|---|---|
--settings.network |
Get all network settings. |
--settings.network.configuration[=<manual\|dhcp>] |
Get or set network mode. |
--settings.network.address[=<ip>] |
Get or set the IP address. |
--settings.network.netmask[=<netmask>] |
Get or set the netmask. |
--settings.network.dns1[=<ip>] |
Get or set the primary DNS server. |
--settings.network.dns2[=<ip>] |
Get or set the secondary DNS server. |
--settings.network.gateway[=<ip>] |
Get or set the gateway. |
--settings.network.proxy.host[=<host>] |
Get or set the proxy host. |
--settings.network.proxy.port[=<port>] |
Get or set the proxy port. |
--settings.network.proxy.user[=<user>] |
Get or set the proxy username. |
--settings.network.proxy.password[=<password>] |
Get or set the proxy password. |
OSD settings
| Command | Description |
|---|---|
--settings.osd |
Get all OSD settings. |
--settings.osd.timeout[=<seconds>] |
Get or set the OSD timeout, in seconds. |
--settings.osd.allow-touch[=<true\|false>] |
Get or set whether the OSD can be operated by touch. |
Picture settings
| Command | Description |
|---|---|
--settings.picture.brightness[=<0-1>] |
Get or set picture brightness, between 0 and 1. |
Remote control settings
| Command | Description |
|---|---|
--settings.remote-control |
Get all remote control settings. |
--settings.remote-control.enabled[=<true\|false>] |
Get or set whether remote control is enabled. |
--settings.remote-control.port[=<port>] |
Get or set the remote control port. |
SSH settings
| Command | Description |
|---|---|
--settings.ssh.enabled[=<true\|false>] |
Get or set whether SSH is enabled. |
Syslog settings
| Command | Description |
|---|---|
--settings.syslog |
Get all syslog settings. |
--settings.syslog.enabled[=<true\|false>] |
Get or set whether syslog forwarding is enabled. |
--settings.syslog.host[=<host>] |
Get or set the syslog host. |
--settings.syslog.port[=<port>] |
Get or set the syslog port. |
--settings.syslog.protocol[=<udp\|tcp>] |
Get or set the syslog protocol. |
--settings.syslog.min-severity[=<severity>] |
Get or set the minimum syslog severity: debug, info, warning, error or critical. |
TUIO settings
| Command | Description |
|---|---|
--settings.tuio |
Get all TUIO settings. |
--settings.tuio.enabled[=<true\|false>] |
Get or set whether TUIO output is enabled. |
--settings.tuio.host[=<host>] |
Get or set the TUIO host. |
--settings.tuio.port[=<port>] |
Get or set the TUIO port. |
--settings.tuio.packet-size[=<n>] |
Get or set the TUIO packet size. |
--settings.tuio.fingers[=<true\|false>] |
Get or set whether TUIO finger events are enabled. |
--settings.tuio.hands[=<true\|false>] |
Get or set whether TUIO hand events are enabled. |
--settings.tuio.objects[=<true\|false>] |
Get or set whether TUIO marker/object events are enabled. |
Tracker (computer vision) settings
| Command | Description |
|---|---|
--tracker.parameter=<extension>/<parameter>[=<value>] |
Get or set a computer-vision tracker parameter. |
--tracker.schema |
Get the computer-vision parameter schema. |
sitemanager [HOSTS] --tracker.parameter=blobtracker/threshold=0.5
Video settings
| Command | Description |
|---|---|
--video.source[=<osd\|external>] |
Get or set the video source. |
Usage and help
To see all commands that the SiteManager command-line interface supports, run the software without any arguments or with [--help]{.title-ref}.
sitemanager --help