> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/displays/displays_command_functionality.md). # Command Functionality Configure a set of commands for users to select and send via the CMS, schedule from the CMS or include in Layouts. Create commands to apply for all Players or create command strings per Players, particularly useful if your have a mixed network. Commands provide easy access to functionality for RS232 and Android Intents. ## Creating Commands Commands should have the following structure: * Code * Command string * Validation string * Create Alert On string (never, always, success, error) ### Parameters Command strings can have parameters separated by the | pipe character, e.g. mute|1. Where this is the case the command string should be separated by | and the first element be used to determine the type of command to run. ### Helpers Command Helpers are prefixes that can be added to the Command String in order to take a more advanced action. Commands without a prefix are executed in the shell of the operating system which runs the Player. `cmd.exe` on Windows and `shell` on Android. ### Validation The **Validation String** is used as a comparison to the **Command** output and if it matches then the Command is considered a success. The Validation String must be an exact match. ## Supported Commands | Command | Command String | Parameters | | ---------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Show status window | showStatusWindow | Timeout in seconds (int) default 60 | | Send status | status | | | RS232 | rs232 |

1. Connection
2. Command
See RS232 section below for further details

| | Android Intent | intent | See Android Intent section below for further details | | Ping | ping | | | Set Timezone | timezone | 1. IANA timezone ID | | Set Auto Time | time\_auto | | | Set Ntp | time\_ntp | | | Set Auto Timzeone | timezone\_auto | | | Philips control | tpv |

1. Operation
screenon
screenoff
backlighton
backlightoff
mute
unmute

| | Philips LED control | tpv\_led |

1. Colour
off
red
white
green
blue
on

| | Sony Screen Control | sony |

1. screenOff
2. screenOn

| | Mute | mute |


1. Operation
1 = on
0 = off

| | Screen On | screenOn | | | Screen Off | screenOff | | | Screen Input Source | screenInputSource |

1. Source
hdmi1

| | Reboot | reboot | | | Refresh | refresh | | | Resize | resize |

1. Percentage
2. Quadrant
top-left
top-right
bottom-left
bottom-right

| | Orientation | orientation |

1. Rotation degrees
(0, 90, 180, 270)

| | Licence Check | licenceCheck | | | Current Geo Location | currentGeoLocation | | | Make a HTTP request | http |

1. URL
2. Content Type
3. Details (JSON)
method
body

| | Configure Wifi | wifi |

1. ssid
2. path
3. identity
4. password
5. domain
6. saveRoot (true/false, default: false)
7. rootCaFileName
8. rootCaAlgo (default: pkcs12)

| | Restart Wifi if disconnected | restartWifiIfDisconnected | | | Generic Command | Any unmatched code | | | Power off | poweroff | | | Panel off | displayoff | | | Panel on | displayon | | | Set picture property | picture\_property | picture value | {% hint style="warning" %} Not all player platforms support all types of command. {% endhint %} {% hint style="success" %} webOS and Tizen have a set of additional commands which if are used as Scheduled commands there is no requirement to set for the display profile. {% endhint %} See the Device Compatibility sheet for full information: [Device Compatibility](https://docs.google.com/spreadsheets/d/e/2PACX-1vRMlLA1A40YBipC4Vx8bEjoQflGNy0AKtXa2Uc7e2UlZGnTvN5Mut7aTfbU9-6uAPvoZI3cbAc3Xdsm/pubhtml) ### HTTP HTTP commands allow triggering or interacting with web based endpoints by defining pre-set commands to make HTTP calls to external services (such as a queue management counter or a sensor) to trigger Layout changes, durations of widgets or activate conditional content in real time. Commands can be triggered on demand via XMR, scheduled at specific dates/times or tied to an interactive touch or click action on a Layout. ### RS232 Commercial displays often have a serial interface for turning the monitor panel on and off. Xibo can use the RS232 Command helper to send these Commands by using the `rs232` prefix in the Command String. The format of the command is `rs232||`. The connection string should be provided in the following format on Windows: ``` ,,,,,, ``` **Please note:** If you need to send your Command in HEX format, you should specify the byte string in the Command String, for example: `7E 00 00 FF 00 00 00 00 00 00 00 00 00 00 00 00 00 FF` , this will be converted to a byte stream by the player. You will need to set the `HexSupport` element of the connection string to `1`. The connection string should be provided in the following format on Android: ``` ,,,,, ``` Each setting is represented by a corresponding number: ``` DATA_BITS_5 = 5; DATA_BITS_6 = 6; DATA_BITS_7 = 7; DATA_BITS_8 = 8; PARITY_NONE = 0; PARITY_ODD = 1; PARITY_EVEN = 2; PARITY_MARK = 3; PARITY_SPACE = 4; STOP_BITS_1 = 1; STOP_BITS_15 = 3; STOP_BITS_2 = 2; FLOW_CONTROL_OFF = 0; FLOW_CONTROL_RTS_CTS = 1; FLOW_CONTROL_DSR_DTR = 2; FLOW_CONTROL_XON_XOFF = 3; ``` The Command itself is a string which gets sent over RS232 using the connection details. ### Android Intent Android Display Profiles can use the `intent` helper to specify an intent that should be called when the Command executes. The format of the Command is `intent|||[]` . `[]` is an optional parameter available from **Android v2 R206** used to provide additional data to the Intent. This must be a JSON formatted string containing an array with at least one object. The object format is below and must be on one line. ```json { "name": "", "type": "", "value": } ``` For example, on some devices you can program the firmware to set on/off times. ``` [{ "name": "timeon", "type": "intArray", "value": [2018, 7, 28, 8, 40] }, { "name": "timeoff", "type": "intArray", "value": [2018, 7, 28, 21, 40] }] ``` This would be set on the command as: ``` intent|broadcast|activity|[{ "name": "timeon", "type": "intArray", "value": [2018, 7, 28, 8, 40] }, { "name": "timeoff", "type": "intArray", "value": [2018, 7, 28, 21, 40] }] ``` Commands containing an intent helper are only available on devices running the Android operating system. ## Adding Commands to the CMS 1. Go to **Commands** under the **Displays** section of the main CMS menu 2. Click the **Add Command** button 3. Give the Command a **Name** 4. Enter a **Code** (such as the command string) to easily identify 5. Use the Command drop down field and select **Free Text** 6. Enter a **Command String** 7. Click to **Save** ## Send Commands from the CMS 1. Navigate to **Displays** from the main CMS menu 2. Use the row menu for a Display and select **Send Command** 3. Use the drop down menu to select the command to use 4. Click to **Save** ## Schedule Commands from the CMS 1. Navigate to **Schedule** from the main CMS menu 2. Click the **Add Event** button 3. Use the Event Type drop down and select **Command** 4. Select the command to use from the list 5. Click **Next** and set the **Displays** 6. Click **Next** and set timings 7. Click **Finish** if no further actions (such as Repeats) are required Scheduled commands are executed once and only require a **Start** date and time. The Command can be executed up to 10 seconds after the time selected. ## Shell Command Widget Use the **Shell Command Widget** to run external Commands based on the Layouts activity. Shell Commands with a Command as their source act in the same fashion as normal shell commands. The Command is executed when the Widget is shown on the Layout. A Shell Command can also be a Command String with options for all Players provided. This allows Users to add Commands ‘ad-hoc’ for one-time use. ## HDMI-CEC HDMI-CEC is a bus that is implemented on nearly all new large-screen commercial displays that have HDMI connectors. This bus (which is physically connected within normal HDMI cables) supports control signals that can perform power-on, power off, volume adjusts, selection of video source and many of the features that are accessible via the remote control. It can also control most other hardware on the HDMI bus. {% hint style="warning" %} Xibo doesn’t provide a direct interface to HDMI-CEC as there are many different manufacturer specifications, however, it is possible to control HDMI-CEC via a batch file. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.xibosignage.com/displays/displays_command_functionality.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.