{"id":25050547,"url":"https://github.com/picoruby/r2p2-esp32","last_synced_at":"2025-05-07T01:07:52.873Z","repository":{"id":275843855,"uuid":"927361647","full_name":"picoruby/R2P2-ESP32","owner":"picoruby","description":"PicoRuby shell for ESP32. This project runs PicoRuby on ESP32 using picoruby-esp32. ","archived":false,"fork":false,"pushed_at":"2025-05-03T00:04:52.000Z","size":28,"stargazers_count":22,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-07T01:07:45.261Z","etag":null,"topics":["esp-idf","esp32","picoruby","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/picoruby.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-04T20:37:59.000Z","updated_at":"2025-05-03T14:19:33.000Z","dependencies_parsed_at":"2025-02-04T22:19:11.186Z","dependency_job_id":"3f9559c5-fa9d-4612-a295-f7f159d2178f","html_url":"https://github.com/picoruby/R2P2-ESP32","commit_stats":null,"previous_names":["picoruby/r2p2-esp32"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/picoruby%2FR2P2-ESP32","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/picoruby%2FR2P2-ESP32/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/picoruby%2FR2P2-ESP32/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/picoruby%2FR2P2-ESP32/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/picoruby","download_url":"https://codeload.github.com/picoruby/R2P2-ESP32/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252793646,"owners_count":21805057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp-idf","esp32","picoruby","ruby"],"created_at":"2025-02-06T09:16:30.763Z","updated_at":"2025-05-07T01:07:52.865Z","avatar_url":"https://github.com/picoruby.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# R2P2-ESP32\n\nThis project runs [R2P2](https://github.com/picoruby/R2P2) (Ruby Rapid Portable Platform) on ESP32.\nIt uses [picoruby-esp32](https://github.com/picoruby/picoruby-esp32), a component to run [PicoRuby](https://github.com/picoruby/picoruby) on ESP32.\n\n\n## Getting Started\n\n### Preparation\n\nSet 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).\n\n### Setup\n\nRun the following shell script to build PicoRuby:\n\n```sh\n$ git clone --recursive https://github.com/picoruby/R2P2-ESP32.git\n```\n\nIf you want to use several files on a device, store them under `./storage/home` .\nThe file named `app.mrb` or `app.rb` is automatically executed after device startup.\n\n#### Looking for Contributors\n\nI 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.  \nIf you are interested in contributing, feel free to submit a pull request or open an issue!\n\n### Build\n\nBuild the project using the `idf.py` command.\n\n```sh\n$ cd R2P2-ESP32\n$ . $(YOUR_ESP_IDF_PATH)/export.sh\n\n# Setup(First time only)\n$ rake setup_esp32   # if you use esp32\n$ rake setup_esp32s3 # if you use esp32s3\n$ rake setup_esp32c3 # if you use esp32c3\n$ rake setup_esp32c6 # if you use esp32c6\n\n# Build\n$ rake build\n```\n\n### Flash and Monitor\n\nFlash the firmware and monitor the output using the `idf.py` command. PicoRuby Shell will start.\n\n```sh\n# Flash\n$ rake flash\n\n# Monitor\n$ rake monitor\n```\n\nIf you want to run `build` -\u003e `flash` -\u003e `monitor` , you can use `rake` .\n\n```sh\n# Build -\u003e Flash -\u003e Monitor\n$ rake\n```\n\n## Supported Environment\n\nCurrently, this project is tested in the following environment only:\n\n- **Build OS**:\n  - Linux\n  - macOS\n- **Device**:\n  - ESP32-DevKitC(esp32)\n  - M5Stamp C3 Mate(esp32c3)\n\n## License\n\n[R2P2-ESP32](https://github.com/picoruby/R2P2-ESP32.git) is released under the [MIT License](https://github.com/picoruby/R2P2-ESP32/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpicoruby%2Fr2p2-esp32","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpicoruby%2Fr2p2-esp32","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpicoruby%2Fr2p2-esp32/lists"}