DLN_ADC_CHANNEL_GET_CFG Command and Response

The DLN_ADC_CHANNEL_GET_CFG command is used to retrieve the current configuration settings of a single ADC channel.

DLN_ADC_CHANNEL_GET_CFG Command

 typedef struct
 {
    DLN_MSG_HEADER header;
    uint8_t port;
    uint8_t channel;
 } __PACKED_ATTR DLN_ADC_CHANNEL_GET_CFG_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_ADC_CHANNEL_GET_CFG_CMD structure.
msgId	Identifies the message. For the DLN_ADC_CHANNEL_GET_CFG command it must be set to 0x060D. You can use the DLN_MSG_ID_ADC_CHANNEL_GET_CFG 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

An ADC port to retrieve the information from.

channel

An ADC channel to retrieve the information from.

DLN_ADC_CHANNEL_GET_CFG Response

Go to command

The adapter sends the DLN_ADC_CHANNEL_GET_CFG response after the DLN_ADC_CHANNEL_GET_CFG command execution. The response contains current configuration of the specified ADC channel.

 typedef struct
 {
    DLN_MSG_HEADER header;
    DLN_RESULT result;
    uint8_t eventType;
    uint16_t eventPeriod;
    uint16_t thresholdLow;
    uint16_t thresholdHigh;
 } __PACKED_ATTR DLN_ADC_CHANNEL_GET_CFG_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_ADC_CHANNEL_GET_CFG_RSP structure.
msgId	Contains the message id. For the DLN_ADC_CHANNEL_GET_CFG response it is set to 0x060D. The DLN_MSG_ID_ADC_CHANNEL_GET_CFG 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_ADC_CHANNEL_GET_CFG command DLN-series adapter can return the following result values:

Return Code	Description
DLN_RES_SUCCESS	Current configuration of the specified ADC channel has been successfully retrieved.

eventType

Contains the currently set event generation condition for the ADC channel. The following values are available:

Value	Description
0 or DLN_ADC_EVENT_NONE	No events are generated for the current channel.
1 or DLN_ADC_EVENT_BELOW	Events are generated when voltage level on the ADC channel crosses the lower threshhold.
2 or DLN_ADC_EVENT_LEVEL_ABOVE	Events are generated when voltage level on the ADC channel crosses the higher threshold.
3 or DLN_ADC_EVENT_OUTSIDE	Events are generated when voltage level on the ADC channel falls outside of the specified range between thresholds.
4 or DLN_ADC_EVENT_INSIDE	Events are generated when voltage level on the ADC channel falls within the specified range between thresholds.
5 or DLN_ADC_EVENT_ALWAYS	Events are sent periodically with predefined repeat interval. The non-zero interval must be specified for this event type.

eventPeriod

Contains the repeat interval for DLN_ADC_CONDITION_MET_EV event generation on the pin. The repeat interval is set in ms (1 to 65,535ms). If the repeat interval is set to 0, the DLN-series adapter will send a single event when the level on the line changes to meet the specified conditions.

thresholdLow

The lower voltage threshold value, specified in bits.

thresholdHigh

The higher voltage threshold value specified in bits.

DLN_ADC_CHANNEL_GET_CFG Command and Response