Espressif ESP32-S2 - Page 652

Chapter 2. API Reference
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG Modbus stack start error
esp_err_t mbc_slave_setup(void *comm_info)
Set Modbus communication parameters for the controller.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG Incorrect parameter data
Parameters
• comm_info: Communication parameters structure.
mb_event_group_t mbc_slave_check_event(mb_event_group_t group)
Wait for specific event on parameter change.
Return
• mb_event_group_t event bits triggered
Parameters
• group: Group event bit mask to wait for change
esp_err_t mbc_slave_get_param_info(mb_param_info_t *reg_info, uint32_t timeout)
Get parameter information.
Return
• ESP_OK Success
• ESP_ERR_TIMEOUT Can not get data from parameter queue or queue overflow
Parameters
• [out] reg_info: parameter info structure
• timeout: Timeout in milliseconds to read information from parameter queue
esp_err_t mbc_slave_set_descriptor(mb_register_area_descriptor_t descr_data)
Set Modbus area descriptor.
Return
• ESP_OK: The appropriate descriptor is set
• ESP_ERR_INVALID_ARG: The argument is incorrect
Parameters
• descr_data: Modbus registers area descriptor structure
Structures
struct mb_param_info_t
Parameter access event information type.
Public Members
uint32_t time_stamp
Timestamp of Modbus Event (uS)
uint16_t mb_offset
Modbus register offset
mb_event_group_t type
Modbus event type
uint8_t *address
Modbus data storage address
size_t size
Modbus event register size (number of registers)
struct mb_register_area_descriptor_t
Parameter storage area descriptor.
Espressif Systems 641
Submit Document Feedback
Release v4.4