Skip to content

PicoRuby shell for ESP32. This project runs PicoRuby on ESP32 using picoruby-esp32.

License

Notifications You must be signed in to change notification settings

picoruby/R2P2-ESP32

Repository files navigation

R2P2-ESP32

This project runs R2P2 (Ruby Rapid Portable Platform) on ESP32. It uses picoruby-esp32, a component to run PicoRuby on ESP32.

Getting Started

Preparation

Set up your development environment using ESP-IDF by referring to this page.

Setup

Run the following shell script to build PicoRuby:

$ git clone https://github.com/picoruby/R2P2-ESP32.git

If you want to use several files on a device, store them under ./storage/home . The file named app.mrb or app.rb is automatically executed after device startup.

Looking for Contributors

I would like to enable the device to be recognized as a USB Mass Storage Class when connected to a PC, allowing files to be written via drag-and-drop, similar to R2P2.
If you are interested in contributing, feel free to submit a pull request or open an issue!

Build

Build the project using the idf.py command.

$ cd R2P2-ESP32
$ . $(YOUR_ESP_IDF_PATH)/export.sh

# Setup(First time only)
$ rake setup_esp32   # if you use esp32
$ rake setup_esp32s3 # if you use esp32s3
$ rake setup_esp32c3 # if you use esp32c3

# Build
$ rake build

Flash and Monitor

Flash the firmware and monitor the output using the idf.py command. PicoRuby Shell will start.

# Flash
$ rake flash

# Monitor
$ rake monitor

If you want to run build -> flash -> monitor , you can use rake .

# Build -> Flash -> Monitor
$ rake

Supported Environment

Currently, this project is tested in the following environment only:

  • Build OS:
    • Linux
    • macOS
  • Device:
    • ESP32-DevKitC(esp32)
    • ESP32-S3-DevKitC(esp32s3)
    • M5Stamp C3 Mate(esp32c3)

License

R2P2-ESP32 is released under the MIT License.

About

PicoRuby shell for ESP32. This project runs PicoRuby on ESP32 using picoruby-esp32.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published