Our main target is having working prebuilt binaries for users to simply download and run, to avoid all the setup below. See releases to download the software for your system.
Note: you need drivers for the USB2serial chipset:
-
Drivers for NodeMCU v3 (CH340)
- Windows (Windows 10 should be able to automatically download these; 2018/09/04 v3.4 mirror)
- MacOS (2018/09/04 v1.4 mirror)
-
Drivers for NodeMCU v2 (CP2102)
- Windows 10, Windows 7/8/8.1 (Windows 10 should be able to automatically download these)
- MacOS
On Linux you should not need drivers, as they are usually already there, but you need to check that you as user have the permission to use the serial devices (otherwise you likely see an error like serial.serialutil.SerialException: [Errno 13] could not open port /dev/ttyUSB0: [Errno 13] Permission denied: '/dev/ttyUSB0').
- Debian/Ubuntu: add your user to the group
dialoutwithsudo usermod -a -G dialout ${USER}(you may need to restart the desktop to apply your new group settings).
To flash a device:
- connect the ESP8266 with a USB cable to your computer (micro-USB)
- launch the downloaded software
- check/select the serial device
- select the firmware (
latest_<COUNTRYCODE>.binshould be fine for any setup) - press button Upload
- wait for a few seconds to finish the flashing procedure
- take a note of the Sensor ID written in the Window status bar at the bottom - you will need it to register the sensor
If you want to delete/reset all settings on the device (e.g. the Wifi credentials) you can use the Erase Flash button (exists in software version 0.2.2 and above).
Now your device is flashed, you may now
- connect the sensors to it,
- configure the WiFi (connect your computer/smartphone to the AP
feinstaubsensor-<sensorID>and open up http://192.168.4.1/ in a browser) and - finally register the sensor at https://meine.luftdaten.info/ with your Sensor ID
Currently Linux builds require Python 3.6 (but 3.7 seems to work fine as well), GNU make and Qt Linguist tools. Following packages should suffice on Ubuntu:
sudo apt install qttools5-dev-tools python3.6 make
If you want to build in a python virtualenv (recommended) you should create one with
mkvirtualenv -p "$(which python3)" airrohr-firmware-flasher
# deactivate # to leave the virtualenv later
# workon airrohr-firmware-flasher to re-enter virtualenv
Then, to install python dependencies and build the binary use:
make deps dist
The built binary will be dist/luftdaten-tool.
Currently Windows builds require Python 3.6 installed system-wide and added to
%PATH%.
To install python and cygwin dependencies and build everything use
deploy\windows-build.bat batch script.
Currently MacOS builds require Python 3.6, dmgbuild tool (pip3 install dmgbuild) and Qt SDK installed (just the "Qt >
5... > macOS" part in installer) with following added to $PATH:
export PATH="$HOME/Qt/5.11.1/clang_64/bin:/Library/Frameworks/Python.framework/Versions/3.6/bin:$PATH"
Then just install dependencies and build everything using:
make deps dmg
In case an error occurs in early stages of application startup, user will be
presented with a "Failed to execute script luftdaten-tool.exe" message. In order
to see actual source of that error, console flag in luftdaten-tool.spec can
be switched to True. In Windows this will make application output a proper
stack trace to cmd popup.
Both build & runtime requirements are defined in requirements.txt file. In
order to install these use the following command:
pip install -r requirements.txt
To manage dynamic UI and translation binaries generation we use a very simple GNU make-based build system.
To simply build everything needed to run luftdaten-tool.py run:
make
To build and run use:
make run
To remove all build artifacts use:
make clean
All requirements are set up using wildcards, so, in theory, Makefile shouldn't
need much changes in near future.
In order to rebuild *.ts files use:
make i18n-update