FB_EnOceanPTM100

The function block FB_EnOceanPTM100() provides a user-friendly evaluation of the state of an EnOcean® PTM100 module. The function block FB_EnOceanReceive() is required for this purpose.

In contrast to the PTM200 and PTM250 modules, only one switch at a time can be pressed in the PTM100 module. In addition, the PTM100 module supports eight switches, not four.

	A new instance of this function block must be created for each switch module used.

Inputs

VAR_INPUT
  bEnable               : BOOL := FALSE;
  tWatchdog             : TIME;
  nTransmitterId        : UDINT;
  stEnOceanReceivedData : ST_EnOceanReceivedData;
END_VAR

Name	Type	Description
bEnable	BOOL	A positive signal at this input enables the function block. A negative signal at the input disables the function block functionality, and all outputs are set to 0 or FALSE.
tWatchdog	TIME	Monitoring time. Within this time, new information must reach this function block via the input stEnOceanReceivedData described below. If this time is set to t#0s, the watchdog function is inactive.
nTransmitterId	UDINT	ID of the EnOcean® module, to which the function block should respond.
stEnOceanReceivedData	ST_EnOceanReceivedData	Information and required connection to the EnOcean® receive function block FB_EnOceanReceive(). This information is stored in a structure.

Outputs

VAR_OUTPUT
  bSwitches : ARRAY [0..7] OF BOOL;
  bError    : BOOL := FALSE;
  nErrorId  : UDINT := 0;
END_VAR

Name	Type	Description
bSwitches	ARRAY OF BOOL	This field of 8 Boolean values describes the states of the 8 push buttons on the push button module.
bError	BOOL	This output goes TRUE as soon as an error occurs. This error is described via the variable nErrorID.
nErrorId	UDINT	Describes the type of error.

The following sample program illustrates the operating principle of this function block:

PROGRAM MAIN
VAR
    fbEnOceanReceive  : FB_EnOceanReceive;
    fbEnOceanPTM100_1 : FB_EnOceanPTM100;
    fbEnOceanPTM100_2 : FB_EnOceanPTM100;
    bSwitches1   : ARRAY    [0..7]    OF    BOOL;
    bSwitches2_1 : BOOL;
    bSwitches2_2 : BOOL;
    bSwitches2_3 : BOOL;
    bSwitches2_4 : BOOL;
    bSwitches2_5 : BOOL;
    bSwitches2_6 : BOOL;
    bSwitches2_7 : BOOL;
    bSwitches2_8 : BOOL;
END_VAR

fbEnOceanReceive(
    bEnable := TRUE,
    stEnOceanInData := stEnOceanInData,
    stEnOceanOutData := stEnOceanOutData);
fbEnOceanPTM100_1(
    bEnable := NOT fbEnOceanReceive.bError AND fbEnOceanReceive.bEnable,
    nTransmitterId := 16#000000C4,
    tWatchdog:=t#0s,
    stEnOceanReceivedData := fbEnOceanReceive.stEnOceanReceivedData);
bSwitches1 := fbEnOceanPTM100_1.bSwitches;
fbEnOceanPTM100_2(
    bEnable := NOT fbEnOceanReceive.bError AND fbEnOceanReceive.bEnable,
    nTransmitterId := 16#000000C5,
    tWatchdog:=t#0s,
    stEnOceanReceivedData := fbEnOceanReceive.stEnOceanReceivedData);
bSwitches2_1 := fbEnOceanPTM100_2.bSwitches[0];
bSwitches2_3 := fbEnOceanPTM100_2.bSwitches[1];
bSwitches2_6 := fbEnOceanPTM100_2.bSwitches[2];
bSwitches2_5 := fbEnOceanPTM100_2.bSwitches[3];
bSwitches2_8 := fbEnOceanPTM100_2.bSwitches[4];
bSwitches2_2 := fbEnOceanPTM100_2.bSwitches[5];
bSwitches2_7 := fbEnOceanPTM100_2.bSwitches[6];
bSwitches2_4 := fbEnOceanPTM100_2.bSwitches[7];

In this sample program two transmitter modules (PTM100) are queried: a transmitter module with the transmitter ID 16#C4 and another module with the transmitter ID 16#C5. A function block FB_EnOceanPTM100 is created for each of the two transmitter modules. Both function blocks obtain their information from the upstream receive function block FB_EnOceanReceive and are only active (input bEnable) if the receive function block is active and not in error. The push buttons of the first transmitter module are assigned to a Boolean array bSwitches1 for further analysis, while the push buttons of the second transmitter module are assigned to individual Boolean variables bSwitches2_1 to bSwitches2_8; both options are conceivable.

Prerequisites

Development environment	PLC library to include
TwinCAT from v3.1.4020.14	Tc2_EnOcean from v3.3.5.0