1 Star 0 Fork 184

jiezhi320 / pikascript

forked from 李昂 / pikapython 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
README.md 20.58 KB
一键复制 编辑 原始数据 按行查看 历史
Lyon 提交于 2022-05-27 21:21 . Update README.md

logo

PikaScript

Cross platform ultra lightweight embedded Python engine

中文页 | Forum | Documents | Videos | BSP | Package Manager | RT-Thread package | Contribute | Business

image

1. Abstract

PikaScript is an ultra-lightweight Python engine with zero dependencies and zero-configuration, that can run with 4KB of RAM and 32KB of flash (such as STM32G030C8 and STM32F103C8).

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.

The Pre-compiler is fully open-source, and the source code is in the tools folder.

image-20220520233540245

Get PikaScript:

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.

Use Pika package manager PikaPackage.exe

  1. Run the PikaPackage.exe directly, then the pikascript repo would be downloaded auto in the /tmp/pikascript folder of your current disc partition.

  2. Add requestment.txt to the same folder of PikaPackage.exe then run PikaPackage.exe. The run-time core, pre-compiler and moudles would be installed in the current folder.

  3. Released modules:packages.toml

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 PikaScript 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.

Document

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

Folders

src - core code

bsp - mcu/board support

port - OS support

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 uart pwm adc i2c
stm32g030c8
stm32g070cB
stm32f103c8
stm32f103rb
stm32f103ze
stm32f103rc
stm32f401cc
stm32f411ce
stm32f407ze
stm32f407zg
stm32h750vb
stm32f051r8
ch582
ch32v103r8t6
cm32m101a
w801
w806
apm32f030r8
apm32e103vb
bl-706
Raspberry Pico
ESP32C3
TC264D
devc

Board support

Board bsp gpio uart pwm adc i2c rgb lcd arm-2d
Pika-Pi-Zero
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

Related Projects

PikaScript Bluepill Demo In PlatformIO — Python-like REPL 🐍🔌

https://github.com/maxgerhardt/pikascript-pio-bluepill

3.Characteristic

(1)Run environment

Support run in mcu without OS or file system. Can run in everywhere with RAM ≥ 4kB and FLASH ≥ 32kB,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.

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 += -= *= /=

Control flow

Syntax State Comment
if
while
for in [list] (PikaStdData.List)
for in range(a, b)
for in [dict] (PikaStdData.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 Comment
l = list() Need to enable the built-in-list in configuration.
l = [a, b, c] Need to enable the built-in-list in configuration.
d = dict() Need to enable the built-in-dict in configuration.
d = {a:"x", b:"y", c:"z"} -

Exception

try except try except else try except as
- - -

Slice

Syntax str bytes list (PikaStdData.List)
test[i] -
test[a : b : c] - - -
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:

Telegram

tg

https://t.me/+JL3TZ9k-Lfg2OWE1

E-mail: liang6516@outlook.com

Tencent QQ: 645275593

5.Demo

The scripts in demos are in the examples folder.

Demo 01 GPIO

import PikaStdLib
import STM32G0

mem = PikaStdLib.MemChecker()
io1 = STM32G0.GPIO()
time = STM32G0.Time()

io1.init()
io1.setPin('PA8')
io1.setMode('out')
io1.enable()
io1.low()

print('hello pikascript')
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

import PikaStdLib
import STM32G0

time = STM32G0.Time()
uart = STM32G0.UART()
uart.init()
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

import PikaStdLib
import STM32G0

time = STM32G0.Time()
adc1 = STM32G0.ADC()

adc1.init()
adc1.setPin('PA1')
adc1.enable()

while True:
    val = adc1.read()
    print('adc1 value:')
    print(val)
    time.sleep_ms(500)

mmexport1631351523907

Demo 04 PWM output

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

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)

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.

A quick comparison can be made between the microPython's MCU STM32F405RG and the PikaScript's MCU STM32G070CB.

RAM resource comparison

image

Flash Resource Comparison

image

Reference price comparison (take the selling price of 10 pieces in Lichuang Mall on September 11, 2021 as reference)

image

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)

step1: Clone the repo

git clone https://github.com/pikastech/pikascript
cd pikascript/docker 

step2: build and run the docker contianer

sh build.sh
sh run.sh

step3: init the port/linux

cd port/linux
sh pull-core.sh
sh init.sh

step4: test the core

sh gtest.sh
sh ci_benchmark.sh

step5: Run the REPL

sh run.sh

7.Contribute

How to contribute

Contribute log Contributer
Add PLOOC support for PikaScript 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 沧御
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

C
1
https://gitee.com/jiezhi3200/pikascript.git
git@gitee.com:jiezhi3200/pikascript.git
jiezhi3200
pikascript
pikascript
master

搜索帮助