readme_cn.md · Foorir/IR_People_Counter_Protocol_SDK_Digit

# 红外客流系列产品通信协议

## 一、协议简述

- 协议目前只针对红外客流数字版系列产品，后续会有其他产品对应支持此协议。后续更新记录请及时关注本仓。
- 设计此协议时，也考虑到了低功耗，低算力等设备，所以协议是直接基于TCP，使用16进制+ANSII码进行传输
- 协议考虑到了粘包、转义等特殊情况

- 适用型号：HX-HE2(WD5)

## 二、协议详解

### 2.1 协议结构

协议由8部分组成，固定报头、固定报尾、设备ID、指令、参数、数据长度、数据、CRC、帧尾

其中固定报头、固定报尾都是固定的，设备ID目前属于预留位，现在默认是32位的整数目前固定为0xFF 0xFF 0xFF 0xFF，CRC使用ModbusCRC16方式，数据部分采用逗号进行字段分割。为了防止数据部分和CRC部分出现固定报头和固定报尾的数据所以引入了转义位：0x7C。

| 固定帧头 | 固定设备ID | 指令  | 参数  | 数据长度 |  数据  | ModbusCRC16低八位 | ModbusCRC16高八位 | 固定帧尾 |
| :------: | :--------: | :---: | :---: | :------: | :----: | :---------------: | :---------------: | :------: |
|  1字节   |   四字节   | 1字节 | 1字节 |  双字节  | 不定长 |       1字节       |       1字节       |  1字节   |

- 固定帧头：0x7E
- 固定设备ID：0xFF 0xFF 0xFF 0xFF
- 指令：详见指令说明章节
- 参数：详见指令说明章节
- 数据长度：数据部分的长度int16类型，分双字传输
- 数据：ANSII字符串
- ModbusCRC16低八位：ModbusCRC16低八位
- ModbusCRC16高八位：ModbusCRC16高八位
- 固定帧尾：0x7D
- 转义字符：0x7C

#### 2.1.1 固定报头、报尾

报头为7E，到7D结束。

7E  ............  7D 这样的数据为完整的一包数据

#### 2.1.2 指令与参数

指令与参数是为了区分不同的数据类型，其中有**心跳数据**、**数据上报**、**历史数据上报**

#### 2.1.3 数据长度与数据

数据长度是为了计算数据部分的长度，是为了方便开发人员通过数据长度截取数据部分，数据部分的数据是由**字段位**、**逗号分隔符组成**。在字段定义章节里面会详细说明。

举例：

客户端发起数据：1902201010001,20220101090004,10,20,1,V4.3,E20          注：长度为45

客户端实际发起数据：00 2D 31 39 30 32 32 30 31 30 31 30 30 30 31 2C 32 30 32 32 30 31 30 31 30 39 30 30 30 34 2C 31 30 2C 32 30 2C 31 2C 56 34 2E 33 2C 45 32 30

注：其中最开始的两个字节是数据长度：0x00 0x2D。高位在前，低位在后。后面的是字符串对应的ASCII码

#### 2.1.4 ModbusCRC16校验

ModbusCRC16校验范围不包括固定帧头和固定帧尾，计算范围是：固定设备ID、指令、参数、数据长度、数据。这些位置必须参与ModbusCRC16计算。ModbusCRC16校验计算的目的是为了保证数据的准确性。C语言实现代码如下：

```c
#include "h_crc.h"

ushort const TAB_CRC16_ITU[256] =
    {
        0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
        0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
        0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
        0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
        0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
        0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
        0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
        0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
        0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
        0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
        0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
        0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
        0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
        0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
        0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
        0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
        0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
        0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
        0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
        0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
        0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
        0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
        0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
        0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
        0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
        0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
        0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
        0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
        0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
        0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
        0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
        0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040};

Bool Is_CRC16_Good(uchar *pData, uint nLength)
{
    ushort Fcs = 0xFFFF;

while (nLength > 0)
    {
        Fcs = (Fcs >> 8) ^ TAB_CRC16_ITU[(Fcs ^ *pData) & 0xFF];
        nLength--;
        pData++;
    }

if (Fcs == 0)
        return True;
    else
        return False;
}

ushort CRC16_ITU_Generate(uchar *pData, int nLength)
{
    ushort Fcs;

Fcs = 0xFFFF;
    while (nLength > 0)
    {
        Fcs = (Fcs >> 8) ^ TAB_CRC16_ITU[(Fcs ^ *pData) & 0xFF];
        nLength--;
        pData++;
    }

return Fcs;
}

```

验证数据校验时，需要将固定设备ID、指令、参数、数据长度、数据和ModbusCRC16两个字节一起再次进行校验计算，如果得出等于0，那么说明校验成功，反之则失败

#### 2.1.5 转义

转义字符的目的是为了发送方发送报文时，防止非包头、包尾的位置出现包头、包尾，这样不便于接收法解析数据。实现方法具体如下：

0x7D：变0x7C 0x5D发送

0x7E：变0x7C 0x5E发送

这里值得注意的是，如果出现了7C本身应该怎么做。同样：

0x7C：变0x7C 0x5C发送

具体实现代码如下：

发送方：

```c
case 0x7D: 
	rsbus_frame_data[rsbus_frame_data_index++] = 0x7C;
	rsbus_frame_data[rsbus_frame_data_index++] = rsbus_send.send_buf[i] - 0x20;
	break;
case 0x7E: 
	rsbus_frame_data[rsbus_frame_data_index++] = 0x7C;
	rsbus_frame_data[rsbus_frame_data_index++] = rsbus_send.send_buf[i] - 0x20;
	break;
case 0x7C: 
	rsbus_frame_data[rsbus_frame_data_index++] = 0x7C;
	rsbus_frame_data[rsbus_frame_data_index++] = rsbus_send.send_buf[i] - 0x20;
	break;
```

发送方在转义时，先发0x7C，紧接着，再减去0x20即可

接收方：

```c#
if (recv == 0x7C) 
{
	if (rec_head_flag == true) 
	{
		rec_specialData_flag = true; 
        return;
	}
}

if (rec_specialData_flag == true) 
{
    recbuf[recbuf_index++] = (byte)(recv ^ 0x20);
    rec_specialData_flag = false;

return;
}
```

接收方在收到7C的时候，需要做还原处理，具体做法就是将0x7C后面一位数据进行^ 0x20操作即可还原

### 2.2 协议指令说明

数据位传输时是以ANSII码16进制发送，这里为了方便演示，使用字符串

#### 2.2.1 心跳指令 0xD1

1.设备开机同步时间、自动上传一条心跳(平台此时可显示设备在线)

2.若设备开机同步时间失败，用户手动对码时也会发送一条心跳，用于设备同步时间。

3.设备营业时间内每半个小时上传一次心跳，用于平台判断在线离线状态。营业时间外设备不上报心跳和数据

- 发送方心跳数据指令格式

指令：0xD1

参数：缺省0x02

数据部分：[SN],[时间戳],[接收电量],[发送电量],[对码状态],[版本],[产品型号]

,：逗号，分隔符，用于分割数据

SN：13位序列号，字符串，可能会不固定长度

时间戳：当前14位时间戳，例：20220101090004

接收电量：接收端电量百分比，约4小时更新一次

发送电量：发射端电量百分比，约1小时更新一次

对码状态：发射端工作正常，如果正常对码，此字段是1，如果没有对码成功此字段是0

版本：设备软件版本号，不固定长度，如：V4.1  V1.0.1

产品型号：设备型号，不固定长度，如：E20 E2

- 接收方心跳数据回复发送方指令

指令：0xD1

参数：缺省0x02

数据部分：[状态码],[时间戳],[营业开始时间],[营业结束时间],[记录周期],[探测速度],[统计方向],[升级标志],[升级链接],[预留]

,：逗号，分隔符，用于分割数据

状态码：0成功  1失败

时间戳：接收方向下设备同步时间，设备收到后，会和接收方时间一致，并且开始从接收方的时间重新计时。例：20220101090004

营业开始时间：设备每天的开始工作时间，长度必须固定，并且24小时制。单位只有时分，例：0800、0830

营业结束时间：设备每天的结束工作时间，长度必须固定，并且24小时制。单位只有时分，例：2230、2359

记录周期：即上传周期，目前以分钟为单位。如果是0是实时模式，实时模式下需要 插入USB，最大设置不能超过一天。默认建议5分钟上报一次

探测速度：新版设备已经取消探测速度，默认0

统计方向：设备的统计计算方向，默认 0 双向、1 只进、2 只出

升级标志：0表示不升级，1表示升级设备固件，2表示升级WIFI固件。如果设备需要升级，

升级链接：如果有升级，那么升级链接就是实际的固件下载链接，如：http://dddddd.com/file.bin   注意：下载链接不支持https

预留：预留项，写0

#### 2.2.2 统计数据指令 0xD2

1、设备数据上报根据心跳返回的“记录周期”对应设备数据每次上报间隔。

2、营业时间内有数据则按上报间隔上报，没有数据，设备则每半个小时返心跳数据，平台可根据心跳判断是否在线。

- 发送方心统计数据指令格式

指令：0xD2

参数：缺省0x02

数据部分：[SN],[时间戳],[进人数],[出人数],[接收电量],[发送电量],[对码状态],[版本],[产品型号]

,：逗号，分隔符，用于分割数据

SN：13位序列号，字符串，可能会不固定长度

时间戳：当前14位时间戳，例：20220101090004

进人数：在记录周期里面的总进人数

出人数：在记录周期里面的总出人数

接收电量：接收端电量百分比，约4小时更新一次

发送电量：发射端电量百分比，约1小时更新一次

对码状态：发射端工作正常，如果正常对码，此字段是1，如果没有对码成功此字段是0

版本：设备软件版本号，不固定长度，如：V4.1  V1.0.1

产品型号：设备型号，不固定长度，如：E20 E2

- 接收方心跳数据回复发送方指令

指令：0xD2

参数：缺省0x02

数据部分：[状态码],[时间戳],[升级标志],[升级链接]

状态码：0成功  1失败  接收方收到失败后，会把此条数据，当作失败数据，等到下一个上报周期再上报，以此内推

时间戳：当前14位时间戳，例：20220101090004

升级标志：0表示不升级，1表示升级设备固件，2表示升级WIFI固件。如果设备需要升级，

升级链接：如果有升级，那么升级链接就是实际的固件下载链接，如：http://dddddd.com/file.bin   注意：下载链接不支持https

#### 2.2.3 失败统计数据指令 0xD3

指令：0xD3

参数：缺省0x02

数据部分：同0xD2命令

注：收发数据格式同0xD2，指令变为0xD3

## 三、收发交互示例

**设备开机**

&dArr;

**设备发起心跳**

HEX：7E FF FF FF FF D1 02 00 33 31 39 35 32 33 30 37 32 38 30 32 36 39 2C 32 30 32 33 30 31 30 31 30 39 30 30 30 30 2C 34 39 2C 34 37 2C 30 2C 56 35 2E 33 38 2D 45 4E 2C 48 58 2D 48 36 7D

数据部分：1952307280269,20230101090000,49,47,0,V5.38-EN,HX-H6

平台回复：7E FF FF FF FF D1 D1 00 26 30 2C 32 30 32 34 30 31 32 34 31 38 34 31 30 31 2C 30 30 30 30 2C 32 33 35 39 2C 31 2C 30 2C 30 2C 30 2C 30 2C 30 4E B6 7D

数据部分：0,20240124184115,0000,2359,1,0,0,0,0,0

&dArr;

**设备发起统计数据**

HEX：7E FF FF FF FF D2 02 00 37 31 39 35 32 33 30 37 32 38 30 32 36 39 2C 32 30 32 34 30 31 31 35 31 35 31 38 30 37 2C 30 2C 31 2C 34 39 2C 34 37 2C 31 2C 56 35 2E 33 38 2D 45 4E 2C 48 58 2D 48 36 00 7F 7D

数据部分：1952307280269,20240115151807,0,1,49,47,1,V5.38-EN,HX-H6

平台回复：7E FF FF FF FF D2 D2 00 18 30 2C 32 30 32 34 30 31 32 34 31 37 34 35 32 37 2C 30 2C 30 97 E5 7D

数据部分：0,20240124174551,0,0

Foorir/IR_People_Counter_Protocol_SDK_Digit

简介

发行版

贡献者

近期动态

Foorir/IR_People_Counter_Protocol_SDK_Digit .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

Foorir/IR_People_Counter_Protocol_SDK_Digit