DLN_LED_SET_STATE Command and Response

The DLN_LED_SET_STATE command is used to set LED states.

DLN_LED_SET_STATE Command

 typedef struct
 {
    DLN_MSG_HEADER header;
    uint8_t ledNumber;
    DLN_LED_STATE state;
 } __PACKED_ATTR DLN_LED_SET_STATE_CMD;

Parameters:

header

Defines the DLN message header DLN_MSG_HEADER. The header contains several predefined fields and is used to identify and route messages. You must fill the following fields before sending the command:

Field	Description
size	The size of the message. Must be equal to the size of the DLN_LED_SET_STATE_CMD structure.
msgId	Identifies the message. For the DLN_LED_SET_STATE command it must be set to 0x0801. You can use the DLN_MSG_ID_LED_SET_STATE constant.
echoCounter	Can be used to link a command to a response. The response will have the same echoCounter value. This field can be any numerical value from 0 to 0xFFFF (65536).
handle	A handle to the DLN-series adapter.

ledNumber

Contains the number of the LED, whose state we are changing.

state

Contains the value of the state to be set.

DLN_LED_SET_STATE Response

Go to command

The adapter sends the DLN_LED_SET_STATE response after the DLN_LED_SET_STATE command execution. The result field informs a user if a LED state has been successfully set.

typedef struct
 {
    DLN_MSG_HEADER header;
    DLN_RESULT result;
 } __PACKED_ATTR DLN_LED_SET_STATE_RSP;

Parameters:

header

Defines the DLN message header DLN_MSG_HEADER. The response header contains the following fields:

Field	Description
size	The size of the message. It is equal to the size of the DLN_LED_SET_STATE_RSP structure.
msgId	Contains the message id. For the DLN_LED_SET_STATE response it is set to 0x0801. The DLN_MSG_ID_LED_SET_STATE constant can be used to check the message ID.
echoCounter	Links a command to a response. The echoCounter value is copied from the respective command header.
handle	A handle to the DLN-series adapter. You can use the handle field to determine the adapter that have sent the response.

result

Contains the result of the command execution. For DLN_LED_SET_STATE command DLN-series adapter can return the following result values:

Return Code	Description
DLN_RES_SUCCESS	State of a LED has been successfully set.
DLN_RES_INVALID_LED_NUMBER	Invalid LED number has been specified;
DLN_RES_INVALID_LED_STATE	Invalid LED state has been specified.

DLN_LED_SET_STATE Command and Response