WorkMan HVS - IP Protocol
Contents
About
This protocol is our own protocol and can be used if no other protocol is in place.
The protocol works over TCP/IP and is linebased with CR+LF (#13#10) as a end of command terminator. WorkMan HVS can work both as a client and as a server so it's up to the hotelsystem to decide which way they prefer.
HS = Hotel System HVS = Our system (Hotel Växel System)
Commands
The first parameter is always the name of the command and the response to it always follows the form OK;<name of command> where OK is considered the command. The server/client should only send one command at a time and then wait for a response. If an answer hasn't been received within 10 seconds the connection should be considered down and a reconnect should be made.
Example:
HVS sends a welcome to a HS client that is connecting
WELCOME;1
The HS-client responds
OK;WELCOME
List over commands
Welcome
| Command | WELCOME |
| Protocolversion | 1 |
| Direction | Server to client |
| Mandatory | Yes |
| Structure | WELCOME;<protocolversion> |
| Response | OK;WELCOME |
| Example sender | WELCOME;1 |
| Example response | OK;WELCOME |
| About | Sends a welcome from the server to connecting client. |
Keep-alive
| Command | ALIVE |
| Protocolversion | 1 |
| Direction | HVS to HS |
| Mandatory | No, only HVS in clientmode sends this. |
| Structure | ALIVE |
| Response | OK;ALIVE |
| Example sender | ALIVE |
| Example response | OK;ALIVE |
| About | Sends an ALIVE-signal to the server to see that connection is up. |
Check In
| Command | CHECKIN |
| Protocolversion | 1 |
| Direction | HS to HVS |
| Mandatory | No, but then all room must be manually checked in. |
| Structure | CHECKIN;<roomid>;????????????????? |
| Response | OK;CHECKIN |
| Example sender | CHECKIN;123 |
| Example response | OK;CHECKIN |
| About |
Check out
TBA
Extension lock/unlock
TBA
Room status
| Command | ROOMSTATUS |
| Protocolversion | 1 |
| Direction | HVS to HS |
| Mandatory | Yes, HS should be able to handle the message and send OK back. |
| Structure | ROOMSTATUS;<roomid>;<roomstatuscode> |
| Response | OK;ROOMSTATUS |
| Example sender | ROOMSTATUS;123;1 |
| Example response | OK;ROOMSTATUS |
| About | Sends information about what condition the room is in. |
Call charge
| Command | ALIVE |
| Protocolversion | 1 |
| Direction | HVS to HS |
| Mandatory | No, only HVS in clientmode sends this. |
| Structure | ALIVE |
| Response | OK;ALIVE |
| Example sender | ALIVE |
| Example response | OK;ALIVE |
| About | Sends an ALIVE-signal to the server to see that connection is up. |
