Integrating with EnOcean Output Devices – Delta Controls

Some additional considerations and steps are required when programming the O3 to communicate with an output device, such as a relay or dimmer.

Configuring Simple Relays

Simple relays provide basic on/off control and do not offer any feedback.

The mapping file should contain the following objects (where DD = EnOcean device number 01-32):

Name	Reference
Device Type	AV3DD993 (e.g., AV301993)
OFF Value	AV3DD990
ON Value	AV3DD991
Relay ONOFF	BV3DD001

The Device Type AV object is used for output control and defines two categories of devices: 0 = Input and output with feedback, and 1 = Output only. For a simple relay, the Device Type value is set to 1.

Depending on the vendor, required on and off levels may vary. The OFF Value and ON Value AV objects provide a flexible way to configure these values. These objects define the packet data value being sent out to command something on or off.

The following procedure assumes that you have already completed steps 1 to 4 in Configuring EnOcean Devices.

To configure a simple relay:

Create the Device Type AV object and leave the value set to 0 to define an input or output with feedback, or set the value to 1 to define an output without feedback.
Create the OFF Value AV object and set the value. For example, 112(0x70).
Create the ON Value AV object and set the value. For example, 80(0x50H).
Create the Relay ONOFF BV object defined in the mapping file.
Create any other objects needed for your application.
Ensure that all Learn Out BV objects are Off.
Put the relay into Learn Mode. For specific instructions, consult the manufacturer's documentation.
Command the Learn Out BV object you are using (One Click Learn Out or Three Click Learn Out) to On.
After the relay has paired with the gateway, command the Learn Out BV object to Off.
Verify that the Relay ONOFF BV object controls the relay state.

RPS Force Send

Since simple relays do not include a feedback function, there is no indication of the relay's actual state. In some cases, you may want to send the same command again to ensure that the command was received and acted on correctly by the relay output device.

The RPS Force Send BV object (BV3DD982) provides a way to send the current relay output value even if that value has not changed.

RPS is an EnOcean term that refers to the repeated switch communication telegram type. EEPs that use RPS telegrams start with F6. For example, F6-02-01.

To use the RPS Force Send feature:

Verify that the OFF Value AV and ON Value AV objects are set to the required values.
Command the RPS Force Send BV object to On. This sends the current value of the Relay ONOFF Output BV object.

To use Force Send repeatedly, the Force Send BV object must be toggled ON and OFF at a rate slower than the program scan rate. Here are some sample programs that can help ensure that the ON/OFF signals are sent at the correct intervals.

The following pseudo code shows the idea of a state machine:

Variable Run As Integer
Variable SetpointOffset As Real
<other parts of the GCL, which sets "Run" and "SetpointOffset">

If (Run =0) Then

  If ( State > 1 ) Then
	BV = 0
	State = 0
  End If
Else
 DoEvery ( SetpointOffset )
  State = State + 1 
  If (State = 1) Then
	BV = 1
  Else
	BV = 0
  	State = 0
  End If
 End Do
End If

<the rest of the GCL+ program>

In the preceding code, "Run" is a GCL+ integer variable that indicates that RPS Force Send should be set periodically when it is non-zero. "SetpointOffset" is a GCL+ variable that indicates the value of the desired RPS Force Send interval. "State" represents the AV object that retains its value between scans. "BV" represents the RPS Force Send BV object.

You will need to create the following additional objects:

Name	Reference	Description
PG1	PG1	Master program to call PG2 and PG3
PG2	PG2	Program to send ON followed by Release
PG3	PG3	Program to send OFF followed by Release
Rocker ON and release switch	BV1	For PG2
Rocker OFF and release switch	BV2	For PG3
Rocker ON state variable	AV1	For PG2
Rocker OFF state variable	AV2	For PG3

PG1 Code: Calls the Two Programs

Call PG2
Call PG3

PG2 Example Code: Sends the ON Followed by a Release Packet

Variable ON_VALUE As Integer
Variable RELEASE_VALUE As Integer

ON_VALUE = 80
RELEASE_VALUE = 0


If ('Rocker ON and release switch' = 0) Then
	If ('Rocker ON state variable' > 7) Then
		'RPS Force Send' = Off
		'Rocker ON state variable' = 0
	End If
Else
	DoEvery 0.1S
		'Rocker ON state variable' = 'Rocker ON state variable' + 1
	If ('Rocker ON state variable' = 1) Then
		'ON Value' = ON_VALUE
		'RPS Force Send' = Off
	ElseIf ('Rocker ON state variable' = 2) Then
// send the ON packet here
	If ('RPS Send .Manual_Override' = Off) Then
		'RPS Send .Manual_Override' = On
	Else
		'RPS Force Send' = On
	End If
	ElseIf  ('Rocker ON state variable' = 3) Then
	'RPS Force Send' = Off
	ElseIf  ('Rocker ON state variable' = 4) Then
	'ON Value' = RELEASE_VALUE
	ElseIf  ('Rocker ON state variable' = 5) Then
// send the release packet here
	'RPS Force Send' = On
	ElseIf  ('Rocker ON state variable' = 6) Then
		'RPS Force Send' = Off
	Else
		'ON Value' = ON_VALUE
		'Rocker ON state variable' = 0
		'Rocker ON and release switch.Manual_Override' = 0
	End If
	End Do
End If

PG3 Example Code: Sends the OFF Followed by a Release Packet

Variable OFF_VALUE As Integer
Variable RELEASE_VALUE As Integer

OFF_VALUE = 112
RELEASE_VALUE = 0

If ('Rocker OFF and release switch' = 0) Then
	If ('Rocker OFF state variable' > 7) Then
		'RPS Force Send' = Off
		'Rocker OFF state variable' = 0
	End If
Else
	DoEvery 0.1S
		'Rocker OFF state variable' = 'Rocker OFF state variable' + 1
	If ('Rocker OFF state variable' = 1) Then
		'OFF Value' = OFF_VALUE
		'RPS Force Send' = Off			
	ElseIf  ('Rocker OFF state variable' = 2) Then
// send the ON packet here
	If ('RPS Send .Manual_Override' = On) Then
		'RPS Send .Manual_Override' = Off
	Else
		'RPS Force Send' = On
	End If
ElseIf  ('Rocker OFF state variable' = 3) Then
		'RPS Force Send' = Off
ElseIf  ('Rocker OFF state variable' = 4) Then
		'OFF Value' = RELEASE_VALUE
ElseIf  ('Rocker OFF state variable' = 5) Then
// send the release packet here
	'RPS Force Send' = On
ElseIf  ('Rocker OFF state variable' = 6) Then
	'RPS Force Send' = Off
Else
	'OFF Value' = OFF_VALUE
	'Rocker OFF state variable' = 0
	'Rocker OFF and release switch.Manual_Override' = 0
		End If
	End Do
End If

Configuring Load Controllers with Central Command Support

Load controllers are typically used in lighting and HVAC circuit applications and usually include a feedback signal.

Many EnOcean output devices offer central command support (A5-38-08). This feature is typically used in combination with another profile. For example, the gateway can use the A5-38-08 lighting dimming profile and the A5-11-01 lighting controller status feedback profile together to control the output device.

Download A5-38-08+A5-11-01 from

https://support.deltacontrols.com/Products/EnOceanEEPs

Currently, the O3 Edge only supports the switching (0x01) and dimming (0x02) command bytes for A5-38-08.

Be extra careful when setting up the packet data. The gateway has the following behaviors for out-of-range or unexpected data values:

The command byte can be set to an out-of-range value.
Other values can be set out of range. For example, the Dimming Value AV object for Command 0x02 has a range of 0 to 255 but can be set to a value greater than 255. If you set to a value greater than 255, the gateway will overflow. Since the device has no way to know that it has overflowed, it will use the overflow value as its data.
Negative values that are out of range are set to 0 by the gateway. A zero in the packet data indicates an error.

The combined A5-38-08 + A5-11-01 mapping file should contain following objects (where DD = EnOcean device number 01-32):

4BS Output does not support scaling in firmware version 2.2 and earlier.

Name	Reference (O3 Edge)
Command	AV3DD001 (e.g. AV301001)
Dimming Value	AV3DD002
Ramping Time	AV3DD003
Dimming Range Relative Value	BV3DD004
Store Final Value Yes	BV3DD005
Switching Command ON	BV3DD006
Illumination	AV3DD007
Illumination Set Point	AV3DD008
Dimming Output Level	AV3DD009
Repeater Enabled	BV3DD010
Power Relay Timer Enabled	BV3DD011
Daylight Harvesting Enabled	BV3DD012
Dimming Load	BV3DD013
Magnet Contact Closed	BV3DD014
Occupancy Occupied	BV3DD015
Power Relay ON	BV3DD016
ONOFF	BV3DD017
Device Type	AV3DD993
Link Status	CSV3DD996
Reliability Timer	AV3DD997
Learn Mode	BV3DD998
4BS Send	BV3DD985
4BS Learn Out	BV3DD986
Learn Out Func	CSV3DD987
Learn Out Type	CSV3DD988
Learn Mode	BV3DD998
Device Address	CSV3DD999

The following procedure assumes that you have already completed steps 1 to 4 in Configuring EnOcean Devices and that you've uploaded an XML mapping file that contains the combined profile A5-38-08+A5-11-01.

To configure a load controller with central command support:

Create the mapping and configuration objects needed for your application.
Set the Device Type AV object value to 0 to define an output with feedback.
Ensure that all Learn Out BV objects are Off.
Set the value of the Learn Out Func CSV object to 38.
Set the value of the Learn Out Type CSV object to 08.
Put the load controller into learn mode. For specific instructions, consult the manufacturer's documentation.
Command the 4BS Learn Out BV object to On.
After the load controller has paired with the gateway, command the 4BS Learn Out BV object to Off.
Set the Command AV object to a value allowed by the profile. For example, to control dimming, set the value to 2.
Command the 4BS Send BV object to On to send a control packet. Confirm that the load controller responds correctly when you send a command.

Setting Up Feedback

If the output device supports feedback, you can set up feedback to show the response to an output command.

To set up feedback:

Command the Learn Mode BV object to On. The Link Status CSV object changes to "Pairing."
On the EnOcean output device, generate a learn packet from the device using the method specified by the manufacturer. When pairing is complete, the Device Address CSV object shows the device’s ID and the Link Status CSV object changes to "Online."
Once pairing is complete, command the Learn Mode BV object to Off.
Confirm that the feedback value matches the actual output value or state.