DLN_GPIO_PIN_DISABLE Command and Response

The DLN_GPIO_PIN_DISABLE command is used to disable a pin as general purpose input/output.

DLN_GPIO_PIN_DISABLE Command

Syntax

C/C++

 typedef struct
 {
    DLN_MSG_HEADER header;
    uint8_t pin;
 } __PACKED_ATTR DLN_GPIO_PIN_DISABLE_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_GPIO_PIN_DISABLE_CMD structure.
msgId	Identifies the message. For the DLN_GPIO_PIN_DISABLE command it must be set to 0x0111. You can use the DLN_MSG_ID_GPIO_PIN_DISABLE 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.

pin

A number of the pin to be configured.

DLN_GPIO_PIN_DISABLE Response

Go to command

The adapter sends the DLN_GPIO_PIN_DISABLE response after the DLN_GPIO_PIN_DISABLE command execution. The result field informs a user if the pin has been successfully disabled as general purpose input/output.

Syntax

C/C++

 typedef struct
 {
    DLN_MSG_HEADER header;
    DLN_RESULT result;
 } __PACKED_ATTR DLN_GPIO_PIN_DISABLE_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_GPIO_PIN_DISABLE_RSP structure.
msgId	Contains the message id. For the DLN_GPIO_PIN_DISABLE response it is set to 0x0111. The DLN_MSG_ID_GPIO_PIN_DISABLE 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_GPIO_PIN_DISABLE command DLN-series adapter can return the following result values:

Return Code	Description
DLN_RES_SUCCESS	Pin has been successfully disabled as general purpose input/output.
DLN_RES_INVALID_PIN_NUMBER	Invalid pin number was specified.
DLN_RES_PIN_IN_USE	Pin is assigned to another module of the adapter and cannot be disabled as GPIO.

DLN_GPIO_PIN_DISABLE Command and Response