Browse Source

add README

master
noerw 1 year ago
parent
commit
466e9aa53d
1 changed files with 68 additions and 0 deletions
  1. 68
    0
      README.md

+ 68
- 0
README.md View File

@@ -0,0 +1,68 @@
1
+# mobile senseBox
2
+
3
+This is some Arduino code for GPS tracked senseBoxes.
4
+They have an SDS011 particulate matter sensor & HDC1008 Temp & Humidity sensor
5
+attached and transmit their measurements to opensensemap.org.
6
+
7
+There are multiple variants to make use of various hardware I had available, and
8
+to evaluate different use cases and workflows of data transmission.
9
+
10
+Each sketch folder has its own readme with (more or less) detailed documentation.
11
+The `libraries` folder contains all code that any sketch may depend on.
12
+The the most simple solution to use these sketches is to make a backup of your
13
+existing `~/Arduino` folder, and clone this repository there instead:
14
+
15
+```sh
16
+mv ~/Arduino ~/Arduino.bak
17
+git clone https://github.com/noerw/mobile-sensebox ~/Arduino
18
+```
19
+
20
+## Hardware
21
+The microcontroller & communication protocol differs for the sketches, but all
22
+variants require a GPS device, a microcontroller with I2C, 2 UARTs (or some sort
23
+of software UART), as well as an Novafit SDS011 & a Bosch HDC1008.
24
+
25
+My builds of all these setups are powered by a 5.6Ah LiPo through an Adafruit
26
+LiPo charger via USB, and enclosed in a 15x8x8 case.
27
+The humidity sensor is included for reference, as the SDS011 only provides valid
28
+data at low humidity. The sensor is enclosed within the case (which heats up
29
+quite a bit), which makes the measurements quite inaccurate, they should only be
30
+treated as approximations.
31
+This setup is quite suboptimal for regular deployment (eg. daily commute by
32
+bike), see `Future Work`.
33
+
34
+### `./lora-gps`
35
+Arduino Mega + Dragino LoRa & GPS Shield + senseBox Shield (SD card)
36
+- transmitting data via LoRa to opensensemap.org through thethingsnetwork.org (details in SETUP.md)
37
+- additionally saving to SD card if no LoRa coverage is available
38
+- Arduino Uno should work as well, you need to play around with SoftSerial i guess..
39
+
40
+### `./esp8266-gps`
41
+Wemos D1 (ESP8266) + senseBox Shield
42
+- stores measurements locally on 3MB SPIFFS, and uploads via WiFi when available
43
+- requires installation of ESP8266 Arduino SDK, see `esp8266-gps/README.md`
44
+- senseBox shield only used for ease of use with JST-connectors, not needed
45
+
46
+### `./sdcard-gps`
47
+Arduino Mega + senseBox Shield
48
+- logging to SD card, manual upload to opensensemap.org
49
+
50
+## Future Work
51
+- Evaluation of SDS011 in a mobile environment: Influence of wind, sunlight,
52
+  vibrations, differing orientations
53
+
54
+- Averaging of measurement values
55
+    - tradeoff: less outliers <-> smaller spatial acurracy
56
+
57
+- Improved case
58
+    - power switch on the outside
59
+    - simple, quick mounting on a bike
60
+    - status LEDs about connectivity, GPS
61
+    - more neutral placement of humidity sensor
62
+    - all-weather proof
63
+
64
+# License
65
+- sketch directories:      MIT Norwin Roosen
66
+- `libraries` directory: see each subdirectory
67
+
68
+

Loading…
Cancel
Save