diff --git a/README.md b/README.md index 94d4e52..e2dd131 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,29 @@ # FBDASH - lightweight dashboard for the RaspberryPi without X (using framebuffer only) - + +- [Installation and Setup](#installation-and-setup) + - [Get the sources](#get-the-sources) + - [Connect the display to the RaspberryPi](#connect-the-display-to-the-raspberrypi) + - [Full connection diagram (9 wires needed)](#full-connection-diagram-9-wires-needed) + - [Minimal connection diagram (7 wires needed)](#minimal-connection-diagram-7-wires-needed) + - [Some explanation about the wiring](#some-explanation-about-the-wiring) + - [Configure the display](#configure-the-display) + - [Enable SPI interface on the RaspberryPi](#enable-spi-interface-on-the-raspberrypi) + - [Activate modules to be loaded on boot](#activate-modules-to-be-loaded-on-boot) + - [Setup fbdash binary](#setup-fbdash-binary) + - [Build the sources](#build-the-sources) + - [Install in /usr/bin](#install-in-usr-bin) + - [Test it](#test-it) + - [Use systemd for regular updates](#use-systemd-for-regular-updates) + - [Install unit files](#install-unit-files) + - [Check timers](#check-timers) + - [Controlling the backlight](#controlling-the-backlight) + +# Installation and setup + ## Get the sources In order to setup the dashboard start with cloning this repo ;) @@ -46,7 +66,7 @@ Wire the display connector according to the connector scheme below.\ GND --------------------------- GND | | PIN 9,14,20,25 VCC --------------------------- 3,3V | | PIN 1,17 -### Some explanation +### Some explanation about the wiring |---------> Power GND --| VCC --| @@ -75,10 +95,10 @@ Essentially we need to * Load the fbtft_device kernel module with the correct parameters to get a working /dev/fb1 framebuffer device. -### Enable SPI interface on the raspberry pi +### Enable SPI interface on the RaspberryPi echo "dtparam=spi=on" | sudo tee -a /boot/config -### Activate modules to be loaded at boot +### Activate modules to be loaded on boot echo "spi_bcm2835" | sudo tee -a /etc/modules echo "fbtft_device" | sudo tee -a /etc/modules echo "options fbtft_device name=rpi-display gpios=reset:25,dc:24,led:18" | sudo tee -a /etc/modprobe.d/fbtft_device.conf