利用Pybind11封装Python版的WiringPi！

原版的WiringPi是一个用于树莓派的GPIO库，用C语言开发，仓库地址：https://github.com/WiringPi/WiringPi。该库允许用户以编程方式访问和控制树莓派的GPIO引脚。而随着Python在嵌入式设备上的快速发展，其对底层引脚的操作也变得越来越多，因此将WiringPi中的API接口封装出对应的Python接口显得格外重要了。

目前是有这个库的Python版本：https://github.com/WiringPi/WiringPi-Python，是利用swig这个工具自动读取头文件完成相关接口的封装，但该方式从使用角度来看存在以下几点问题：

  • 灵活性不够强。比如：某些函数返回值通过输入的指针来传递，这种swig就没法有效识别。
  • 未封装注释，且开发时无法弹出其中的API。开发时无法知道so文件内有什么函数，只能通过尝试去找相关用法。
  • 存在重定义问题。WiringPi是C语言，部分头文件存在重定义问题。

Python的最大优势就是降低开发者的使用难度，因此上述这个仓库并未良好的展示出这一特点。考虑到Pybind11是一款广为使用的封装工具，熟知的pytorch就是基于这个工具将其C++接口封装为python的。因此，我就借用Pybind11来提供一个超好用的Python版的WiringPi！！！！

🌈仓库地址：https://github.com/Li-Zhaoxi/Pybind11-WiringPi

下面将介绍怎么安装编译Python版的WiringPi，并介绍了使用方法，以及这段时间的开发历程。

💡💡特别感谢晟哥在使用体验上提供的宝贵建议😎😎

文章目录

  • 一 工具包编译
  • 二 使用方式
  • 三 开发过程
  • 四 小结

一 工具包编译

在编译前，有以下几点需要注意下：

  • 目前封装的WiringPi的仓库地址是https://gitee.com/study-dp/WiringPi，仅适用于地平线开发板。其他开发板比如树莓派等，我手上暂时没有，在后续开发中会慢慢补上，各位可以多多关注仓库主页以及Release信息。
  • Python包依赖C++库，编译时候会安装到系统环境中。在之后迭代时我打算将编译出的so文件都放在包这个路径下，而且编译过程全部自动化处理。

我说下封装的思想，Python包是在现有C++动态库的基础上进行的二次封装，这样在C++项目中和Python项目中只会启动一个so文件，起到节省内存的作用。

  • 如果你想从头编译本项目，编译安装流程如下：
# 安装依赖包
sudo pip3 install mypy ninja# 下载项目，recursive必须要加
git clone --recursive https://github.com/Li-Zhaoxi/Pybind11-WiringPi
cd Pybind11-WiringPi# 安装依赖的WiringPi C动态库
cd 3rdparty/WiringPi-RDK
./build
cd ../..# 安装Pybind11
cd 3rdparty/pybind11
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=OFF ..
sudo make install
cd ../../..# 编译出用于安装的python.whl
python3 setup.py bdist_wheel# 安装我们编译好的包
sudo pip3 install dist/WiringPi*.whl
  • 如果你想利用我编译好的whl文件，可以从这里下载编译好的whl文件WiringPi-0.1.0-cp38-cp38-linux_aarch64.whl，之后编译安装流程如下：
# 下载项目，recursive必须要加
git clone --recursive https://github.com/Li-Zhaoxi/Pybind11-WiringPi
cd Pybind11-WiringPi# 安装依赖的WiringPi C动态库
cd 3rdparty/WiringPi-RDK
./build
cd ../..# 安装提供的python包，<path>表示包存放的根目录
sudo pip3 install <path>/WiringPi-0.1.0-cp38-cp38-linux_aarch64.whl

输入python3，如果能正确import WiringPi，就表明你已经正确安装当前项目，可以快乐开发了。

二 使用方式

先放使用效果图，在import WiringPi之后，你可以直接看到包内的所有函数接口以及相关的注释。每个函数我都将C语言中的注释迁移过来了，而且我从使用角度对函数的api进行了微调！！！（还不快快谢谢小玺玺→_→）
在这里插入图片描述
我已经在项目主页的README中补充了包中所有的函数/变量的层级关系及接口声明。这样如果我们知道要调用的函数名，可以直接在项目主页中搜索这个函数名，得到调用方式。比如softPwmCreate这个函数的调用方式就是from WiringPi.softdriven import softPwmCreate。
在这里插入图片描述

三 开发过程

这里我聊聊聊聊自己的开发细节，先说说为啥自己心血来潮要封装WiringPi，首先是因为去年Arui在利用X3的PWM接口时，官方提供的python版本的控制PWM出现抖动的问题，C++版本的wiringPi能满足要求，但没法python调用。当时快速给他用Cython包装了他要的接口，已经验证通过了。然而最近另一位开发者要使用这个东西，但是在他的板子上怎么也运行不起来，我又没太多时间教他怎么配置这个，为了减少各位在这种造轮子上花费的时间，所以我要将WiringPi这个库彻底封装。

该项目从1月10日创建，到目前出了一版，用了1个月的时间，在构造这个项目的时候，我就一直在思考构造一个“好用”的Package都要考虑什么，目前我想到的点主要有以下这些：

  • 接口设计。Python的习惯是利用返回值返回数据，而C语言是通过传递指针来输出数据的。我需要理解每个函数的用法，并制定相关的优化方式。
  • 安装简化。用最少的指令完成项目的编译与安装。即，利用pip install安装包，利用python setup.py生成包。
  • 注释完善/辅助开发。利用好vscode开发的自动弹出功能，展示函数的接口以及相关的注释，让内容变得透明。
  • 撰写好用的开发文档。从博客/项目readme等角度，减少用户的学习成本。

除了“接口设计”这一部分是开发部分的工作，其他的工作都是围绕着生态展开的，由此也可见生态是多么重要。封装WiringPi这个是个大工程，下面列举出我在开发时为了提升使用体验做出的努力😎：

  • 检查了所有函数的接口，并对其中一些函数的使用方式进行了优化。比如

    • 对于通过输入参数类型为指针来返回值的，通过lambda表达式进行了新的定义。函数void wiringPiVersion(int *major, int *minor)返回的版本信息，存储在major, minor中，这样我就可以将其封装为封装在返回值中，在py中可以通过major, minor = wiringPiVersion()的方式进行调用。
    • 优化了一些实际返回值是int但实际上应该是bool的函数。C语言中用1,0表示true,false，防止py使用时产生疑惑，我从其实现代码中将只返回0,1的函数返回类型改为bool。
    • 输入参数包含数组的函数，适配为输入np.ndarray的形式。比如函数void ds1302clockWrite(const int clockData[8]);需要输入一个包含8个元素的数组，对应的python声明为def ds1302clockWrite(clockData: numpy.ndarray[numpy.int32]) -> None，代码中会自动校验元素个数。
    • 按照传感器的类型进行了分类与整合。比如GPIO扩展芯片mcp23s08, pcf8574，我把相关的函数封装在WiringPi.gpio模块里。

  • 简化安装过程，编译这个包只需要python3 setup.py bdist_wheel即可。

    • 在setup.py过程中就已经完成了辅助开发的构造。封装c++生成的so文件，vscode是无法弹出其中的函数的，也就意味着so文件对用户来说是不透明的。所以必须基于so文件生成对应的.pyi声明文件。
      • 最开始使用的是pybind11-stubgen，但是问题较多，C++17的特性支持的一般，研究测试了一段时间后放弃。
      • 目前使用的是mypy来导出大部分函数的声明与注释。但是奇怪的是每个模块的doc无法导出，只能在setup.py中补充个后处理函数来解决这个问题。
    • 在setup.py中利用cmakelists.txt对模块进行编译。就是将正常编译cmake项目关联的指令整理在一起，完成自动编译。当然由于包含模块的后处理之类的，这里对其中的一些关键函数进行了重载。

  • 整理了所有函数的注释。WiringPi中很多注释是写在.c文件里了，我把这些注释都封装在pybind中，量真的很大😭。

开发中我经常能遇到undefined symbol的问题，这里记录下导致这个问题的几种情况。
在这里插入图片描述

  • 头文件忘记extern "C"。比如报错说是_Z10rht03Setupii是个未定义的符号，
    • 首先利用c++filt _Z10rht03Setupii解析出函数声明：rht03Setup(int, int)
    • 然后nm -g /usr/local/lib/libwiringPi.so列举出这个库是否包含rht03Setup
    • 发现库包含这个函数，所以看头文件，发现没写extern "C"。这会导致C++项目链接到这个库时，无法引用相关的函数。补充上即可。
      在这里插入图片描述
  • Makefile漏掉了某些.c文件，比如softServo这个就没编译。同样，我利用nm工具发现库中就没这个函数，就直接去检查是否编译了。修复这个问题就能正常使用了。

四 小结

这一个月，下班回家后就开始研究封装相关的技术和工具，几乎天天从11点整理到2点，其实如果只是封装的话并不难，主要是很多传感器我要分类，我要研究用法。而且经常凌晨拉着晟哥哥讨论怎么设计结构，获取使用体验等等（真的感谢）。真心希望各位后续不会在接口的使用上困住。

WiringPi这个项目还有很多工作要做，在未来的工作中还需要继续完善与优化，还请各位多多关注仓库主页：Pybind11-WiringPi。后续的工作主要还是围绕以下几点：

  • 增加BPU推理python自定义层的支持。目前自定义层仅用于c++推理，导致部分模型，比如HED边缘检测算法，部署难度大幅增加。
  • 增加树莓派引脚的适配。我目前使用的WiringPi是地平线X3开发板专用的，为了避免对树莓派用户开发干扰，会补充个全局变量来解决。这部分工作其实就是解决设备兼容问题，欢迎树莓派用户一起来搞。
  • 尽可能补充各个模块函数的使用demo。降低用户的学习/开发成本。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/676442.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

【人工智能】聊聊Transformer，深度学习的一股清流(13)

【人工智能】聊聊Transformer，深度学习的一股清流(13)

嘿&#xff0c;大家好&#xff01;今天我们来聊一聊深度学习领域的一位“大明星”——Transformer模型。这个模型的提出可不得了&#xff0c;让自然语言处理领域焕发了新生。 在深度学习领域&#xff0c;Transformer模型架构的引入标志着一场革命&#xff0c;它改变了自然语言处…
阅读更多...
linux系统定时任务管理

linux系统定时任务管理

crontab使用 一、crontab简介 crontab 这个指令所设置的工作将会循环的一直进行下去&#xff01;可循环的时间为分钟、小时、每周、每月或每年等。crontab 除了可以使用指令执行外&#xff0c;亦可编辑 /etc/crontab 来支持。 至于让 crontab 可以生效的服务则是 crond 这个服…
阅读更多...
【开源】基于JAVA+Vue+SpringBoot的假日旅社管理系统

【开源】基于JAVA+Vue+SpringBoot的假日旅社管理系统

目录 一、摘要1.1 项目介绍1.2 项目录屏 二、功能模块2.1 系统介绍2.2 QA 问答 三、系统展示四、核心代码4.1 查询民宿4.2 新增民宿评论4.3 查询民宿新闻4.4 新建民宿预订单4.5 查询我的民宿预订单 五、免责说明 一、摘要 1.1 项目介绍 基于JAVAVueSpringBootMySQL的假日旅社…
阅读更多...
《小狗钱钱》读书笔记——如何看待金钱

《小狗钱钱》读书笔记——如何看待金钱

目录 前言 作者 经典摘录 1、 了解致富的规律&#xff0c;一开始&#xff0c;必须明确金钱对你的意义 2、 梦想储蓄罐和梦想相册 3、认真去找机会 4、主人公吉娅的财富路径 5、注意财富积累本质 写在最后 前言 尽管[ 智慧是无法传授的], 但读书可以启发思路&#xff0…
阅读更多...
30岁还一事无成，怎么办？

30岁还一事无成，怎么办？

前些日子&#xff0c;知乎有一个话题&#xff0c;特别火。 原话是&#xff1a;30岁&#xff0c;如果你还没当上管理层&#xff0c;或者在某个领域取得成就&#xff0c;那你一辈子基本也就这样了。 这句话一出&#xff0c;戳中了许多人的软肋&#xff0c;一时间群情哗然。 理由是…
阅读更多...
Electron基本介绍

Electron基本介绍

Electron基本介绍 Electron 官方网站&#xff1a;https://www.electronjs.org/zh/ Electron安装方法&#xff1a;npm install electron -g 全局安装 Electron简介&#xff1a;Electron提供了丰富的本地&#xff08;操作系统&#xff09;API&#xff0c;使你能够使用纯JavaScr…
阅读更多...
golang设置

golang设置

golangci-lint 代码检查工具的集合&#xff0c;聚集了多种 Go 代码检查工具&#xff0c;如 golint 会自动查找项目中的 .golangci.yml 配置文件 会检查代码中潜在常见问题以及代码风格问题 # 文档&#xff1a;https://golangci-lint.run/ # https://github.com/golangci/golang…
阅读更多...
leetcode——滑动窗口题目汇总

leetcode——滑动窗口题目汇总

本章总结一下滑动窗口的解题思路&#xff1a; 在字符串中使用双指针 left 和 right 围成的一个左闭右开的区域作为一个窗口。不断将 right 向右滑动&#xff0c;直到窗口中的字符串符合条件。此时将 left 向右滑动&#xff0c;直到窗口中的字符串不符合条件&#xff0c;期间需…
阅读更多...
Django中的SQL注入攻击防御策略

Django中的SQL注入攻击防御策略

Django中的SQL注入攻击防御策略 SQL注入是一种常见的网络安全威胁&#xff0c;可以导致数据库被非法访问和数据泄露。本文将介绍在Django框架中防止SQL注入攻击的关键方法&#xff0c;包括使用参数化查询、使用ORM、进行输入验证和使用安全的编码实践。 SQL注入是一种利用应用程…
阅读更多...
SpringBoot：多环境配置

SpringBoot：多环境配置

多环境配置demo代码&#xff1a;点击查看LearnSpringBoot02 点击查看更多的SpringBoot教程 方式一、多个properties文件配置 注意&#xff1a;创建properties文件,命名规则&#xff1a;application-&#xff08;环境名称&#xff09; 示例&#xff1a;application-dev.proper…
阅读更多...
循环神经网络（RNN）简介与应用

循环神经网络（RNN）简介与应用

循环神经网络&#xff08;RNN&#xff09;简介与应用 一、RNN基本概念二、RNN原理解析2.1 RNN网络结构RNN网络主要组件输入层(Input)&#xff0c;隐藏层(Hidden State)&#xff0c;输出层(Output)循环单元(Recurrent Unit)权重参数(Weights)和偏置项(Bias) RNN的数据流向时间步…
阅读更多...
算法刷题day10

算法刷题day10

目录 引言一、最长上升子序列二、地宫取宝三、波动数列 引言 今天是大年三十&#xff0c;提前祝大家新的一年天天开心&#xff0c;事事如意&#xff0c;过年把身体精神修养好后&#xff0c;年后继续朝着目标奋斗&#xff0c;然后加油吧&#xff01; 一、最长上升子序列 标签&…
阅读更多...
Android截屏方法

Android截屏方法

// 截屏方法private void getSnapshot() {wView.measure(View.MeasureSpec.makeMeasureSpec(0, View.MeasureSpec.UNSPECIFIED), View.MeasureSpec.makeMeasureSpec(0, View.MeasureSpec.UNSPECIFIED));wView.layout(0, 0, wView.getMeasuredWidth(), wView.getMeasuredHeight(…
阅读更多...
U3D记录之FBX纹理丢失问题

U3D记录之FBX纹理丢失问题

今天费老大劲从blender建了个模型&#xff0c;然后导出进去unity 发现贴图丢失 上网查了一下 首先blender导出要改设置 这个path mode要copy 然后unity加载纹理也要改设置 这里这个模型的纹理load要改成external那个模式 然后就有了&#xff0c;另外这个导出还有好多选项可…
阅读更多...
Python判断列表A中是否有元素出现在了列表B中

Python判断列表A中是否有元素出现在了列表B中

目录 1. 问题重述2. 问题求解2.1 暴力法2.2 哈希表法2.3 集合法 3. 总结 1. 问题重述 给定两个列表 A A A 和 B B B&#xff0c;它们的长度分别为 n n n 和 m m m。我们要检查的是&#xff0c;是否存在 x ∈ A x\in A x∈A&#xff0c;使得 x ∈ B x\in B x∈B。 以下介…
阅读更多...
Java项目maven打包的包名设置（finalname标签的使用）

Java项目maven打包的包名设置（finalname标签的使用）

天行健&#xff0c;君子以自强不息&#xff1b;地势坤&#xff0c;君子以厚德载物。 每个人都有惰性&#xff0c;但不断学习是好好生活的根本&#xff0c;共勉&#xff01; 文章均为学习整理笔记&#xff0c;分享记录为主&#xff0c;如有错误请指正&#xff0c;共同学习进步。…
阅读更多...
C#用Array类的Reverse方法反转数组中元素

C#用Array类的Reverse方法反转数组中元素

目录 一、Array.Reverse 方法 1.重载 2.Reverse(Array, Int32, Int32) 3. Reverse(Array) 4.Reverse(T[]) 5. Reverse(T[], Int32, Int32) 二、实例 1.Array.Reverse 方法4种重载方法综合实例 2.Reverse(Array)方法的实例 一、Array.Reverse 方法 反转一维 Array 或部…
阅读更多...
wireshark分析数据包：追踪流

wireshark分析数据包：追踪流

打开追踪流的界面 方法 1 方法 2 选中数据包&#xff0c;右键弹出菜单 说明&#xff1a; 流内容的显示顺序和它在网络上出现的顺序相同。不可打印的字符被点代替。从客户端到服务器的流量被标记为红色&#xff0c;而从服务器到客户端的流量被标记为蓝色。这些颜色可以通过下…
阅读更多...
numpy基础之transpose

numpy基础之transpose

1 numpy基础之transpose 用法 ndarray.transpose(*axes)描述 根据axes将ndarray数组进行转置。 入参 axes&#xff1a;可选&#xff0c;元组或列表。若指定&#xff0c;则元素个数必须为数组轴大小(ndarray.ndim)&#xff0c;元素值的范围为[0,1,2,…,ndarray.ndim-1]&…
阅读更多...
Python（22）正则表达式中的“限定符”

Python（22）正则表达式中的“限定符”

大家好&#xff01;我是码银&#x1f970; 欢迎关注&#x1f970;&#xff1a; CSDN&#xff1a;码银 公众号&#xff1a;码银学编程 获取资源&#xff1a;公众号回复“python资料” 限定符功能?匹配前面的字符0次或1次匹配前面的字符1次或多次*匹配前面的字符0次或多次{n…
阅读更多...
最新文章

Copyright @ 2022~2023