Definition lists

MANAGING STATUS

ALiS makes it possible to request the current (or latest depending on hardware) status of segment controllers, lights and groups within the system. This enables implementing software to retrieve the status, light output and such to (for instance) display on a map or list.

NOTIFICATIONS

Notifications are used to show if there are either (important) activities or alerts and a specific message describing the type of notification (for example a lamp failure). Using this request it is possible to act upon these notifications by for instance adding coloured markers to the maps showing the lights or if needed sending alert e-mails or text messages to report problems to the administrators or contractors.

PERIPHERALS

Within the ALiS standard, it is possible to define peripheral devices. These are devices that may be installed on lamp posts for certain purposes such as motion sensors, hydroscopes, etc. Peripherals can be defined, monitored and controlled using the ALiS standard.

LOGS

It is also possible (implementation is vendor specific) to retrieve log data from the different elements (segment controllers, lights, peripherals). This data can be used for making report or running statistical analysis on the system. Examples of log data can be energy consumption, burning hours, temperature, etc.

Log definitions list

A JSON Objects with log items about the specific segment controller. The log elements should contain the same information as available using the request /segmentcontrollers/[:segmentcontrollerid][/:segmentcontrollerid].

See pages 28 , 33 of the specifiction for more information.

List

 

Segmentcontroller

JSON Object

      • String ID (A Unique id for the device. The server will not contain a second device with the same id)

 

      • String Name (Human readable name for segment controller) (PUT)

 

      • String Version (Version of segment controller)

 

      • String Time (Segment Controller Local time)

Note*: Time shows the current time of the segment controller thus the time that is used by the dimming scenarios. Showing this time (and knowing for instance the server time) enables us to detect lag in the astroclock.

Optional

      • String ConnectionMethod (Example: TCP, COM,UDP)

 

      • String ConnectionInfo (Example: 192.168.4.1:30000, 3(as in COM 3), IPv6:port)

 

      • String MACAddress (MAC Address of the device)

 

      • String GPSCoordinates (see GPS Format) (PUT)

 

      • String Power (ON/OFF describes if power is on or off for the cabinet housing the segment controller)

 

      • String PowerTimestamp (time of Power ON/OFF see Timestamp Format)

 

      • String ProductInformation (The Device Type and Device Manufacturer separated by ‘;’)

 

      • String PassThroughPort (The Port to Use to have Passthrough access to the proprietary device)

 

Lights

JSON Object

      • String ID (unique ID for this notification)

 

      • String Name (Alpha Numeric Text, unique for this device) (PUT)

 

      • String TimeStamp (Last update time of the data for this light)

 

      • String State (Can only be “ON” or “OFF” as in are the lights ON or OFF)

 

      • String Override (ON/OFF describes if State and Lightoutput are set manually overriding the dim scenario)

(PUT)

      • Int Lightoutput (see Lightoutput format) (PUT)

 

      • String GPSCoordinates (see GPS format) (PUT)

 

      • Array containing Doubles Current (in mA, using Array to enable multiple values)

 

      • Array containing Doubles Voltage (in Volts, using Array to enable multiple values)

 

      • Array containing Doubles Temperature (in Celsius, using Array to enable multiple values)

 

      • Array containing Integers WorkingHours (number of hours the light has been on using Array to enable multiple values)

 

Peripheral definitions list

List

 

Type StateMin StateMax StateIncrement StateUnit
Temp sensor -50 50 1 Celcius
Motion sensor 0 1 1 Active
Light cell Lumen
Camera 0 1 1 Active
Wind 0 12 1 Bofort
Hydroscoop 0 90 1 Degree

 

Example

{

“ID”: “1”,

“Name”: “temp sensor”,

“Type”: “Temp sensor”,

“State”: 20,

“Timestamp”: “2015/06/01 02:14:00 (+02:00)”,

“StateMin”: -50,

            “StateMax”: 50,

            “StateIncrement”: 1,

            “StateUnit”: “celcius”

}

Notification definitions list

Errorcode definition

It is proposed to use (a variant of) HTTP status codes to indicate the error types. The reason is that we can devide codes in relevant groups, for instance 2xx Success, 4xx Client Error, 5xx Server Error and using 0xx for vendor specific errors.

Current usage of the errorcodes are as followed

2xx: this notification is informative (low priority) and in most cases no action is required

4xx: this notification indicates that something is happening that needs attention. If further action is required is determined by either implementing software or users. For instance the duration of the notification or multiple occurrences could indicate a real error (door open is no problem, but door open for one hour could indicate that someone forgot to close it)

5xx: this notification needs immediate attention since it affects the proper working of the hardware. Simply put: all errors that show that the light is not on while it should be need a 5xx range to indicate the importance of the notification.

Ranges within error codes

We start counting from the 10 range to prevent collision with generally used HTTP status codes.

x1x:                Light notifications:

x2x:                Segmentcontroller:

x3x:                OLC:

x4x:                Communication:

x5x:                Hardware:

x6x:                Power:

All codes ending in zero (0) are reserved for the general notification. If a type of notification you have the report is not mentioned in the current list. Please use the 0 number to indicate the group and make the message defined. Request for extending the list with new types within the ranges can be submitted at the ALiS Foundation for approval.

Code list

Parameter Errorcode
Light error 410
Partial light failure 411
Light error 510
Light failure 511
Communication Error 440
Error OLC/Driver 430
Unexpected Communication Error 441
Power Loss 560
Unexpected Power Loss 561
Hardware 450
Hardware Door open 451
Hardware 250
Hardware Door closed 251
Light High temperature alarm 412

 

To ad new definitions please place a suggestion on our user forum