From f17b5c427511c6594296476ac4621a44cf1ebfab Mon Sep 17 00:00:00 2001 From: noerw Date: Sun, 18 Sep 2016 13:30:51 +0200 Subject: [PATCH] update README.md --- .gitignore | 2 ++ README.md | 9 +++++---- 2 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..28b5066 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.vscode +config.h \ No newline at end of file diff --git a/README.md b/README.md index 95347a5..14c3f7d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # mobile-sensebox -This is a modular (but probably overcomplicated) sketch for a mobile sensebox. +This is a modular (but probably overcomplicated) sketch for a mobile sensebox, written as a part of my bachelors thesis. It measures arbitrary phenomena (currently only implemented: WiFi network count), which are geocoded and uploaded to the [openSenseMap](https://opensensemap.org) upon wifi connection. @@ -13,14 +13,14 @@ Written for a ESP8266 ([Wemos D1 R1](http://www.wemos.cc/Products/d1.html)) with and based on the [ESP8266 Arduino core](https://github.com/esp8266/Arduino) for Arduino IDE. The sketch should work with any other ESP variant as well. -The GPS module must provide NMEA sentences & be connected via the hardware serial (GPIOs `0` & `1`) -SoftSerial did not work for me but created many issues (random crashes, due to buffer overflows?). +The GPS module must provide NMEA sentences & be connected via the hardware serial (Wemos Pins `0` & `1`). +`SoftSerial` did not work for me but created many issues (random crashes, due to buffer overflows?). ## software installation - install [Arduino IDE](https://arduino.cc/en/Main/Software) - install [ESP8266 Arduino core](https://github.com/esp8266/Arduino#installing-with-boards-manager) - connect your ESP8266 via USB -- open the file `mobile-sensebox.ino` in the Arduino IDE +- open the file `mobile-sensebox.ino` in Arduino IDE - change the configuration to your needs in the file `config.h` - select the board `Wemos D1 (retired)` (or whatever you have) - hit upload (the GPS device must not be connected!) @@ -28,6 +28,7 @@ SoftSerial did not work for me but created many issues (random crashes, due to b ## program behaviour Once started, the device will idle until a first GPS fix was established. From then on the following procedure runs repeatedly: + 1. **measure** phenomena (wifi scan takes ~1sec) 2. update GPS **location** (takes 0.5-2sec) 3. **store** measurements to local filesystem (SPIFFS)