Before you get started you will need to follow the setup documentation from the esp-idf project for your specific operating system.
I have only tested this on macOS and using a certain version of esp-idf. You should try to use more recent version if you have failed.
You will need to recursively clone this project with the recursive flag because it includes mruby as a submodule:
git clone --recursive https://github.com/mruby-esp32/mruby-esp32.git
The main ruby program can be found in the main/simplest_mrb.rb file. The
makefile configuration in main/component.mk and the main entry point source
file mruby_main.c will also be of interest if you want to change the name of
the ruby script. The examples included are very simple scripts that only print
to the ESP32's debug console.
I'm assuming you have followed all the steps in the install documentation and are at least somewhat familiar with the building steps. With that in mind you can do something like the following and see the example running:
cp main/examples/$(YOU_WISH_TO_TRY_FILE) main/spiffs/main.rb
idf.py build
idf.py -p $(YOUR_SERIAL_PORT) flash monitor
The valiable YOU_WISH_TO_TRY_FILE can be replaced with one of the following:
- simplest_mrb.rb - Simply prints two strings
- gpio.rb - An example of using GPIO
- wifi_example_mrb.rb - An example of connecting to WiFi, you will need to modify this file to include your SSID and password
- mqtt_publish.rb - An sample of publishing to MQTT broker
- system_mrb.rb - Examples of most of the system APIs
The clean command will clean both the ESP32 build and the mruby build:
idf.py fullclean
There are multiple GEMS that can be turned on and off via the mruby
configuration file found in
components/mruby_component/esp32_build_config.rb:
- mruby-esp32-system - ESP32 system calls
- mruby-esp32-wifi - ESP32 WiFi
- mruby-esp32-mqtt - ESP32 MQTT library