XIM Gen4 Sensor Programming Examples. Rev /05/ PDF Free Download

XIM Gen Sensor Programming Examples Rev 0.6 2/0/206

Overview The latest XIM Gen firmware (V0.28), Xsensor firmware (V0.0) and XIM-BLE Control Panel (V..) update includes significant changes to sensor support. The updated version of the Control Panel can be downloaded from: https://xicato.sharefile.com/d-sb0c922cd2d8b These changes add support for multiple sensors and sensor types as well as the production version of EnOcean s BLE switch The following are the basic semantics and structure of the new programming methodology and examples of programming different sensor responses. Note that the examples given are known to work, but are not necessarily the only way to implement the desired functionality 2

Functional Overview: Sensor Intelligent Response Engine The Sensor Intelligent Response Engine (SIRE) is a programmable state machine, where the user defines the transitions between states along with the associated action. A state transition is defined by the following: To State: The state number that it is going to. For example: 2 From State(s): One or more states that it can transition from. For example: 0 and Condition(s): The conditions that would trigger this state transition. For example: {Motion Sensor Event OR Schedule Start Time}; {Button Press}. Action: The action to perform when the state transition occurs. For example: direct intensity % with s fade; 00 lux with a slow response time. Condition: Motion Detected State 0: Lights Off Action: Fade to 00% Condition: Motion Timeout State : Lights On Note: The SIRE will remain in a given state until the explicit conditions to transition out of the state are met. Action: Fade to 0%

Supported Conditions (/2) Category Name Condition Description AND AND Links multiple conditions. Value is true if both linked condition are true. Condition Modifiers OR OR Links multiple conditions. Value is true if either linked conditions is true. Always True True Condition is always true. In State Duration Less Than StateTime < t Time in State < t Maximum time is hours. State Time In State Duration Greater Than StateTime > t Time in State > t Maximum time is hours. Switches & Buttons Button Press Bx.y Press Button Press Event for Switch x Button y Button Release Bx.y Release Button Release Event for Switch x Button y Long Button Press Bx.y PressTime > t Button Press Time > (or <) t seconds for Switch x Button y Long Button Release Bx.y ReleaseTime < t Button Release Time > (or <) t seconds for Switch x Button y All Button Events Timeout B& Time > t Button Event > t seconds for all enabled Switch Buttons. Maximum time is hours Lux Light Control Lux Less Than Lx.y < l Lux sensor x, sub-sensor y value is less than l lux Lux Greater Than Lx.y > l Lux sensor x, sub-sensor y value is greater than l lux Light Control Event LC Evt Direct Light Control (Direct Intensity or Scene Recall) Event Light Control Timeout LC Time > t Last Direct Light Control > (or <) t seconds ago. Maximum time is hours. *x and y can be wildcards or numbers. Wildcards are & (all must be true) or + (any must be true)

Supported Conditions (2/2) Category Name Condition Description Motion Schedule Intensity Motion Event Mx.y Evt Motion Detection Event for Motion Sensor x, sub-sensor y Motion Timeout Mx.y Time > t Last Motion Detection > (or <) t seconds ago for Motion Sensor x, sub-sensor y. Maximum time is hours. All Motion Timeout M& Time > t Last Motion Detection > t seconds ago for All Motion Sensors. Maximum time is hours. Schedule Active T0 Active Schedule Inactive T0 Inactive Opposite of T0 Active Current day is enabled and current time is between the defined start and end time. If start time is greater than end time (e.g. Start = 7:00:00, End = 08:00:00), then it will stay active into the next day. Only the day that the event starts needs to be enabled (e.g. if it starts Monday night and ends Tuesday morning, then only Monday should be enabled) Schedule Start T0 Start Schedule has started Event. The current time has just reached the start time. Schedule End T0 End Schedule has ended Event. The current time has just reached the end time. Time Not Available TNone Current time is unknown. Condition is true when no local time advertisement has been received. Tracking Intensity Value Less Than Tracking Intensity Value Greater Than Tracking Intensity Received Time Less Than Tracking Intensity Received Time Less Than Y0 < i Y0 > i Y0 Time < t Y0 Time > t Device Y0 intensity value is less than i percent. Device Y0 intensity value is greater than i percent. Last light status or light change packet from device Y0 received < t seconds ago. Last light status or light change packet from device Y0 received > t seconds ago.

Sensor Page Setup Define States, Conditions, & Actions Assign Schedules, Switches, Sensors, etc. Import/Export Configuration Info Retrieve and Set Configuration Info Monitor Current State Current Device 6

XIM State Machine Step Process. Identify how the XIM being programmed should behave in a space. Think of all scenarios where light intensity would change and what conditions would trigger those changes. 2. Diagram the state machine based on the events and scenarios identified in Step. Label each state and use arrows to show which states can be reached, what the conditions are for reaching them, and what action the XIM should take when transitioning to each state.. Use the state machine diagram from step 2 as a guide for populating the fields of the Sensor Setup Tab. 7

Example A Accent Lighting on Painting. Identify how the XIM being programed should behave in a space. Think of all scenarios where light intensity would change and what conditions would trigger those changes. During museum hours (7AM to 7PM Tuesday through Saturday), the accent light will illuminate a painting when motion is detected on Sensor A or B. Target illuminance is 0 lux which is detected on Sensor A. When no motion is detected after minutes on either motion sensor, intensity will fade to %. Outside of museum hours, XIM will be OFF. 8

Example A Accent Lighting on Painting 2. Diagram the State Machine based on the events and scenarios identified in step. Label each state and use arrows to show which states can be reached, what the conditions are for reaching them, and what action the XIM should take when entering each state. During museum hours (7AM to 7PM Tuesday through Saturday), the accent light will illuminate a painting when motion is detected on Sensor A or B. Target illuminance is 0 lux which is detected on Sensor A. When no motion is detected after minutes on either motion sensor, intensity will fade to %. Outside of museum hours, XIM will be OFF. 2 # Condition Action Schedule Active (Museum Open) Fade to % 2 Motion Event Set illuminance to 0 lux No motion detected for minutes Fade to % S0: Museum Closed S: Museum Open/ Set Intensity to % S2: Motion Detected/ Set Illumination level to 0 lux Schedule Inactive (Museum Closed) Fade to 0% 9

Example A Accent Lighting on Painting. Use the state machine diagram from step 2 as a guide for populating the fields of the Sensor Setup Tab. 2 S0: Museum Closed S: Museum Open/ Painting to % Line Condition Action Schedule T0 is Active (Museum Open) S2: Motion/ Painting to 0lx Fade to % over seconds Current time must be advertised to device in order for T0 active (or T0 Inactive) to function. The XIM Control Panel can be set to advertise current time to the device through the Settings tab. Local time Advertising Interval must be set to a value other than 0. 2 Motion is detected on sensor M0.0 or M.0 No motion is detected on any sensor for minutes (00 seconds). Schedule T0 is Inactive (Museum Closed) Increase intensity of light (at a response rate of 60) until an illuminance of 0 lux is detected on sensor L0.0 Fade to % over seconds Fade to 0% over seconds

Example A Accent Lighting on Painting. Use the state machine diagram from step 2 as a guide for populating the fields of the Sensor Setup Tab. 2 S0: Museum Closed S: Museum Open/ Painting to % S2: Motion/ Painting to 0lx Line Condition Action 2 Schedule T0 is Active (Museum Open) Motion is detected on sensor M0.0 or M.0 No motion is detected on any sensor for minutes (00 seconds). Schedule T0 is Inactive (Museum Closed) Fade to % over seconds Increase intensity of light (at a response rate of 60) until an illuminance of 0 lux is detected on sensor L0.0 Fade to % over seconds Fade to 0% over seconds When lux tracking, the XIM uses a PID control loop feedback mechanism to determine the correct output value needed to reach the target illuminance. The LX+ and LXvalues (-20) represent the proportional gains for increasing and decreasing intensity respectively. The SIRE will continuously track the lux error % to adjust the rate of responses to prevent the system from becoming unstable. The response rate should be tuned based upon total lux delta (larger delta should use smaller gain values) and desired user experience.

Example A Accent Lighting on Painting. Use the state machine diagram from step 2 as a guide for populating the fields of the Sensor Setup Tab. 2 S0: Museum Closed S: Museum Open/ Painting to % S2: Motion/ Painting to 0lx Line Condition Action Schedule T0 is Active (Museum Open) Fade to % over seconds When T0 is Inactive (any time not defined as Active), the light will go to state 0 and the intensity go to 0%. In this example, the transition will not occur until the light enters state from state 2. 2 Motion is detected on sensor M0.0 or M.0 No motion is detected on any sensor for minutes (00 seconds). Schedule T0 is Inactive (Museum Closed) Increase intensity of light (at a response rate of 60) until an illuminance of 0 lux is detected on sensor L0.0 Fade to % over seconds Fade to 0% over seconds

Example A Accent Lighting on Painting. Use the state machine diagram from step 2 as a guide for populating the fields of the Sensor Setup Tab. 2 S0: Museum Closed S: Museum Open/ Painting to % S2: Motion/ Painting to 0lx Line Condition Action 2 Schedule T0 is Active (Museum Open) Motion is detected on sensor M0.0 or M.0 Fade to % over seconds Increase intensity of light (at a response rate of 60) until an illuminance of 0 lux is detected on sensor L0.0 Field indicates which state the device is currently in. In this example, our XIM is currently in State 2. Default state is 0 so there must always be a transition to and from state 0. Device will automatically enter state 0 whenever unit is power cycled or a new configuration is set. No motion is detected on any sensor for minutes (00 seconds). Schedule T0 is Inactive (Museum Closed) Fade to % over seconds Fade to 0% over seconds 7

Example B Utility Room Vacancy Sensor & EnOcean Switch. Identify how the XIM being programmed should behave in a space. Think of all scenarios where light intensity would change and what conditions would trigger those changes. Utility room light will automatically turn on to a low level when motion is detected. Light will fade to full intensity when an EnOcean BLE wall switch button is pressed. Light will turn off when switch button2 is pressed. If user holds down either switch, light will fade up or down, respectively, and stop fading when button is released. The light will also fade to 0% intensity if no motion is detected in the space after minutes. 8

Example B - Utility Room Vacancy Sensor & EnOcean Switch 2. Diagram the State Machine based on the events and scenarios identified in step. Label each state and use arrows to show which states can be reached, what the conditions are for reaching them, and what action the XIM should take when entering each state. Utility room light will automatically turn on to a low level when motion is detected. Light will fade to full intensity when an EnOcean BLE wall switch button is pressed. Light will turn off when switch button2 is pressed. If user holds down either switch, light will fade up or down, respectively, and stop fading when button is released. The light will also fade to 0% intensity if no motion is detected in the space after minutes. # Condition Action 2, Motion Detected Fade to 20% 2 Switch 0 Pressed Fade to 00% Switch Pressed Fade to 0% Long Button Release Stop Fading S0: Vacant Room S: Occupied Room No Motion Detected for minutes Fade to 0% 9

Basic Setup: EnOcean PTM 2B BLE Switch Response As part of its sensor support suite, the XIM Gen can support two independent EnOcean PTM 2B BLE switches (designated B0 and B). Independent response to each of the switch buttons of the PTM 2B can be programmed into each XIM module. The mapping of the physical buttons of the PTM 2B to the logical names used in Xicato s XIM BLE Control Panel to configure switch response is shown below B<x>.0 B<x>. B<x>.2 B<x>. PTM 2B Button Designator Control Panel Logical Name Channel A, State O B<x>.0 Channel A, State I B<x>. Channel B, State O B<x>.2 Channel B, State I B<x>.. <x> is the physical switch designator of either 0 or 22

Example B - Utility Room Vacancy Sensor & EnOcean Switch. Use the state machine diagram from step 2 as a guide for populating the fields of the Sensor Setup Tab. S0: Vacant Room S: Occupied Room 2,, Line Condition Action Motion Event detected on sensor M0.0 2 Switch B0.0 Pressed Switch B0. Pressed Switch B0.0 or B0. is released after 0. No Motion Detected on sensor M0.0 for minutes Fade to 20% over seconds Fade to 00% over Fade to 0% over 8 Stop Fading Fade to 0% over 8 To have the light respond to the EnOcean switch, set the B0 switch ID value as printed on the label on the back of the EnOcean switch (set to E2::00:00::99 in this example). Make sure to colon ( : ) separate each byte value. 2

Example B - Utility Room Vacancy Sensor & EnOcean Switch. Use the state machine diagram from step 2 as a guide for populating the fields of the Sensor Setup Tab. S0: Vacant Room S: Occupied Room 2,, Here, the + wildcard is used for switch B0. Any switch (B0.0 or B0.) held for more than. secs will trigger this condition. Line Condition Action Motion Event detected on sensor M0.0 2 Switch B0.0 Pressed Switch B0. Pressed Switch B0.0 or B0. is released after 0. No Motion Detected on sensor M0.0 for minutes Fade to 20% over seconds Fade to 00% over Fade to 0% over 8 Stop Fading Fade to 0% over 8 2

Example C Office Light with EnOcean Switch and Manual Override This example builds on Example B to add support for temporary manual override. The override is the use of the XIMtroller app to manually control light levels in an office.. Identify Office light will turn ON to full intensity when a BLE switch is pressed. Light turns OFF when 2nd switch is pressed. If user holds down either switch, light will stop fading when switch is released. Light intensity can also be controlled using XIMtroller app. If each of the following conditions are true after minutes, the office light will turn OFF automatically.. No motion is detected in room 2. No switch has been pressed. XIMtroller app has not been used to control intensity 26

Example C Office Light with EnOcean Switch and Manual Override 2. Diagram the State Machine Office light will turn ON to full intensity when a BLE switch is pressed. Light turns OFF when 2nd switch is pressed. If user holds down either switch, light will stop fading when switch is released. Light intensity can also be controlled using XIMtroller iphone App. If each of the following conditions are true after minutes, the office light will turn OFF automatically. No motion is detected in room No switch has been pressed XIMtroller App has not been used to control intensity,2,,2 # Condition Action Switch 0 Press Fade to 00% 2 Switch Press Fade to 0% Long Button Release Stop Fading S0: Vacant Office S: Switch Pressed/ Held S2: XIMtroller Control Light Control Event None Motion Timeout AND Light Control Timeout AND Button Timeout Fade to 0%,2 27

Example C Office Light with EnOcean Switch and Manual Override,2,,2 S0: Vacant Office S: Switch Pressed S2: Ximtroller Control,2 Line Condition Action Switch B0.0 is pressed Fade to 00% over seconds 2 Switch B0. is pressed Fade to 0% over 8 seconds Switch B0.0 or B0. is released after 0. Light Control Event occurs (XIMtroller) None No motion is detected on sensor M0.0, no light control event has occured, and no switch has been activated for minutes. Stop Fading Fade to 0% over seconds 28

Example C Office Light with EnOcean Switch and Manual Override,2,,2 S0: Vacant Office S: Switch Pressed S2: Ximtroller Control,2 Line Condition Action Switch B0.0 is pressed Fade to 00% over seconds 2 Switch B0. is pressed Fade to 0% over 8 seconds Switch B0.0 or B0. is released after 0. Light Control Event occurs (XIMtroller) None No motion is detected on sensor M0.0, no light control event has occurred, and no switch has been activated for minutes. Stop Fading Fade to 0% over seconds 29

Example C Office Light with EnOcean Switch and Manual Override,2,,2 S0: Vacant Office S: Switch Pressed S2: Ximtroller Control,2 Line Condition Action Switch B0.0 is pressed Fade to 00% over seconds The trigger for the manual override is LC Evt (Light Control Event).This causes a transition to state 2. No action is taken since the action is defined by the light control command. 2 Switch B0. is pressed Fade to 0% over 8 seconds Switch B0.0 or B0. is released after 0. Light Control Event occurs (XIMtroller) None No motion is detected on sensor M0.0, no light control event has occurred, and no switch has been activated for minutes. Stop Fading Fade to 0% over seconds 0

Example C Office Light with EnOcean Switch and Manual Override,2,,2 S0: Vacant Office S: Switch Pressed S2: Ximtroller Control,2 Line Condition Action Switch B0.0 is pressed Fade to 00% over seconds 2 Switch B0. is pressed Fade to 0% over 8 seconds Switch B0.0 or B0. is released after 0. Light Control Event occurs (XIMtroller) None No motion is detected on sensor M0.0, no light control event has occurred, and no switch has been activated for minutes. Stop Fading Fade to 0% over seconds

Sensor Templates The following templates can be used and modified as desired to create an area control or multi-level lighting control system. 2

Example : Vacancy Sensor Light must be manually turned on but will automatically turn off when the room is vacant and motion is no longer detected. Condition (Line #) Description Fade to 00% (ON) over seconds when switch B0.0 is pressed 2 Fade to 0% (OFF) over 8 seconds switch B0. is pressed Stop fading when any switch is released after 0. Fade to 0% (OFF) over 8 seconds when no motion is detected on sensor M0.0, and no switch has been activated for minutes.

Example 2: Occupancy Sensor Automatically turns the light on when motion is detected and automatically turns the light off when motion is no longer detected. Condition (Line #) 2 Description Fade to 00% (ON) over seconds when motion is detected on sensor M0.0. Fade to 0% (OFF) over 0 seconds when no motion is detected on sensor M0.0 for minutes (00 seconds)

Example : Partial-OFF Occupant Sensor Automatically turns off part of the lighting load after an area is vacated of occupants and is capable of automatically turning on the lighting load when an area is occupied. Condition (Line #) 2 Description Fade to 0% over 8 seconds when switch B0.0 is pressed Fade to 00% over 8 seconds when motion is detected on sensor M0.0 Fade to 0% over 8 seconds when no motion is detected on sensor M0.0 for minutes (00 seconds) Fade to 0% (OFF) over 8 seconds switch B0. is pressed

Example : Partial-ON Occupant Sensor Automatically turns lights off after an area is vacated of occupants and is capable of automatically or manually turning on part of the lighting load when an area is occupied. Condition (Line #) Description Fade to 0% over seconds when motion is detected on sensor M0.0 2 Fade to 00% over seconds switch B0.0 is pressed Fade to 0% over 8 seconds switch B0. is pressed Stop fading when any switch is released after 0. Fade to 0% (OFF) over 8 seconds when no motion is detected on sensor M0.0, and no switch has been activated for minutes. 6

Example : Occupancy Sensor with Lux Response Function: Automatically turns the light on to a set lux level when motion is detected and automatically turns the light off when motion is no longer detected. Condition (Line #) 2 Description When motion is detected on sensor M0.0, increase intensity of light (at a response rate of 80) until an illuminance of 70 lux is detected on sensor L0.0 When illuminance on sensor L0.0 is within 0% of target lux value, slow the response rate to 0. Fade to 0% (OFF) over 8 seconds when no motion is detected on sensor M0.0 for minutes (00 seconds) 7

Example 6: Single Switch Alternates between 00% (On) and 0% (Off) whenever switch is pressed. Condition (Line #) Description Fade to 00% (ON) over seconds when switch B0.0 is pressed 2 Fade to 0% (OFF) over seconds switch B0.0 is pressed 8

Example 7: Single Rocker EnOcean Switch First switch turns the light on. Second switch turns the light off. Holding any switch down for more than. seconds and releasing will stop fading. Condition (Line #) Description Fade to 00% (ON) over seconds when switch B0.0 is pressed 2 Fade to 0% (OFF) over 8 seconds switch B0. is pressed Stop fading when any switch is released after 0. 9

Example 8: Dual Rocker EnOcean Switch w/ Lux Response First switch turns the light on. Second switch turns the light off. Third switch sets the light to a target illuminance. Forth switch commands the light to go to the minimum intensity value. Holding any of the first two switches down for more than. seconds and releasing will stop fading. Condition (Line #) Description Fade to 00% (ON) over seconds when switch B0.0 is pressed 2 Fade to 0% (OFF) over 8 seconds switch B0. is pressed Increase (or decrease) intensity of light (at a response rate of 2) until an illuminance of 00 lux is detected on sensor L0.0 when switch B0.2 is pressed Fade to 0.% over seconds switch B0. is pressed Stop fading when switch B0.0 or B0. is released after 0. 0

Example 9: Switch Response with Automatic Shutoff Turns light on to full intensity when switch is pressed. Turns light off when another switch is pressed. If user holds down switch, light will stop fading when switch is released. If light intensity has not been modified by a button press or light control event after 90 minutes, turn lights off. Condition (Line #) Description Fade to 00% over seconds when switch B0.0 is pressed. 2 Fade to 0% over 8 seconds when switch B0. is pressed. Stop fading if switch B0.0 or B0. is released after 0. Fade to 0% over 0 seconds if no switch has been pressed after 90 minutes Move to State if a Light Control Event occurs. 6 Fade to 0% over 0 seconds if no Light Control Event has occurred after 90 minutes

Example 0: Countdown Timer Switch Turns light on when switch is pressed. After 0 minutes, light automatically turns off. Condition (Line #) Description Fade to 00% (ON) over seconds when switch B0.0 is pressed 2 Perform no action when a Light Control Event occurs. 0 minutes after the switch is pressed or a Light Control event occurs, fade to 0% over 0 2

XIM Gen4 Sensor Programming Examples. Rev /05/2016