clarified wiring scheme conventions, added voltage measurements for ESP8266

Author: simonrupf

libraries/MonSens/MonSens_ESP8266_Vcc.cpp

@@ -0,0 +1,54 @@
+/*
+ * Copyright © 2017 Simon Rupf
+ *
+ * This file is part of MonSens.
+ *
+ * MonSens is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option)
+ * any later version.
+ *
+ * MonSens is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with MonSens. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @file
+ * @author Simon Rupf <[email protected]>
+ * @brief MonSens implementation of the ESP8266 internal voltage sensor.
+ *
+ * The ESP8266 can measure its internal voltage (around 2.7 - 3.1 V) when the
+ * analog pin A0 is left unconnected.
+ */
+
+#include <MonSens_ESP8266_Vcc.h>
+
+/**
+ * After it is registered in the communicator, the sensor gets initialized.
+ */
+void MonSens_ESP8266_Vcc::init() {
+}
+
+/**
+ * Take a sensor reading, to be returned by the communicator.
+ */
+bool MonSens_ESP8266_Vcc::measure(const char* input) {
+  if (strstr(input, "V") != NULL) {
+    reading = (float) ESP.getVcc() / 1000.0;
+    return true;
+  }
+  return false;
+}
+
+/**
+ * If no sensor supports the input value, usage instructions are collected.
+ */
+const __FlashStringHelper* MonSens_ESP8266_Vcc::usage() {
+  return F("V   - voltage at the ESP8266 chip");
+}
+

libraries/MonSens/MonSens_ESP8266_Vcc.h

@@ -0,0 +1,60 @@
+/*
+ * Copyright © 2017 Simon Rupf
+ *
+ * This file is part of MonSens.
+ *
+ * MonSens is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option)
+ * any later version.
+ *
+ * MonSens is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with MonSens. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @file
+ * @author Simon Rupf <[email protected]>
+ * @brief MonSens implementation of the ESP8266 internal voltage sensor.
+ *
+ * The ESP8266 can measure its internal voltage (around 2.7 - 3.1 V) when the
+ * analog pin A0 is left unconnected.
+ */
+
+#ifndef MONSENS_ESP8266_VCC_H
+#define MONSENS_ESP8266_VCC_H
+
+#include <MonSens.h>
+
+/* as of Arduino IDE 1.6.8, the below sequence doesn't work:
+ADC_MODE(ADC_VCC);
+*/
+
+/**
+ * MonSens implementation for a Photoresistor
+ */
+class MonSens_ESP8266_Vcc: public IMonSens_Sensor {
+  public:
+    /**
+     * After it is registered in the communicator, the sensor gets initialized.
+     */
+    void init();
+
+    /**
+     * Take a sensor reading, to be returned by the communicator.
+     */
+    bool measure(const char* input);
+
+    /**
+     * If no sensor supports the input value, usage instructions are collected.
+     */
+    const __FlashStringHelper* usage();
+};
+
+#endif
+

sensors/README.md

@@ -8,3 +8,25 @@ easier to use one of the many breakout boards available online. These will
 package the sensor with all the required components (usually in SMD formats) and
 leads out clearly labelled pins to solder it onto the MCU with a few short wires
 or to stick it to a breadboard for testing.
+
+Illustrations
+-------------
+
+Included with the supported sensors description are Fritzing project files that
+show working examples for wiring these to the various MCUs. You may extend these
+with your own modifications.
+
+As a convention the following wire colors are used throughout these sketches:
+
+- power:
+  - red: 3.3 V (ESP8266) / 5 V (DigiSpark)
+  - black: ground
+- SPI bus:
+  - orange: serial clock (SCLK or SCK)
+  - yellow: master input, slave output (MISO or SDO on the sensor side)
+  - green: master output, slave input (MOSI or SDI on the sensor side)
+  - blue: chip select (CS or SS for slave select)
+- I²C bus:
+  - brown: signal clock (SCL)
+  - white: signal data (SDA)
+

wireless/ESP8266/initialize-sketchbooks.sh

@@ -44,7 +44,7 @@ done
 # MonSens libraries, excluding DigiSpark (those only works when the Arduino IDE
 # is set to that board)
 cp -r "$SELF_PATH/../../libraries/MonSens" "$LIBRARY_PATH/"
-rm "$LIBRARY_PATH/DigiSpark.*"
+rm "$LIBRARY_PATH/MonSens/MonSens_DigiSpark"*
 
 # MonSens sketches
 for SKETCH in monsens-esp8266-example