FB_DMXGetStatusIdDescription

This function block reads the text of a certain status Id from the DMX device.

RDM defines some standard messages. Each of these messages has a unique status Id. The associated text can be read out from the DMX device with this function block.

Inputs

VAR_INPUT
  bStart                     : BOOL;
  wDestinationManufacturerId : WORD;
  dwDestinationDeviceId      : DWORD;
  byPortId                   : BYTE;
  uiStatusMessageId          : UINT := 1;
  dwOptions                  : DWORD := 0;
END_VAR

Name	Type	Description
bStart	BOOL	The function block is activated by a positive edge at this input.
wDestinationManufacturerId	WORD	Unique manufacturer Id of the DMX device (for details, see DMX device address).
dwDestinationDeviceId	DWORD	Unique device Id of the DMX device (for details, see DMX device address).
byPortId	BYTE	Channel within the addressed DMX device. Sub-devices are addressed through the Port Id. The root device always has the Port Id 0.
uiStatusMessageId	UINT	Status Id for which the text is to be read.
dwOptions	DWORD	Options (currently not used).

Inputs/outputs

VAR_IN_OUT
  stCommandBuffer : ST_DMXCommandBuffer;
END_VAR

Name	Type	Description
stCommandBuffer	ST_DMXCommandBuffer	Reference to the structure for communication (buffer) with the function block FB_EL6851Communication()

Outputs

VAR_OUTPUT
  bBusy                   : BOOL;
  bError                  : BOOL;
  udiErrorId              : UDINT;
  sStatusMessage          : STRING;
END_VAR

Name	Type	Description
bBusy	BOOL	When the function block is activated the output is set, and it remains active until execution of the command has been completed. For some errors (e.g. faulty parameters), bError is set immediately after the positive edge at bStart without bBusy switching to TRUE.
bError	BOOL	This output is switched to TRUE as soon as an error occurs during the execution of a command. The command-specific error code is contained in udiErrorId. Only valid if bBusy is FALSE.
udiErrorId	UDINT	Contains the command-specific error code of the most recently executed command. Only valid if bBusy is FALSE (see error codes).
sStatusMessage	STRING	Status message

Requirements

Development environment	PLC library to include
TwinCAT from v3.1.4020.14	Tc2_DMX from 3.5.3.0