Base Nerves system configuration for the Raspberry Pi 2
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci nerves_system_br: bump to v1.5.2 Sep 25, 2018
assets/images Add more information on generated image May 12, 2016
fwup_include Add provisioning.conf and include it in fwup.conf Aug 20, 2018
rootfs_overlay Fix commands/spacing Sep 25, 2018
test nerves_system_br: bump to v1.5.1 Sep 25, 2018
.formatter.exs mix format Mar 14, 2018
.gitignore Synchronize files with other systems Mar 17, 2018
CHANGELOG.md v1.5.0 Oct 3, 2018
CODE_OF_CONDUCT.md Add links to contribution guides Aug 27, 2018
CONTRIBUTING.md Add links to contribution guides Aug 27, 2018
ISSUE_TEMPLATE.md Add links to contribution guides Aug 27, 2018
LICENSE updated license and package info for hex Apr 3, 2016
README.md Enable audio output over HDMI and the stereo jack Sep 29, 2018
VERSION v1.5.0 Oct 3, 2018
cmdline.txt Fix UART docs; sync with other RPi systems May 2, 2018
config.txt Enable audio output over HDMI and the stereo jack Sep 29, 2018
fwup-revert.conf Bump nerves_system_br; sync up revert changes Jan 7, 2018
fwup.conf Fix commands/spacing Sep 25, 2018
linux-4.14.defconfig Enable audio output over HDMI and the stereo jack Sep 29, 2018
mix.exs nerves_system_br: bump to v1.5.2 Sep 25, 2018
mix.lock nerves_system_br: bump to v1.5.2 Sep 25, 2018
nerves_defconfig Enable audio output over HDMI and the stereo jack Sep 29, 2018
post-build.sh Add provisioning.conf and include it in fwup.conf Aug 20, 2018
post-createfs.sh Bump RPi kernel to 4.4.43 Jan 27, 2017

README.md

Raspberry Pi 2 Model B

CircleCI

This is the base Nerves System configuration for the Raspberry Pi 2 Model B.

Fritzing Raspberry Pi 2 image
Image credit

Feature Description
CPU 900 MHz quad-core ARM Cortex-A7
Memory 1 GB DRAM
Storage MicroSD
Linux kernel 4.14 w/ Raspberry Pi patches
IEx terminal HDMI and USB keyboard (can be changed to UART)
GPIO, I2C, SPI Yes - Elixir ALE
ADC No
PWM Yes, but no Elixir support
UART 1 available - ttyAMA0
Camera Yes - via rpi-userland
Ethernet Yes
WiFi Requires USB WiFi dongle
Bluetooth Not supported
Audio HDMI/Stereo out

Using

The most common way of using this Nerves System is create a project with mix nerves.new and to export MIX_TARGET=rpi2. See the Getting started guide for more information.

If you need custom modifications to this system for your device, clone this repository and update as described in Making custom systems

If you're new to Nerves, check out the nerves_init_gadget project for creating a starter project. It will get you started with the basics like bringing up networking, initializing the writable application data partition, and enabling ssh-based firmware updates. It's easiest to begin by using the wired Ethernet interface 'eth0' and DHCP.

Supported USB WiFi devices

The base image includes drivers and firmware for Ralink RT53xx (rt2800usb driver), RealTek RTL8712U (r8712u driver) and RealTek RTL 8192 (rtl8192cu driver) devices (e.g. Edimax USB WiFi dongles).

We are still working out which subset of all possible WiFi dongles to support in our images. At some point, we may have the option to support all dongles and selectively install modules at packaging time, but until then, these drivers and their associated firmware blobs add significantly to Nerves release images.

If you are unsure what driver your WiFi dongle requires, run Raspbian and configure WiFi for your device. At a shell prompt, run lsmod to see which drivers are loaded. Running dmesg may also give a clue. When using dmesg, reinsert the USB dongle to generate new log messages if you don't see them.

Audio

The Raspberry Pi has many options for audio output. This system supports the HDMI and stereo audio jack output. The Linux ALSA drivers are used for audio output.

To try it out, run:

:os.cmd('espeak -ven+f5 -k5 -w /tmp/out.wav Hello')
:os.cmd('aplay -q /tmp/out.wav')

The general Raspberry Pi audio documentation mostly applies to Nerves. For example, to force audio out the HDMI port, run:

:os.cmd('amixer cset numid=3 2')

Change the last argument to amixer to 1 to output to the stereo output jack.

Provisioning devices

This system supports storing provisioning information in a small key-value store outside of any filesystem. Provisioning is an optional step and reasonable defaults are provided if this is missing.

Provisioning information can be queried using the Nerves.Runtime KV store's Nerves.Runtime.KV.get/1 function.

Keys used by this system are:

Key Example Value Description
nerves_serial_number "1234578"` By default, this string is used to create unique hostnames and Erlang node names. If unset, it defaults to part of the Raspberry Pi's device ID.

The normal procedure would be to set these keys once in manufacturing or before deployment and then leave them alone.

For example, to provision a serial number on a running device, run the following and reboot:

iex> cmd("fw_setenv nerves_serial_number 1234")

This system supports setting the serial number offline. To do this, set the NERVES_SERIAL_NUMBER environment variable when burning the firmware. If you're programming MicroSD cards using fwup, the commandline is:

sudo NERVES_SERIAL_NUMBER=1234 fwup path_to_firmware.fw

Serial numbers are stored on the MicroSD card so if the MicroSD card is replaced, the serial number will need to be reprogrammed. The numbers are stored in a U-boot environment block. This is a special region that is separate from the application partition so reformatting the application partition will not lose the serial number or any other data stored in this block.

Additional key value pairs can be provisioned by overriding the default provisioning.conf file location by setting the environment variable NERVES_PROVISIONING=/path/to/provisioning.conf. The default provisioning.conf will set the nerves_serial_number, if you override the location to this file, you will be responsible for setting this yourself.

Linux kernel and RPi firmware/userland

There's a subtle coupling between the nerves_system_br version and the Linux kernel version used here. nerves_system_br provides the versions of rpi-userland and rpi-firmware that get installed. I prefer to match them to the Linux kernel to avoid any issues. Unfortunately, none of these are tagged by the Raspberry Pi Foundation so I either attempt to match what's in Raspbian or take versions of the repositories that have similar commit times.

Image credit: This image is from the Fritzing parts library.