Micropython Custom Image for Obo Car

Customized Micropython Image inbuilt with Obo Car specific modules and configurations for Obo Car.

Table of Contents

• Prerequisites
• Installation
• Usage
• Contributing
• License

Prerequisites

• ESP-IDF installed and environment set up.
• Python 3.9 or later installed.
• Git installed.

Tip

If you have installed Docker, you may use act to run this GitHub Action locally. 💀✅

Installation

1. Clone the repository:

   git clone https://github.com/RoboticGen/Obo-Car-Micropython-SDK.git

2. Change the directory:

   cd Obo-Car-Micropython-SDK

3. Initialize the submodules:

   git submodule update --init lib/micropython src/obo-car

Warning

Sometimes you may need to checkout the specfic branch or tag of the submodules. Currently micropython is checked out to v1.23.0 and obo-car is checked out to dev-micropython-image.be sure to checkout the correct branch or tag.

4. Install micropython libraries:

   cd lib/micropython
   git submodule update --init lib/berkeley-db-1.xx lib/micropython-lib
   cd ../..

5. Build mpy-cross(Micropython cross compiler):

   make -C lib/micropython/mpy-cross

6. Run patch script:

   python3 patch.py

7. Build the firmware:

   cd boards/OBO_CAR
   idf.py build
   cd ../..

Usage

1. Flash the firmware:

   cd lib/micropython
   idf.py -p <PORT> flash
   cd ../..

   Replace <PORT> with the port where the Obo-Car is connected.

Latest Release

Tip

You can download the latest release from here or you can find it in the releases section.

Credits

This repository is fork of micropython-example-boards

License

This project is maintained under MIT License.