Hardware change & documentation

Author: bmellink

QuizHubEsp32/QuizHubEsp32.ino

@@ -43,6 +43,9 @@ the data folder to the internal flash memory of the ESP32. The upload tool, once
 of your Arduino environment as extra menu item "ESP32 Sketch data upload". See these links:
 - https://github.com/me-no-dev/arduino-esp32fs-plugin
 
+Buttons for manual start/stop/test are implemented using the ESP32 capcitive touch. You only need to feed
+a wire to the outside of your box and touch it to "touch" the button.
+
 NAT support. 
 Version 1.0.4 of ESP32 core does not support NAT (like ESP8266 does). This means that nodes connected to the soft AP side can not
 reach the internet. This is fine for the quiz nodes and the web browser can connect to the quiz hub through the second IP address provided
@@ -94,14 +97,15 @@ Still todo:
 #define LEDBLUEPIN 2            // blue led (on board LED and also extern connected to GPIO02) 1=on, 0=off
 #define LEDGREENPIN 22      // green LED: when a node has won
 #define LEDREDPIN 23        // red LED: when "hot" (nodes are flashing)
+#define PIN_HOT 4           // enter hot mode to all nodes GPIO5 => GPIO4 Touch
+#define PIN_STOP 33         // set stop mode to all nodes GPIO4 => GPIO33 Touch
+#define PIN_TEST 15         // run connection test (will turn on/off all button LEDs) GPIO15 Touch
+#define WIFIPORTALPIN PIN_HOT   // trigger WiFi portal during reboot 
+
+// parameters
 #define LEDON 1             // for LEDs: value to digitalwrite to turn led off
 #define LEDOFF 0            // for LEDs: value to digitalwrite to turn led on
-#define PIN_HOT 5           // enter hot mode to all nodes GPIO5 => GPIO5 mark
-#define PIN_STOP 18         // set stop mode to all nodes GPIO4 => GPIO18
-#define PIN_STATUS 19       // show statistics of all nodes and run connection test (will turn on/off all button LEDs) GPIO19
-#define SWITCH_OFF 0        // DigitalRead for PIN_HOT, PIN_STOP, PIN_STATUS to show the switch is not pressed
-#define SWITCH_ON 1         // idem for switch is pressed
-#define WIFIPORTALPIN PIN_HOT   // trigger WiFi portal during reboot 
+#define TOUCHTHRESHOLD 50   // value from touchRead() to consider the button to be touched
 
 // We have 2 webservers defined on port 80, of which only 1 runs at a time
 WebServer server(80);    // web server for normal Quiz function
@@ -215,10 +219,6 @@ void setup(void) {
   digitalWrite(LEDBLUEPIN, LEDON); // turn on blue LED
   digitalWrite(LEDREDPIN, LEDOFF);
   digitalWrite(LEDGREENPIN, LEDOFF);
-  pinMode(WIFIPORTALPIN, INPUT_PULLUP);
-  pinMode(PIN_HOT,   INPUT_PULLUP);
-  pinMode(PIN_STOP,  INPUT_PULLUP);
-  pinMode(PIN_STATUS,INPUT_PULLUP);
   Serial.begin(115200);
 
   Serial.println();
@@ -242,7 +242,7 @@ void setup(void) {
   wm.setClass("invert");                // set dark theme
   wm.setConfigPortalTimeout(40);        // auto close configportal after n seconds
 
-  if (digitalRead(WIFIPORTALPIN)==SWITCH_ON) {
+  if (getTouch(WIFIPORTALPIN)) {
     Serial.println("Button pressed at boot, wipe WiFi settings");
     wm.resetSettings(); // wipe settings to force 
   }
@@ -293,7 +293,6 @@ void setup(void) {
 
   digitalWrite(LEDBLUEPIN, LEDOFF); // turn off LED
 
-
   // configure standard Quiz web server
   server.on("/", handleRoot);
   server.on("/quiz", handleNodeAPI);
@@ -318,7 +317,7 @@ void loop(void) {
     }
   }
 
-  if (((digitalRead(PIN_STOP)==SWITCH_ON) && flashtime+1000 < millis()) || tell2cmd==0) {
+  if ((getTouch(PIN_STOP) && flashtime+1000 < millis()) || tell2cmd==0) {
     Serial.println(F("Setting stop mode.."));
     digitalWrite(LEDREDPIN, LEDOFF);
     digitalWrite(LEDGREENPIN, LEDOFF);
@@ -329,7 +328,7 @@ void loop(void) {
     flashtime = millis();
   } 
 
-  if (((digitalRead(PIN_HOT)==SWITCH_ON) && flashtime+1000 < millis()) || tell2cmd==1) {
+  if ((getTouch(PIN_HOT) && flashtime+1000 < millis()) || tell2cmd==1) {
     Serial.println(F("Setting hot mode.."));
     sendAllNodes(CMD_HOT); // set hot to all buttons
     quizMode = mode_hot;
@@ -340,7 +339,7 @@ void loop(void) {
     flashtime = millis();
   }
 
-  if (((digitalRead(PIN_STATUS)==SWITCH_ON) && flashtime+1000 < millis()) || tell2cmd==2) {
+  if ((getTouch(PIN_TEST) && flashtime+1000 < millis()) || tell2cmd==2) {
     flashtime = millis();
     digitalWrite(LEDGREENPIN, LEDOFF);
     digitalWrite(LEDREDPIN, LEDOFF);
@@ -632,3 +631,15 @@ void displayDir(String dirname) {
     file = root.openNextFile();
   }
 }
+
+// capacitive touch routine. To filter out spike noises we require the touchRead() value to be 100ms at a filter below
+// the defined threshhold
+int getTouch(int port) {
+  int t;
+  for (int i=0; i<10; i++) {
+    t=touchRead(port);
+    if (t>TOUCHTHRESHOLD) return 0;
+    delay(10);
+  }
+  return 1;
+}

README.md

@@ -2,6 +2,8 @@
 
 This project was based on the need to create a set of "Quiz" buttons for a fun family evening to support a Quiz setting, where multiple teams have to answer quiz questions and you need to know who presses the Quiz-button first.
 
+![Quiz Hub ESP32](img/QuizHubESP32Outside.png?raw=true "Quiz Hub ESP32")
+
 ## Overview
 
 I bought 4 large pushbuttons on Sparkfun (see https://www.sparkfun.com/products/9181) and mounted the buttons on a piece of plywood, supported by some large screws. The Arduino hardware for each button is mounted underneath.
@@ -44,16 +46,15 @@ The quiz button is powered by 2 AA batteries making the supply 3V (on average).
 
 ![Quiz Button back](img/QuizButton_ESP8266.png?raw=true "Quiz Button back")
 
-The ESP8266 or ESP32 hub is powered by a standard USB connector/ power supply. Gameplay can be activated using buttons or using the web interface of the built-in web server. You can defined in the source if pressing a button
-generates a 1 (high) or 0 (low). In the picture below I use TTP223 based touch button modules for the switches (https://www.aliexpress.com/item/32964219843.html).
+The ESP8266 or ESP32 hub is powered by a standard USB connector/ power supply. Gameplay can be activated using buttons or using the web interface of the built-in web server. In the picture below, standard switches are used
+as buttons. In the ESP32 version the capacitive "Touch" feature of the ESP32 chip is used, so you only need to
+feed the wires from the "Touch" pins to the outside of your box.
 
 ![Quiz Hub ESP8266](img/QuizHub_ESP8266.png?raw=true "Quiz Hub ESP8266")
 
-![Quiz Hub ESP32](img/QuizHubESP32A.png?raw=true "Quiz Hub ESP32")
-
-![Quiz Hub ESP32](img/QuizHubESP32B.png?raw=true "Quiz Hub ESP32")
+![Quiz Hub ESP32 Inside](img/QuizHubESP32Inside.png?raw=true "Quiz Hub ESP32 Inside")
 
-Hardware schematics will be added soon
+TODO: Adding hardware schematics
 
 ## Getting started with the 3rd generation (ESP8266/ESP32)
 
@@ -76,7 +77,7 @@ https://github.com/earlephilhower/arduino-esp8266littlefs-plugin/releases)
 Steps for each button:
 - Add the circuit to allow measurement of the battery voltage (optional) and current driver for the external LED
 - Compile and upload the QuizNode8266 sketch (optionally change the source in case you want to the use the built in LED instead of an external LED)
-- Once the button restarts, you should see an entry appear on the web server interface of the hub and you can assign a name and MP3 file to play when the given button wins. The MP3 file will be played on the phone or web browser used to control the quiz hub
+- Once the button restarts, it will connect to the quizhub WiFi network and ping the server.
 
 ## Web Interface
 
@@ -86,11 +87,13 @@ When the QuizHub can not connect to the WiFi the Blue LED stays on and the confi
 
 You can also force the WiFi portal but keeping the Start/Hot button pressed while rebooting.
 
-As soon as a Quiz Node is booted and connected to your WiFi, you get to the QuizHub web server by pointing your browser (phone/computer/tablet) to http://quiz.local. Any new node should show up in the table:
+As soon as a Quiz Node is booted and connected to your configured WiFi, you get to the QuizHub web server by pointing your browser (phone/computer/tablet) to http://quiz.local. The quizhub will also keep the quizhub WiFi
+up for the nodes. Any new node that boots should show up in the table:
 
 ![Quiz Hub Web site](img/QuizHubWeb.png?raw=true "Quiz Hub Web Site")
 
-You can assign a name and optional sound to each button by clicking on a row in the table. The configured sound will play through the speakers of the device showing the web site. The team name and selected sound are stored within the browser local storage. Please note that on IOS (Apple) devices you should play a sound once (manually) by clicking one of the play button before sounds work.
+You can assign a name and optional sound to each node by clicking on a row in the table. The configured sound will play through the speakers of the device showing the web site. The team name and selected sound are stored within the browser local storage so the names are kept for your next quiz session. 
+Please note that on IOS (Apple) devices you should play a sound once (manually) by clicking one of the play button before sounds work.
 
 The statistics button allows you to see the battery level of all hubs and various communication statistics: