Support Remote Commands via MQTT
Please note that this feature can be accessible by amusement vendor admin. Only roles with both Room Management and Remote Command permissions can use this feature.
To conduct remote commands, you can log in to your vendor portal account and click on Location Management -> “Edit” button of a location -> “Rooms” tab -> “Search Room” -> “View” button of a room. In this Room View page, you can click on the “Remote Command” tab. In that “Actions” drop-down menu, you can see a list of commands that you can select to issue remotely, such as Reboot Reader/Kiosk/Modem, Start Machine, etc. Then you can follow the steps below to issue a remote command.
Click the drop-down list of “Action” then the remote commands will be revealed. Click to select the action you’d like to perform.
To cycle the power to the machine you’d like, the Remote Power Cycle command requires a Remote Power Cycle Module (RPC-M) paired to it. If the machine is paired with the RPC-M, you will see a two-socket icon displayed aside of it in the Room View. This feature is provided with an associated cost per use. The Reboot Modem command applies to KioSoft modem only.
In the Comments field, you can leave a note which will be displayed on the Activity Detail page of Activity Audit Log. This field is not mandatory.
Click the Date/Time picker of the field “Issue Command Time” (local server time) to schedule the remote command. Pick a date on the calendar then choose a specific time on the following page. You can schedule a remote command to a maximum of one month later. Or you can click the “Today” button to issue the command immediately after all steps are completed.
If you select Today to issue an immediate remote command, you’ll need to finish the remaining steps within 1 minute, otherwise it will fail and prompt the message “Issue Command Time cannot be earlier than the current time.”
Then you can use the search bar (entering the machine #, SN or machine ID/name) or browse through the list to select the device(s) to issue the command. Then click on the “Submit” button.
Offline devices are not selectable. If a reader’s offline status is caused due to failure to connect to MQTT, reconnection action will be performed during the next daily reboot or manual power cycle. And if a modem is rebooting, all its connected readers will also turn into offline status in about 2 minutes and in about 5 minutes after the modem reboots, the readers will be online and available for remote command.
After all parameters are set, click “Submit” to issue the remote command. You need to click the Search button again to obtain the updated command status. You may experience the following scenarios after the remote command is submitted.
Scenario 1: If it’s a scheduled task in future time, you will see it listed with Command Status being “Wait To Process” and a Cancel button in red. When there is a time conflict between the reader and the paired router, a prompt message will be displayed to the user for reminder. The cancellation action will impact both devices.
Scenario 2: When the command is not successfully executed, a Retry option will be displayed in the list. It’s an immediate action upon click.
Scenario 3: If a device is busy, the remote command won’t be executed so as not to interfere with the ongoing operations. It will also indicate the busy status in the record list.
Scenario 4: When the command is issued and no response is received, its Command Status will be displayed as Wait to Process (otherwise it will be Processing). For Remote Power Cycle, after 10 mins with no result returned, its status will be marked as failed, and for the other commands, it is after 5 minutes with no result returned when the status will be marked as failed.
Scenario 5: For Remote Power Cycle command, you may need to wait for 10 minutes or so to get the final status of the command. If the command status displays successful, it means the command is successfully received by the reader. You can go to Activity Audit Log to view the execution result of this command.