DLN_I2C_MASTER_IS_ENABLED Command and Response
The DLN_I2C_MASTER_IS_ENABLED command is used to retrieve information, whether the specified I2C master port is activated.
DLN_I2C_MASTER_IS_ENABLED Command
typedef struct
{
DLN_MSG_HEADER header;
uint8_t port;
}__PACKED_ATTR DLN_I2C_MASTER_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_I2C_MASTER_IS_ENABLED_CMD structure. msgId Identifies the message. For the DLN_I2C_MASTER_IS_ENABLED command it must be set to 0x0303. You can use the DLN_MSG_ID_I2C_MASTER_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 I2C master port to retrieve the information from.
DLN_I2C_MASTER_IS_ENABLED Response
The adapter sends the DLN_I2C_MASTER_IS_ENABLED response after the DLN_I2C_MASTER_IS_ENABLED command execution. The response informs a user if the specified I2C master port is activated.
typedef struct
{
DLN_MSG_HEADER header;
DLN_RESULT result;
uint8_t enabled;
}__PACKED_ATTR DLN_I2C_MASTER_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_I2C_MASTER_IS_ENABLED_RSP structure. msgId Contains the message id. For the DLN_I2C_MASTER_IS_ENABLED response it is set to 0x0303. The DLN_MSG_ID_I2C_MASTER_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_I2C_MASTER_IS_ENABLED command DLN-series adapter can return the following result values:
Return Code Description DLN_RES_SUCCESS The state of the I2C master port has been successfully retrieved. - enabled
-
Informs whether the specified I2C master port is activated. There are two possible values:
0 or DLN_I2C_MASTER_DISABLED the I2C master port is activated 1 or DLN_I2C_MASTER_ENABLED the I2C master port is deactivated
2006-2012