https://github.com/yuuu/espicoruby
This project runs PicoRuby on ESP32 and serves as an example of using picoruby-esp32.
https://github.com/yuuu/espicoruby
esp-idf esp32 picoruby ruby
Last synced: over 1 year ago
JSON representation
This project runs PicoRuby on ESP32 and serves as an example of using picoruby-esp32.
- Host: GitHub
- URL: https://github.com/yuuu/espicoruby
- Owner: yuuu
- License: mit
- Created: 2025-01-12T10:20:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-28T21:13:43.000Z (over 1 year ago)
- Last Synced: 2025-01-28T22:23:30.702Z (over 1 year ago)
- Topics: esp-idf, esp32, picoruby, ruby
- Language: CMake
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
*This repository has been moved to [picoruby/R2P2-ESP32](https://github.com/picoruby/R2P2-ESP32) .*
# espicoruby
This project runs [PicoRuby](https://github.com/picoruby/picoruby) on ESP32 and serves as an example of using [picoruby-esp32](https://github.com/yuuu/picoruby-esp32).
Currently, **it has only been tested on the [M5Stamp C3 Mate](https://docs.m5stack.com/ja/core/stamp_c3).**
## Getting Started
### Preparation
Set up your development environment using ESP-IDF by referring to [this page](https://docs.espressif.com/projects/esp-idf/en/v5.4/esp32/get-started/index.html#manual-installation).
### Setup
Run the following shell script to build PicoRuby:
```sh
$ git clone https://github.com/yuuu/espicoruby.git
```
### Build
Build the project using the `idf.py` command.
```sh
$ . $(YOUR_ESP_IDF_PATH)/export.sh
$ idf.py set-target $(YOUR_ESP_TARGET) # example: idf.py set-target esp32c3
$ idf.py build
```
### Flash and Monitor
Flash the firmware and monitor the output using the `idf.py` command. PicoRuby Shell will start.
```sh
$ idf.py flash
$ idf.py monitor
```
## Supported Environment
Currently, this project is tested in the following environment only:
- **Build OS**:
- macOS
- **Device**:
- M5Stamp C3 Mate(esp32c3)
## License
[espicoruby](https://github.com/yuuu/espicoruby) is released under the [MIT License](https://github.com/yuuu/espicoruby/blob/main/LICENSE).