Adapter - GENISYS PoE Lighting System Adapter

This page describes version 2.0.4 of the adapter.

Overview

The GENISYS PoE Lighting System adapter interfaces with the GENISYS PoE Lighting System Driver over a UDP network connection. The commands allow control of zones, devices and select system features. Additionally, notification event messages can be used to monitor for movement, room temperature, etc.

Important

The GENISYS PoE Lighting System Driver interface will not acknowledge any commands, whether valid or invalid.  The user must make sure the configuration is correct by checking for events and/or by manually running a command to verify that the request has taken place.  Connection faults will not be detected by the adapter.

GENISYS PoE Lighting System Adapter Configuration

The adapter must be installed externally from the main UIP system. The adapter will only work using an external Adapter Proxy or an Adapter HUB. UDP ports 4637 and 4636 must be open to communicate with the GENISYS Lighting System Server Driver. It is recommended by GENISYS that the Adapter Proxy or HUB be installed on the same sub network for best performance.

GENISYS PoE Lighting System Driver Configuration

The GENISYS Poe Lighting System Driver is configured as follows:

1. Stop the GENISYS Driver service.
2. Check the UDP Server checkbox under the 3rd Party Settings section.
3. Check the UDP Notify checkbox under the UDP Notify Settings section.
4. Enter the IP Address of the network location to send the UDP messages (i.e. Address of machine hosting the adapter)
   
5. Click the Save button and close the application.
6. Restart the GENISYS Driver service.

GENISYS PoE Lighting System Integration

The GENISYS PoE Lighting System uses universally unique identifiers (UUID) to identify devices, sensors, zones, scenes, etc. The adapter commands require the use of a specific UUID when sending a command to the GENISYS System. The GENISYS PoE Lighting System provides an integration report of all entities configured on the system. Open the GENISYS Lighting System's Web interface and select the "default" button in top right corner of view:

Open the "Integration Report" section:

The integration report view shows each device and its corresponding UUID along with what zone each device belongs. The view also provides an option to export the report to a comma delimited .CSV file for importing into a database:

Note: Scene UUID's are shown by selecting the "Report-Type" field at the bottom of the view:



Properties

Name	Display	Is Required	Comments	Type	Default Value	Maximum Value	Minimum Value	Maximum Length	Minimum Length
ipAddress	Host Controller Address	True	The IP Address of the GENISYS Lighting Controller Server	string				15	1
portCmd	Command Send Port	True	The remote UDP port that command messages are sent. (Default: 4637)	integer	4637			5	1
portNotify	Notification Listen Port	True	The local UDP port that notification messages are received. (Default: 4636)	integer	4636			5	1



Commands

Device State (deviceState)

Change the device state (On/Off)

Request Properties

Name	Display	Description	Is Required	Type
uuid	UUID	The universally unique identifier (UUID) used to identify the Device.	True	string
state	State	Changes the device state to either On or Off.	True	string

Device Level (deviceLevel)

Change the device level or brightness.

Request Properties

Name	Display	Description	Is Required	Type
uuid	UUID	The universally unique identifier (UUID) used to identify the Device.	True	string
level	Device Level	Changes the device's brightness level. (0-99)	True	string

Device Color RGB (deviceColorRGB)

Change the device RGB Color output.

Request Properties

Name	Display	Description	Is Required	Type
uuid	UUID	The universally unique identifier (UUID) used to identify the Device.	True	string
colorRGB	Device ColorRGB	Changes the device's RGB color output. (#000000 to #FFFFFF)	True	string

Device Color Temperature (deviceColorCT)

Change the device color temperature output.

Request Properties

Name	Display	Description	Is Required	Type
uuid	UUID	The universally unique identifier (UUID) used to identify the Device.	True	string
colorCT	Device Color Temperature	Changes the device's color temperature output. (Pre3500k,Pre4000k, Pre5000k, Pre6000k) or (0-99)	True	string

Zone State (zoneState)

Change the zone state (On/Off)

Request Properties

Name	Display	Description	Is Required	Type
uuid	UUID	The universally unique identifier (UUID) used to identify the Zone.	True	string
state	State	Changes the zone's state to either On or Off.	True	string

Zone Level (zoneLevel)

Change the zone level or brightness.

Request Properties

Name	Display	Description	Is Required	Type
uuid	UUID	The universally unique identifier (UUID) used to identify the Zone.	True	string
level	Zone Level	Changes the zone's brightness level. (0-99)	True	string

Zone Color RGB (zoneColorRGB)

Change the zone RGB Color output.

Request Properties

Name	Display	Description	Is Required	Type
uuid	UUID	The universally unique identifier (UUID) used to identify the zone.	True	string
colorRGB	Zone ColorRGB	Changes the zone's RGB color output. (#000000 to #FFFFFF)	True	string

Zone Color Temperature (zoneColorCT)

Change the zone color temperature output.

Request Properties

Name	Display	Description	Is Required	Type
uuid	UUID	The universally unique identifier (UUID) used to identify the zone.	True	string
colorCT	Zone Color Temperature	Changes the zone's color temperature output. (Pre3500k,Pre4000k, Pre5000k, Pre6000k) or (0-99)	True	string

Zone Scene (zoneScene)

Change the zone to the specified scene.

Request Properties

Name	Display	Description	Is Required	Type
uuid	Zone UUID	The universally unique identifier (UUID) used to identify the Zone.	True	string
scene	Scene UUID	The universally unique identifier (UUID) used to identify the Scene.	True	string

ODR Mode (onDemandResponseMode)

Reduces light output to a predefined amount.

Request Properties

Name	Display	Description	Is Required	Type
odr	Enable ODR Mode	Enabling ODR mode will reduce light output to a predefined amount.	False	boolean

Events

Sensor Event (sensorEvent)

A sensor event occurs when the sensor is activated.

Event Properties

Name	Display	Description	Type
Sensor.UUID	UUID	The universally unique identifier (UUID) used to identify the sensor.	string
Sensor.LastALS	Last ALS	The last ALS.	string
Sensor.LastState	Last State	The last state of the sensor.	string
Sensor.Temp	Temperature	The local temperature detected by the sensor.	string

Switch Event (switchEvent)

A switch event occurs when the switch has changed state.

Event Properties

Name	Display	Description	Type
Switch.UUID	UUID	The universally unique identifier (UUID) used to identify the switch.	string
Switch.LastLevel	Last Level	The last level the switch was set to.	string
Switch.LastState	Last State	The last state of the switch.	string
Switch.Temp	Temperature	The local temperature detected by the switch.	string

Accessory Event (accessoryEvent)

An accessory event occurs when the accessory device has changed state.

Event Properties

Name	Display	Description	Type
Switch.UUID	UUID	The universally unique identifier (UUID) used to identify the accessory.	string
Switch.LastState	Last State	The last state of the accessory.	string

Device Event (deviceEvent)

A device event occurs when a device changes state.

Event Properties

Name	Display	Description	Type
Device.UUID	UUID	The universally unique identifier (UUID) used to identify the switch.	string
Device.LastLevel	Last Level	The last level the switch was set to.	string
Device.LastState	Last State	The last state of the switch.	string
Device.Color	Color	The current color setting for the device.	string

Release History

Version	Type	Description	Tracking #	Date
2.0.1	Initial	First release in the Adapter Type store.
2.0.3	Maintenance	Updated third-party components and improved maintainability.	NAP-11518
2.0.4	Maintenance	Updated third-party components and improved maintainability.	NAP-23945	2022-11-29

Categories

• Environment
• Notification
• Sensor