Skip to main content

Generic User commands for Windows devices

Some functions on Windows devices can be reached over the command sending function in the Editor.

Where can you set these commands?​

1.x UI​

These commands are available from the context menu of the device: Manage screen >> Send command

  • A modal will appear where you can type or paste the command and send it to the device.

2.0 UI​

Navigate yourself to Devices menu, select the device where you wish to send user commands.

  • In the details tab, select settings, scroll down until you find the Advanced controls modal.
  • Select Send command
  • Here you will see a box where you have to place the command

Set up KIOSK mode​

info

For more information about Kiosk mode visit the following article: Kiosk mode

Turn off web security​

This user command disables the web security in the browser that the application uses.

{"user_command":"WebSecurity", "command_data":{"enabled":false}}
Please note

Turning off web security is at the user's own discretion. It is highly recommended to exercise caution when doing so.

Flash sensor firmware remotely (deprecated)​

Please note

Flashing M5 sensor function is End of Life command, please do not use!

You can remotely update Wallboard Sensors with this command. The firmware must be available for the device on the provided URL.

{"user_command": "FlashSensor", "command_data": {"url":"URL", "type":"SENSOR_TYPE", "id": "SENSOR_ID", "port":"COM_PORT", "force": false}}

Parameters​

At least one of the optional parameters must be defined

  • url - location of the firmware package
  • type [optional] - type of connected sensor (m5stack, m5stack_plus, m5stack_usb_host, m5stack_plus_usb_host, m5stack_fire, m5stick, m5stick_c, m5stick_c_plus, m5stick_v, atom, atom_qr_code, atom_ble)
  • id [optional] - unique ID of the connected sensor
  • port [optional] - COM port of the connected sensor
  • force - whether to skip sensor and firmware validation during the process

Reset serial device remotely​

You can remotely reset a specific serial device/sensor via RTS signal with this command.

{"user_command": "ResetSensor", "command_data": {"port":"COM_PORT"}}

Parameters​

  • port - COM port of the serial device

You can remotely print to log or change the presistent configuration of the connected sensor with the following commands.

Print configuration to the log

{"user_command": "GetSensorDeviceConfig", "command_data": {"type":"SENSOR_TYPE", "id": "SENSOR_ID", "port":"COM_PORT"}}

Change the sensor configuration

{"user_command": "SetSensorDeviceConfig", "command_data": {"type":"SENSOR_TYPE", "id": "SENSOR_ID", "port":"COM_PORT", "config": "CONFIG_KEY", "value": "CONFIG_VALUE"}}

Parameters​

At least one of the optional parameters must be defined

  • type [optional] - type of connected sensor (m5stack, m5stack_plus, m5stack_usb_host, m5stack_plus_usb_host, m5stack_fire, m5stick, m5stick_c, m5stick_c_plus, m5stick_v, atom, atom_qr_code, atom_ble)
  • id [optional] - unique ID of the connected sensor
  • port [optional] - COM port of the connected sensor
  • config - configuration key (baudRate)
  • value - the value that will be set on the sensor

Example

{"user_command": "SetSensorDeviceConfig", "command_data": {"port":"COM3", "config": "baudRate", "value": 115200}}

Set working hours​

Please note

If you have 1.11 editor server version please refrain from using Working hours feature as a user command.

In 1.11 we created a generic UI for the feature, please refer to that article on how to set it up under the Windows section.

If you have 1.10 editor server version, and wish to use the command, please also refer to the linked article about the prerequsites of the feature.

Example

{
    "user_command": "WorkingHours",
    "command_data": {
        "workingHours": {
            "days": {
                "MON": {
                    "from": "7:55",
                    "to": "15:55"
                },
                "TUE": {
                    "from": "7:55",
                    "to": "15:55"
                },
                "WED": {
                    "from": "7:55",
                    "to": "15:55"
                },
                "THU": {
                    "from": "7:55",
                    "to": "15:55"
                },
                "FRI": {
                    "from": "7:55",
                    "to": "15:55"
                },
                "SAT": {
                    "from": "7:55",
                    "to": "15:55"
                },
                "SUN": {
                    "from": "7:55",
                    "to": "15:55"
                }
            }
        }
    }
}

To disable working hours

{"user_command":"WorkingHours","command_data":{}}}
Last updated on