DLN_GPIO_PIN_GET_VAL Command and Response

The DLN_GPIO_PIN_GET_VAL command is used to retrieve the current value on the specified GPIO pin.

DLN_GPIO_PIN_GET_VAL Command

Go to response

 typedef struct
 {
    DLN_MSG_HEADER header;
    uint8_t pin;
 } __PACKED_ATTR DLN_GPIO_PIN_GET_VAL_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_GET_VAL_CMD structure.
msgId Identifies the message. For the DLN_GPIO_PIN_GET_VAL command it must be set to 0x010B. You can use the DLN_MSG_ID_GPIO_PIN_GET_VAL 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 pin to get the value from.

DLN_GPIO_PIN_GET_VAL Response

Go to command

The adapter sends the DLN_GPIO_PIN_GET_VAL response after the DLN_GPIO_PIN_GET_VAL command execution. The response contains the current value on the specified pin.

 typedef struct
 {
    DLN_MSG_HEADER header;
    DLN_RESULT result;
    uint8_t pin;
    uint8_t value;
 } __PACKED_ATTR DLN_GPIO_PIN_GET_VAL_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_GET_VAL_RSP structure.
msgId Contains the message id. For the DLN_GPIO_PIN_GET_VAL response it is set to 0x010B. The DLN_MSG_ID_GPIO_PIN_GET_VAL 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_GET_VAL command DLN-series adapter can return the following result values:

Return Code Description
DLN_RES_SUCCESS Value was successfully retrieved.
DLN_RES_INVALID_PIN_NUMBER Invalid pin number was specified.
DLN_RES_PIN_NOT_CONNECTED_TO_MODULE Pin is not assigned to the GPIO module of the adapter and its value cannot be retrieved.
pin
A pin to get the value from.
value
The current value on the pin.