Scribd
Upload
43 views5 pages

Room Booking System CLI Guide

This guide provides information on using TCP commands to control an ATEN Room Booking System panel. It describes how to establish a TCP connection using PuTTY, the supported commands including echo, help, read, and reboot, and provides examples of using each command. The echo command notifies the controller of management actions on the panel, help displays all supported functions and commands, read looks up the current room status, and reboot restarts the panel. Ports 6262 and 7373 are used for executing commands and monitoring the panel, respectively.

Uploaded by

tech.filnippon
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
43 views5 pages

Room Booking System CLI Guide

This guide provides information on using TCP commands to control an ATEN Room Booking System panel. It describes how to establish a TCP connection using PuTTY, the supported commands including echo, help, read, and reboot, and provides examples of using each command. The echo command notifies the controller of management actions on the panel, help displays all supported functions and commands, read looks up the current room status, and reboot restarts the panel. Ports 6262 and 7373 are used for executing commands and monitoring the panel, respectively.

Uploaded by

tech.filnippon
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

About This Guide

ATEN Room Booking System adopts TCP protocol to supports 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

2
2. Click Open. This window appears and a connection is established.

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 on ↙ to 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
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
Manual room release action = release
Auto room release when the reservation action = auto-release
time is up
Room reservation action = reserve
Reservation extension action = extend

3
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.
Example:
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.

4
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

© Copyright 2023 ATEN® International Co., Ltd.


Released: April 13, 2023 11:43 AM

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.

You might also like