utilities for developer using mruby/c
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bintest
images/tutorials/1
mrblib
releases
templates
tools/mrubyc-utils
.gitignore
Dockerfile
LICENSE
README.md
Rakefile
TUTORIAL_1.md
TUTORIAL_2.md
build_config.rb
docker-compose.yml
mrbgem.rake

README.md

mrubyc-utils

====

Utilities for developer who uses mruby/c

Description

mrubyc-utils is built with mruby-cli and provides some usuful functions for your development with mruby/c. Make your IoT development smooth and fun.

Wrapper of gem 'mrubyc-test' and 'mrubyc-debugger'

mrubyc-test and mrubyc-debugger are gems of CRuby. They may have a problem of ruby-version because the gems run on CRuby but want to use mruby internally. You can use mrubyc-utils as wrapper command fot those gems because mrubyc-utils does not depend on rubyenv. Note that this feature is available on v0.0.6+

Wapper of any command

Any argument except test, debugger and options which mrubyc-utils accepts will be executed as it is with changing RBENV_VERSION into CRuby version you specified at the time of mrubyc-utils install

For example, this command will run CRuby's rfd in spite of .ruby-version is mruby-x.x.x

$ mrubyc-utils rfd

Usage

This is equivalent to mrubyc-test init

$ mrubyc-utils test init

Also you can

$ mrubyc-utils debugger

Requirement

mrubyc-utils assumes that you are using PSoC Creator to write firmware program and targetting PSoC5LP microcontrollers.

Though PSoC Creator works on only Windows platform, mrubyc-utils works on Linux and macOS. It is recommneded that you use Windows as a host machine to build firmware and Linux as a virtual client to write mruby code. Vice versa you can use Linux or macOS as a host to write mruby and Windows as a virtual client to build firmware with PSoC Creator.

Linux or macOS

  • git (mrubyc-utils uses git internally to clone mruby/c into your project directory)
  • mruby 1.3.0 (mrubyc-utils uses mrbc to compile your mruby program)
  • your favorite text editor (to write mruby program)

Windows

  • PSoC Creator 4.2 or later (to build PSoC project and to write firmware to your microcontroller)

Usage

  • hitting mrubyc install in your mruby/c project's directory will check out mruby/c repository from GitHub.com and create some files and directories. Note that this operation may overwrite main.c. See standard output to know more about its result
  • mrubyc update pulls the newest master branch of mruby/c from GitHub.com. This operation will keep your modification of src/vm_config.h (so you can update mrubyc freely. I recommend you to use the newest mruby/c instead of release version)
  • mrubyc classes shows list of class that you can use with mruby/c's VM
  • mrubyc methods --class=[Class Name] shows list of methods that you can use with the class
  • mrubyc compile compiles your mrblib/**xxx.rb into xxx.c
  • see .mrubycconfig that mrubyc install created to know configurations you can modify
  • mrubyc --help will show you more about usage

Install

Tutorial

see TUTORIAL_1.md

Contribution

  1. Fork this repository
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Licence

MIT(see LICENSE)

Author

hasumkin