FB_DMXDiscMute

FB_DMXDiscMute 1:

This function block sets the mute flag of a DMX device. The mute flag specifies whether a DMX device reacts to the FB_DMXDiscUniqueBranch() command (mute flag is not set) or not (mute flag is set).

Applying a positive edge to the bStart input starts the block, and the bBusy output goes TRUE. The wDestinationManufacturerId and dwDestinationDeviceId inputs address the DMX device. The byPortId input defines the channel within the addressed DMX device. If the execution of the command has been completed, the bBusy output goes back to FALSE. The bError, udiErrorId and wControlField outputs can now be processed. Further positive edges at the bStart input will be ignored as long as the block is active (bBusy is TRUE).

VAR_INPUT

bStart                      : BOOL;
wDestinationManufacturerId  : WORD;
dwDestinationDeviceId       : DWORD;
byPortId                    : BYTE;
dwOptions                   : DWORD := 0;

bStart: The command is started by a positive edge at this input.

wDestinationManufacturerId: Unique manufacturer ID of the DMX device.

dwDestinationDeviceId: Unique device ID of the DMX device.

byPortId: Channel within the addressed DMX device. Sub-devices are addressed through the Port ID. The root device always has the Port ID 0.

dwOptions: Options (currently not used).

VAR_OUTPUT

bBusy            : BOOL;
bError           : BOOL;
udiErrorId       : UDINT;
wControlField    : WORD;

bBusy: When the block is activated the output is set, and it remains active until execution of the command has been completed.

bError: 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: Contains the command-specific error code of the most recently executed command. Only valid if bBusy is FALSE. See Error codes.

wControlField: If the execution of the command has been completed (bBusy is FALSE), then further information about the DMX device will be output at this output. The meaning of the individual bits is defined as follows:

Bit

Description

0 - Managed Proxy Flag

This bit is set if the DMX device is a proxy device.

1 - Sub-Device Flag

This bit is set if the DMX device supports sub-devices.

2 - Boot-Loader Flag

This bit is set if the DMX device cannot receive any commands (e.g. whilst the firmware is being loaded).

3 - Proxied Device Flag

This bit is set if the response was transmitted by a proxy device.

4 - 15

Reserve (always 0).

VAR_IN_OUT

stCommandBuffer          : ST_DMXCommandBuffer;

stCommandBuffer: A reference to the structure for communication (the buffer) with the FB_EL6851CommunicationEx() block.