Nerves QtWebEngine Kiosk system for Raspberry Pi 3
Elixir Shell HTML CSS
Clone or download
Latest commit daf10e8 Aug 15, 2018

README.md

Raspberry Pi 3 Kiosk

Implements qt-webengine-kiosk for rendering QtWebEngine.

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

Fritzing Raspberry Pi 3 image
Image credit

Feature Description
CPU 1.2 GHz quad-core ARMv8
Memory 1 GB DRAM
Storage MicroSD
Linux kernel 4.9 w/ Raspberry Pi patches
IEx terminal ttyS0
GPIO, I2C, SPI Yes - Elixir ALE
ADC No
PWM Yes, but no Elixir support
UART 1 available - ttyS0
Camera Yes - via rpi-userland
Ethernet Yes
WiFi Yes - Nerves.InterimWiFi
Bluetooth Not yet

Using

The most common way of using this Nerves System is create a project with mix nerves.new and to export MIX_TARGET=rpi3.

Then, change the rpi3 system dependency to {:kiosk_system_rpi3, "~> 1.0"}

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

See the example project for more info

Building

Building this image require running under docker. If you are compiling locally, your instance of docker will need to have at least 8gb of ram assigned to it.

Built-in WiFi Firmware

WiFi modules almost always require proprietary firmware to be loaded for them to work. The Linux kernel handles this and firmware blobs are maintained in the linux-firmware project. The firmware for the built-in WiFi module on the RPi3 hasn't made it to the linux-firmware project nor Buildroot, so it is included here in a rootfs-additions overlay directory. The original firmware files came from https://github.com/RPi-Distro/firmware-nonfree/blob/master/brcm80211/brcm.

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

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 serial_number 1234")

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

sudo 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.