下载库函数源码

编译路径添加

libmodbus 源码分析

核心数据结构

• modbus_t结构体：
  这是 libmodbus 的核心数据结构，代表一个 Modbus 上下文。它包含了与 Modbus 通信相关的各种信息，如通信方式（串口或 TCP）、设备地址、端口号等。

struct _modbus {/* Slave address */// 存储 Modbus 从设备地址。在 Modbus 通信中，主设备通过指定从设备地址来与特定的从设备进行通信。int slave;/* Socket or file descriptor */// 存储套接字描述符或文件描述符。根据通信方式的不同，这个值可以是一个套接字描述符（用于 TCP 通信）或文件描述符（用于串口通信）。int s;// 调试标志。如果设置为非零值，表示启用调试模式，可以输出更多的调试信息。int debug;// 错误恢复标志。用于指示是否启用错误恢复机制，例如在通信出现错误时尝试重新连接或采取其他恢复措施。int error_recovery;// 响应超时时间。这是一个结构体 timeval，用于指定在等待从设备响应时的超时时间。如果在这个时间内没有收到响应，将认为通信出现错误。struct timeval response_timeout;// 字节超时时间。同样是一个结构体 timeval，用于指定在接收单个字节时的超时时间。如果在这个时间内没有接收到下一个字节，也将认为通信出现错误。struct timeval byte_timeout;// 指示超时时间。这个超时时间的具体用途可能因实现而异，可能用于等待某些特定的指示或事件。struct timeval indication_timeout;// 指向特定后端实现的指针。Modbus 库可能支持多种不同的通信后端，例如不同的操作系统或硬件平台。这个指针指向相应的后端实现结构体。const modbus_backend_t *backend;// 后端数据指针。用于存储特定于后端实现的数据。不同的后端可能需要不同的数据结构来存储其特定的状态信息。void *backend_data;
};

• modbus_mapping_t
  用于映射 Modbus 寄存器和线圈的数据结构。它包含了输入寄存器、输出寄存器、输入线圈和输出线圈的内存映射，方便开发者在应用程序中访问和操作 Modbus 设备的数据

typedef struct _modbus_mapping_t {int nb_bits;// 表示映射的线圈（位）的总数。在 Modbus 协议中，线圈通常用于表示离散的开/关状态。int start_bits;// 映射的线圈的起始地址。这是相对于 Modbus 地址空间的起始位置。int nb_input_bits;// 表示映射的离散输入（只读位）的总数。离散输入通常用于反映外部设备的状态，不能被写入。int start_input_bits;// 映射的离散输入的起始地址。同样是相对于 Modbus 地址空间的起始位置。int nb_input_registers;// 表示映射的输入寄存器的总数。输入寄存器通常用于存储只读的 16 位数据，例如传感器的测量值。int start_input_registers;// 映射的输入寄存器的起始地址。在 Modbus 地址空间中的起始位置。int nb_registers;// 表示映射的保持寄存器的总数。保持寄存器可用于存储可读可写的 16 位数据，通常用于配置参数或存储设备状态。int start_registers;// 映射的保持寄存器的起始地址。相对于 Modbus 地址空间的起始位置。uint8_t *tab_bits;// 指向一个字节数组的指针，用于存储线圈（位）的状态。每个字节可以表示 8 个位的状态。uint8_t *tab_input_bits;// 指向一个字节数组的指针，用于存储离散输入（只读位）的状态。同样每个字节可以表示 8 个位的状态。uint16_t *tab_input_registers;// 指向一个 16 位无符号整数数组的指针，用于存储输入寄存器的值。uint16_t *tab_registers;// 指向一个 16 位无符号整数数组的指针，用于存储保持寄存器的值。
} modbus_mapping_t;

• modbus_backend_t：

typedef struct _modbus_backend {unsigned int backend_type;// 表示后端的类型标识。可能用于区分不同的通信方式（如串口、TCP 等）或特定的实现。unsigned int header_length;// 表示通信协议头部的长度。不同的通信方式可能有不同长度的头部信息。unsigned int checksum_length;// 表示校验和的长度。用于确定在通信中使用的校验和数据的长度。unsigned int max_adu_length;// 表示最大应用数据单元（Application Data Unit，ADU）的长度。ADU 是 Modbus 协议中在通信中传输的数据单元。int (*set_slave) (modbus_t *ctx, int slave);// 这是一个函数指针，用于设置 Modbus 从设备地址。接收一个指向 modbus_t 结构体的指针和一个整数表示从设备地址，返回一个整数表示操作的结果状态。int (*build_request_basis) (modbus_t *ctx, int function, int addr,int nb, uint8_t *req);// 函数指针，用于构建基本的请求。接收 modbus_t 结构体指针、功能码、地址、数量和一个指向请求数据的指针，返回一个整数表示操作的结果状态。int (*build_response_basis) (sft_t *sft, uint8_t *rsp);// 函数指针，用于构建基本的响应。接收一个指向特定结构体的指针和一个指向响应数据的指针，返回一个整数表示操作的结果状态。int (*prepare_response_tid) (const uint8_t *req, int *req_length);// 函数指针，用于准备带有事务标识符的响应。接收一个指向请求数据的指针和一个指向请求长度的指针，返回一个整数表示操作的结果状态。int (*send_msg_pre) (uint8_t *req, int req_length);// 函数指针，在发送消息之前执行一些预处理操作。接收一个指向请求数据的指针和请求长度，返回一个整数表示操作的结果状态。ssize_t (*send) (modbus_t *ctx, const uint8_t *req, int req_length);// 函数指针，用于发送数据。接收一个指向 modbus_t 结构体的指针、指向请求数据的指针和请求长度，返回实际发送的字节数。int (*receive) (modbus_t *ctx, uint8_t *req);// 函数指针，用于接收数据。接收一个指向 modbus_t 结构体的指针和一个指向接收缓冲区的指针，返回一个整数表示操作的结果状态。ssize_t (*recv) (modbus_t *ctx, uint8_t *rsp, int rsp_length);// 函数指针，用于接收特定长度的数据。接收一个指向 modbus_t 结构体的指针、指向响应数据的指针和响应长度，返回实际接收的字节数。int (*check_integrity) (modbus_t *ctx, uint8_t *msg,const int msg_length);// 函数指针，用于检查消息的完整性。接收一个指向 modbus_t 结构体的指针、指向消息数据的指针和消息长度，返回一个整数表示消息是否完整。int (*pre_check_confirmation) (modbus_t *ctx, const uint8_t *req,const uint8_t *rsp, int rsp_length);// 函数指针，在检查确认之前执行一些预处理操作。接收一个指向 modbus_t 结构体的指针、指向请求数据的指针、指向响应数据的指针和响应长度，返回一个整数表示操作的结果状态。int (*connect) (modbus_t *ctx);// 函数指针，用于建立连接。接收一个指向 modbus_t 结构体的指针，返回一个整数表示连接操作的结果状态。void (*close) (modbus_t *ctx);// 函数指针，用于关闭连接。接收一个指向 modbus_t 结构体的指针，无返回值。int (*flush) (modbus_t *ctx);// 函数指针，用于刷新缓冲区。接收一个指向 modbus_t 结构体的指针，返回一个整数表示操作的结果状态。int (*select) (modbus_t *ctx, fd_set *rset, struct timeval *tv, int msg_length);// 函数指针，用于执行 select 操作。接收一个指向 modbus_t 结构体的指针、一个文件描述符集合指针、一个时间结构指针和消息长度，返回一个整数表示操作的结果状态。void (*free) (modbus_t *ctx);// 函数指针，用于释放资源。接收一个指向 modbus_t 结构体的指针，无返回值。
} modbus_backend_t;

常用接口函数

以下是对 libmodbus 库常用接口函数的详细介绍：

一、创建和释放上下文

1. modbus_new_rtu(const char *device, int baud, char parity, int data_bit, int stop_bit)

   • 功能：创建一个用于 Modbus RTU 通信的上下文。
   • 参数：
     • device：串口设备名称，例如 “/dev/ttyS0”。这是与 Modbus 设备进行通信的物理串口设备的路径。
     • baud：波特率，常见的值有 9600、19200 等。决定了数据在串口上传输的速度。
     • parity：校验位，‘N’ 表示无校验，‘E’ 表示偶校验，‘O’ 表示奇校验。用于检测数据传输中的错误。
     • data_bit：数据位数，通常为 7 或 8。表示每个数据字节中的有效数据位数。
     • stop_bit：停止位数，常见的值为 1 或 2。用于标识一个数据帧的结束。
   • 返回值：如果创建成功，返回一个指向 modbus_t 结构体的指针，该结构体代表创建的 Modbus 上下文；如果创建失败，返回 NULL。

2. modbus_new_tcp(const char *ip_address, int port)

   • 功能：创建一个用于 Modbus TCP 通信的上下文。
   • 参数：
     • ip_address：服务器 IP 地址，例如 “192.168.1.100”。指定要连接的 Modbus TCP 服务器的 IP 地址。
     • port：端口号，通常为 502。这是 Modbus TCP 通信使用的端口号。
   • 返回值：如果创建成功，返回一个指向 modbus_t 结构体的指针，该结构体代表创建的 Modbus 上下文；如果创建失败，返回 NULL。

3. modbus_free(modbus_t *ctx)

   • 功能：释放 Modbus 上下文占用的资源。
   • 参数：
     • ctx：指向要释放的 modbus_t 结构体的指针。这个指针是之前通过 modbus_new_rtu 或 modbus_new_tcp 创建的 Modbus 上下文。
   • 返回值：无。

二、设置参数

1. modbus_set_slave(modbus_t *ctx, int slave)

   • 功能：设置 Modbus 从设备地址。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
     • slave：从设备地址，通常是一个整数，范围在 1 到 247 之间。在 Modbus 网络中，每个设备都有一个唯一的地址，主设备通过这个地址来与特定的从设备进行通信。
   • 返回值：无。

2. modbus_set_debug(modbus_t *ctx, int debug)

   • 功能：设置调试模式。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
     • debug：非零值表示开启调试模式，零表示关闭调试模式。当开启调试模式时，库可能会输出更多的调试信息，帮助开发者诊断问题。
   • 返回值：无。

三、连接和断开连接

1. modbus_connect(modbus_t *ctx)

   • 功能：建立与 Modbus 设备的连接。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
   • 返回值：如果连接成功，返回 0；如果连接失败，返回 -1。

2. modbus_close(modbus_t *ctx)

   • 功能：关闭与 Modbus 设备的连接。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
   • 返回值：无。

四、读取数据

1. modbus_read_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest)

   • 功能：读取线圈状态。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
     • addr：起始地址，线圈在 Modbus 地址空间中的位置。
     • nb：要读取的线圈数量。
     • dest：存储读取结果的缓冲区。这个缓冲区应该足够大，以存储 nb 个线圈的状态。每个线圈的状态用一个字节中的一位表示，0 表示关闭，1 表示打开。
   • 返回值：如果读取成功，返回读取的字节数；如果读取失败，返回 -1。

2. modbus_read_input_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest)

   • 功能：读取离散输入状态。
   • 参数和返回值与 modbus_read_bits 类似，但离散输入是只读的，不能被写入。

3. modbus_read_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest)

   • 功能：读取保持寄存器的值。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
     • addr：起始地址，保持寄存器在 Modbus 地址空间中的位置。
     • nb：要读取的寄存器数量。
     • dest：存储读取结果的缓冲区。这个缓冲区应该足够大，以存储 nb 个 16 位的寄存器值。
   • 返回值：如果读取成功，返回读取的字节数（通常是 nb 乘以 2）；如果读取失败，返回 -1。

4. modbus_read_input_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest)

   • 功能：读取输入寄存器的值。
   • 参数和返回值与 modbus_read_registers 类似，但输入寄存器也是只读的。

五、写入数据

1. modbus_write_bit(modbus_t *ctx, int addr, int status)

   • 功能：写入单个线圈状态。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
     • addr：地址，要写入的线圈在 Modbus 地址空间中的位置。
     • status：0 表示关闭线圈，非零值表示打开线圈。
   • 返回值：如果写入成功，返回 1；如果写入失败，返回 -1。

2. modbus_write_register(modbus_t *ctx, int addr, int value)

   • 功能：写入单个保持寄存器的值。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
     • addr：地址，要写入的保持寄存器在 Modbus 地址空间中的位置。
     • value：要写入的值，一个 16 位的整数。
   • 返回值：如果写入成功，返回 1；如果写入失败，返回 -1。

3. modbus_write_bits(modbus_t *ctx, int addr, int nb, const uint8_t *data)

   • 功能：写入多个线圈状态。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
     • addr：起始地址，要写入的第一个线圈在 Modbus 地址空间中的位置。
     • nb：要写入的线圈数量。
     • data：存储要写入的线圈状态的缓冲区。这个缓冲区中的每个字节表示 8 个线圈的状态，0 表示关闭，1 表示打开。
   • 返回值：如果写入成功，返回写入的字节数；如果写入失败，返回 -1。

4. modbus_write_registers(modbus_t *ctx, int addr, int nb, const uint16_t *data)

   • 功能：写入多个保持寄存器的值。
   • 参数：
     • ctx：指向 Modbus 上下文的指针。
     • addr：起始地址，要写入的第一个保持寄存器在 Modbus 地址空间中的位置。
     • nb：要写入的寄存器数量。
     • data：存储要写入的值的缓冲区。这个缓冲区中的每个元素都是一个 16 位的整数，表示要写入的保持寄存器的值。
   • 返回值：如果写入成功，返回写入的字节数（通常是 nb 乘以 2）；如果写入失败，返回 -1。

开发 TCP Server 端

待补充

开发TCP Client 端

待补充