1 Star 0 Fork 0

许师傅 / poem

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

【Funpack 2-5】基于ESP32-S3-Box-Lite和CircuitPython的电子诗词阅读器

[TOC]

一、项目概述

本项目基于ESP32-S3-Box-Lite套件和CircuitPython固件,实现了一个电子诗词阅读器。本项目旨在将传统文化与现代科技相结合,为用户提供一种全新的诗词阅读体验。本项目参与了得捷电子和硬核学堂联合举办的Funpack第二季第五期活动

二、设计思路

本项目硬件基于ESP32-S3-Box-Lite套件,固件使用CircuitPython 8.2.1(官方支持了ESP32-S3-Box-Lite开发套件),软件代码基于CircuitPython内置包和一些扩展包,使用PyCharm IDE编写。

主要设计思路如下:

  • 硬件使用ESP32-S3-Box-Lite,主要用到显示屏、按键、WiFi等功能;
  • 固件使用CircuitPython,官方支持了ESP32-S3-Box-Lite开发板,固件自带库支持了显示屏、WiFi功能,可以满足基本功能要求;
  • 软件使用了CircuitPython内置包和扩展包,内置包主要使用os,time,gc,json等包,扩展包主要使用adafruit_bitmap_font,adafruit_display_text,adafruit_reqeusts等;
  • 业务功能实现,主要包括WiFi联网、HTTP请求、JSON解析、界面绘制、UI交互,基于CircuitPython内置包和扩展包实现;

设计思路的整体框图如下所示:

e-poem-reader.png

三、硬件介绍

3.1 ESP32-S3-BOX-LITE 简介

ESP-BOX 是乐鑫发布的新一代 AIoT 开发平台,ESP32-S3-BOX-Lite 开发套件配备了一块 2.4 寸 LCD 显示屏、双麦克风、一个扬声器、两个用于硬件拓展的 Pmod™ 兼容接口和3个独立按键,可构建多样的 HMI 人机交互应用。开发板可实现离线语音唤醒和命令词识别,支持乐鑫自研的高性能声学前端算法构建语音交互系统。开发者可利用开源的 SDK轻松构建在线离线语音助手、智能语音设备、HMI 人机交互设备、多协议网关等多样的应用。

3.2 前面板按键原理图

查阅ESP32-S3-Box-Lite原理图,可以知道——前面板三个按键是通过ADC进行区分的:

Untitled

可以看到,前面板的键盘子板连接在主控芯片的GPIO1上。

3.3 启动键原理图

查阅ESP32-S3-Box-Lite原理图,可以找到侧边的启动和复位按键的部分:

Untitled

Untitled

可以看到,BOOT按键连接在主控芯片的GPIO0上。

四、软件介绍

不同于使用C语言进行嵌入式软件开发,底层驱动库代码和应用代码需要编译到同一份固件中,一次烧录到设备的二进制代码同时包含驱动代码和应用代码。使用CircuitPython或者MicroPython进行嵌入式开发时,固件和应用代码是完全分离的。

本文将软件部分和固件部分分别介绍,正是因为在开发过程中这两部分相对独立。但宽泛的来说,固件也属于一种软件,本章节重点介绍的是——不包含在固件内的Python代码部分,具体包括一些CircuitPython扩展软件包和业务功能实现代码。

4.1 CircuitPython简介

固件使用的是ESP32-S3-Box-Lite版的CircuitPython,下载页面: ESP32-S3 Box Lite - 16MB Flash, 8MB PSRAM (circuitpython.org)

使用CuicirPython最大的好处是,Adafruit已经对ESP32-S3-Box-Lite开发板做了支持,板子的绝大部功能都可以开箱即用,包括wifi、LCD功能,同时Flash、RAM配置也是正确的可以充分利用设备的运行内存和存储空间。

另外Adafruit提供了大量包,基于这些软件包进行一些功能扩展和二次开发也非常方便,例如本项目中使用到的adafruit_bitmap_font、adafruit_display_text、adafruit_requests。

4.2 导入的软件包

本项目使用到的CircuitPython扩展软件包有:

  • adafruit_bitmap_font,用于支持位图字体库
  • adafruit_display_text,用于支持文本框控件
  • adafruit_requests,用于实现HTTP请求

另外,还使用到了CircuitPython内置包:

  • digitalio,GPIO功能接口
  • analogio,ADC功能接口
  • displayio,显示功能接口
  • board,引脚别名,用microcontroller包也可以

以及Python原生包:

  • gc,用于主动触发垃圾回收
  • time,用于实现延时操作
  • json,用于实现json字符串解析

4.3 业务功能实现

目前整个业务功能代码实现全部位于一个文件内,按照过程式凡事设计为一系列函数。

业务功能实现代码主要包括:

  • WiFi联网
  • HTTP请求
  • JSON解析
  • 界面绘制
  • UI交互

下面分别介绍相关功能实现的代码片段。

WiFi联网功能,主要代码片段:

Untitled

HTTP请求和JSON解析功能,主要实现代码:

Untitled

JSON解析,调用json.loads即可解析字符串。

目录界面绘制,主要实现代码:

Untitled

绘制选择光标、选择交互界面,包括翻页功能:

Untitled

显示诗词内容界面:

Untitled

底部会显示行数的进度。

诗词内容交互,包括长诗词的翻页功能:

Untitled

五、活动心得

本次活动项目是我第一次使用CircuitPython,虽然此前也接触过不少开发板,但基本上是以C/C++开发为主。本次项目整个完成的过程中,最大的体会是感叹CircuitPython的功能完善和强大,比如这次的电子诗词阅读器软件业务代码仅用了不到500行Python代码就实现了,虽然界面比较丑陋。另外Adafruit提供的文档和示例也非常的丰富。

项目开源代码库地址,包括预处理之后的诗词数据:https://gitee.com/swxu/poem/

六、参考链接

  1. Funpack第二季第5期活动页面: Digikey Funpack (eetree.cn)
  2. ESP32-S3-Box-Lite原理图: SCH_ESP32-S3-BOX-Lite_MB_V1.1_20211221.pdf (gitee.com)
  3. ESP32-S3-Box-Lite CircuitPython固件下载页面: ESP32-S3 Box Lite - 16MB Flash, 8MB PSRAM (circuitpython.org)
  4. PyCharm IDE下载页面: https://www.jetbrains.com/pycharm/download/
  5. 文泉驿中文字体pcf位图格式: https://sourceforge.net/projects/wqy/files/wqy-bitmapfont/1.0.0-RC1/wqy-bitmapsong-pcf-1.0.0-RC1.tar.gz
  6. CircuitPython外设控制教程: CircuitPython Essentials | CircuitPython Essentials | Adafruit Learning System
  7. CircuitPython显示控制教程:Introduction | CircuitPython Display Support Using displayio | Adafruit Learning System
  8. CircuitPython字体定制教程:https://learn.adafruit.com/custom-fonts-for-pyportal-circuitpython-display
  9. CircuitPython内置包wifi参考文档: wifi — Adafruit CircuitPython documentation
  10. CircuitPython内置包analogio参考文档: analogio – Analog hardware support — Adafruit CircuitPython documentation
  11. CircuitPython内置包digitalio参考文档: digitalio – Basic digital pin support — Adafruit CircuitPython documentation
  12. CircuitPython内置包displayio参考文档: displayio – Native helpers for driving displays — Adafruit CircuitPython documentation
  13. CircuitPython扩展包adafruit_bitmap_font参考文档: adafruit_bitmap_font.bdf — Adafruit Bitmap_Font Library 1.0 documentation (circuitpython.org)
  14. CircuitPython扩展包adafruit_display_text包考文档: adafruit_display_text — Adafruit Display_Text Library 1.0 documentation (circuitpython.org)
  15. CircuitPython扩展包adafruit_requests参考文档: adafruit_requests — Adafruit Requests Library 1.0 documentation (circuitpython.org)
木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

古诗词 展开 收起
Python
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/swxu/poem.git
git@gitee.com:swxu/poem.git
swxu
poem
poem
master

搜索帮助