Yumud

基于C++20的嵌入式开发框架

用C进行嵌入式开发已经落伍了，现在是面向对象与函数式编程的时代。外设天然就是一个个类，传统的面向过程与全局变量乱飞的思维显然已经不适用于编写出安全高效可复用性强的代码。

我目睹了编写着结构体以及调用初始化函数的不胜其烦的没有统一函数名的各家标准固件库；看似统一了硬件实则在库中大量使用宏去重新对不同的硬件平台作细分，缺乏对底层的精细化控制的毫无美感的Java风格C++的Arduino;与尚未摆脱真正的硬件抽象仅仅局限与STM32的HAL库，感叹嵌入式已经到了今天这样不堪的地步吗。起始不然，实时，低成本，分布式的嵌入式系统可以遍布各处，但实际上嵌入式开发夕阳西下被人唾弃，根本原因是大部分嵌入式开发中在作斗争的是编写对应平台SDK驱动的代码，而不是在其上部署高性能的算法，或许那些作顶层开发从不正眼瞧底层与写着屎山代码的“行业老者”从来没有发现嵌入式可以这样美。

利用C++的高级语法，我们可以让嵌入式开发从这些令人作呕的外设配置变成了调度抽象语义的游戏，才能够使我们编写出更快更清爽更加与现代设计模式接轨的代码,不是吗？

很多人说C++不适合用在嵌入式上，更别说STL了。实际上这样的观点大错特错，实际上我们完全能在嵌入式开发上享用最新的特性且随处使用STL。只要我们提高优化选项，手动重写nanolib(离开printf)，禁用dynamic_cast，禁用浮点改用定点，禁用异常等本就不健康的开发方式，C++的代码产生的二进制文件完全可以部署在嵌入式上。在本框架上，完全可以在32Kb不到的芯片上编写大量业务代码而不超过芯片的极限。例如，通过本框架可以在短时间内部署大量低成本节点进行组网并实现传感，控制，计算等组件的模块化。

下面是一些测试效果：

作用	描述	开销	性能
步进电机FOC驱动器	基于CH32V203(对标F103)芯片实现了完整的Can节点及FOC控制	45KB / 64KB	电流环/速度环/位置环均能以40khz+运行
机器人视觉主控板	基于CH32V307(对标F407)芯片实现了完整的Can主机以及视觉/AI/行为树的运行	128KB / 192KB	能以60fps运行视觉算法，自动完成对目标的搜索
九轴传感节点	基于CH32V203(对标F103)芯片实现了完整的Can节点及串口命令行	28KB / 32KB	微秒级解算

本库相较主流开发框架的优势：

vs arduino：

提供了对外设每一分细节的精细控制，不需要再用宏定义区分各个平台
提供了统一的设备管理层
提供了统一的抽象层所有同类外设均有对应的抽象类
提供了对常用总线的原生支持，而不是全局单例
C++化程度更高，减少Java风格的糟糕体验
大量使用模板与泛型，以实现代码的复用与泛化
大量使用stl(参考odrive)

vs HAL：

做到了真正的硬件抽象，对不同的芯片都提供的近乎相同的api
应用层与库函数完全隔离，在应用层完全不需要和厂方SDK进行交互
没有丑陋的HAL前缀表示函数的命名空间
用多态取或lambda取代函数指针的使用，减少了心智负担
所有外设通过用户自定义宏裁剪而不是工程文件管理提供了更高的自由度
将自动化生成代码与用户业务代码隔离

无需复杂的结构体配置点亮一盏led

int main(){
    //...prework()

    //通过引用获取GPIO
    //端口使用工厂模式返回GPIO，确保GPIO不会被随意构造
    auto & led = portC[13];

    //将led设置为输出模式，并以高电平初始化
    led.outpp(HIGH);

    while(true){

        //通过重载GPIO的布尔运算符以写入与读取，使得GPIO能够直接被布尔量赋值
        led = !led;
        delay(200);
    }
}

又或是开启互补PWM快速验证SPWM输出

int main(){
    //...prework()

    //将定时器①以36Khz初始化 使用字面量常量表达式来计算
    timer1.init(36_KHz);

    //使用工厂模式来获取定时器①的输出比较通道①
    auto & pwm = timer1.oc(1);
    pwm.init();

    {
        //获取互补PWM通道并初始化
        auto & pwmn = timer1.ocn(1);
        pwmn.init();

        //或者也可以直接
        timer1.ocn(1).init();
    }

    //将刹车寄存器初始化 默认为200ns
    timer1.initBdtr();

    //进入主循环
    while(true){
        // t(时间) 是一个全局变量 将在systick中被自动更改

        // 重载了PWM被数值赋值的函数 使得对它的赋值能直接改变占空比
        pwm = 0.5 + 0.5 * sin(t);
    }

    //或者也可以直接这样做

    //以0:0的中断优先级将定时器①的更新中断使能
    //使用枚举类以确保安全 
    timer1.enableIt(TimerIT::Update, {0,0});

    //使用lambda函数建立对应中断请求的回调函数
    timer1.bindCb(TimerIT::Update, [&](){pwm = 0.5 + 0.5 * sin(t);});
}

再或者通过CAN指令精细控制云台的角度

int main(){
    //...prework()

    //将CAN1以1Mbps的波特率初始化
    can1.init(1_MHz);

    //将串口一以921600的波特率初始化 默任TX和RX都使用DMA进行数据收发
    uart1.init(921600);

    //OutputStream是串口的基类 可以实现数据的打印
    OutputStream & logger = uart1;

    //建立舵机与步进电机变量
    SG90   servo   {timer1.ch(1)};
    DRV8825 stepper {timer1.ch(2);}

    //通过引用的方式建立is-a的关系 其中多继承确保只要是两个继承自角度可控类的对象均可以传入云台中
    Gimbal  gimbal  {servo, stepper};
    gimbal.init();

    real_t angle;
    while(true){
        if(can1.available()){
            //从CAN的接收FIFO中读取报文
            const auto & msg = can1.read();
            
            //使用模板以确保报文可以转换为任意类型的数据
            msg.load(angle);

            //直接就能将数据打印到串口
            logger.println("angle is:", angle);
        }

        //内部有多种向量数据类型(多维向量与四元数等)，为机器人学奠定基础
        gimbal.moveTo(Vector2(1, 0).rotated(angle));
    }
}

当我们用面向对象的方式构建起代码时一切是如此自然且清晰。我们脱离了厂家的SDK，在业务代码中就不应该和具体平台绑定。

⚠️声明

目前受到完整支持的芯片只有CH32V2/CH32V3系列，正在考虑添加将文件进一步分层，加入非SXX32风格的芯片乃至支持Linux

使用C++20编写请使用gcc12及以上的版本进行编译使用Vscode下的eide搭建开发环境

厂方sdk库已改动请使用用本仓库提供的sdk 位于sdk目录下下

大量使用iqmath在无浮点单元的情况下进行高速数学运算请选择16位IQ数（调整宏定义GLOBAL_Q）否则可能会出现意想不到的问题

🌱参与贡献

算是用来练习git的项目, 第一次使用git不太熟悉孩子自个写着玩的本框架全由作者一人编写，参考了其他代码。由于目前项目架构尚不稳定不要轻易fork！！！！！

🔨开发环境

GCC

由于本项目使用GCC进行开发（对各平台实现最大化开源），目前不打算增加对其他编译器的支持（ARMCC/ARMCLANG不支持）且本项目使用到了完整的C++20的特性进行开发，故GCC的版本不低于12

CH32系列开发：

同时由于WCH为了支持快速中断，为GCC添加了魔改的中断关键字，故应使用WCH定制的GCC12（需要安装MounRiver Studio以获取我们所需要的厂家魔改版riscv-none-elf-gcc(买椟还珠属于是了)）

VSCODE

为了提供插件EIDE的宿主以及获得遥遥领先的编码体验需要下载vscode并安装

EIDE

为了提供方便快捷开箱即用的环境体验本项目选择vscode的插件eide进行开发具体请移步 eide

OPENOCD

为了支持WCH-Link基于OPENOCD进行了定制化开发故需要安装WCH提供的OpenOCD(同样在MounRiver Studio的安装目录中可以找到)

编译选项

请使用Os/O3/Ofast进行编译，以确保代码的尺寸和运行速度被尽可能优化, 否则FLASH占用不足以支持使用

Name		Name	Last commit message	Last commit date
Latest commit History 1,152 Commits
.vscode		.vscode
algo		algo
concept		concept
docu		docu
drivers		drivers
dsp		dsp
examples		examples
hal		hal
hwspec		hwspec
nvcv2		nvcv2
robots		robots
sdk		sdk
sys		sys
targets		targets
thirdparty		thirdparty
tools		tools
types		types
.gitignore		.gitignore
.gitmodules		.gitmodules
LICENSE		LICENSE
README.md		README.md
Yumud.code-workspace		Yumud.code-workspace

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Yumud

基于C++20的嵌入式开发框架

⚠️声明

🌱参与贡献

🔨开发环境

GCC

VSCODE

EIDE

OPENOCD

编译选项

🍴目录

docu 文档

algo 数据结构与算法

dsp 信号处理

types 各种类型

nvcv2 图像处理框架

drivers 设备驱动

concept 外设的抽象基类

sys 系统

src 主要源代码

hal 物理抽象层

robots 机器人与电力学相关代码

About

Releases

Packages

Languages

License

Left-Hand/Yumud

Folders and files

Latest commit

History

Repository files navigation

Yumud

基于C++20的嵌入式开发框架

⚠️声明

🌱参与贡献

🔨开发环境

GCC

VSCODE

EIDE

OPENOCD

编译选项

🍴目录

docu 文档

algo 数据结构与算法

dsp 信号处理

types 各种类型

nvcv2 图像处理框架

drivers 设备驱动

concept 外设的抽象基类

sys 系统

src 主要源代码

hal 物理抽象层

robots 机器人与电力学相关代码

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages