Skip to content

Latest commit

 

History

History
207 lines (141 loc) · 4.1 KB

hands_on.md

File metadata and controls

207 lines (141 loc) · 4.1 KB

class: center, middle, riot

Bachelor PO - RIOT in the Internet of Things

Hands On

Raphael Hiesgen, Peter Kietzmann, Sebastian Meiling, Thomas C. Schmidt

:scale 50%

iNET, Department Informatik, HAW Hamburg

Getting Started

First Steps

Important Links

  1. Code: https://github.com/RIOT-OS/RIOT
  2. Wiki: https://github.com/RIOT-OS/RIOT/wiki
  3. Mailing List: [email protected]
  4. IRC: irc.freenode.org #riot-osv

Development Environment

The vagrant image created by RIOT already includes most compilers and tools for flashing.

Try an Example

  • Open a terminal
  • Get the code & switch to your branch
$ git clone https://github.com/USERNAME/RIOT.git
$ cd RIOT
$ git checkout <working_branch>
  • Start vagrant
$ vagrant up
$ vagrant ssh
  • Compile and flash an example
$ cd RIOT/examples/hello-world
$ # Connect a Atmel SAM R21 Xplained Pro board via USB
$ BOARD=samr21-xpro make all flash term

Application Output

  • Press the reset button on the board
  • You should see a Hello World! message
  • Congratulations, you just flashed your first RIOT application! :-)

Create Your Own Project

  • Copy the hello-world files to your project folder
  • Edit main.c and add new includes ...
#include "board.h"
#include "xtimer.h"
  • ... and code for the LEDs
for(int i = 0; i < 10; i++) {
    puts("LED on");
    LED_RED_ON;
    xtimer_sleep(1);
    puts("LED off");
    LED_RED_OFF;
    xtimer_sleep(1);
}

Adjust the Makefile

  • Rename you application
APPLICATION = my_project
  • Include the xtimer module
USEMODULE += xtimer

Flash and start your project

  • Sync your project folder using the VirtualBox UI OR via the Vagrantfile in RIOT
config.vm.synced_folder ".", "/home/vagrant/RIOT"
# Add this line to sync your PROJECT folder to /home/vagrant/PROJECT
config.vm.synced_folder "/path/to/PROJECT", "/home/vagrant/PROJECT"
  • Reload and connect to vagrant
$ vagrant reload && vagrant ssh
  • Compile and flash your project
$ cd your/project
$ BOARD=samr21-xpro make all flash term
  • In addition to the message, you should see a blining LED

HOWTO: Track Changes with Git

  • Set your name and email
$ git config --global user.email "[email protected]"
$ git config --global user.name "Your Name"
  • Look at your changes
$ git status
  • Add, commit and push files
$ git add FILE_1 FILE_2
$ git commit
$ git push
  • Reset an uncommited file to the upstream
$ git checkout FILE

HOWTO: Update Your Fork

  • RIOT regularly receives updates in form of pull requests.
  • To update your fork:
    • update your master branch
    • rebase your working branch to your master.
$ git checkout master
$ git pull https://github.com/RIOT-OS/RIOT.git
$ git checkout <working_branch>
$ git rebase master

Git Help

There are various sites online that explain git. Here are a few we like:

class: center, middle, riot :scale 100%

www.riot-os.org