Modbus-DTU 相关接口

API 列表

函数	说明
Ql_iotMBInit()	初始化 modbus 组件
Ql_iotMBCloudRecv()	转换平台下发的物模型数据为 ModBus 格式后发送到 ModBus 从机设备
Ql_iotMBLocalRecv()	转发串口接收到的 ModBus 数据至 ModBus 组件中并处理
Ql_iotMBDeinit()	注销 modbus 组件

API 详情

Ql_iotMBInit

该函数用于初始化 ModBus 组件，同时配置可用于烧写配置文件（该配置文件包含设备信息、QuecThing 配置和串口配置。该文件由移远通信提供的工具生成，详情可联系移远通信技术支持）的串口列表、注册用于向串口发送数据的回调函数和初始化回调函数。

函数原型

qbool Ql_iotMBInit(quint16_t uartList[],quint32_t uartNum,QIot_MBSend_f sendFunc,QIot_MBInitCb_f initCb);

参数说明

• 输入参数
  • quint16_t     uartList：可用于串口烧写配置文件的串口列表，需要自行打开对应串口。
  • quint32_t     uartNum：可用于串口烧写配置文件的串口数量，若不需要串口烧写文件功能可以填 0。
  • QIot_MBSend_f  sendFunc：串口发送函数。 详情请参考QIot_MBSend_f 解析。
  • QIot_MBInitCb_f  initCb：初始化回调函数。详情请参考QIot_MBInitCb_f 解析。

返回值

• True：  函数执行成功。
• False：函数执行失败。

---

调用示例

quint16_t portList[] = {0,1,2,3,4,5,6,7,8,9};
#define QIOT_MODBUS_PORT_MAXNUM   100
static pointer_t portFd[QIOT_MODBUS_PORT_MAXNUM] = {[0 ...(QIOT_MODBUS_PORT_MAXNUM-1)] = SOCKET_FD_INVALID};

quint32_t i;
for (i = 0; i < sizeof(portList)/sizeof(quint16_t); i++)
{
    portFd[i] = modbusUartInit(portList[i],9600,QIOT_MBUART_DATABITS_8,QIOT_MBUART_PARITY_NONE,QIOT_MBUART_STOPBITS_1);
}
/* 初始化modbus */
Ql_iotMBInit(portList,sizeof(portList)/sizeof(quint16_t),modbusUartSend,modbusInitCb);

---

QIot_MBSend_f

ModBus 组件需向串口发送数据时会调用该回调函数。用户需在该函数中实现串口发送能力。

函数原型

typedef qbool (*QIot_MBSend_f)(quint16_t port, const quint8_t *buf, quint32_t bufLen);

参数说明

• 输入参数
  • quint16_t     port：端口号。
  • const quint8_t *  buf： 需要发送的数据内容。
  • quint32_t     bufLen：需要发送的数据长度。

返回值

• True： 函数执行成功。
• False： 函数执行失败。

---

QIot_MBInitCb_f

ModBus 组件初始化完成后，将配置文件中的设备信息传入至该回调函数。用户需在该函数中实现串口收发以及设备连接平台的操作。

函数原型

typedef void (*QIot_MBInitCb_f)(char *pk, char *ps,QIot_MBUartCfg_t *uartInfo[], quint32_t uartNum);

参数说明

• 输入参数
  • char *         pk：创建产品生成的 ProductKey。
  • char *         ps：创建产品生成的 ProductSecret。
  • QIot_MBUartCfg_t *  uartInfo：配置文件中的串口配置信息。详情请参考Ql_iotMBCloudRecv()
  • quint32_t       uartNum：配置文件中的串口数量。

QIot_MBUartCfg_t

串口配置信息定义如下：

typedef struct
{
    quint16_t port;
    quint32_t baudrate;
    QIot_MBDataBits_e dataBits;
    QIot_MBParity_e parity;
    QIot_MBStopBits_e stopBits;
}QIot_MBUartCfg_t;

参数说明

类型	参数	描述
quint16_t	port	端口号
quint32_t	baudrate	波特率
QIot_MBDataBits_e	dataBits	数据位，详情请参考数据位解析
QIot_MBParity_e	parity	校验位，详情请参考校验位解析
QIot_MBStopBits_e	stopBits	停止位，详情请参考停止位解析

---

QIot_MBDataBits_e

数据位枚举定义如下：

typedef enum
{
    QIOT_MBUART_DATABITS_5  = 0,
    QIOT_MBUART_DATABITS_6  = 1,
    QIOT_MBUART_DATABITS_7  = 2,
    QIOT_MBUART_DATABITS_8  = 3,
}QIot_MBDataBits_e;

参数说明

参数	描述
QIOT_MBUART_DATABITS_5	数据位为 5bit
QIOT_MBUART_DATABITS_6	数据位为 6bit
QIOT_MBUART_DATABITS_7	数据位为 7bit
QIOT_MBUART_DATABITS_8	数据位为 8bit

---

QIot_MBParity_e

校验位枚举定义如下：

typedef enum
{
    QIOT_MBUART_PARITY_NONE  = 0,
    QIOT_MBUART_PARITY_EVEN  = 1,
    QIOT_MBUART_PARITY_ODD   = 2,
    QIOT_MBUART_PARITY_MARK  = 3,
    QIOT_MBUART_PARITY_SPACE = 4,
}QIot_MBParity_e;

参数说明

参数	描述
QIOT_MBUART_PARITY_NONE	无校验
QIOT_MBUART_PARITY_EVEN	偶校验
QIOT_MBUART_PARITY_ODD	奇校验
QIOT_MBUART_PARITY_MARK	始终为 1
QIOT_MBUART_PARITY_SPACE	始终为 0

---

QIot_MBStopBits_e

停止位枚举定义如下：

typedef enum
{
    QIOT_MBUART_STOPBITS_1   = 0,
    QIOT_MBUART_STOPBITS_1_5 = 1,
    QIOT_MBUART_STOPBITS_2   = 2,
}QIot_MBStopBits_e;

参数说明

参数	描述
QIOT_MBUART_STOPBITS_1	停止位为 1bit
QIOT_MBUART_STOPBITS_1_5	停止位为 1.5bit
QIOT_MBUART_STOPBITS_2	停止位为 2bit

---

Ql_iotMBCloudRecv

该函数用于将平台下发的物模型数据转为 ModBus 格式后发送到 ModBus 从机设备。

函数原型

qbool Ql_iotMBCloudRecv(const void *ttlvHead);

参数说明

• 输入参数
  • const void *  ttlvHead： TTLV 数据表。

返回值

• True： 函数执行成功。
• False： 函数执行失败。

---

调用示例

void *ttlvHead = NULL;
qbool ret = Ql_iotMBCloudRecv(ttlvHead);
Ql_iotTtlvFree(&ttlvHead);

---

Ql_iotMBLocalRecv

该函数用于将串口接收到的 ModBus 数据转发到 ModBus 组件中并处理。

函数原型

qbool Ql_iotMBLocalRecv(quint16_t port,quint8_t *data,quint32_t len);

参数说明

• 输入参数
  • quint16_t  port：串口端口号。
  • quint8_t *  data：串口接收到的 modbus 数据。
  • quint32_t  len：modbus 串口接收到的 modbus 数据长度。

返回值

• True： 函数执行成功。
• False： 函数执行失败。

---

调用示例

int uartId;
quint8_t buf[1024];
qint32_t bufLen = read(sockFd, buf, sizeof(buf));
Ql_iotMBLocalRecv(uartId, buf, bufLen);

---

Ql_iotMBDeinit

用于删除已经初始化的 modbus 组件。

函数原型

qbool Ql_iotMBDeinit(void);

参数说明

无。

返回值

• True： 函数执行成功。
• False： 函数执行失败。

---

调用示例

qbool ret = Ql_iotMBDeinit();

---