RaceHF Bean 协议

-> 概述
-> 开发说明
-> 定位数据协议
-> 模式设置协议
-> 系统状态
-> 参数配置
-> 有问题反馈

概述

Bean面向广大赛车爱好者，为广大车友们提供一个融合软硬件平台的优质服务产品。

产品主要特点：

32位超低功耗嵌入式处理器
支持蓝牙5.0协议
优质定位芯片，最高真实刷新率可达20hz，专为赛车应用场景优化算法。兼容GPS/GLONASS/GALILEO，内置高灵敏度陶瓷天线，可外接天线
支持空中固件升级
支持SD卡记录VBO格式文件，把记录的数据导入CTool Track attack等主流的赛车数据分析软件，实现开机即用，不再依赖手机
开放的数据通讯协议，第三方软件开发商快速开发和硬件兼容的APP
支持Andriod与IOS
支持全球使用最广泛的两个赛车数据分析APP：Harry's Laptimer和Racechrono

开发说明

设备名：RaceHF_[0-9,A-Z,a-z]{1,4} (_后面表示1~4个字母或数字)
数据和控制 Service UUID：AAA0
定位数据 Characteristic UUID：AAA1
模式设置 Characteristic UUID：AAA2
系统状态 Characteristic UUID：AAA3
参数设置 Characteristic UUID：AAA4
字节序模式：小端对齐

标准GATT服务：Battery Service、Device Information Service
参考连接： service, characteristic

Bean产品为了兼容更广泛的APP开发者，使用兼容蓝牙4.0协议通讯(MTU=23)，定位数据包内容固定为20字节。

定位数据协议

特征值：AAA1
开放权限：Notify

GPS部分包含从GPS中解析得到的数据，数据主要从NMEA格式中读取包括经纬度、时间、速度等。
GPS数据包含的内容太多，蓝牙4.0协议(MTU=23)无法一次承载全部信息，所以把GPS信息分解到两条数据包发送，用不同的index(0x10,0x11)区分。
加速度计数据包含从X-Y-Z三个方向上的加速度分量。

Index	Type	Comment
0x10	GPS Part.1	经度 / 纬度 / 海拔高度 / 定位模式
0x11	GPS part.2	UNIX时间戳 / 毫秒 / 速度 / 方位角 / HDOP / 锁定卫星数
0x21	Accelerate	X分量 / Y分量 / Z分量

GPS Part.1

GPS Part.1包含经度 / 纬度 / 海拔高度 / 定位模式 数据排列方式如下，没有内存对齐：

Byte Index	Content	Type(bytes)	Comment
0	Index	byte(1)	= 0x10，表示该数据包是GPS Part.1
1	longitude	double(8)	经度，例如：12.12345678 或 123.12345678 单位：度
9	latitude	double(8)	纬度，例如：12.12345678 or -12.12345678 单位：度
17	altitude	int16(2)	海拔高度，整数类型，单位：米
19	fix quality	byte(1)	定位模式，0:未定位，1:2D定位，2:3D定位，4:3D差分定位

C语言代码如下：

/* GNSS Pack.1 数据 */
#pragma pack(1)
typedef struct
{
  uint8_t     index;
  double      longitude;      /* 经度 */
  double      latitude;       /* 纬度 */
  int16_t     height;         /* 海拔 */
  uint8_t     locatemode;     /* 定位方式 */
} stuGPSPack1;
#pragma pack()

GPS Part.2

GPS Part.2包含 UNIX时间戳 / 毫秒 / 速度 / 方位角 / HDOP / 锁定卫星数
数据排列方式如下，没有内存对齐：

Byte Index	Content	Type(bytes)	Comment
0	Index	byte(1)	= 0x11，表示该数据包是GPS Part.2
1	unix TimeStamp	uint32(4)	UNIX时间戳，从1970/1/1以UTC-0作为时间起点
5	millsecond	uint16(2)	毫秒数，例如： 0, 100, 200, ... 900 或者更高经度：50, 150, 950等
7	speed	float(4)	速度，总是大于等于0, 单位：km/h
11	direction	float(4)	方位角，单位：度
15	hdop	float(4)	水平定位因子，表示水平定位精度因数
19	tracked satellites	byte(1)	锁定卫星数量

C语言代码如下：

/* GNSS Pack.2 数据 */
#pragma pack(1)
typedef struct
{
  uint8_t     index;
  uint32_t    seconds;        /* UNIX时间戳 */
  uint16_t    milliseconds;   /* 毫秒数 */
  float       speed;          /* 速度 */
  float       direction;      /* 方位角 */
  float       hdop;           /* HDOP */
  uint8_t     satellites;     /* 锁定卫星数 */
} stuGPSPack2;
#pragma pack()

说明

将0x10、0x11两条完整的共40字节称为一组数据。设备发送一组数据一定是0x10在前0x11在后，APP需要根据原始数据还原出对应的内容。
有小概率APP接收不到完整的一组数据包，直接丢弃整组即可

示例

如收到如下两条共一组数据包：

0x10 0x72 0x24 0x44 0xB7 0xE6 0xC7 0x5E 0x40 0x91 0x91 0xBB 0x21 0xF0 0x74 0x37 0xC0 0x7B 0x00 0x03
0x11 0x39 0x8B 0x7C 0x5D 0x5E 0x01 0x14 0xAE 0xE0 0x42 0xFA 0x3E 0xF6 0x42 0x52 0xB8 0x9E 0x3F 0x12

从第一包中可以解出：

Index = 0x10
经度原始数据为：0x72 0x24 0x44 0xB7 0xE6 0xC7 0x5E 0x40 => 经度 = 123.12345678
纬度原始数据为：0x91 0x91 0xBB 0x21 0xF0 0x74 0x37 0xC0 => 纬度 = -23.45678912
海拔原始数据为：0x7B 0x00 => 海拔 = 123米
定位模式原始数据为：0x03 => DGPS+3D模式

从第二包中可以解出：

Index = 0x11
UNIX时间戳原始数据为：0x39 0x8B 0x7C 0x5D => 时间戳：1568443193
毫秒数原始数据为：0x5E 0x01 => 毫秒数：350
速度原始数据为：0x14 0xAE 0xE0 0x42 => 速度：112.34km/h
方位角原始数据为：0xFA 0x3E 0xF6 0x42 => 方位角：123.123
HDOP原始数据为：0x52 0xB8 0x9E 0x3F => HDOP：1.24
锁定卫星数原始数据为：0x12 => 锁定卫星数量：18颗

参考代码：gps.c

Accelerate

Accelerate包含 X分量 / Y分量 / Z分量 数据排列方式如下，没有内存对齐：

Byte Index	Content	Type(bytes)	Comment
0	Index	byte(1)	= 0x21，表示该数据包是Accelerate
1	x	float(4)	X分量，单位:g
5	y	float(4)	Y分量，单位:g
9	z	float(4)	Z分量，单位:g

C语言代码如下：

/* Accel数据 */
#pragma pack(1)
typedef struct
{
  uint8_t   index;
  float     x;
  float     y;
  float     z;
} stuAccelPack;
#pragma pack()

模式设置协议

特征值：AAA2
开放权限：Write Without Response，Read，Notify

设置自动关机超时时长，文件开始记录触发方式，记录文件类型和记录文件时区。

程序中C语言结构体如下：

struct
{
  uint8_t   file_record_trigger;   /* 文件开始记录触发方式 */
  uint8_t   file_record_filetype;  /* 文件记录文件类型 */
  int8_t    file_record_timezone;  /* 文件记录文件时区 */
} content;

读可以直接获取结构体存储的所有信息。
设置需要发送配置项ID和参数内容，指令格式是：id+param
设置完毕后会回应一条结构体存储的所有信息。

示例：

读到内容：0x00 0x00 0x08
表示内容为：

速度触发文件记录

记录文件格式为VBO文件

时区为东8区

开始记录触发方式
file_record_trigger：配置id = 0x11
触发文件记录条件：0：速度触发；1：GPS触发；

0：GPS定位成功速度大于3km/h持续3s触发记录，GPS定位信号丢失超过10s或速度小于3km/h超过30s停止记录
1：GPS搜到信号开启记录，GPS信号丢失超过10s停止记录

示例：

速度触发：写 0x11 0x00
GPS触发：写 0x11 0x01

记录文件类型
file_record_filetype：配置index = 0x12
设置记录文件类型。0：VBO文件；1：RHF文件

示例：

设置记录成vbo文件：0x12 0x00
设置记录成rhf文件：0x12 0x01

记录文件时区
file_record_timezone：配置index = 0x13
设置时区：范围为{-12,12}

示例：

设置成东八区：0x13 0x08
设置成西四区：0x13 0xFC

设备控制命令
配置index = 0xA0

示例：

设备关机：0xA0 0x02

系统状态

特征值：AAA3
开放权限：Read，Notify

AAA3仅允许读系统状态，当系统状态发生改变后会主动发送通知。
为了将更多的系统信息放入一条状态内容中，使用了位域特性

程序中C语言结构体如下：

typedef struct
{
  uint8_t     battery_percent;       /* 电量百分比 */
  
  /********** 模式状态 **********/
  uint8_t     charge_mode:1;         /* 充电模式? */
  uint8_t     connect_mode:1;        /* 蓝牙已连接？ */
  uint8_t     oad_mode:1;            /* OAD模式？ */
  uint8_t     loopback_mode:1;       /* 回传模式? */
  uint8_t     :0;                    /* 位域分割 */
  
  /********** 文件记录 **********/
  uint8_t     record_hard:2;         /* 记录文件硬件？ 0：内建无操作文件系统；1：FLASH；2：SD卡 */
  uint8_t     file_mode:2;           /* 文件模式？ 0：初始化失败；1：初始化成功；2：记录文件中；3：文件记录异常 */
  uint8_t     :0;                    /* 位域分割 */
  
  /********** 系统锁 **********/
  uint8_t     gps_lock:1;            /* GPS锁 */
  uint8_t     acc_lock:1;            /* 加速度锁 */
  uint8_t     file_lock:1;           /* 文件操作锁 */
  uint8_t     :0;
  
  /********** 调试 **********/
} stuSYS;

battery_percent：
电池电量百分比。充电时始终为100

charge_mode：
是否在充电。1：正在充电；0：不在充电

connect_mode：
蓝牙是否连接。1：蓝牙已连接；0：蓝牙未连接（APP读应始终为1）

oad_mode：
是否在固件升级。1：正在固件升级；0：不在固件升级

loopback_mode：
是否在回传模式。1：当前是回传模式；0：不在回传模式

record_hard：
使用何种硬件记录数据。0：不做任何文件记录；1：FLASH记录；2：SD卡记录

file_mode：
文件记录模式状态：0：初始化失败；1：初始化成功；2：记录文件中；3：文件记录异常

gps_lock：
GPS解析任务锁（APP不用管）

acc_lock：
加速度解析任务锁（APP不用管）

file_lock：
文件记录锁（APP不用管）

示例：

读到如下数据：0x07 0x02 0x05 0x00
表示内容为：

电池电量为7%

不在充电

蓝牙已连接

不在固件升级

不在回传模式

使用FLASH记录数据

文件记录准备就绪

示例：

读到如下数据：0x64 0x03 0x0A 0x00
表示内容为：

电池电量100%（不真实，在充电模式下始终显示100%）

正在充电

蓝牙已连接

不在固件升级

不在回传模式

使用SD卡记录数据

正在记录数据

link:位域

参数配置

特征值：AAA4
开放权限：Write Without Response，Read，Notify

用于配置或读取系统中的参数。
读取参数方法：直接发送对应参数的index并将长度设置为0会立即从Notify中回应对应的内容，或稍后从Read中读取对应的内容。
设置参数方法：与AAA2相似，使用index+length+param方式，设置完后也会立即回应设置的参数，Read也可以读出设置的参数。
读取或设置的内容前两个字节分别是index和payload长度，读参数第二个字节写0x00。

index称为命令字，length表示参数长度，param为自定义参数，发送数据请求（即长度为0）的指令，按index+length+param方式返回，param部分内容即为请求的内容。
若发送的命令有误，则按如下命令格式返回（0x00开头的响应）：

返回值	含义
0x00 0x00	参数配置正确
0x00 0x01	命令字错误（没有这个命令）
0x00 0x02	长度错误，部分命令只允许读，其命令长度参数只能为0
0x00 0x03	参数错误

用户ID
id = 0x01，可读可写
字符串类型，表示设备名RaceHF_XXXX中的XXXX部分

示例：

获取用户ID：
写：0x01 0x00
立即收到通知：0x01 0x04 0x59 0x58 0x43 0x00
或读到：0x01 0x04 0x59 0x58 0x43 0x00
表示用户ID是"YXC"

设置用户ID：
写：0x01 0x03 0x59 0x58 0x43
立即收到通知：0x01 0x04 0x59 0x58 0x43 0x00
或读到：0x01 0x04 0x59 0x58 0x43 0x00
表示设置用户ID为"YXC"

重置用户ID：
写：0x01 0x01 0x00
立即收到通知：0x01 0x04 0x00 0x00 0x00 0x00
或读到：0x01 0x04 0x00 0x00 0x00 0x00
表示设置用户ID已经重置

设备型号
id = 0x02，只读
字符串类型，返回设备型号

示例：

获取设备型号：
写：0x02 0x00
立即收到通知：0x02 0x0B 0x52 0x61 0x63 0x48 0x46 0x20 0x42 0x65 0x61 0x6E
或读到：0x02 0x0B 0x52 0x61 0x63 0x48 0x46 0x20 0x42 0x65 0x61 0x6E
表示设备型号是"RaceHF_Bean"

硬件版本
id = 0x03，只读
字符串类型，返回设备硬件版本

示例：

获取硬件版本：
写：0x03 0x00
立即收到通知：0x03 0x05 0x56 0x30 0x2E 0x31
或读到：0x03 0x05 0x56 0x30 0x2E 0x31
表示硬件版本是"V0.1"

软件版本
id = 0x04，只读
字符串类型，返回设备软件版本

示例：

获取硬件版本：
写：0x04 0x00
立即收到通知：0x04 0x09 0x56 0x30 0x2E 0x32 0x2E 0x34 0x2E 0x33 0x32
或读到：0x04 0x09 0x56 0x30 0x2E 0x32 0x2E 0x34 0x2E 0x33 0x32
表示硬件版本是"V0.2.4.32"

设备ID
Id = 0x05, 只读
字节数组类型，返回包含设备ID的字节数组

示例：

获取设备ID：
写：0x05 0x00
立即收到通知：0x05 0x06 0x12 0x23 0x34 0x45 0x56 0x67
或读到：0x05 0x06 0x12 0x23 0x34 0x45 0x56 0x67
设备ID = 12:23:34:45:56:67

上次关机时间
id = 0x61，只读
4字节整数类型，返回UTC时间示例：

获取上次关机时间：
写：0x61 0x00
立即收到通知：0x61 0x04 0xDB 0x3E 0x00 0x5E
或读到：0x61 0x04 0xDB 0x3E 0x00 0x5E
上次关机时间：2019/12/23 04:13:15

PRO版本
Id = 0x81, 读写
字节数组类型，读取/配置PRO版本功能
内容部分第一个字节表示pro功能的index号

Index	Comment
1	PRO版电量
2	PRO版GPS
3	PRO版SD卡
5	PRO版加速度
0xff	所有PRO版配置/读取

示例：

读PRO版电量状态：
写：0x81 0x01 0x01
立即收到通知：0x81 0x02 0x01 0x01
或读到：0x81 0x02 0x01 0x01
表示PRO版电量已经开启

开启PRO版电量：
写：0x81 0x02 0x01 0x01
关闭PRO版电量：
写：0x81 0x02 0x01 0x00

查看所有PRO状态：
写：0x81 0x01 0xff
立即收到通知：0x81 0x05 0xff 0x01 0x00 0x00 0x01
或读到：0x81 0x05 0xff 0x01 0x00 0x00 0x01
表示PRO版电量开启，PRO版GPS未开启，PRO版SD卡未开启，PRO版加速度开启

开启所有PRO版功能：
写：0x81 0x02 0x0ff 0x01
关闭所有PRO版功能：
写：0x81 0x02 0x0ff 0x00

三星定位卫星数目
id = 0xA1，只读
字节数组类型，返回所有定位卫星数/GPS/GLONASS/GALILEO 定位卫星数量

示例：

获取三星定位卫星数目：
写：0xA1 0x00
立即收到通知：0xA1 0x04 0x0E 0x09 0x02 0x03
或读到：0xA1 0x04 0x0E 0x09 0x02 0x03 0x6E
表示回应的是id=0xA1的内容，内容长度是4字节，定位卫星数14颗，GPS卫星数为9颗，格洛纳斯卫星数为2颗，伽利略卫星数为3颗

有问题反馈

在开发中有任何问题，欢迎反馈给我

邮件：yuanxiaochen1995@gmail.com
facebook： @弁杓

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README_zh.md

README_zh.md

RaceHF Bean 协议

概述

开发说明

定位数据协议

GPS Part.1

GPS Part.2

说明

示例

Accelerate

模式设置协议

系统状态

参数配置

有问题反馈

Files

README_zh.md

Latest commit

History

README_zh.md

File metadata and controls

RaceHF Bean 协议

概述

开发说明

定位数据协议

GPS Part.1

GPS Part.2

说明

示例

Accelerate

模式设置协议

系统状态

参数配置

有问题反馈