Difference between revisions of "WorkMan HVS - IP Protocol"
From WorkManSoft Wiki
Jump to navigationJump to search| Line 125: | Line 125: | ||
{| class="wikitable" {{table }} | {| class="wikitable" {{table }} | ||
| − | | style="background-color:#ffffcc;" |'''Command'''|| | + | | style="background-color:#ffffcc;" |'''Command'''||CALLCHARGE |
|- | |- | ||
| style="background-color:#ffffcc;" | '''Protocolversion'''||1 | | style="background-color:#ffffcc;" | '''Protocolversion'''||1 | ||
| Line 131: | Line 131: | ||
| style="background-color:#ffffcc;" | '''Direction'''||HVS to HS | | style="background-color:#ffffcc;" | '''Direction'''||HVS to HS | ||
|- | |- | ||
| − | | style="background-color:#ffffcc;" | '''Mandatory'''|| | + | | style="background-color:#ffffcc;" | '''Mandatory'''||Yes, HS should be able to handle this. |
|- | |- | ||
| − | | style="background-color:#ffffcc;" | '''Structure'''|| | + | | style="background-color:#ffffcc;" | '''Structure'''||CALL;<roomid>;<callednumber>;<talked time in seconds>;<amount> |
|- | |- | ||
| − | | style="background-color:#ffffcc;" | '''Response'''||OK; | + | | style="background-color:#ffffcc;" | '''Response'''||OK;CALLCHARGE |
|- | |- | ||
| − | | style="background-color:#ffffcc;" | '''Example sender'''|| | + | | style="background-color:#ffffcc;" | '''Example sender'''||CALLCHARGE;123;0046708656820;35;0 |
|- | |- | ||
| − | | style="background-color:#ffffcc;" | '''Example response'''||OK; | + | | style="background-color:#ffffcc;" | '''Example response'''||OK;CALLCHARGE |
|- | |- | ||
| − | | style="background-color:#ffffcc;" | '''About'''||Sends | + | | style="background-color:#ffffcc;" | '''About'''||Sends a callcharge to HS. Note that amount is included in the protocol but the current version of HVS (as of 31st of august 2012) doesn't send an actual amount but only sends 0 as amount. Note that the amount is also in a 100th fraction of the currency e.g. 1100 in amount is 11 SEK (or EUR or whatever currency that the system uses). |
|} | |} | ||
| − | |||
[[Category:WorkMan HVS]] | [[Category:WorkMan HVS]] | ||
Revision as of 16:11, 31 August 2012
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 | CALLCHARGE |
| Protocolversion | 1 |
| Direction | HVS to HS |
| Mandatory | Yes, HS should be able to handle this. |
| Structure | CALL;<roomid>;<callednumber>;<talked time in seconds>;<amount> |
| Response | OK;CALLCHARGE |
| Example sender | CALLCHARGE;123;0046708656820;35;0 |
| Example response | OK;CALLCHARGE |
| About | Sends a callcharge to HS. Note that amount is included in the protocol but the current version of HVS (as of 31st of august 2012) doesn't send an actual amount but only sends 0 as amount. Note that the amount is also in a 100th fraction of the currency e.g. 1100 in amount is 11 SEK (or EUR or whatever currency that the system uses). |
