ATEN Room Booking System CLI Guide
Simply Better Connections
About This Guide
ATEN Room Booking System adopts TCP protocol to support CLI commands. Use TCP tools, ATEN controller, or any third-party controller that supports TCP to issue CLI commands. This guide provides information on the supported functions, corresponding CLI commands, and example commands.
Sending a Command
Follow the steps below to establish a TCP connection to the RBS panel and send commands. This procedure uses PuTTY as an example.
| Purpose | Port |
|---|---|
| To execute RBS panel commands | 6262 |
| To monitor RBS panel (echo on) | 7373 |
1. In PuTTY, specify the following:
- Host Name: Specify IP address of the RBS panel to which you wish to connect
- Port: 6262
- Connection type: Click Other and select Raw
A screenshot of the PuTTY Configuration window is displayed, showing fields for Host Name (e.g., 10.3.66.21), Port (e.g., 6262), and Connection type (selected as Other: Raw).
2. Click Open. This window appears and a connection is established.
A screenshot of the PuTTY terminal window shows a successful connection to an IP address (e.g., 10.3.66.50).
3. To execute help, read, or reboot command, type the command in the command-line interface.
To execute an echo command, i.e., to monitor the RBS panel and receive notifications for management actions carried out on the RBS panel, go to the next step. See Supported Commands for full information on commands.
4. To monitor the RBS panel by using the echo command, do the following:
- (a) In the command-line interface, type
echo onto allow the RBS panel to send feedback messages to the controller. Note: Remain on the Port 6262 connection. - (b) In the chosen controller's setup page, use Port 7373 for monitoring.
- Host Name: Specify IP address of the RBS panel to which you wish to connect
- Port: 7373
Supported Commands
Book
Usage
To reserve room on the specified RBS panel. Refer to the table below for the management actions and the corresponding feedback messages.
| Action | Feedback Message |
|---|---|
| book | Book xxx min successfully Book failed due to the system being busy. Please try again later. Book failed due to no available rooms. Book failed due to an unknown error. Please contact your system integrator for troubleshooting. |
| checkin | Check-in successfully Check-in failed due to the system being busy. Please try again later. Check-in failed due to incorrect room status. |
| checkout | Check-out successfully Check-out failed due to the system being busy. Please try again later. Check-out failed due to incorrect room status. Check-out failed due to an unknown error. Please contact your system integrator for troubleshooting. |
| release | Release successfully Release failed due to the system being busy. Please try again later. Release failed due to incorrect room status. Release failed due to an unknown error. Please contact your system integrator for troubleshooting. |
| extend | Extend xxx min successfully Extend failed due to the system being busy. Please try again later. Extend failed due to incorrect room status. Extend failed due to the time has already been occupied. Extend failed due to an unknown error. Please contact your system integrator for troubleshooting. |
Syntax
book d [duration] [control]
Parameter
Duration: The number of minutes for reserving or extending the booking.
control:
- (empty) – book the room for the upcoming 30 minutes or for the specified duration.
checkin– execute check-in actioncheckout– execute check-out actionrelease– execute release actionextend– execute extend action w/duration parameterduration: booking period from 1-120min (default: 30)
Acknowledge
Command OK: Command is correct and the action is executed.
Command incorrect: The action is not executed due to one or more errors in the command.
Examples
book: book a room in 30min to the RBS panelbook d 120: book a room in 120min to the RBS panelbook checkin: execute check-in action to the RBS panelbook checkout: execute check-out action to the RBS panelbook release: execute release action to the RBS panelbook extend: execute extend action to the RBS panelbook d 60 extend: execute extend action in 60min to the RBS panel
Echo
Usage
To notify the controller of the management action carried out via the RBS panel. Refer to the table below for the management actions and the corresponding feedback message.
| Action | Feedback Message |
|---|---|
| Check-in | action = check-in |
| Check-out | action = check-out |
| Release room | action = release |
| Release room when the reservation time is up | action = auto-release |
| Reserve room through quick booking | action = quick booking |
| Reserve room | action = reserve |
| Extend the reservation | action = extend |
Syntax
echo [control]
Parameter
control:
on– Sends action feedback of operations carried out via the RBS panel to the controller.off– (default) Stops sending action feedback of operations carried out via the RBS panel to the controller.
Acknowledge
Command OK: Command is correct and the action is executed.
Command incorrect: The action is not executed due to one or more errors in the command.
Examples
echo on: Set the RBS panel to send action feedback to the controller when an operation is carried out.echo off: Set the RBS panel to not sending action feedback on any operation.
Help
Usage
To display supported functions, the corresponding commands, and detailed information.
Syntax
help
Acknowledge
Command OK: Command is correct and the action is executed.
Command incorrect: The action is not executed due to one or more errors in the command.
Example
help: A list of supported commands is displayed.
Read
Usage
To look up the current room status.
Syntax
read
Acknowledge
Command OK: Command is correct and the action is executed.
Command incorrect: The action is not executed due to one or more errors in the command.
Example
read: Indicate room status (available, reserved or occupied) to the controller.
Reboot
Usage
Reboot the RBS panel.
Syntax
reboot
Acknowledge
Command OK: Command is correct and the action is executed.
Command incorrect: The action is not executed due to one or more errors in the command.
Example
reboot: Reboot the RBS pane.
