DLN_PWM_CHANNEL_IS_ENABLED Command and Response

The DLN_PWM_CHANNEL_IS_ENABLED command is used to retrieve information, whether the specified PWM channel is activated.

DLN_PWM_CHANNEL_IS_ENABLED Command

Go to response

  typedef struct
  {
     DLN_MSG_HEADER header;
     uint8_t port;
     uint8_t channel;
  }__PACKED_ATTR DLN_PWM_CHANNEL_IS_ENABLED_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_PWM_CHANNEL_IS_ENABLED_CMD structure.
msgId Identifies the message. For the DLN_PWM_CHANNEL_IS_ENABLED command it must be set to 0x0707. You can use the DLN_MSG_ID_PWM_CHANNEL_IS_ENABLED 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.
port
A number of the PWM port to retrieve the information from.
channel
A number of the PWM channel to retrieve the information from.

DLN_PWM_CHANNEL_IS_ENABLED Response

Go to command

The adapter sends the DLN_PWM_CHANNEL_IS_ENABLED response after the DLN_PWM_CHANNEL_IS_ENABLED command execution. The response informs a user if the specified PWM channel is activated.

 typedef struct
 {
    DLN_MSG_HEADER header;
    DLN_RESULT result;
    uint8_t enabled;
 }__PACKED_ATTR DLN_PWM_CHANNEL_IS_ENABLED_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_PWM_CHANNEL_IS_ENABLED_RSP structure.
msgId Contains the message id. For the DLN_PWM_CHANNEL_IS_ENABLED response it is set to 0x0707. The DLN_MSG_ID_PWM_CHANNEL_IS_ENABLED 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_PWM_CHANNEL_IS_ENABLED command DLN-series adapter can return the following result values:

Return Code Description
DLN_RES_SUCCESS The state of the PWM channel has been successfully retrieved.
enabled

Informs whether the specified PWM channel is activated. There are two possible values:

Value Description
0 or DLN_PWM_CHANNEL_DISABLED the specified PWM channel is deactivated.
1 or DLN_PWM_CHANNEL_ENABLED the specified PWM channel is activated.