Dynalite Lighting API
This document describes the API specifications for Dynalite lighting control systems, and provides guidance to developers wishing to integrate System Manager features into their applications. API access requires a working Philips Dynalite lighting control system with a System Manager server on the network.
Smart buildings create synergies between different systems present in the building. They offer tools to control monitor and maintain these systems from centralized applications. They also support their occupants with tools that help them to be more comfortable and productive. These features are offered through open APIs.
Each API provides access to resources (data entities) via URI paths. To use a RESTful API, your application will make an HTTP request and parse the response. The response format is JSON. The methods will be the standard HTTP methods such as GET, POST and PATCH. Because each RESTful API is based on open standards, you can use any web development language to access the API.
| We recommend using a secure HTTPS connection to access APIs. |
| These instructions have been prepared by Philips Dynalite and provide information on products for use by registered partners or owners. Some information may become superseded through changes to the law and as a result of evolving technology and industry practices. Any reference to non-Philips Dynalite products or web links does not constitute an endorsement of those products or services. |
Last Updated: 2024-12-12
Lighting Control Systems
Philips Dynalite lighting control systems offer a digital ceiling infrastructure that provides both high-quality, reliable illumination and a smart communications platform that is capable of supporting data-enabled services.
Information collected through sensors and other IoT devices in the system affords deeper insight into building usage and greater control over the distribution and consumption of resources. Building owners and managers can realize enhanced value and savings from optimizing lighting and other building services such as HVAC.
The systems use a modular Philips Dynalite control architecture with flexible controller outputs, multifunction sensors and a range of user interfaces and integration options. Systems are fully scalable, quick to install and can be preconfigured or commissioned on-site.
The systems are composed of intelligent networked devices that share a common protocol. Logical areas in the building are defined within each device and are primarily controlled by recalling preset lighting scenes in an area or by dimming individual lighting channels. Channel levels can also be predefined and saved to any preset in an area. Each room has a preconfigured group of areas, devices and functions and rooms can operate independently without System Manager.
As one of the most important subsystems in the building, lighting is more and more being integrated into the Building Management System (BMS). By moving to LED and digital lighting, the lighting system is capable of automated behavior with distributed network control and data analytics providing additional benefits beyond lighting.
System Manager
System Manager is a Windows based client/server application designed to give the end user full operational monitoring, reporting and control of the lighting system. System Manager provides a centralized view of the entire system and provides a web service interface for API integration.
The API enables users to monitor and control the lighting status of areas and channels in real time through the Data Access server. Although the API enables control from third party systems, System Manager provides other control options through the System Manager client interface, mobile app, touchscreen and/or web-based dashboard.
In addition to software user interfaces, the system provides the standard options for building occupants to manually control the lighting via wall mounted user interfaces. Furthermore, most lighting control functions can be automated with System Manager or with wall/ceiling mounted sensors in different areas of the building.
WebSocket
The API provides a websocket for the purpose of capturing system events. The websocket establishes a HTTP(S) connection between the third-party software and the system API. Events may be triggered from anywhere in the system, such as:
-
Channel level changes
-
Preset lighting scene changes
Glossary
| Term | Description |
|---|---|
Area |
A part of a floor plan that contains a group of lighting channels. Areas have a name and a number. |
Channel |
A single lighting circuit or group of DALI lamp drivers that operate in unison. |
Channel level |
The light intensity of a lighting circuit. Two variables are required; the channel number and the channel level in the range 0 to 255. |
Join |
An 8-bit part of a preset message or channel level message that enables the logical linking and separation of areas. Usually set to FF (hex) to enable all join bits. |
Preset |
A preset is a saved scene in an area. The preset controls multiple channel levels in an area with a single message. Two variables are required: the area number and the preset number. An area may have many presets. |
Color temperature |
The light setting from warm-white to cool-white usually expressed in degrees Kelvin |
Fade |
The transition time that may be specified when changing presets or levels. |