91 Star 767 Fork 180

GVP李昂 / pikapython

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md
MIT

logo

PikaPython

Cross platform ultra lightweight embedded Python engine

中文页 | Forum | Documents | Videos | BSP | Package Manager | Contribute | Business

image

1. Abstract

PikaPython is an ultra-lightweight Python interpreter that runs with only 4KB of RAM, zero dependencies. It is ready to use out of the box without any configuration required and easy to extend with C.

PikaPython also known as PikaScript and PikaPy.

It's very easy to bind C function to python module with the help of Pika Pre-compiler.Only write the API of python in .pyi and the bindings are autoly generated by Pre-compiler.

image-20220520233540245

Get pikapython:

Use Online Project Generator

Generator url: http://pikascript.com

Note: You need the Community Edition license (Now Free) to build Keil projects, and the version of Keil should be newer than v5.36.

PikaPython studio

PikaPython serial terminal, script download and package menage tool.

Quick Start

You can use simulation project to quick start without hardware,or use the out-of-the-box develop board Pika-Pi—Zero.

image

The board based on STM32G030C8T6 MCU, only 64kB Flash, 8kB RAM can run pikapython with total peripheral device (GPIO、TIME、IIC、RGB、KEY、LCD、RGB). CH340 is deployed to support USB to serial with Type-C USB, support download python script py serial, there are 4 RGB on the board and support the LCD.

Related Projects

Document

https://pikadoc-en.readthedocs.io/en/latest/index.html

How to contribute

https://pikadoc-en.readthedocs.io/en/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

Folders

src - core code

bsp - mcu/board support

port - OS and package manager

test - unit test

document - developt document

examples - example scripts

package - packages and moudles

pikaCompiler - pre-compiler write by Rust, used to bind C function to python moudle.

pikaPackageManager - pacakge manager

2.Platform support

MCU support

MCU bsp gpio time uart pwm adc i2c dac
stm32g030c8
stm32g070cB
stm32f103c8
stm32f103rb
stm32f103ze
stm32f103rc
stm32f401cc
stm32f411ce
stm32f407ze
stm32f407zg
stm32h750vb
stm32f051r8
air32f103cb
ch582
ch32v103r8t6
cm32m101a
w806
apm32f030r8
apm32e103vb
bl-602
bl-706
bl-618
Raspberry Pico
ESP32C3
TC264D
devc
visual-studio
EC600N
mm32f5277e9p
xr806(openharmony)

Board support

Board bsp gpio uart pwm adc i2c rgb lcd arm-2d
Pika-Pi-Zero
Board bsp pika_lvgl
lvgl-vs-simu
swm320
Board bsp arm-2d
QEMU-arm2d
Board bsp LED KEY
SmartLoong

OS support

OS port GPIO TIME PWM
RT-Thread
vsf
OS port Google Test Benchmark
linux

3.Characteristic

(1)Run environment

Support run in mcu without OS or file system. Can run in everywhere with RAM ≥ 4kB and FLASH ≥ 64kB,such as stm32g030, stm32f103c8t6,esp8266.

(2)Develop enviroment

Support REPL by serial.

微信交流群

Support run and program python scripts by serial.

微信交流群

Support IDEs like Keil, IAR, RT-Thread studio and segger embedded studio to develop C moudle.

Support build tools like CMake, makeFile and Scons.

Zero dependencies, zero configuration, out-of-the-box, easy to integrated into privious C projcet.

Eazy to extern customized C moudles.

Support linux.

(3)Syntax

Support subaggregate of python 3 standard syntax.

Support class and method define, encapsulation-inheritance-polymorphism and moudles in .pyi of C module.

More Details About Syntax Support
Syntax Compile-Time Run-Time Shell
Module Define - -
Module Import
Class Define
Class Inherit
Method Define
Method Override
Method Invoke
Argument Define
Argument Assignment
Object New
Object Free
Object Nest
Control flow

Operator

+ - * / == > < >= <= % ** // != & >> << and or not in += -= *= /=

Control flow

Syntax State
if
while
for in [list]
for in range(a, b)
for in [dict]
if elif else
for break/continue
while break/continue

Module

Syntax Python Module C Module
import [module]
import [module] as -
from [module] import [class/function>] -
from [module] import [class/function>] as -
from [module] import * - PikaObj Module Only

List/Dict

Syntax State
l = list()
l = [a, b, c]
d = dict()
d = {'a':x, 'b':y, 'c':z}

Exception

Syntax State
try:
except:
except [Exception]: -
except [Exception] as [err]: -
except: ... else: -
raise:
raise [Exception]: -
finally: -

Slice

Syntax str bytes list
test[i]
test[a : b]
test[a :]

Other keywords/Syntax

yield is comprehensions
- -

(4)Develop standard.

Readability first, nearly never use macro function and global argument.

Complete unit testes based on google test.

4.Both talk and show the code:

E-mail: liang6516@outlook.com

5.Demo

The scripts in demos are in the examples folder.

Demo 01 GPIO

View Code
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)

Demo 02 USART

View Code
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)

Demo 03 ADC

View Code
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

Demo 04 PWM output

View Code
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

View Code
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)

View Code
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
	

image

The maximum RAM usage of these demos is only 3.56K, which is 4.56K if the 1K stack is included, and the maximum Flash usage is 30.4K. Refer to the 20K RAM and 64K Flash of STM32F103C8T6, less than 25% RAM and less than 50% Flash are used.

About the custom extern module ?

In addition to device drivers, developing custom Python modules for MCU is very easy. The following two demos are extensions of the custom module, which developed python interfaces for the ARM-2D image driver library.

Boxes~

Hnet-image (7)

Rotating suns~

Hnet-image (6)

6.Test and develop Core

Test core in docker (recommend)

get start with docker

✨ Contributors

How to contribute

Contribute Log On 2023

Contribute log Contributer
fix REPL echo for '\b' and 0x7F versaloon
pika_hal support for ESP32 geekheart
Driver Design for PIKA-OPEN-HARDWARE Kirin
bsp support for Makefile-win-mingw unsigned_0
Fix bug for STM32F4 delay_unit() MrLeekon
bsp support for air780e Kirin
Component Selection, Schematic Diagram, PCB Design for PIKA-OPEN-HARDWARE 冰点 (WeChat Name)
Driver Design for PIKA-OPEN-HARDWARE Kirin
Product Design, Component Selection for PIKA-OPEN-HARDWARE 方海钰
Hardware Verification for PIKA-OPEN-HARDWARE HonestQiao
support PIKA_UNBUFFERD_ENABLE config item Seny Lee
add this module blueloveTH
Fix memory leak in event queue randyscott
Fix a bug of _OP_POW blueloveTH
fix bsp/esp32/README.md erzongxie
Fixed a bug where help("modules") crashed when no lib was loaded 梦程MI
support GPIO driver for rt-thread supperthomas
Fixed a typo J. Neuschäfer
codecov CI support Renzhihan
rt-thread build script fix and improve supperthomas
support pikafs pack and unpack to path sjy
fix pika_platform_get_tick() in linux port 梦程MI
CH307开发板、BL618开发板 VeriMake
VM instruction extension framework GorgonMeducer
iotcloud module 梦程MI
implement shell filter GorgonMeducer
修复socket模块在lwip中fcntl的参数数量错误 梦程MI
support GPIO pika_hal for BLMCU codercmd
Fix Typo on PikaVM.c Ikko Eltociear Ashimine
Fix type assert on dataArgs.c itschina
add examples/Device/KEY_POLL.PY codercmd
hmac hashlib base64 aes modules 梦程MI
fix pikaCompiler build error on macos 梦程MI
Contribute Log On 2022
Contribute log Contributer
request module onceday
mqtt module FlintJ
Donate:500¥ hardsofttech
Donate:500¥ edmund_wz
Donate:500¥ Meco Jianting Man
Donate:500¥ hardsofttech
PikaNN module Renzhihan
re module eglwang
PikaMath.Quaternion() purewind7
contrubute to PikaCV purewind7
xr806(openharmony) bsp sjy
ESP32 package 沧御
MM32F5277E9P package unsigned
mm32f5277e9p BSP unsigned
Add CMSIS-PACK GorgonMeducer
donate: air32f103 board * 20 合宙 xinxi204
contrubute to PikaMath.Math() onceday
add support for Unix Time onceday
contrubute to PikaStdLib.String() purewind7
Add PLOOC support for pikapython Core GorgonMeducer
Donate:500¥ (ctypes 相关) 蒋太平
fix linux install script Maximilian Gerhardt
ch582 package 梦程MI
ch582 BSP 梦程MI
Donate:EC600X QuecPython Develop board 移远通信 武加玉
Performance Point: 900->1400 GorgonMeducer
stm32f051r8 BSP unsigned
stm32f407ze BSP unsigned
devc BSP unsigned
TC264D BSP unsigned
PikaVM improvement GorgonMeducer
W801Device package 刘延(微信名)
W806 bsp 刘延(微信名)
Donate:ESP32C3 5pic,linker 启明云端 沧御
Donate:LS1C101 mcu 10pic, LS1c101 develop board,debuger 龙芯俱乐部 石南
PikaVSF OS package versaloon
ESP32C3 BSP 沧御
Contribute Log On 2021
Contribute log Contributer
Donate:ESP32 board、ink lcd*4 name(微信名)
Donate:smartloong board 龙芯俱乐部 石南
package/STM32F1 sjy
package/STM32F103RBBooter sjy
bsp/stm32f103rb sjy
QEMU ARM-2D simulation proejct liuduanfei
Donate:GD32E103TB2 2 pic 信息牛(微信名)
Rt-thread bsp、port、module Meco Jianting Man
Donate:EC600S-CN 4G 移远模块
Donate:BL706 board 博流智能 bouffalolab
Donate:CM32M101A 开发板 孟巍(微信名)
Donate:APM32F030R8 board 极海半导体 陈成
Donate:APM32E103VB board 极海半导体 陈成
Donate:APEX-Link 极海半导体 陈成
corde format,add gitattributes Meco Jianting Man
demo/simulation-keil 千帆(微信名)
demo/stm32f103zet6/demo01-led-stm32f103zet6 甜航
demo/stm32f103zet6/demo02-led-stm32f103zet6_tworoot 甜航
demo/stm32f407zgt/demo01-led-stm32f407vgt 甜航

Star History

Star History Chart

MIT License Copyright (c) 2021 lyon 李昂 liang6516@outlook.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

PikaPython 是一个完全重写的超轻量级python引擎,零依赖,零配置,可以在少于4KB的RAM下运行(如stm32g030c8和stm32f103c8),极易部署和扩展 expand collapse
Cancel

Releases (12)

All

Contributors

All

Activities

Load More
can not load any more
C
1
https://gitee.com/Lyon1998/pikapython.git
git@gitee.com:Lyon1998/pikapython.git
Lyon1998
pikapython
pikapython
master

Search