logo

PikaPython

跨平台的超轻量级嵌入式 Python 引擎

论坛 | 文档中心 | 视频 | 开发板 | BSP | 包管理器 | RT-Thread 软件包 | 参与贡献 | 商业合作

[![image](document/image/147997370-ff37b6e7-25b2-4174-aa64-c1fb92cede04.png)](https://pikastech.github.io/PikaPython/dev/bench/) # 1.简介 PikaPython 是一个完全重写的超轻量级 python 引擎,零依赖,零配置,可以在 **Flash ≤ 64KB,RAM≤ 4KB** 的平台下运行(如 stm32g030c8 和 stm32f103c8),极易部署和扩展,具有大量的中文文档和视频资料。 PikaPython 也称 PikaScript、PikaPy。 PikaPython 具有框架式 C 模块开发工具,只要用 Python 写好调用 API ,就能够自动连接到 C 模块,非常方便快捷。不用手动处理任何全局表、宏定义、等等。 PikaPython 也支持 MDK、iar、RT-studio 等常见 ide 开发,能够轻松地调试 C 模块。 # 最新资讯 - [📢 发布公告:PikaPython v1.12.2 发布 🚀](https://mp.weixin.qq.com/s?__biz=MzU4NzUzMDc1OA==&mid=2247484789&idx=1&sn=bedfc580932a4bd286264110a065de2a&chksm=fdebd21cca9c5b0a4654a394f48fb3cb0e743b4ad72fef4d96e4cf28fa4357349b4862f0be7e&token=2116766907&lang=zh_CN#rd) - [万元结项奖金!学生报名开启!PikaPython 开源之夏 2023](https://mp.weixin.qq.com/s?__biz=MzU4NzUzMDc1OA==&mid=2247484785&idx=1&sn=1cf983057765198f53c4f6c8aa04e516&chksm=fdebd218ca9c5b0e3444112a5a033dc295c63482bcb8934422a199784e900c2cd95f633da5b4&token=2116766907&lang=zh_CN#rd) - [【喜报】PikaPython突破 1000+ Github Star,物联网与边缘AI领域的轻量级Python解释器再创新高!](https://mp.weixin.qq.com/s?__biz=MzU4NzUzMDc1OA==&mid=2247484773&idx=1&sn=e0273c1c55614ea11387d6f785c4bfb9&chksm=fdebd20cca9c5b1a14fef9c2cd90f01551ce0c04eac4de0759fdc8ba27ae4158a68ce1eb5a5f&token=2116766907&lang=zh_CN#rd) - [PikaPython项目入选中国开源创新大赛决赛,携手共建国内开源生态](https://mp.weixin.qq.com/s?__biz=MzU4NzUzMDc1OA==&mid=2247484762&idx=1&sn=2b3e570bbc7e98874b6773fe8e2678c7&chksm=fdebd233ca9c5b255296db6e9874035577a02b6b26354c4c2a2298696a02ec467149ca91a078&token=2116766907&lang=zh_CN#rd) - [轻量级Python解释器PikaPython成功入选开源之夏,探索无限可能!](https://mp.weixin.qq.com/s?__biz=MzU4NzUzMDc1OA==&mid=2247484738&idx=1&sn=7af1c9bb61e6decd5c155924cb7a05f8&chksm=fdebd22bca9c5b3d3f2fbd8742941e6c33e86cbcba88c329b0b9550b54b0291b6f50553d5eea&token=709915806&lang=zh_CN#rd) - [2022 年 PikaPython 年终总结](https://mp.weixin.qq.com/s/cWtujWF8EuJnuXuVUeWNKw) - [【快讯】PikaScript 合并进入 LVGL 主线文档,创始人Gabor 这样说...](https://mp.weixin.qq.com/s/2vcZfRfAAmAqPfyOm7CqUg) # 获取 PikaPython: ## 使用在线图形化工程生成器 生成器地址: http://pikascript.com [![](assets/1644129110261-049ad5bb-21af-40e2-9533-a1c8c86790f1.jpg)](http://pikascript.com) ## 使用 Pika 包管理器[PikaPackage.exe](https://pikadoc.readthedocs.io/zh/latest/%E5%8C%85%E7%AE%A1%E7%90%86%E5%99%A8%E4%B8%8E%E6%A8%A1%E5%9D%97%E7%AE%A1%E7%90%86.html) 1. 直接运行[PikaPackage.exe](https://pikadoc.readthedocs.io/en/latest/%E5%8C%85%E7%AE%A1%E7%90%86%E5%99%A8%E4%B8%8E%E6%A8%A1%E5%9D%97%E7%AE%A1%E7%90%86.html), 自动下载并更新pikapython主仓库(文件在当前磁盘的/tmp/pikapython文件夹) 2. 将[requestment.txt](/bsp/stm32g070cb/pikapython/requestment.txt)放在[PikaPackage.exe](https://pikadoc.readthedocs.io/en/latest/%E5%8C%85%E7%AE%A1%E7%90%86%E5%99%A8%E4%B8%8E%E6%A8%A1%E5%9D%97%E7%AE%A1%E7%90%86.html)同一文件夹下, 运行[pikaPackage.exe](https://pikadoc.readthedocs.io/en/latest/%E5%8C%85%E7%AE%A1%E7%90%86%E5%99%A8%E4%B8%8E%E6%A8%A1%E5%9D%97%E7%AE%A1%E7%90%86.html), 自动在当前目录下安装[内核](../../tree/master/src)、[预编译器](../../tree/master/tools/pikaCompiler)与[模块](../../tree/master/package)。 3. 已发布的模块列表:[packages.toml](/packages.toml) # 快速上手 可使用[仿真工程](document/1.三分钟快速上手.md)快速上手,无需硬件,也可以使用官方支持的开发板[Pika派—Zero](https://item.taobao.com/item.htm?spm=a2126o.success.result.1.76224831Y0X1gO&id=654947372034),上手即玩。 [Pika派python编程游玩指南](https://pikadoc.readthedocs.io/zh/latest/Pika%20%E6%B4%BE%E5%BC%80%E5%8F%91%E6%9D%BF%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B.html) [![PikaPi-Zero](document/image/147940229-a6b8ebf5-41db-4614-a525-448f47de0a67.png)](https://item.taobao.com/item.htm?spm=a2126o.success.result.1.76224831Y0X1gO&id=654947372034) 开发板基于 STM32G030C8T6 小资源 MCU,仅 64kB Flash,8kB RAM 即可运行完整解释器,和完整的外设驱动(GPIO、TIME、IIC、UART、ADC、PWM、RGB、KEY、LCD)。板载 CH340 USB 转串口芯片,Type-C 接口,支持串口下载 python 脚本,板载4颗 RGB 灯,可选配[LCD屏幕](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-23991764791.12.16f97c58fsLjVk&id=660745643102)。 # 开发手册 ### [点此进入文档中心](http://pikascript.com/doc) ![image](document/image/144693400-99f9c038-76fd-4d95-b3d2-137bd972d580.png) # 视频教程 ### [点此进入视频中心](https://space.bilibili.com/5365336/channel/seriesdetail?sid=1034902) ![image](document/image/142173892-35e33f36-413c-4422-8470-b873b7c3bd71.png) # 交流论坛 ### [点此进入论坛](https://whycan.com/f_55.html) ![image](document/image/144693543-4aee46c8-b6c8-4282-99c4-e07271a4ba5f.png) ## 文件目录 [src](../../tree/master/src) - 内核源码 [bsp](../../tree/master/bsp) - 裸机芯片/板卡支持 [port](../../tree/master/port) - 操作系统和包管理器支持 [test](../../tree/master/port/linux/test) - 单元测试 [document](../../tree/master/document) - 开发文档 [examples](../../tree/master/examples) - 示例脚本 [package](../../tree/master/package) - 模块目录 [pikaCompiler](../../tree/master/tools/pikaCompiler) - 使用 rust 编写的预编译器 [pikaPackageManager](../../tree/master/tools/pikaPackageManager) - 使用 go 编写的模块管理器 # 2.平台支持列表 ## MCU support !INCLUDE "bsp.mdpp" ## Board support !INCLUDE "board.mdpp" ## OS support !INCLUDE "os.mdpp" ## 相关开源项目 - ▶️ [pikapython Binding For LVGL](https://github.com/lvgl/lv_binding_pikascript) - ⭐ [pikapython Bluepill Demo In PlatformIO — Python-like REPL 🐍🔌](https://github.com/maxgerhardt/pikascript-pio-bluepill) - ⭐ [pikapython Bluepill Demo In GCC 🐍](https://github.com/Chandler-Kluser/pikascript_gcc_bluepill) # 3.特性 ### (1)运行环境 支持裸机运行,可运行于 **RAM ≥ 4kB** ,**FLASH ≥ 64kB** 的mcu中,如stm32g030, stm32f103c8t6,esp8266。 ### (2)开发环境 支持串口下载 Python 脚本。 微信交流群
支持 Keil、IAR、rt-thread studio、segger embedded studio 等IDE开发。 支持 CMake、makeFile、Scons 等构建工具 零依赖,零配置,开箱即用,极易集成进已有的C工程。 极易拓展自定义的C原生函数。 支持跨平台,可在 linux 环境开发内核。 ### (3)语法特性 使用 python3 标准语法的子集。 在编译时支持 python 类和方法定义,完整支持封装、继承、多态、模块功能 - 基于 [Pika 预编译器](../../tree/master/tools/pikaCompiler)。 在运行时支持 python 方法调用、变量定义、对象构造、对象释放、控制流(if\while) - 基于 [Pika 运行时内核](../../tree/master/src)。
更多语法特性细节 |语法|编译时|运行时|Shell| |---|---|---|---| |模块定义 |√|-|-| |模块导入 |√|√|√| |类定义 |√|√|√| |类继承 |√|√|√| |方法定义 |√|√|√| |方法重载 |√|√|√| |方法调用 |√|√|√| |参数定义 |√|√|√| |参数赋值 |√|√|√| |对象新建 |√|√|√| |对象销毁 |√|√|√| |对象嵌套 |√|√|√| |控制流 |√|√|√| !INCLUDE "syntax.mdpp"
### (4)源码规范 注重源码可读性,命名规范,标准统一,完全不使用宏,几乎不使用全局变量。 完整的 googletest 单元测试。 # 4.交流与技术支持: ## Tencent QQ Group: 微信交流群
## E-mail: liang6516@outlook.com # 5.Demo展示 ## Demo 01 GPIO
查看代码 ``` python import PikaStdLib import STM32G0 mem = PikaStdLib.MemChecker() io1 = STM32G0.GPIO() time = STM32G0.Time() io1.setPin('PA8') io1.setMode('out') io1.enable() io1.low() print('hello pikapython') print('mem.max :') mem.max() print('mem.now :') mem.now() while True: io1.low() time.sleep_ms(500) io1.high() time.sleep_ms(500) ```
![Hnet-image (2)](document/image/132943428-f2b365ca-140e-42f4-936c-db6a7d9f8dee.gif) ## Demo 02 USART
查看代码 ``` python import PikaStdLib import STM32G0 time = STM32G0.Time() uart = STM32G0.UART() uart.setId(1) uart.setBaudRate(115200) uart.enable() while True: time.sleep_ms(500) readBuff = uart.read(2) print('read 2 char:') print(readBuff) ```
![Hnet-image (3)](document/image/132943365-0f7059b3-4f9d-4989-a5ec-2cce72b0cc96.gif) ## Demo 03 ADC
查看代码 ``` python import PikaStdLib import STM32G0 time = STM32G0.Time() adc1 = STM32G0.ADC() adc1.setPin('PA1') adc1.enable() while True: val = adc1.read() print('adc1 value:') print(val) time.sleep_ms(500) ```
![mmexport1631351523907](document/image/132944185-0a01b1ba-8cf7-4f9f-9d73-fe9cbcd52f0b.png) ## Demo 04 PWM output
查看代码 ``` python import PikaStdLib import STM32G0 time = STM32G0.Time() pwm = STM32G0.PWM() pwm.setPin('PA8') pwm.setFrequency(2000) pwm.setDuty(0.5) pwm.enable() while True: time.sleep_ms(500) pwm.setDuty(0.5) time.sleep_ms(500) pwm.setDuty(0.001) ```
## Demo 05 RGB
查看代码 ``` python import STM32G0 import PikaPiZero import PikaStdLib rgb = PikaPiZero.RGB() mem = PikaStdLib.MemChecker() rgb.init() rgb.enable() print('hello 2') print('mem used max:') mem.max() while True: print('flowing') rgb.flow() ```
## Demo 06 Snake(Need LCD)
查看代码 ``` python from PikaObj import * import PikaStdLib import PikaPiZero import STM32G0 # hardware init lcd = PikaPiZero.LCD() lcd.init() lcd.clear('white') key = PikaPiZero.KEY() key.init() time = STM32G0.Time() x_max = 120 y_max = 150 # snake init s = PikaPiZero.Point() w = 9 h = 9 s.x = 50 s.y = 10 len = 0 while len < 3: b = s i = 0 while i < len: b = b.next i = i + 1 b.next = PikaPiZero.Point() b.next.x = b.x - 10 b.next.y = b.y b.next.prev = b len = len + 1 # ring link b.next = s s.prev = b i = 0 b = s while i < len: lcd.fill(b.x, b.y, w, h, 'blue') b = b.next i = i + 1 print('snake lengh') print(len) # fruit init f = PikaPiZero.Point() f.x = 30 f.y = 20 lcd.fill(f.x, f.y, w, h, 'green') # memory check mem = PikaStdLib.MemChecker() print('mem used max:') mem.max() # main loop d = 0 isUpdate = 1 isEat = 0 while True: if isUpdate: # isUpdate = 0 # check eat fruit if f.x == s.x and f.y == s.y: # have eat fruit isEat = 1 f.x = f.x + 30 if f.x > x_max: f.x = f.x - x_max f.y = f.y + 30 if f.y > y_max: f.y = f.y - y_max lcd.fill(f.x, f.y, w, h, 'green') # move snake by the direction if d == 0: x_new = s.x + 10 y_new = s.y if x_new > x_max: x_new = 0 elif d == 1: x_new = s.x y_new = s.y - 10 if y_new < 0: y_new = y_max elif d == 2: x_new = s.x y_new = s.y + 10 if y_new > y_max: y_new = 0 elif d == 3: x_new = s.x - 10 y_new = s.y if x_new < 0: x_new = x_max if isEat: isEat = 0 b_new = PikaPiZero.Point() b_new.x = x_new b_new.y = y_new b_new.prev = s.prev b_new.next = s s.prev.next = b_new s.prev = b_new s = b_new len = len + 1 print('snake lengh') print(len) print('mem used max:') mem.max() # drow the snake and fruit # clear last body lcd.fill(s.prev.x, s.prev.y, w, h, 'white') # new body s.prev.x = x_new s.prev.y = y_new # head is last body s = s.prev lcd.fill(s.x, s.y, w, h, 'blue') b = s i = 0 # scan key key_val = key.get() if key_val == 0: d = 0 isUpdate = 1 elif key_val == 1: d = 1 isUpdate = 1 elif key_val == 2: d = 2 isUpdate = 1 elif key_val == 3: d = 3 isUpdate = 1 ```
![输入图片说明](document/image/imagefwef.png) 这几个 Demo 占用的 RAM 最大值只有3.56K,把1K的堆栈也算上就是4.56K,Flash 最大占用是30.4K,以 STM32F103C8T6 的 20K RAM 和 64K Flash 为标准,RAM 才用掉不到25%,Flash 才用掉不到50%。 我们可以简单对比一下 micropython 的常用芯片 STM32F405RG 和这次跑 pikapython 的芯片STM32G070CB ## RAM资源对比 ![image](document/image/132944731-a55ece1d-061f-4b91-ba87-bd6547be96a7.png) ## Flash资源对比 ![image](document/image/132944745-e9cf598d-e75f-40bb-873e-911819d535b7.png) ## 参考价对比(以2021年9月11日立创商城10片售价为参考) ![image](document/image/132944757-2b5cfda8-f93f-4456-8d7f-4e4767954056.png) ## 拓展能力如何呢? 除了设备驱动之外,为 mcu 开发自定义的 python 脚本绑定在 pikapython 的开发框架下非常轻松,下面两个 Demo 就是自定义的C模块拓展,这个 Demo 基于 ARM-2D 图像驱动库开发了一些 python 脚本接口。 ## 几个小方块~ ![Hnet-image (7)](document/image/132945282-bfd310df-8063-456d-b90c-6b798a2c8ed5.gif) ## 几个旋转太阳~ ![Hnet-image (6)](document/image/132945107-e473a2cc-9fbc-47f9-aaed-a28d3ad1048c.gif) # 6.内核测试与开发 ## 在 Docker 中测试 (recommend) [ Docker 开发环境搭建指南 ](https://pikadoc.readthedocs.io/zh/latest/get-start_linux.html) # 7.贡献者 ## [如何参与贡献](https://pikadoc.readthedocs.io/zh/latest/%E5%A6%82%E4%BD%95%E5%8F%82%E4%B8%8E%E7%A4%BE%E5%8C%BA%E8%B4%A1%E7%8C%AE.html) | 贡献者 | [成就勋章](document/achivement_zh.md) | !INCLUDE "achivement_list.mdpp"
### 贡献记录 (2023 年) | 贡献记录 | 贡献者 | | --- | --- | !INCLUDE "contributor2023.mdpp"
贡献记录 (2022 年) | 贡献记录 | 贡献者 | | --- | --- | !INCLUDE "contributor2022.mdpp"
贡献记录 (2021 年) | 贡献记录 | 贡献者 | | --- | --- | !INCLUDE "contributor2021.mdpp"