Difference between revisions of "Mews"

From HSYCO
Jump to navigation Jump to search
Line 146: Line 146:
 
|-
 
|-
  
|department.<departmentId>.id
+
|resource.<resourceId>.id
 
|String
 
|String
 
|R
 
|R
|The department id
+
|The resource id
 
|-
 
|-
|department.<departmentId>.name
+
|resource.<resourceId>.name
 
|String
 
|String
 
|R
 
|R
|The department name  
+
|The resource name  
 
|-
 
|-
|department.<departmentId>.isactive
+
|resource.<resourceId>.isactive
 
|true/false
 
|true/false
 
|R
 
|R
|true if the departmentis active, false if the department is not active  
+
|true if the resource active, false if the resource is not active  
 +
|-
 +
|resource.<resourceId>.state
 +
|Dirty/Clean/Inspected/OutOfService/OutOfOrder
 +
|R
 +
|The resource state
 +
|-
 +
|resource.<resourceId>.checkedin
 +
|true/false
 +
|R
 +
|true if the resource owner is currently in checked-in in that specific resource
 
|-
 
|-
  

Revision as of 16:44, 10 February 2023

Avigilon Control Center (ACC) 7 is a video management software that can be integrated in HSYCO with a TCP/IP connection. The current release of the I/O Server has been tested with the Avigilon Control Center WebEndpoint

Note 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.

Options

  • username: Username of the AVIGILON ACC 7 client.
  • password: Password of the AVIGILON ACC 7 client.
  • userkey: User api key Avigilon developer page.
  • usernonce: User api nonce Avigilon developer page.
  • 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
  • usessl: Tells the driver if the webendpoint uses SSL or not, leave blank for true

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/false R true if the service is active, false if 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/false R true if the departmentis active, false if 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/false R true if the resource active, false if the resource is not active
resource.<resourceId>.state Dirty/Clean/Inspected/OutOfService/OutOfOrder R The resource state
resource.<resourceId>.checkedin true/false R true if the resource owner is currently in checked-in in that specific resource

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