https://github.com/seeed-studio/sscma-example-esp32
Example of SenseCraft Model Assistant Model deployment related to ESP32
https://github.com/seeed-studio/sscma-example-esp32
Last synced: 11 months ago
JSON representation
Example of SenseCraft Model Assistant Model deployment related to ESP32
- Host: GitHub
- URL: https://github.com/seeed-studio/sscma-example-esp32
- Owner: Seeed-Studio
- Created: 2023-01-09T07:03:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-20T03:38:21.000Z (over 1 year ago)
- Last Synced: 2024-11-20T04:26:32.973Z (over 1 year ago)
- Language: C++
- Homepage:
- Size: 9.12 MB
- Stars: 23
- Watchers: 15
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SSCMA Deployment on Espressif Chipsets
English | [简体中文](README_zh-CN.md)
## Introduction
The project provides examples of how to deploy models from SSCMA to Espressif chipsets. It is based on the [ESP-IDF](https://github.com/espressif/esp-idf) and [TFLite-Micro](https://github.com/tensorflow/tflite-micro).
## Getting Started
### Install ESP IDF
Follow instructions in this guide
[ESP-IDF - Get Started](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html)
to setup the built toolchain used by SSCMA examples. Currently we're using the latest version `v5.3`.
### Clone and Setup the Repository
1. Clone our repository.
```sh
git clone https://github.com/Seeed-Studio/sscma-example-esp32
```
2. Go to `sscma-example-esp32` folder.
```sh
cd sscma-example-esp32
```
3. Fetch the submodules.
```sh
git submodule update --init
```
### Build and Run Examples
1. Go to examples folder and list all available examples.
```sh
cd examples && \
ls
```
2. Choose a `` and enter its folder.
```sh
cd ''
```
3. Generate build config using ESP-IDF.
Currently we develop and test on [XIAO-ESP32S3](https://www.seeedstudio.com/XIAO-ESP32S3-p-5627.html) module.
```sh
# set build target
idf.py set-target esp32s3
```
You can change a display driver, enable or disable a TFLite operator if it need using menuconfig.
```sh
# change device or demo specific configuration
idf.py menuconfig
```
4. Build the demo firmware.
```sh
idf.py build
```
5. Flash the demo firmware to device and Run.
To flash (the target serial port may vary depend on your operating system, please replace `/dev/ttyACM0` with your device serial port).
```
idf.py --port /dev/ttyACM0 flash
```
Monitor the serial output.
```
idf.py --port /dev/ttyACM0 monitor
```
#### Tip
- Use `Ctrl+]` to exit monitor.
- The previous two commands can be combined.
```sh
idf.py --port /dev/ttyACM0 flash monitor
```
### Supported Models and Performance
Please refer to [SSCMA Model Zoo](https://github.com/Seeed-Studio/sscma-model-zoo) for details.
## Contributing
- If you find any issue in using these examples, or wish to submit an enhancement request, please use the raise a [Issue](https://github.com/Seeed-Studio/sscma-example-esp32/issues) or submit a [Pull Request](https://github.com/Seeed-Studio/sscma-example-esp32/pulls).
## License
```
This software is licensed under the Apache 2.0 license, see LICENSE for more information.
```