Skip to content

Latest commit

 

History

History
108 lines (74 loc) · 4.49 KB

README.rst

File metadata and controls

108 lines (74 loc) · 4.49 KB
Raw

MtigOS

An out of the box Raspberry Pi "Raspberry Pi OS" distro that lets you receive, store and graph sensor information from ESP8266 chips.

It uses and MTIG stack: Mosquitto, Telegraf, InfluxDB and Grafana which are all pre-configured to work together. They automatically update using Docker.

Where to get it?

You can use the pi-imager commuity raspberrypi imager here, unofficial section.

Or download directly form the official mirror here

How to use it?

Blog post with step-by-step instructions here

  1. Unzip the image and install it to an SD card like any other Raspberry Pi image
  2. Configure your WiFi by editing mtigos-wpa-supplicant.txt at the root of the flashed card when using it like a flash drive
  3. Boot the Pi from the SD card
  4. Hostname is mtigos (not raspberrypi as usual), username: pi and inital password is: raspberry
  5. After a few mintues you should be able to access http://mtigos.local/
  6. You can change the settings of the MTIG stack in the files located at /boot/docker-compose/mtig/
  7. Flash an ESP8266 with the sketches here. Full blog post with schematics here.

Requirements

  • Raspberrypi all versions should work
  • 2A power supply
  • Esp8266 with one of the supported sensors

Features

  • Mosquitto, Telegraf, InfluxDB and Grafana which are all pre-configured to work together.
  • Pre-installed dashboards for grafana to display Temperature, moisture and PH.

Developing

Requirements

  1. Docker or Vagrant, docker recommended
  2. Docker-compose - recommended if using docker build method, instructions assume you have it
  3. Downloaded Raspbian Lite image.
  4. Root privileges for chroot
  5. Bash
  6. sudo (the script itself calls it, running as root without sudo won't work)

Build MtigOS

MtigOS can be built using docker running either on an intel or RaspberryPi (supported ones listed). Build requires about 4.5 GB of free space available. You can build it assuming you already have docker and docker-compose installed issuing the following commands:

git clone https://github.com/guysoft/MtigOS.git
cd MtigOS/src/image
wget -c --trust-server-names 'https://downloads.raspberrypi.org/raspios_lite_armhf_latest'
cd ..
sudo docker-compose up -d
sudo docker exec -it mtigos-build build

Building MtigOS Variants

MtigOS supports building variants, which are builds with changes from the main release build. An example and other variants are available in the folder src/variants/example.

To build a variant use:

sudo docker exec -it mtigos-build build [Variant]

Building Using Vagrant

There is a vagrant machine configuration to let build MtigOS in case your build environment behaves differently. Unless you do extra configuration, vagrant must run as root to have nfs folder sync working.

To use it:

sudo apt-get install vagrant nfs-kernel-server
sudo vagrant plugin install vagrant-nfs_guest
sudo modprobe nfs
cd MtigOS/src/vagrant
sudo vagrant up

After provisioning the machine, its also possible to run a nightly build which updates from devel using:

cd MtigOS/src/vagrant
run_vagrant_build.sh

To build a variant on the machine simply run:

cd MtigOS/src/vagrant
run_vagrant_build.sh [Variant]

Usage

  1. If needed, override existing config settings by creating a new file src/config.local. You can override all settings found in src/config. If you need to override the path to the Raspbian image to use for building MtigOS, override the path to be used in ZIP_IMG. By default, the most recent file matching *-raspbian.zip found in src/image will be used.
  2. Run src/build_dist as root.
  3. The final image will be created in src/workspace

Code contribution would be appreciated!