Raspberry Pi Zero 2 W and 3 A+ (64-bit)

This is the main branch. If you are customizing a v1.x system, please see the maint-v1.x branch. See the "Upgrading to 2.0" section if you are upgrading your Nerves system dependency.

This is the base Nerves System configuration for the Raspberry Pi Zero 2 W with the USB port running in gadget mode. It is similar to nerves_system_rpi3a except that it runs the ARM Cortex-A53 in 64-bit mode to support the Erlang JIT.

Using

The most common way of using this Nerves System is create a project with mix nerves.new and to export MIX_TARGET=rpi0_2. 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.

Upgrading to 2.0

If your application depended on a pre-2.0 version of this Nerves system and you are upgrading, you'll need to start validating firmware after it boots the first time. If you don't do this, the Nerves MOTD will show that the firmware hasn't been validated when you log in. You can manually validate by calling Nerves.Runtime.validate_firmware/0 or running the fw_validate helper at the IEx prompt. If you don't do this, the device will run the old firmware on the next reboot.

A simple default way of validating the firmware can be enabled using Nerves.Runtime's startup guard feature as described in Assisted firmware validation and automatic revert. Please follow the directions there for the needed config file update.

If in doubt, use mix nerves.new to create a new project and compare what it creates to your project. If you haven't modified the Nerves-specific configuration parts of your project much, the firmware validation piece should be the main update.

Please also review your use of Nerves.Runtime.KV in your application since the nerves_fw_active key no longer is used. Use Nerves.Runtime.firmware_slots/0 to determine the active firmware slot. The nerves_fw_active key wasn't always accurate, so it was removed to avoid a misleading answer. The function call is reliable and also a generic way to determine slot status on all Nerves platforms.

Supported WiFi devices

The base image includes drivers for the onboard Raspberry Pi Zero 2 wifi module (brcmfmac driver).

Camera

This system supports the official Raspberry Pi camera modules via libcamera. The libcamera applications are included so it's possible to replicate many of the examples in the official Raspberry Pi Camera Documentation.

Here's an example commandline to run:

cmd("libcamera-jpeg -n -v -o /data/test.jpeg")

On success, you'll get an image in /data that you can copy off with sftp.

Since libcamera is being used instead of MMAL, the Elixir picam library won't work.

Bluetooth

BlueHeronTransportUART supports Bluetooth on the Raspberry Pi Zero 2 W using ttyS0. The details are similar to the [RPi Zero W] (https://github.com/nerves-project/nerves_system_rpi0/issues/224#issuecomment-913799838).

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.

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

cmd("amixer cset numid=3 2")

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

Gadget mode on the 3A+!

The Raspberry Pi 3 Model A+ is supported by the official nerves_system_rpi3, but the USB port is configured to work as a host only. This Raspberry Pi can be connected directly to your computer via a USB cable like the Raspberry Pi Zeros. To do this, you'll need a USB A to USB A connector like this or this.

Linux's preempt_rt patches

If you need better real-time performance from the Linux kernel, the preempt_rt patch set may help. Be aware that we do not test with the patches so this may not work. To enable it, make a custom system using this one as a base and add the following to the nerves_defconfig:

BR2_LINUX_KERNEL_PATCH="http://cdn.kernel.org/pub/linux/kernel/projects/rt/4.19/patch-4.19.25-rt16.patch.xz"

Please verify the patch version since these instructions may be out-of-date.

Next, update the Linux configuration to use it. Review the Nerves documentation for running make linux-menuconfig and enable PREEMPT_RT_FULL. Alternately, make the following change to the Linux configuration:

-CONFIG_PREEMPT=y
+CONFIG_PREEMPT_RT_FULL=y

Build the system and you should now have a preempt_rt kernel.

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 | "12345678" | 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 12345678")

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=12345678 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 by SparkFun Electronics - https://www.sparkfun.com/products/18713, CC BY 2.0, https://commons.wikimedia.org/w/index.php?curid=111936085