FAQ

Ludwig Knüpfer edited this page Feb 25, 2017 · 37 revisions
Clone this wiki locally

Under what license is RIOT code released?

The license is currently LGPLv2.1

Why LGPL?

Studies such as this one show that small companies and start-ups are going to determine IoT. More than bigger companies, such small structures need to spread development and maintenance costs for the kernel and all the software that is not their core business. Our analysis is that this is more compatible with LGPL than with BSD/MIT.

We are of the opinion that, compared to BSD/MIT, LGPL will improve final user experience, security and privacy, by hindering device lock-down, favoring up-to-date, and field-upgradable code. We think this a more solid base to provide a consistent, compatible, secure-by-default standard system which developers can build upon to create trustworthy IoT applications, while not hindering business models based on closed source linked with RIOT (see the automated tools provided to help check LGPL compliance, and/or this technical guide)

Since solutions competing with RIOT are quasi-exclusively BSD/MIT, we gauge that LGPL is a way to stand out favorably, and is a characteristic backing positive comparisons of RIOT with Linux.

Last but not least, we think that (L)GPL is a better base than BSD/MIT to keep the community united in the mid and long run.

For the record: we have also considered MIT/BSD (see this thread), but there was not enthusiastic majority supporting such a switch.

Compare https://github.com/RIOT-OS/RIOT/issues/2128

How is RIOT development organized?

In short there are certain Coding Conventions to follow and we are using Github's pull requests for code review. So for new features and fixes create a fork of the RIOT repository and open a pull request with a detailed description of your changes.

For a more in depth description check out the dedicated page on development procedures.

Also, do check out the open community processes.

What should be my first steps to get started?

So we attracted your attention? That's great!
The Starter Guide might be just what you are looking for.

I want to contribute. How should I proceed?

First of all, welcome to the RIOT community! There is a dedicated page on contributing listing opportunities to interact with fellow RIOT enthusiasts and some suggestions how to get started.

I have an issue with RIOT code I can't solve. How can I get help?

Log an issue in GitHub. Then post to the mailing list devel@riot-os.org and/or users@riot-os.org. You're also welcome to ask in the IRC channel #riot-os at freenode.net, but don't be disappointed if everyone there is busy. It is also a very good idea to search the mailing list archives of the devel@ and/or users@ mailing lists.

Does RIOT run as-is on my hardware?

Check out this page on supported hardware. If your hardware is not listed there, you're welcome to provide a port for your hardware!

How much memory (ROM/RAM) will it need?

This depends on the board and on the application. When you compile an application for a board, the last thing printed gives each sections memory footprint and looks like this:

text       data     bss     dec     hex filename
  77732     296   24272  102300    18f9c applications/sixlowapp/bin/iot-lab_M3/sixlowapp.elf

The required RAM is data + bss, ROM is text + data.

Please note: Usually a big portion of RAM is consumed by the stack space for threads. Although RIOT maintainers try to optimize the default values, manual tweaking may be necessary to get the most efficient results. You can check the maximum stack usage at runtime with the shell command ps or the corresponding function thread_print_all() from the module ps.

My terminal doesn't recognize newlines coming from RIOT over serial!

See this page.

Does RIOT support Raspberry PI?

No. From the RIOT point of view the Raspberry PI is a supercomputer. RIOT targets mostly systems that are too constrained to run Linux (less than 1MB of RAM, no MMU). However, it is supported to run RIOT native on platforms like the Raspberry PI, and other hardware supported by Linux or BSD.

A good rule of thumb concerning RIOT support of a particular board is: can Linux support this board? If yes, then you should ask yourself why you really want to use RIOT (other than native) on this board. If no, then RIOT support is probably desirable.

(Why) is there no 64 bit support, at least in native?

There is not much to be gained from 64 bit support as RIOT does not target any other platforms that offer 64 bit. That being said there are pros and cons.

Pro:

  • improve RIOT's code base by fixing 64 related errors
  • simplify toolchain setup for native

Con:

  • effort / gain (as it's unlikely we will support any other 64 bit platform, fixing potential 64 bit errors in RIOT is less beneficial)
  • decreased 32 bit testing (unless we make 32 the default in which case the toolchain setup argument is diminished)

From our perspective this does not justify pulling manpower from other tasks. Nobody will stop you from adding support if you want to, though ;)