Technische informatie

Meet je leefomgeving

Meet je leefomgeving (MJLO) is een project van Ichthus College Veenendaal, gestart door Klaas van Lavieren en doorontwikkeld door Steven Boonstoppel. MJLO omvat 60 sensorkastjes die allerlei verschillende omgevingsfactoren meet (zoals temperatuur, luchtdruk, fijnstof e.d.).
In deze repository is de meest recente software te vinden die op de meetkastjes gebruikt wordt. Ook is het aansluitschema aanwezig en verdere informatie en instructies rondom het bouwen van een kastje.
Bij interesse om aan te sluiten bij het project kan contact opgenomen worden via [email protected].
In principe is bijna alles openbaar te vinden op deze site, met uitzondering van enkele 'secrets'.

Een kastje flashen en activeren

Download de officiële release en flash deze op de LoPy4 door middel van de Pycom Firmware Updater (flash from local file, use LittleFS). Vervolgens moet eenmalig een aantal registers opgeslagen worden voor instellingen: daarvoor is bij releases meestal een bestand upgrade.py beschikbaar. Stel daarin het nummer voor de node in, en steek het vervolgens via een microSD in het Expansion Board. Bij juiste benaming van het bestand (dat is een secret), wordt het uitgevoerd. Verder is er nog een bestand secret.py dat hier niet te vinden is en noodzakelijke sleutels bevat voor activatie van het kastje.

Algemene opzet

De focus van de kastjes ligt uiteraard op uithoudingsvermogen. Praktisch betekent dat dat elke sensor zo kort mogelijk actief is en de stroomsterkte geminimaliseerd is.
Met dat doel voor ogen is de volgende constructie opgezet:
De kastjes worden zes keer per uur 'wakker' uit een diepe slaapstand. Als eerste wordt de fijnstofsensor geactiveerd: deze moet ongeveer 25 tot 30 seconden aanstaan om een goede meetwaarde te krijgen. Ondertussen worden een voor een de andere sensoren uitgelezen.
Zodra de eerste helft aan sensoren gemeten is, worden die meetwaarden op het scherm weergegeven. De tweede helft wordt weergegeven zodra de andere sensoren zijn gemeten.
Terwijl de tweede set aan waarden op het display staat, wordt de data verzonden via LoRa. Elk derde bericht wordt verzonden op SF12, de andere twee op SF10: er mag namelijk niet continu op SF12 worden gecommuniceerd. Daarna wordt nog een paar seconden gewacht zodat het display nog even af te lezen is.

De GPS-module wordt alleen bij het opstarten geactiveerd - daarna wordt aangenomen dat een kastje volledig stationair is en niet verplaatst wordt terwijl hij actief is. De GPS-module staat aan totdat er een locatie fix is: een valide locatie met een hdop < 5. Daarna wordt GPS uitgeschakeld.

Zodra een meetcyclus voltooid is gaat het kastje in deepsleep waarbij nagenoeg alle componenten uitgeschakeld zijn: alleen de drukknop aan de zijkant van het kastje wordt nog gemonitord. Wordt die knop ingedrukt, dan wordt het kastje wakker gemaakt en verricht een meting. Dit helpt bijvoorbeeld bij bepaalde opdrachten waarbij leerlingen vaker een meting willen / moeten doen dan het standaard-interval van 10 minuten.

LoRa en The Things Network

De data van de kastjes wordt verzonden via het LoRa (Long Range) protocol. De kastjes fungeren als end node en communiceren met de antenne bovenop het Ichthus College en eventuele andere antennes in de omgeving (Scherpenzeel, Aalst, ..). Daarvoor kan gebruik gemaakt worden van verschillende data-rates met elk hun eigen voordelen.
De antennes en daarmee de kastjes zijn aangesloten op het The Things Network (TTN). Deze ondersteunt standaard SF7 t/m SF12 (respectievelijk data rates 5 t/m 0). Hoe lager de data rate, hoe groter het bereik. SF7 en SF8 zijn gelimiteerd tot 235 bytes per bericht, SF9 tot 128 bytes, en SF10 t/m SF12 tot 51 bytes. Helaas is het niet toegestaan om alleen gebruik te maken van SF11 en/of SF12; apparaten die dit verrichten worden pro-actief geblokkeerd. Hoe hoger de Spreading Factor, hoe groter het bereik en hoe meer airtime en stroom het kost om de berichten te versturen. Achtergrondinformatie.
Voor het versturen van de LoRa berichten wordt gebruik gemaakt van een eigen decoder. De waarden worden verpakt in integers met een bepaalde precisie en gecodeerd tot kale bytes. Vervolgens draait op TTN een decoder die op dezelfde wijze de getallen terugberekend. De LoRa berichten van de kastjes zijn 20 bytes (of 30 bij GPS) in omvang. Deze worden gedecodeerd via de Payload Formatter op TTN, en daaruit doorgestuurd naar twee onafhankelijke opslaglocaties in beheer van het Ichthus College.

Hardware

Microcontroller: Pycom LoPy4 op Expansion Board v3(.1)
Accu: Keeppower Li-ion 26650 5200 mAh
LoRa antenne
SSD1306 OLED display (4-pin I2C variant!)
VEML6070 UV sensor
TSL2591 Lux sensor (andere uitvoering)
BME680 Temperatuur/luchtvochtigheid/luchtdruk sensor (andere uitvoering)
MAX4466 Volume sensor
MQ135 CO2 sensor
SDS011 Fijnstof sensor
Neo-6M GPS module

LoPy4

Pinout
Micropython for LoPy4 documentation

Expansion Board v3.1

Let op: versie 3.1 van dit breakout board verschilt op meer vlakken van v3.0 dan de fabrikant beweert. Daarnaast is het stroomverbruik zeer slecht gedocumenteerd in verschillende modi. Gebruik dan ook de tweede link hieronder voor een zorgvuldige en complete analyse van de verschillende versies van het Expansion Board.
Specs: definitely a lie
Specs: much better
Voltage divider: mess

Stroomgebruik

Zie de figuur hieronder voor het stroomgebruik van een kastje (zonder dat het zonnepaneeltje is aangesloten). De gemiddelde stroomsterkte tijdens een meting is 100 mA; in deepsleep een kleine 3 mA.
De accuduur is ongeveer drie weken, waarbij het zonnepaneel buiten beschouwing wordt gelaten.

Schema

Zie de figuur voor de opbouw van het circuit in de sensorkastjes.

Custom firmware

De eenvoudige variant voor het ontwikkelen van software is het uploaden van alle losse bestanden naar /flash. Bij het wijzigen van een bestand kan dat losse bestand snel gewijzigd en opnieuw geupload worden. Er zijn echter meerdere nadelen aan verbonden:

  • Het uploaden van alle bestanden kan lang duren (ca. een minuut)
  • Het is onduidelijk of alle bestanden van de nieuwste versie zijn
  • OTA updates zijn niet goed uit te voeren
  • Ieder willekeurig persoon kan de bestanden downloaden en de sleutels misbruiken
  • Het importeren van bestanden na deepsleep duurt meerdere seconden
  • Het aansluiten van een kastje via USB-kabel vereist meerdere pruts-handelingen

Daarom is ervoor gekozen om zelf de firmware te compilen (Linux only!) en daar de software bij in te vriezen; het lost alle bovenstaande problemen op (behalve dat een OTA update ook ca. een minuut duurt). Daarvoor zijn de volgende stappen nodig, verzameld van een aantal links die eronder vermeld zijn:

  • sudo apt-get install git gcc python3 make
  • git clone --recursive -b idf_v3.3.1 https://github.com/pycom/pycom-esp-idf.git
  • cd pycom-esp-idf
  • nano tools/idf_tools.py -> regel 1155: verwijder '--no-site-packages' optie
  • ./install.sh

De volgende twee regels moeten elke keer uitgevoerd worden bij het openen van een terminal alvorens de firmware te compilen (tenzij het lukt om PATH goed in te stellen):

  • . ./export.sh
  • idf.py build
  • cd ..
  • git clone --recursive https://github.com/pycom/pycom-micropython-sigfox.git
  • cd pycom-micropython-sigfox
  • cd mpy-cross && make clean && make && cd ..
  • cd esp32
  • nano Makefile -> regel 12: vervang WIPY door LOPY4 om standaard voor de LoPy4 te compilen

(De volgende opmerkingen gaan er allemaal vanuit dat je je in de map pycom-micropython-sigfox/esp32 bevindt.)

Om bestanden te bevriezen, moeten ze in de subfolder /frozen/Base geplaatst worden. Standaard staan daar een _boot.py en _main.py: die kunnen overschreven worden met de desbetreffende bestanden uit deze repository zonder verlies van functionaliteit.
Om relatieve imports te behouden (bijvoorbeeld import lib.SSD1306) kan de map /lib ook gewoon binnen de map /frozen/Base geplaatst worden.
Let op: het is niet mogelijk de bestanden boot.py en main.py zelf te bevriezen: die worden standaard geleegd bij het compilen.

Om de versienaam aan te passen:

  • nano pycom_version.h -> regel 13: aanpassen
    bron

Om aan te passen welk bestand er uitgevoerd wordt na _boot.py en _main.py (in dit geval "error.py" in /frozen/Base):

  • nano mptask.c -> regel 339: vervang pyexec_file(main.py) door pyexec_frozen_module("error.py")
    bron

Om een OrderedDict toe te voegen:

  • nano mpconfigport.h -> regel 79 nieuwe regel: #define MICROPY_PY_COLLECTIONS_ORDEREDDICT (1)
    bron

De volgende regel is (elke keer) nodig om de firmware te compilen:

  • make clean && make && make release

Het resulterende .tar.gz bestand staat in de subfolder /build. Dit bestand kan gebruikt worden om de LoPy4 te flashen via de Pycom Firmware Updater. Om het .bin bestand te verkrijgen dat nodig is voor de OTA updates, moet de .tar.gz uitgepakt worden via bijvoorbeeld tar -xzf filename: het resulterende lopy4.bin is het gezochte bestand.

Installing pycom-esp-idf
Installing pycom-micropython-sigfox
Frozen modules documentation
Modyfing startup sequence