Merge branch 'develop'

panchazo · panchazo · commit 130a38df0f0e · 2018-01-29T15:15:34.000-03:00
diff --git a/README.md b/README.md
@@ -1,10 +1,8 @@
 ![OpenWeatherStation (OWS)](https://github.com/panchazo/open-weather-station/blob/master/docs/img/OpenWeatherStation.png)
 
 **The Open Weather Station (OWS) is an accessible do-it-yourself weather station solution that aims to be affordable, stable, easy to build and tested in the wild. It evolved from other approaches I have been testing and using in the field since late 2012 to this day.**
-
 **Cheers!** 
-
-  ___Eng. Francisco Clariá___
+___Eng. Francisco Clariá___
 
 ![OpenWeatherStation Presentation (OWS)](https://github.com/panchazo/open-weather-station/blob/master/docs/img/openweatherstation_presentation.jpg)
 
@@ -49,7 +47,7 @@
 * wind gust direction (angle)
 * rain (mm)
 * temperature (Cº)
-* atmospheric/barometric pressure (Pascal)
+* absolute atmospheric pressure (Pascal)
 * relative humidity (%)
 * ambient light (lux)
 
@@ -195,10 +193,12 @@ Use the following diagram and the list of components to solder each element to t
 
  * the __blue__ is a female header pin to later on plug the HC05, the red circles denote that no connection is needed on those pins so soldering is not actually required
 
-* pay close attention to the capacitors polarity and diodes direction as instructed in the diagram
+* pay close attention to the capacitors polarity and diodes direction as instructed in the diagram. I have soldered those in the top side so it is easier to show how I did it in the step by step gallery, but it would be better to solder those in the oposite side if you want to achieve a better looking board.
 
 * [Soldering header pins](https://github.com/panchazo/open-weather-station/tree/master/docs/img/assembly-step-by-step/2%20-%20PCB%20header%20pins)
 
+ * You can finish the PCB circuit __after everything is in place and tested__ with a small layer of clear nail polish (varnish) to protect the exposed contacts in order to reduce oxidation.
+
 ![OWS pcb](https://github.com/panchazo/open-weather-station/blob/master/docs/img/pcb-components.png)
 
 | Item              | assembly code |
@@ -247,9 +247,13 @@ The arduino module, as explained before, sends the data using the HC05 Bluetooth
 The status led is just a red or green led that blinks to indicate that the station is working. Therefore I recommend placing the led where it is visible. Wire the led with a female jumper to the “stat” male header pin on the module board (recall to connect the shortest leg of the led to the board pin that is connected to ground). 
 
 # Powering arduino module
-To power the module connect the Arduino Uno USB cable to the portable power bank, and the power bank to one of the 2 available USB outputs on the wall socket charger module, the remaining output can be used later on to connect the Android usb cable to power the smartphone. If you dont want to use a power bank to keep the module on in the event of power loss then you can simply plug the arduino usb cable directly to the wall socket module.
+To power the module connect the Arduino Uno USB cable to the portable power bank, and the power bank to one of the 2 available USB outputs on the wall socket charger module, the remaining output can be used later on to connect the Android usb cable to power the smartphone. If you dont want to use a power bank to keep the module on in the event of power loss then you can simply plug the arduino usb cable directly to the wall socket module. The power bank must comply with the following features: 
+
+* must have a power consumption that the charger can supply, so if you buy one that needs 2A (2000mA) input please use a charger that has __at least__ that output power 
+* the power bank MUST work without user intervention, once plugged, if electricity goes off you wont be there to push any button to turn it on
+* lastly, it has to be able to feed the device WHILE charging it at the same time, some power banks will not output power while being charged
 
-The wall socket charger module connects to 110/220v to feed power to the module. I recommend wiring it with the 110/220v power cable so it is easier later on to connect it to any power outlet. You could also accomplish the same using a regular usb wall charger, but please be sure to protect it inside the housing as usually chargers will not work well exposed outdoors for a long period of time.
+The wall socket charger module connects to 110/220v to feed power to the module. I recommend wiring it with the 110/220v power cable so it is easier later on to connect it to any power outlet. You could also accomplish the same using a regular usb wall charger, but please be sure to protect it inside the housing as usually chargers will not work well exposed outdoors for a long period of time. I have used this approach when I couldnt find a decent 2A output dual wall socket charger module and used a regular dual usb charger instead (with 2A output).
 
 * [Power the module](https://github.com/panchazo/open-weather-station/tree/master/docs/img/assembly-step-by-step/5%20-%20Wire%20sensors%20and%20power)
 
@@ -273,7 +277,7 @@ I did my best to organize, add comments the code and keep the code simple to mak
 
 * __ARDUINO_AUTOREBOOT_MINUTES__: once the amount of minutes defined in this constant elapses the arduino will auto reboot and reset the bluetooth chip (turn off and on again). This timer can be restarted by sending a command to the module. 
 
-* __SEND_CALCULATED_WIND_SPEED_MS__ and __SEND_CALCULATED_RAIN_MM__: the module will send the cycles per second it counts for anemometer and rain gauge so you can convert this to an actual wind speed or millimeters of rain in the other end and apply your own calibration. If these constants are set to true, the station will perform this calculation internally and send also the calculated windspeed and rain based on default calibrations parameters you can manipulate by changing the following constants:
+* __Calibration parameters__: the station module will perform the calculation internally and send windspeed and rain based on default calibrations parameters you can manipulate by changing the following constants:
 
   * __ANEMOMETER_SPEED_FACTOR__, cup anemometer factor, if you don’t know this value leave it as is
   * __ANEMOMETER_CIRCUMFERENCE_MTS__, the circumference of a full cycle calculated from the cup centerpoint
@@ -302,4 +306,4 @@ You can send commands (single uppercase ascii character) to make the module do s
 * character __L__: send all the measures stored in modules volatile memory for the past WIND_AVG_MINUTE_LOG_SIZE minutes (recall this log is erased after a module reboot and may have been initialized to zero)
 
 # Coming next, the app
-__In the upcoming months I will produce an Android app so you can connect to the stations, monitor the parameters in real time, store the samples for long periods of time and see graphics with its evolution and send the information in real time to cloud services. The app will be released as open source too and you will be able to use it as is (apk) or download the code and make your custom flavor of it. Stay tunned!__
+__In the upcoming months I will produce an Android app so you can connect to the stations, monitor the parameters in real time, store the samples for long periods of time and see graphics with its evolution and send the information in real time to cloud services. The app will be released as open source too and you will be able to use it as is (apk) or download the code and make your custom flavor of it. Stay tuned!__
diff --git a/arduino/open-weather-station/open-weather-station.ino b/arduino/open-weather-station/open-weather-station.ino
@@ -1,27 +1,27 @@
 /**********************************************************************
-                    Open Weather Station 
+                    Open Weather Station
                 https://OpenWeatherStation.com
 
-PROJECT
-This software reads data from the sensors and sends the samples via
-bluetooth. It has been build a part of a larger solution that
-integrates with an external device to connect, store, visualize and
-send data to external services.
+  PROJECT
+  This software reads data from the sensors and sends the samples via
+  bluetooth. It has been build a part of a larger solution that
+  integrates with an external device to connect, store, visualize and
+  send data to external services.
 
-LICENCE
-Copyright 2017 Francisco Claria
+  LICENCE
+  Copyright 2017 Francisco Claria
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
 
     http://www.apache.org/licenses/LICENSE-2.0
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
 ***********************************************************************/
 
 /**********************************************************************
@@ -44,8 +44,6 @@ limitations under the License.
    CONFIGS
 ***********************************************************************/
 
-#define SEND_CALCULATED_WIND_SPEED_MS true //meters per second, set to false to only send raw wind cycles count
-#define SEND_CALCULATED_RAIN_MM true //millimeters, set to false to only send raw rain cycles count
 #define ARDUINO_AUTOREBOOT_MINUTES 30 //if no ack is received within this minutes arduino autoreboots
 #define ANEMOMETER_PIN 2 //digital pin 2 (interrupt 0)
 #define RAINGAUGE_PIN 3 //digital pin 3 (interrupt 1)
@@ -57,9 +55,7 @@ limitations under the License.
 #define BLUETOOTH_SERIAL_SPEED 9600
 #define WIND_SAMPLING_SECONDS 5 //from 5 to 15 seconds would be recommended
 #define WIND_SAMPLES_SIZE 12 //this value MUST be 60secs/WIND_SAMPLING_SECONDS, eg. 60/6 => 10=WIND_SAMPLES_SIZE
-#define WIND_AVG_MINUTE_LOG_SIZE 18 //this MUST be DATA_EQUAL or greater than 1 to store the current sample
-#define DATA_SEPARATOR ','
-#define DATA_EQUAL '='
+#define WIND_AVG_MINUTE_LOG_SIZE 18 //this MUST be equal or greater than 1 to store the current sample
 
 /**********************************************************************
   WIND/RAIN CALIBRATION VALUES - SPEED, RAIN & WIND ANGLE
@@ -89,7 +85,7 @@ BME280I2C pressureSensor;
 SoftwareSerial bluetooth(BLUETOOTH_SERIAL_RX_PIN, BLUETOOTH_SERIAL_TX_PIN);
 BH1750 lightMeter;
 
-volatile unsigned long nextTimeAnemometerInterrupt = 0 , nextTimeRainIterrupt = 0  ; //software debounce variable
+volatile unsigned long nextTimeAnemometerInterrupt = 0 , nextTimeRainIterrupt = 0  ; //software debounce variables
 volatile int anemometerCyclesCounter = 0, anemometerMinuteCyclesCounter = 0, rainCyclesCounter = 0; //interrupt counters
 unsigned long lastMinuteSampleMillis = 0;
 boolean enableSendWindPartialSamples = true;
@@ -105,9 +101,9 @@ struct WindSample {
 
 struct SensorsSample {
   float temperature;//Cº
-  float humidity;
+  float humidity;//%
   float pressure;//Pa
-  unsigned int lux;
+  int lux;
   float windCyclesPerSecond;
   int windAngle;
   float gustCyclesPerSecond;
@@ -179,23 +175,24 @@ void captureAndSendPartialSample() {
 }
 
 void sendWindPartialSample(Stream &port, WindSample ws) {
-  port.print(F("rw"));
-  port.print(DATA_EQUAL);
-  port.print(ws.windCyclesPerSecond);
-  port.print(DATA_SEPARATOR);
-  if (SEND_CALCULATED_WIND_SPEED_MS) {
-    port.print(F("rws"));
-    port.print(DATA_EQUAL);
-    port.print(ws.windCyclesPerSecond / (float)ANEMOMETER_CYCLES_PER_LOOP * (float)ANEMOMETER_CIRCUMFERENCE_MTS * (float)ANEMOMETER_SPEED_FACTOR);
-    port.print(DATA_SEPARATOR);
-  }
-  port.print(F("ra"));
-  port.print(DATA_EQUAL);
+  port.print(F("{"));
+  port.print(F("\"rt\""));
+  port.print(F(":"));
+  port.print(1);
+  port.print(F(","));
+  port.print(F("\"ws\""));
+  port.print(F(":"));
+  port.print(ws.windCyclesPerSecond / (float)ANEMOMETER_CYCLES_PER_LOOP * (float)ANEMOMETER_CIRCUMFERENCE_MTS * (float)ANEMOMETER_SPEED_FACTOR);
+  port.print(F(","));
+  port.print(F("\"a\""));
+  port.print(F(":"));
   port.print(ws.windAngle);
-  port.print(DATA_SEPARATOR);
-  port.print(F("rms"));
-  port.print(DATA_EQUAL);
-  port.println(ws.sampleMillis);
+  port.print(F(","));
+  port.print(F("\"ms\""));
+  port.print(F(":"));
+  port.print(ws.sampleMillis);
+  port.print(F("}"));
+  port.println();
   port.flush();
 }
 
@@ -210,26 +207,29 @@ void captureAndSendMinuteSample() {
   BME280::PresUnit presUnit(BME280::PresUnit_Pa);
   pressureSensor.read(pressureSensorPressure, pressureSensorTemp, pressureSensorHum, tempUnit, presUnit);
 
-  if (isnan(pressureSensorPressure)) {
-    pressureSensorPressure = -1;
+  if (isnan(pressureSensorPressure) || pressureSensorPressure < 0) {
+    pressureSensorPressure = -500;
   }
-  if (isnan(pressureSensorTemp)) {
+  if (isnan(pressureSensorTemp) || pressureSensorTemp < -273 || pressureSensorTemp > 100) {
     pressureSensorTemp = -500;
   }
-  if (isnan(pressureSensorHum)) {
-    pressureSensorHum = -1;
+  if (isnan(pressureSensorHum) || pressureSensorHum < 0 || pressureSensorHum > 100) {
+    pressureSensorHum = -500;
   }
 
   int avgWindAngle = 0, gustAngle = 0;
   float gustCyclesPerSecond = 0;
 
   calcValuesFromWindSamples(windSamples, WIND_SAMPLES_SIZE, avgWindAngle, gustCyclesPerSecond, gustAngle);
 
+  int lightLvl = lightMeter.readLightLevel();
+  lightLvl = (lightLvl > 54612 || lightLvl < 0) ? -500 : lightLvl;
+
   SensorsSample avgMinuteSample = {
     pressureSensorTemp,
     pressureSensorHum,
     pressureSensorPressure,
-    lightMeter.readLightLevel(),
+    lightLvl,
     windCyclesPerSecond,
     avgWindAngle,
     gustCyclesPerSecond,
@@ -251,63 +251,56 @@ void captureAndSendMinuteSample() {
 
 void sendFullSamples(Stream &port, SensorsSample * samples, int samplesToSend) {
   for (int i = 0; i < samplesToSend; i++) {
-    port.print(F("t"));
-    port.print(DATA_EQUAL);
+    port.print(F("{"));
+    port.print(F("\"log\""));
+    port.print(F(":"));
+    port.print(i);
+    port.print(F(","));
+    port.print(F("\"rt\""));
+    port.print(F(":"));
+    port.print(0);
+    port.print(F(","));
+    port.print(F("\"t\""));
+    port.print(F(":"));
     port.print(samples[i].temperature);
-    port.print(DATA_SEPARATOR);
-    port.print(F("h"));
-    port.print(DATA_EQUAL);
+    port.print(F(","));
+    port.print(F("\"h\""));
+    port.print(F(":"));
     port.print(samples[i].humidity);
-    port.print(DATA_SEPARATOR);
-    port.print(F("p"));
-    port.print(DATA_EQUAL);
+    port.print(F(","));
+    port.print(F("\"p\""));
+    port.print(F(":"));
     port.print(samples[i].pressure);
-    port.print(DATA_SEPARATOR);
-    port.print(F("l"));
-    port.print(DATA_EQUAL);
+    port.print(F(","));
+    port.print(F("\"l\""));
+    port.print(F(":"));
     port.print(samples[i].lux);
-    port.print(DATA_SEPARATOR);
-    port.print(F("w"));
-    port.print(DATA_EQUAL);
-    port.print(samples[i].windCyclesPerSecond);
-    port.print(DATA_SEPARATOR);
-    if (SEND_CALCULATED_WIND_SPEED_MS) {
-      port.print(F("ws"));
-      port.print(DATA_EQUAL);
-      port.print(samples[i].windCyclesPerSecond / (float)ANEMOMETER_CYCLES_PER_LOOP * (float)ANEMOMETER_CIRCUMFERENCE_MTS * (float)ANEMOMETER_SPEED_FACTOR);
-      port.print(DATA_SEPARATOR);
-    }
-    port.print(F("wa"));
-    port.print(DATA_EQUAL);
+    port.print(F(","));
+    port.print(F("\"ws\""));
+    port.print(F(":"));
+    port.print(samples[i].windCyclesPerSecond / (float)ANEMOMETER_CYCLES_PER_LOOP * (float)ANEMOMETER_CIRCUMFERENCE_MTS * (float)ANEMOMETER_SPEED_FACTOR);
+    port.print(F(","));
+    port.print(F("\"wa\""));
+    port.print(F(":"));
     port.print(samples[i].windAngle);
-    port.print(DATA_SEPARATOR);
-    port.print(F("g"));
-    port.print(DATA_EQUAL);
-    port.print(samples[i].gustCyclesPerSecond);
-    port.print(DATA_SEPARATOR);
-    if (SEND_CALCULATED_WIND_SPEED_MS) {
-      port.print(F("gs"));
-      port.print(DATA_EQUAL);
-      port.print(samples[i].gustCyclesPerSecond / (float)ANEMOMETER_CYCLES_PER_LOOP * (float)ANEMOMETER_CIRCUMFERENCE_MTS * (float)ANEMOMETER_SPEED_FACTOR);
-      port.print(DATA_SEPARATOR);
-    }
-    port.print(F("ga"));
-    port.print(DATA_EQUAL);
+    port.print(F(","));
+    port.print(F("\"gs\""));
+    port.print(F(":"));
+    port.print(samples[i].gustCyclesPerSecond / (float)ANEMOMETER_CYCLES_PER_LOOP * (float)ANEMOMETER_CIRCUMFERENCE_MTS * (float)ANEMOMETER_SPEED_FACTOR);
+    port.print(F(","));
+    port.print(F("\"ga\""));
+    port.print(F(":"));
     port.print(samples[i].gustAngle);
-    port.print(DATA_SEPARATOR);
-    port.print(F("r"));
-    port.print(DATA_EQUAL);
-    port.print(samples[i].rainCyclesPerMinute);
-    port.print(DATA_SEPARATOR);
-    if (SEND_CALCULATED_RAIN_MM) {
-      port.print(F("rmm"));
-      port.print(DATA_EQUAL);
-      port.print((float)samples[i].rainCyclesPerMinute * (float)RAIN_BUCKET_MM_PER_CYCLE);
-      port.print(DATA_SEPARATOR);
-    }
-    port.print(F("ms"));
-    port.print(DATA_EQUAL);
-    port.println(samples[i].sampleMillis);
+    port.print(F(","));
+    port.print(F("\"rmm\""));
+    port.print(F(":"));
+    port.print((float)samples[i].rainCyclesPerMinute * (float)RAIN_BUCKET_MM_PER_CYCLE);
+    port.print(F(","));
+    port.print(F("\"ms\""));
+    port.print(F(":"));
+    port.print(samples[i].sampleMillis);
+    port.print(F("}"));
+    port.println();
     port.flush();
   }
 }
@@ -328,18 +321,24 @@ void readCmdFromBluetooth() {
     }
     if (c == 'T') {
       timerManager.restartTimer(arduinoAutorebootTimer);
-      bluetooth.println(F("EXT"));
-      bluetooth.flush();
+      if (ENABLE_DEBUG_SERIAL_OUTPUT) {
+        Serial.println(F("EXT"));
+        Serial.flush();
+      }
     }
     if (c == 'S') {
       enableSendWindPartialSamples = true;
-      bluetooth.println(F("RT1"));
-      bluetooth.flush();
+      if (ENABLE_DEBUG_SERIAL_OUTPUT) {
+        Serial.println(F("RT1"));
+        Serial.flush();
+      }
     }
     if (c == 'Q') {
       enableSendWindPartialSamples = false;
-      bluetooth.println(F("RT0"));
-      bluetooth.flush();
+      if (ENABLE_DEBUG_SERIAL_OUTPUT) {
+        Serial.println(F("RT0"));
+        Serial.flush();
+      }
     }
     if (c == 'L') {
       sendFullSamples(bluetooth, avgMinuteSamplesLog, WIND_AVG_MINUTE_LOG_SIZE);
