ATEN VK430 Room Booking System User Guide
- September 3, 2024
- Aten
Table of Contents
ATEN VK430 Room Booking System
Product Specifications
- Protocol: TCP
- Supported Commands: CLI commands
Product Usage Instructions
Sending a Command
Follow the steps below to establish a TCP connection to the RBS panel and
send commands using PuTTY as an example:
- In PuTTY, specify the following:
- Host Name: Specify IP address of the RBS panel
- Port: 6262
- Connection type: Click Other and select Raw
- Click Open to establish a connection.
- Type the desired command in the command-line interface to execute commands or monitor the RBS panel.
- To monitor the RBS panel using the echo command, type “echo on” in the command-line interface.
Supported Commands
The product supports the following commands:
- Book: To reserve a room on the specified RBS panel. Refer to the feedback messages for management actions.
- Checkin: To check-in successfully or handle check-in failures.
- Checkout, Release, Extend: Commands for various actions with syntax and parameters.
Echo Command
To notify the controller of the management actions carried out via the RBS
panel.
FAQ
-
What do I do if the system is busy when trying to book a room?
If booking fails due to the system being busy, please try again later. -
How do I extend a room booking?
Use the command “book d [duration] extend” to extend a room booking by the specified duration.
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 |
-
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
-
Click Open. This window appears and a connection is established.
-
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. -
To monitor the RBS panel by using the echo command, do the following.
-
In the command-line interface, type echo on ↙ to allow the RBS panel to send feedback messages to the controller.
Note: Remain on the Port 6262 connection. -
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.
| Check-in failed due to an unknown error. Please contact your system
integrator for troubleshooting.
---|---
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 action
- checkout – execute check-out action
- release – execute release action
- extend – execute extend action w/duration parameter
- duration : 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 panel
- book d 120↙ : book a room in 120min to the RBS panel
- book checkin↙ : execute check-in action to the RBS panel
- book checkout↙ : execute check-out action to the RBS panel
- book release↙ : execute release action to the RBS panel
- book extend↙ : execute extend action to the RBS panel
- book 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
ABOUT COMPANY
- © Copyright 2024 ATEN® International Co., Ltd.
- Released: February 20, 2024
- ATEN and the ATEN logo are registered trademarks of ATEN International Co., Ltd. All rights reserved. All other brand names and trademarks are the registered property of their respective owners.