3 Star 2 Fork 0

y-cz / y_protocol

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

y_protocol

1. y_protocol 介绍

一种用于嵌入式设备的简单通信协议,可以方便用于设备芯片间的通信。

2. y_protocol 使用说明

y_protocol 目前包含两个源码文件 y_protocol.c 和 y_protocol.h 文件,使用时无需其他设置。

示例:

#include <stdio.h>
#include <stdlib.h>
#include "y_protocol.h"
#include "y_log.h"

int main() {

    // 打印版本号
    y_protocol_print_version();

    // 打包解包示例
    PROTOCOL_MSG_st msg;
    msg.mod_id     = 1;
    msg.cmd_id     = 2;
    msg.cmd_size   = 3;
    uint8_t buf[4] = {4, 5, 6};
    msg.cmd_data   = buf;

    // 打包数据
    YLOG_CRLF();
    YLOGI("********** pcak msg **********");
    uint8_t *send_data;
    uint16_t send_size;
    if (y_protocol_pack(PROTOCOL_MSG, &msg, &send_data, &send_size) == true) {
        YLOG_DATA("pack msg", send_data, send_size);
        // free(send_data);
    }
    
    // 解包数据
    YLOG_CRLF();
    YLOGI("********** unpcak msg **********");
    PROTOCOL_MSG_st *p_msg;
    y_protocol_unpack(PROTOCOL_MSG, send_data, send_size, (void **) &p_msg);
    YLOGI("p_msg->mod_id         %d", p_msg->mod_id);
    YLOGI("p_msg->cmd_id         %d", p_msg->cmd_id);
    YLOGI("p_msg->cmd_size       %d", p_msg->cmd_size);
    YLOG_DATA("p_msg->cmd_data", p_msg->cmd_data, p_msg->cmd_size);

    // 释放内存
    free(p_msg->cmd_data);
    free(p_msg);

    free(send_data);

    return 0;
}


// 输出结果
[INFO ][0252][    y_protocol_print_version] ----- <  y_protocol module version : V0.1.0  >

[INFO ][0018][                        main] ----- <  ********** pcak msg **********  >
[DATA ][0022][                        main] ----- <  pack msg 6 byte :  >
[DATA ][0022][                        main] ----- <  01 02 03 04 05 06  >

[INFO ][0029][                        main] ----- <  ********** unpcak msg **********  >
[INFO ][0032][                        main] ----- <  p_msg->mod_id         1  >
[INFO ][0033][                        main] ----- <  p_msg->cmd_id         2  >
[INFO ][0034][                        main] ----- <  p_msg->cmd_size       3  >
[DATA ][0035][                        main] ----- <  p_msg->cmd_data 3 byte :  >
[DATA ][0035][                        main] ----- <  04 05 06  >

3. 依赖

y_protocol 目前依赖于以下代码库

  1. y_log :   依赖于 y_log 进行格式日志打印
  2. y_clangformat :   依赖于 y_clangformat 保持代码格式统一

4. 版本说明

V0.2.1

  1. 去掉 一对多 协议
  2. 修改断言逻辑为断言宏

V0.2.0

  1. 修改协议为 一对一 一对多 多对多 三种形式

V0.1.5

  1. 增加转存接口
  2. 增加私有 LORA 协议类型

V0.1.4

  1. 删除一些未使用的代码
  2. 修改断言逻辑

V0.1.3

  1. 增加协议累加和校验

V0.1.2

  1. 修改消息长度为两个字节

V0.1.1

  1. 修复开辟 json 字符串空间时,指针类型错误

V0.1.0

  1. 实现 简单消息格式 和 json格式 的协议打包、解包功能,预留用户自定义协议的接口。
MIT License Copyright (c) 2021 y-cz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

一种用于嵌入式设备间的简单通信协议 展开 收起
C
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C
1
https://gitee.com/y-cz/y_protocol.git
git@gitee.com:y-cz/y_protocol.git
y-cz
y_protocol
y_protocol
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891