Skip to content

XDU-IRobot/librm

Repository files navigation

librm

build docs CodeFactor

All-in-one、跨平台Robomaster嵌入式软件开发框架,为多种硬件平台提供统一的外设API、设备驱动和算法库。电控组需要的一切都在这里。

  • STM32F/H
  • Linux PC
  • Raspberry Pi/Orange Pi
  • Jetson

使用类似Arduino的语法,快速操作手中的硬件和编写业务逻辑,无需重复造驱动轮子和算法轮子。

使用方法

编译所需最低C++标准为C++17。(GCC7、clang16)

Linux

  1. 下载仓库。注意为了连同第三方库一起下载,clone时需要使用--recursive参数:

    git clone --recursive https://github.com/IRobot-EC-2024/librm.git
  2. 在CMakeLists.txt里把整个仓库添加为子目录,并把rm静态库链接到需要使用本框架的构建目标上;

    add_subdirectory(<仓库路径>)
    target_link_libraries(<目标> PUBLIC rm)
  3. 开始使用。使用方法请参考examples文件夹下的例程。

STM32

方法同上,但需要注意:

  • librm的STM32部分基于HAL库开发,且依赖STM32CubeMX生成的CMake工程。请确保工程中存在CubeMX自动生成的stm32cubemx CMake target。

  • librm的STM32外设封装依赖HAL库提供的Register Callback功能,请自己手动修改HAL库配置,或者在CubeMX里设置,启用要使用的外设的Register Callback:

API文档

API文档可以使用Doxygen构建,也可以在这里查阅。

doxygen ./Doxyfile

正确构建后,文档会被放在docs/文件夹下。

About

跨平台Robomaster嵌入式软件开发框架

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages