PikaScript development documentation

中文文档: https://pikadoc.readthedocs.io/zh/latest/index.html

PikaScript is a completely rewritten ultra-lightweight python engine with zero dependencies, zero configuration, and can run under less than 4KB of RAM (such as stm32g030c8 and stm32f103c8), making it extremely easy to deploy and scale.

You can help us improve the document by Pull Request on the document source repo: https://github.com/pikasTech/pikadoc-en

• 1. Introduction
  • 1.1. Principle introduction
  • 1.2. Demo show
• 2. Get Start
  • 2.1. How to Get Started with PikaScript using KEIL Simulator
  • 2.2. Pika Pie Development Board Quick Start
  • 2.3. Use BSP project
  • 2.4. Start with RT-Thread package
  • 2.5. Start with CMSIS-PACK
  • 2.6. Start with the Docker Development Environment
  • 2.7. Start with the LVGL GUI Simulation Project
  • 2.8. Play Python on Raspberry Pi Pico in MDK
  • 2.9. ARM-2D based GUI simulation project
• 3. Porting
  • 3.1. Deploy to new platform in ten minutes
  • 3.2. Interactive Run
  • 3.3. Docking with IDE
  • 3.4. Serial port download Python script
  • 3.5. Running Files Using the File System
• 4. Module Development
  • 4.1. Module Import
  • 4.2. Package manager
• 5. Standard Library
  • 5.1. PikaStdLib standard library
  • 5.2. PikaStdDevice standard device
  • 5.3. PikaStdData data structure
  • 5.4. PikaStdTask multitasking
  • 5.5. PikaDebug debugger
  • 5.6. PikaCV Image Processing Libraries
• 6. C Module - bind C code to Python module
  • 6.1. PikaScript C module overview
  • 6.2. PikaScript C module development process
  • 6.3. C module variable parameters
  • 6.4. C module keyword parameters
  • 6.5. C module returns List/Dict
  • 6.6. C module constants
  • 6.7. C module initialization
  • 6.8. Module clipping
• 7. Kernal API
  • 7.1. Pika object PikaObj
  • 7.2. Parameter list Args
  • 7.3. Generic parameters Arg
  • 7.4. String pool Strs
• 8. Configuration and advanced features
  • 8.1. PikaScript configuration manual
  • 8.2. Run Bytecode Directly
  • 8.3. Event callback mechanism
  • 8.4. Compact Memory Pools
  • 8.5. Interrupting a running script
• 9. Contribute
  • 9.1. How to contribute
  • 9.2. How to contribute to PikaScript BSP
  • 9.3. How to contribute to modules
  • 9.4. How to contribute to the standard library
  • 9.5. How to contribute to the kernel
• 10. Column Tutorial
  • 10.1. STM32F429 PikaScript Practice Notes
  • 10.2. MM32 PikaScript 开发实战
• 11. Selected Technical Articles
  • 11.1. Issue 1
• 12. Business cooperation
  • 12.1. General
  • 12.2. Source code usage
  • 12.3. Custom Development Services
  • 12.4. product marketing
  • 12.5. Training Services
• 13. Development Meeting
  • 13.1. PikaScript kernel advanced