Difference between revisions of "WorkMan HVS - IP Protocol"
From WorkManSoft Wiki
Jump to navigationJump to search (→About) |
|||
| Line 3: | Line 3: | ||
This protocol is our own protocol and can be used if no other protocol is in place. | 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. | + | 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. |
| − | WorkMan HVS can work both as a client and as a server. | ||
HS = Hotel System | HS = Hotel System | ||
HVS = Our system (Hotel Växel 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. | ||
| + | |||
| + | Example: | ||
| + | |||
| + | '''HVS to HS''' WELCOME;1 | ||
| + | '''HS to HVS''' OK;WELCOME | ||
== List over commands == | == List over commands == | ||
Revision as of 13:34, 31 August 2012
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.
Example:
HVS to HS WELCOME;1 HS to HVS OK;WELCOME
List over commands
Welcome
| Command | WELCOME |
| Direction | HVS to HS |
| Mandatory | No, only HVS in servermode sends this. |
| Structure | WELCOME; |
| Response | none |
| Example sender | WELCOME;1 |
| Example response | |
| About | Sends a welcome from the HVS server to connecting client. |
Keep-alive
| Command | ALIVE |
| 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. |
