Skip to content

grisp/rebar3_grisp

Repository files navigation

rebar3_grisp

Rebar plug-in for the GRiSP project. To obtain information about the plugin and its tasks, use the following command:

rebar3 help grisp [<task>]

📖 Table of content

Installation

Globally

To install the plug-in globally, add the plug-in to your plug-ins list in ~/.config/rebar3/rebar.config:

{plugins, [
    rebar3_hex,
    rebar3_grisp
]}.

The first time you use Rebar the plug-in will be installed. To upgrade the plug-in to the latest version, you need to first update the Hex index and then the plug-in:

$ rebar3 update
===> Updating package registry...
===> Writing registry to ~/.cache/rebar3/hex/default/registry
===> Generating package index...
===> Writing index to ~/.cache/rebar3/hex/default/packages.idx
$ rebar3 plugins upgrade rebar3_grisp
===> Fetching rebar3_grisp ({pkg,<<"rebar3_grisp">>,<<"1.1.0">>})
===> Downloaded package, caching at ~/.cache/rebar3/hex/default/packages/rebar3_grisp-1.1.0.tar
===> Compiling rebar3_grisp

For an Existing Project

Add the plug-in to your rebar config:

{plugins, [rebar3_grisp]}.

Then just call your plug-in directly in the root of the existing application:

$ rebar3 grisp
===> Fetching grisp
===> Compiling grisp
<Plugin Output>

Create New Application

Prerequisites:

To create a new GRiSP project:

rebar3 grisp configure

This command will provide you with a CLI that will guide you in the creation of your GRiSP project.

You can also use the command in a non-interactive way:

rebar3 grisp configure -i false

Unless stated otherwise, the non-interactive option will use the default values to create the GRiSP project. You can overwrite the default values in the command:

rebar3 grisp configure -i false --name="my_grisp_app" -n true -w true --ssid="mywifi" --psk="wifipsk"

This command will create a new GRiSP project named "my_grisp_app" with a network (-n true) and wifi (-w true) configuration already setup. The configuration will use the ssid "mywifi" and the psk "wifipsk".

Note that some options require others. For example, if you want to setup the ssid of the wifi, then you also need to activate the network and wifi configuration (-n true and -w true).

The specific variables provided by this plug-in are:

  • interactive activate the interactive mode
  • name is the name of the OTP application
  • dest is the destination path for deployment. This should point to where your SD-card is mounted (e.g. on macOS it is /Volumes/<NAME> where <NAME> is the name of the SD-card partition)
  • otp_version is the target Erlang/OTP version used on the GRiSP board
  • network specifies if the project contains network configuration files
  • wifi specifies if the project contains wifi configuration files. (requires network)
  • ssid is the ssid of the wifi network you want your board to connect to. (requires network and wifi)
  • psk is the psk of the wifi network you want your board to connect to. (requires network and wifi)
  • grisp_io specifies if you want your board to connect and use GRiSP.io. (requires network)
  • grisp_io_linking specifies if you want your board to link itself to GRiSP.io. (requires network and grisp_io)
  • token is your personnal GRiSP.io token. (requires network, grip_io and grisp_io_linking)
  • epmd specifies if you want your board to have epmd. (requires network)
  • cookie is the magic cookie that your board should use. (requires network and epmd)

Some variables are modfiable only through the command line. These variables are:

  • desc is the short description of the GRiSP application
  • copyright_year is the copyright year
  • author_name is the name of the author of the project
  • author_email is the email of the author of the project

For a full list of customizable variables as well as their short form, run rebar3 help grisp configure.

In the interactive mode you can also specify a few variables. During the CLI interaction, the questions related to these variable will be skipped. For example:

rebar3 grisp configure --name="mygrispapp"

Here the CLI won't ask you for the name of your GRiSP project because it's already provided.

Compile the project

rebar3 compile

Make sure you do that with the same Erlang version that you configured in the rebar.config. If you compiled rebar3 yourself with a more recent version of Erlang it will give errors, you will need to recompile rebar3 as well in that case.

For further information have a look at the GRiSP Wiki

Deploy an Application

To deploy a GRiSP application, use the command rebar3 grisp deploy. The command requires the release name and version to be provided. The deployment destination can be set in rebar.config or be given as an additional argument.

Example:

rebar3 grisp deploy --relname mygrispproject --relvsn 0.7.8

or shorter:

rebar3 grisp deploy -n mygrispproject -v 0.1.0

Above command will try to download a crosscompiled OTP version from our CDN and unpack it. In many usecases this will be enough. If you want to add own port drivers or NIFs in C you will have to build your own toolchain and OTP, see below.

Run rebar3 help grisp deploy for information on all arguments.

Configuration

rebar.config:

{grisp, [
    {otp, [{version, "22.0"}]},
    {deploy, [
        % Path to put deployed release in
        {destination, "/path/to/destination"},

        % Shell script to run before deploying begins
        {pre_script, "rm -rf /path/to/destination/*"},

        % Shell script to run after deploying has finished
        {post_script, "umount /path/to/destination"}
    ]}
]}.

Listing Packages

The plug-in can list pre-built GRiSP OTP packages and toolchains:

$ rebar3 grisp package list
===> GRiSP pre-built OTP versions for platform 'grisp2'
Version
23.3.4.11
23.3.4.9
$ rebar3 grisp package list --type=toolchain
===> GRiSP pre-built toolchain packages
OS     Latest  OS Version         Url
Linux  true    5.11.0-1027-azure  https://grisp.s3.amazonaws.com/platforms/grisp2/toolchain/grisp2-rtems-toolchain_Linux_5.11.0-1027-azure_e2c29d3374d9046af01af570f6a85a6aa99546bb.tar.gz
Linux          5.11.0-1028-azure  https://grisp.s3.amazonaws.com/platforms/grisp2/toolchain/grisp2-rtems-toolchain_Linux_5.11.0-1028-azure_3122986b9cd7073f42f1387f3981c812a2909b68.tar.gz
macOS  true    10.15.7            https://grisp.s3.amazonaws.com/platforms/grisp2/toolchain/grisp2-rtems-toolchain_macOS_10.15.7_e2c29d3374d9046af01af570f6a85a6aa99546bb.tar.gz
macOS          11.6.3             https://grisp.s3.amazonaws.com/platforms/grisp2/toolchain/grisp2-rtems-toolchain_macOS_11.6.3_3122986b9cd7073f42f1387f3981c812a2909b68.tar.gz

Build OTP for GRiSP

The fastest way is to use our docker image grisp/grisp2-rtems-toolchain:

Add the toolchain image name to the rebar.config under grispbuildtoolchaindocker

Or if you have a local installation you can use that:

Add the path to the toolchain to the rebar.config under grispbuildtoolchaindirectory

{grisp, [
    {otp, [{version, "25"}]},
    {build, [
        {toolchain, [
            {directory, "/PATH/TO/TOOLCHAIN-ROOT"}
            % Or use docker
            {docker, "grisp/grisp2-rtems-toolchain"}
            % If both are specified, only 'directory' is used
        ]}
    ]},
    {deploy, [
        {destination, "/PATH/TO/DESTINATION"}
    ]}
]}.

Then execute rebar3 grisp build. This will take some time, because Erlang/OTP is cross-compiled for the GRiSP board.

You only need to do that again if you updated and rebuilt the grisp2-rtems-toolchain repository or if you changed or wrote new drivers in C. If you need to build OTP for a second time and just changed files you can speed it up by using rebar3 grisp build --configure false. Each time you add new C files you will need to run configure again, because this tool will apply a patch to a makefile for each C driver, NIF and system file.

You can create the tarballs we use for distribution on our CDN with rebar3 grisp build --tar true

The built Erlang distribution and its runtime system is located in the project folder, under the path _grisp/otp/<version>/install.

Bug reports

You can run rebar3 grisp report to gather info about the project configuration. The user can view and edit the generated text files. It's possible to pack them later adding --tar to the same command. Providing such report file can speedup debugging and support from the dev team.

Development

To test the plug-in and develop for it, we recommend checking out a specific version into a local project. You can also create a new temporary GRiSP project using this plug-in. This can be useful to test deployments locally before copying them to an SD card:

$ rebar3 new grispapp name=grisp_test dest=/tmp/GRISP_SD_CARD

Go into the project folder and prepare the checkout directory used by Rebar 3 for dependency overrides:

$ cd grisp_test
$ mkdir -p _checkouts

Testing master

You need to clone both rebar3_grisp (this repo) and its dependency grisp_tools. If you want the latest master versions:

$ git clone git clone https://github.com/grisp/rebar3_grisp.git _checkouts/rebar3_grisp
$ git clone git clone https://github.com/grisp/grisp_tools.git _checkouts/rebar3_grisp

Testing a Specific Branch

Alternatively, clone a specific branch. Replace $REBAR3_PLUGIN_BRANCH with the branch name you want from rebar3_grisp and $GRISP_TOOLS_BRANCH with the branch name you want from grisp_tool:

$ git clone git clone --single-branch --branch $REBAR3_PLUGIN_BRANCH https://github.com/grisp/rebar3_grisp.git _checkouts/rebar3_grisp
$ git clone git clone --single-branch --branch $GRISP_TOOLS_BRANCH https://github.com/grisp/grisp_tools.git _checkouts/rebar3_grisp

In case you only need a specific branch of rebar3_grisp, you can default to using the master version of grisp_tools.