mbc_master_get_cid_info() function

Get information about supported characteristic defined as cid. Uses parameter description table to get this information. The function will check if characteristic defined as a cid parameter is supported and returns its description in param_info. Returns ESP_ERR_NOT_FOUND if characteristic is not supported.

Syntax

Show:

Summary

Declaration

Definition

from esp_modbus_master.h:275

esp_err_t mbc_master_get_cid_info(uint16_t cid, const mb_parameter_descriptor_t** param_info);

Implemented in esp_modbus_master.c:45

Arguments

Argument

Description

cid

characteristic id

param_info

pointer to pointer of characteristic data.

Return value

- esp_err_t ESP_OK - request was successful and buffer contains the supported characteristic name - esp_err_t ESP_ERR_INVALID_ARG - invalid argument of function - esp_err_t ESP_ERR_NOT_FOUND - the characteristic (cid) not found - esp_err_t ESP_FAIL - unknown error during lookup table processing

Examples

References

from examples

mbc_master_get_cid_info() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle