Difference between revisions of "Mews"

From HSYCO
Jump to navigation Jump to search
 
(41 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Avigilon Control Center (ACC) 7 is a video management software that can be integrated in HSYCO with a TCP/IP connection.
+
Mews is an Hotel management software that can be integrated in HSYCO with an API connection.
−
The current release of the I/O Server has been tested with the Avigilon Control Center WebEndpoint
+
The current release of the I/O Server has been tested with the Mews Web API
−
 
 
−
{{tip|This driver supports only a single connection with an Avigilon Control Server. If you have multiple Avigilon Control Servers it is mandatory to add more I/O servers to HSYCO, one for each Avigilon Control Server. Every I/O server must use a different IP address and TCP/IP port.}}
 
  
 
[[Category:I/O Server]]
 
[[Category:I/O Server]]
  
 
=== Options ===
 
=== Options ===
−
*'''username''': Username of the AVIGILON ACC 7 client.
+
*'''clienttoken''': Mews client token.
−
*'''password''': Password of the AVIGILON ACC 7 client.
+
*'''accesstocken''': Mews access token.
−
*'''userkey''': User api key [https://support.avigilon.com/s/technology-partners Avigilon developer page].
+
*'''startupevents''': Turn on/off the startup events.
−
*'''usernonce''': User api nonce [https://support.avigilon.com/s/technology-partners Avigilon developer page].
+
*'''useidasdatapoints''': If set to false the resources data points will use the name as identifier instead of the id
−
*'''pollingtime''': Time in milliseconds that hsyco will wait before the next alarm check, leave blank or set it o 0 to use default polling time 300
+
*'''pollingtime''': Time in milliseconds that hsyco will wait before the next api check, leave blank or set it o 0 to use default polling time 10000
−
*'''usessl''': Tells the driver if the webendpoint uses SSL or not, leave blank for true
+
*'''demoenv''': Turn on/off the demo mews environment.
  
 
== Datapoints ==
 
== Datapoints ==
  
 +
=== Basic infos ===
 
{| class="wikitable"
 
{| class="wikitable"
 
!ID
 
!ID
Line 31: Line 30:
 
|R
 
|R
 
|HSYCO cannot create the connection socket
 
|HSYCO cannot create the connection socket
 +
|-
 +
|info.name
 +
|String
 +
|R
 +
|The hotel name
 +
|-
 +
|info.legalenviromentcode
 +
|String
 +
|R
 +
|The hotel legal env code
 +
|-
 +
|info.location.city
 +
|String
 +
|R
 +
|The hotel city
 +
|-
 +
|info.location.postalcode
 +
|String
 +
|R
 +
|The hotel city postal code
 +
|-
 +
|info.location.countrycode
 +
|String
 +
|R
 +
|The hotel country code
 +
|-
 +
|}
 +
 +
{| class="wikitable"
 +
!ID
 +
!Value
 +
!R/W
 +
!Description
 
|-
 
|-
  
−
|rowspan="2" |<alarmName>.alarm
+
=== Customers ===
−
|0
+
|customer.<customerId>.name
 +
|String
 
|R
 
|R
−
|The alarm is off
+
|The name of the user
 
|-
 
|-
−
|1
+
|customer.<customerId>.lastname
 +
|String
 
|R
 
|R
−
|The alarm is on
+
|The lastname of the user
 
|-
 
|-
−
|<alarmName>.state
+
|customer.<customerId>.reservation
−
|active, autoacknowledged, acknowledged
+
|Json
 
|R
 
|R
−
|get an alarm state
+
|This datapoint contains all the reservation for given customerId, if no reservation is present an empty Json array will be given.
 +
|-
 +
 
 +
|}
 +
 
 +
=== Services ===
 +
{| class="wikitable"
 +
!ID
 +
!Value
 +
!R/W
 +
!Description
 +
|-
 +
 
 +
|service.<serviceId>.id
 +
|String
 +
|R
 +
|The service id
 +
|-
 +
|service.<serviceId>.name
 +
|String
 +
|R
 +
|The service name
 +
|-
 +
|rowspan="2" |service.<serviceId>.isactive
 +
|true
 +
|R
 +
|The service is active
 +
|-
 +
|false
 +
|R
 +
|The service is NOT active
 +
|-
 +
|}
 +
 
 +
=== Departments ===
 +
{| class="wikitable"
 +
!ID
 +
!Value
 +
!R/W
 +
!Description
 +
|-
 +
 
 +
|department.<departmentId>.id
 +
|String
 +
|R
 +
|The department id
 +
|-
 +
|department.<departmentId>.name
 +
|String
 +
|R
 +
|The department name
 +
|-
 +
|rowspan="2" |department.<departmentId>.isactive
 +
|true
 +
|R
 +
|The department is active
 +
|-
 +
|false
 +
|R
 +
|The department is NOT active
 +
|-
 +
 
 +
|}
 +
 
 +
=== Resources ===
 +
{| class="wikitable"
 +
!ID
 +
!Value
 +
!R/W
 +
!Description
 +
|-
 +
 
 +
|resource.<resourceId>.id
 +
|String
 +
|R
 +
|The resource id
 +
|-
 +
|resource.<resourceId>.name
 +
|String
 +
|R
 +
|The resource name
 +
|-
 +
|rowspan="2" |resource.<resourceId>.isactive
 +
|true
 +
|R
 +
|the resource is active
 +
|-
 +
|false
 +
|R
 +
|the resource is NOT active
 +
|-
 +
|rowspan="5" |resource.<resourceId>.state
 +
|Dirty
 +
|R
 +
|The resource is dirty
 +
|-
 +
|Clean
 +
|R
 +
|The resource is clean
 +
|-
 +
|Inspected
 +
|R
 +
|The resource is inspected
 +
|-
 +
|OutOfService
 +
|R
 +
|The resource is Out Of Service
 +
|-
 +
|OutOfOrder
 +
|R
 +
|The resource is Out Of Order
 +
|-
 +
|rowspan="2" |resource.<resourceId>.checkedin
 +
|true
 +
|R
 +
|The resource owner is currently in checked-in in that specific resource
 +
|-
 +
|false
 +
|R
 +
|The resource owner is NOT currently in checked-in in that specific resource
 +
|-
 +
|resource.<resourceId>.checkedinby
 +
|String
 +
|R
 +
|If the checkedin is true, this datapoints shows the owner name and lastname
 +
|-
 +
|resource.<resourceId>.checkedinbyid
 +
|String
 +
|R
 +
|If the checkedin is true, this datapoints shows the owner id
 +
|-
 +
|rowspan="2" |resource.<resourceId>.reserved.today
 +
|true
 +
|R
 +
|The resource is reserved for the current day
 +
|-
 +
|false
 +
|R
 +
|The resource is NOT reserved for the current day
 +
|-
 +
|rowspan="2" |resource.<resourceId>.reserved.tomorrow
 +
|true
 +
|R
 +
|The resource is reserved for the next day
 +
|-
 +
|false
 +
|R
 +
|The resource is NOT reserved for the next day
 +
|-
 +
|resource.<resourceId>.children
 +
|Array
 +
|R
 +
|This datapoint contains all the childrens for given resourceId if the room is a family room.
 +
|-
 +
|}
 +
 
 +
=== Tasks ===
 +
{| class="wikitable"
 +
!ID
 +
!Value
 +
!R/W
 +
!Description
 +
|-
 +
|task.new
 +
|Json
 +
|W
 +
|Json that contains data for creating a new task (Read example below)
 
|-
 
|-
 
|}
 
|}
  
−
== Example ==
+
== New Task Example ==
  
−
In this example HSYCO is using the following format to turn on a light when the alarm goes off:
+
In this example HSYCO is using the following format to create a new task:
  
−
  io avigilonapi.newalarm.alarm = 1 : io dummy.light.1 = 1
+
  INIT : {
−
Where "avigilonapi" is the name of the driver given in HSYCO
+
    var obj = new Object();
−
and "newalarm" is the name of the alarm given in ACC
+
    obj.Name = "Clean room 101";
 +
    obj.Description = "Start cleaning the room 101 asap";
 +
    obj.DeadlineUtc = "2023-02-06T18:00:00Z";
 +
    obj.DepartmentId = "915fbb82-de35-48a0-9e9b-f4a7eac711bb";
 +
    var jsonString = JSON.stringify(obj);
 +
    ioSet("mews.task.new", jsonString);
 +
}
 +
Where "DepartmentId" is the id of the department with the task is assignd to, you can get this id reading the "mews.department" datapoints in HSYCO
 +
and "mews." is the name of the mews I/O Server in HSYCO
  
 
== Release Notes ==
 
== Release Notes ==

Latest revision as of 15:55, 26 July 2023

Mews is an Hotel management software that can be integrated in HSYCO with an API connection. The current release of the I/O Server has been tested with the Mews Web API

Options

  • clienttoken: Mews client token.
  • accesstocken: Mews access token.
  • startupevents: Turn on/off the startup events.
  • useidasdatapoints: If set to false the resources data points will use the name as identifier instead of the id
  • pollingtime: Time in milliseconds that hsyco will wait before the next api check, leave blank or set it o 0 to use default polling time 10000
  • demoenv: Turn on/off the demo mews environment.

Datapoints

Basic infos

ID Value R/W Description
connection online R HSYCO connection socket is open
offline R HSYCO cannot create the connection socket
info.name String R The hotel name
info.legalenviromentcode String R The hotel legal env code
info.location.city String R The hotel city
info.location.postalcode String R The hotel city postal code
info.location.countrycode String R The hotel country code

Customers

ID Value R/W Description
customer.<customerId>.name String R The name of the user
customer.<customerId>.lastname String R The lastname of the user
customer.<customerId>.reservation Json R This datapoint contains all the reservation for given customerId, if no reservation is present an empty Json array will be given.

Services

ID Value R/W Description
service.<serviceId>.id String R The service id
service.<serviceId>.name String R The service name
service.<serviceId>.isactive true R The service is active
false R The service is NOT active

Departments

ID Value R/W Description
department.<departmentId>.id String R The department id
department.<departmentId>.name String R The department name
department.<departmentId>.isactive true R The department is active
false R The department is NOT active

Resources

ID Value R/W Description
resource.<resourceId>.id String R The resource id
resource.<resourceId>.name String R The resource name
resource.<resourceId>.isactive true R the resource is active
false R the resource is NOT active
resource.<resourceId>.state Dirty R The resource is dirty
Clean R The resource is clean
Inspected R The resource is inspected
OutOfService R The resource is Out Of Service
OutOfOrder R The resource is Out Of Order
resource.<resourceId>.checkedin true R The resource owner is currently in checked-in in that specific resource
false R The resource owner is NOT currently in checked-in in that specific resource
resource.<resourceId>.checkedinby String R If the checkedin is true, this datapoints shows the owner name and lastname
resource.<resourceId>.checkedinbyid String R If the checkedin is true, this datapoints shows the owner id
resource.<resourceId>.reserved.today true R The resource is reserved for the current day
false R The resource is NOT reserved for the current day
resource.<resourceId>.reserved.tomorrow true R The resource is reserved for the next day
false R The resource is NOT reserved for the next day
resource.<resourceId>.children Array R This datapoint contains all the childrens for given resourceId if the room is a family room.

Tasks

ID Value R/W Description
task.new Json W Json that contains data for creating a new task (Read example below)

New Task Example

In this example HSYCO is using the following format to create a new task: 

INIT : {
    var obj = new Object();
    obj.Name = "Clean room 101";
    obj.Description = "Start cleaning the room 101 asap";
    obj.DeadlineUtc = "2023-02-06T18:00:00Z";
    obj.DepartmentId = "915fbb82-de35-48a0-9e9b-f4a7eac711bb";
    var jsonString = JSON.stringify(obj);
    ioSet("mews.task.new", jsonString);
}

Where "DepartmentId" is the id of the department with the task is assignd to, you can get this id reading the "mews.department" datapoints in HSYCO and "mews." is the name of the mews I/O Server in HSYCO

Release Notes

3.8.0

  • initial release


Mews is a registered trademark of Mews Systems

Retrieved from "https://wiki.hsyco.com/3.8/index.php?title=Mews&oldid=11005"