All projects up to date

diff --git a/AtmosNode/AtmosSystem.scad b/AtmosNode/AtmosSystem.scad
new file mode 100644 (file)
index 0000000..96d7022
--- /dev/null
+++ b/AtmosNode/AtmosSystem.scad
@@ -0,0 +1,669 @@
+/*## COPYRIGHT NOTICE
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+#    COPYRIGHT 2020 : Slightly Cyberpunk
+#                     www.slightlycyberpunk.com
+#
+#
+
+### DESCRIPTION
+#
+#
+#    Stacking cases designed to hold a large speaker driver with a
+#      Sparkfun "Noisy Cricket" amplifier, plus Sparkfun breakout
+#      boards for the BCM680 and SCD30 atmospheric sensors, along
+#      with a 40mm fan to blow air across these sensors and a PIR
+#      sensor and webcam to provide motion detection, all connected
+#      to a Raspberry Pi. Held together with a few small bolts.
+*/
+
+
+$fn=15;
+
+// === Main model ===
+// For printing, do one module at a time ;)
+
+// Speaker Box
+translate([85,40,0]) {
+  speakerplate();
+}
+translate([49,4,28]) {
+  speakercover();
+}
+
+// Sensor Box
+sensorplate();
+translate([-6,4,28]) {
+  sensorcover();
+}
+
+// Volume Knob
+translate([75,0,0]) {
+  knob();
+  knobback();
+}
+
+// Camera Mount
+translate([-44,0,0]) {
+  camera();
+}
+
+// Raspberry Pi Mount (Needs Improvement)
+translate([0,0,-28]) {
+  pimount();
+}
+
+// Mount for bolt at the bottom
+translate([75,0,-28]) {
+  closetMount();
+}
+
+// Joiner :)
+joiner();
+
+// === MODULES ===
+// Arches (for spacing -- my speaker is large)
+//   with pegs to mount to the screw holes off 
+//   the fairly generic case my Pi is in.
+module pimount() {
+  $fn=90;
+  joiner();
+
+  translate([-2,8,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([-2,72,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+  
+  translate([-4,10,25]) {
+    cube([4,60,3]);
+  }
+  
+  translate([0,10,25]) {
+    cube([42,4,3]);
+  }
+  translate([0,66,25]) {
+    cube([42,4,3]);
+  }
+  
+  difference() {
+    translate([30,10,4]) {
+      cube([10,60,24]);
+    }
+    translate([30,40,24]) {    
+      rotate([0,90,0]) {
+        scale([1,0.4,1]) {
+          cylinder(r=18,h=10);
+        }
+      }
+    }
+    translate([30,59,24]) {    
+      rotate([0,90,0]) {
+        scale([1,0.4,1]) {
+          cylinder(r=18,h=10);
+        }
+      }
+    }
+    translate([30,21,24]) {    
+      rotate([0,90,0]) {
+        scale([1,0.4,1]) {
+          cylinder(r=18,h=10);
+        }
+      }
+    }
+  }
+  
+  translate([35,12,-1]) {
+    cylinder(r=2,h=5);
+    translate([-1.5,-3,0]) {
+      cube([3,6,2]);
+    }
+  }
+  translate([35,68,-1]) {
+    cylinder(r=2,h=5);
+    translate([-1.5,-3,0]) {
+      cube([3,6,2]);
+    }
+  }
+}
+
+// Joiner to hold the boxes together
+module joiner() {
+  translate([42,8,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([42,72,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([53,8,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([53,72,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([44,7,25]) {
+    cube([7,2,3]);
+  }
+  translate([44,71,25]) {
+    cube([7,2,3]);
+  }
+  translate([41,10,25]) {
+    cube([2,60,3]);
+  }
+  translate([52,10,25]) {
+    cube([2,60,3]);
+  }
+  
+  difference() {
+    union() {
+      translate([52,7.5,25]) {
+        rotate([0,0,9.6]) {
+          cube([2,65,3]);
+        }
+      }
+      translate([41,7.5,25]) {
+        rotate([0,0,-9.6]) {
+          cube([2,65,3]);
+        }
+      }
+    }
+    
+    translate([42,8,25]) {
+      cylinder(r=2,h=3);
+    }
+    translate([42,72,25]) {
+      cylinder(r=2,h=3);
+    }
+    translate([53,8,25]) {
+      cylinder(r=2,h=3);
+    }
+    translate([53,72,25]) {
+      cylinder(r=2,h=3);
+    }
+  }
+}
+
+// Main mount for the volume knob
+module knob() {
+  $fn=45;
+  translate([42,8,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([42,72,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  difference() {
+    translate([44,-5,25]) {
+      cube([6,80,3]);
+    }
+    translate([0,40,25]) {
+      cylinder(r=49,h=3);
+    }
+  }
+  translate([45,-5,25]) {
+    difference() {
+      cylinder(r=5,h=3);
+      translate([-10,-5,0]) {
+        cube([10,10,3]);
+      }
+    }
+  }
+
+  translate([26,-7,25]) {
+    difference() {
+      cylinder(r=20,h=3);
+      cylinder(r=4,h=3);
+      translate([0,0,1]) {
+        $fn=6;
+        cylinder(r=6,h=2);
+      }
+      translate([-20,15,0]) {
+        cube([35,20,3]);
+      }
+      translate([0,0,2]) {
+        difference() {
+          cylinder(r=17,h=2);
+          cylinder(r=10,h=2);
+        }
+      }
+      translate([-26,47,0]) {
+        cylinder(r=48,h=3);
+      }
+    }
+  }
+}
+
+// Small shim that goes on the back of the bolts holding on the knob
+//  This keeps the base more level
+module knobback() {
+  translate([42,8,-3]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([42,72,-3]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([44,5,-3]) {
+    cube([6,70,3]);
+  }
+}
+
+// Webcam mount (Holds a bolt for a standard tripod mount; I'm using a C920)
+module camera() {
+  translate([42,8,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([42,72,25]) {
+    difference() {
+      cylinder(r=3,h=3);
+      cylinder(r=2,h=3);
+    }
+  }
+
+  translate([37,10,25]) {
+    cube([7,60,3]);
+  }
+
+  difference() {
+    translate([36,10,0]) {
+      cube([2,60,30]);
+    }
+    translate([36,40,10]) {
+      rotate([0,90,0]) {
+        cylinder(r=4,h=10);
+      }
+    }
+  }
+
+  translate([38,15,0]) {
+    cube([6,5,20]);
+  }
+  translate([38,60,0]) {
+    cube([6,5,20]);
+  }
+}
+
+// Holds a bolt to mount it on the bottom
+// I have a rail of pre-drilled aluminum on top of my closet which this mounts to
+// Approximately fits a 1/4" bolt
+module closetMount() {
+  translate([42,8,22]) {
+    difference() {
+      cylinder(r=3,h=6);
+      cylinder(r=2,h=6);
+    }
+  }
+
+  translate([42,72,22]) {
+    difference() {
+      cylinder(r=3,h=6);
+      cylinder(r=2,h=6);
+    }
+  }
+
+  translate([41,10,22]) {
+    cube([2,60,6]);
+  }
+  translate([43,10,22]) {
+    cube([2,60,6]);
+  }
+  translate([44,8,22]) {
+    cube([7,64,6]);
+  }
+  difference() {
+    translate([50,8,22]) {
+      cube([3,64,41]);
+    }
+    translate([50,40,42.5]) {
+      rotate([0,90,0]) {
+        cylinder(r=5,h=5);
+      }
+    }
+  }
+
+  translate([42,8,61]) {
+    difference() {
+      cylinder(r=3,h=2);
+      cylinder(r=2,h=2);
+    }
+  }
+  translate([42,72,61]) {
+    difference() {
+      cylinder(r=3,h=2);
+      cylinder(r=2,h=2);
+    }
+  }
+  translate([41,10,61]) {
+    cube([2,60,2]);
+  }
+  translate([43,10,61]) {
+    cube([2,60,2]);
+  }
+  translate([44,8,61]) {
+    cube([7,64,2]);
+  }
+}
+
+// Gridded cover for the atmospheric sensors
+module sensorcover() {
+  difference() {
+    cube([52,72,2]);
+    translate([4,4,0]) {
+      cylinder(r=2,h=5);
+    }
+    translate([48,68,0]) {
+      cylinder(r=2,h=5);
+    }
+    translate([4,68,0]) {
+      cylinder(r=2,h=5);
+    }
+    translate([48,4,0]) {
+      cylinder(r=2,h=5);
+    }
+    
+    for(j=[0:1:3]) {
+      for(i=[1:1:11]) {
+        $fn=6;
+        translate([11+(10*j),6*i,0]) {
+          cylinder(r=3,h=5);
+        }
+      }
+      for(i=[1:1:10]) {
+        $fn=6;
+        translate([6+(10*j),3+(6*i),0]) {
+          cylinder(r=3,h=5);
+        }
+      }
+    }
+      for(i=[1:1:10]) {
+        $fn=6;
+        translate([6+(10*4),3+(6*i),0]) {
+          cylinder(r=3,h=5);
+        }
+      }
+  }
+}
+
+// Holds the atmospheric sensors and fan
+module sensorplate() {
+  difference() {
+    union() {
+      translate([11,0,0]) {
+        cube([10,80,3]);
+      }
+      translate([16,37,0]) {
+        cylinder(r=0.6,h=10);
+      }
+    }
+    translate([16,7,0]) {
+      cylinder(r=0.6,h=3);
+    }
+    translate([16,72,0]) {
+      cylinder(r=0.6,h=3);
+    }
+    translate([10,30,0]) {
+      cube([5,10,3]);
+    }
+    translate([18,30,0]) {
+      cube([5,10,3]);
+    }
+  }
+
+  difference() {
+    translate([3,40,0]) {
+      cube([34,10,15]);
+    }
+    translate([5,42,0]) {
+      cube([30,6,15]);
+    }
+  }
+
+  sidewall();
+  translate([37,0,0]) {
+    sidewall();
+  }
+
+  translate([0,-2,0]) {
+    difference() {
+      cube([40,2,40]);
+      translate([20,2,20]) {
+        rotate([90,0,0]) {
+          cylinder(r=17,h=2);
+        }
+      }
+      translate([4,2,4]) {
+        rotate([90,0,0]) {
+          cylinder(r=2,h=2);
+        }
+      }
+      translate([4,2,36]) {
+        rotate([90,0,0]) {
+          cylinder(r=2,h=2);
+        }
+      }
+      translate([36,2,4]) {
+        rotate([90,0,0]) {
+          cylinder(r=2,h=2);
+        }
+      }
+      translate([36,2,36]) {
+        rotate([90,0,0]) {
+          cylinder(r=2,h=2);
+        }
+      }
+    }
+  }
+
+  translate([0,78,0]) {
+    difference() {
+      cube([40,3,20]);
+      translate([3,0,5]) {
+        cube([34,3,15]);
+      }
+    } 
+  }
+  difference() {
+    cube([40,3,20]);
+    translate([3,0,3]) {
+      cube([34,3,20]);
+    }
+  }
+
+  translate([-2,8,0]) {
+    difference() {
+      cylinder(r=3,h=25);
+      cylinder(r=2,h=25);
+    }
+  }
+
+  translate([-2,72,0]) {
+    difference() {
+      cylinder(r=3,h=25);
+      cylinder(r=2,h=25);
+    }
+  }
+
+  translate([42,8,0]) {
+    difference() {
+      cylinder(r=3,h=25);
+      cylinder(r=2,h=25);
+    }
+  }
+
+  translate([42,72,0]) {
+    difference() {
+      cylinder(r=3,h=25);
+      cylinder(r=2,h=25);
+    }
+  }
+}
+
+// Slotted side walls the sensor box
+module sidewall() {
+  difference() {
+    cube([3,80,20]);
+    for(i = [-2:1:18]) {
+      translate([0,i*7,4]) {
+        rotate([-45,0,0]) {
+          cube([3,2,19]);
+        }
+      }
+    }
+  }
+}
+
+// Base plate to hold the speaker
+module speakerplate() {
+  difference() {
+    cylinder(r=30,h=3);
+    cylinder(r=27,h=3);
+  }
+
+  difference() {
+    translate([-36,-36,0]) {
+      cube([72,72,3]);
+    }
+    translate([-29,-29,0]) {
+      cube([58,58,3]);
+    }
+    translate([-32,-32,0]) {
+      cylinder(r=2,h=25);
+    }
+    translate([32,-32,0]) {
+      cylinder(r=2,h=25);
+    }
+    translate([-32,32,0]) {
+      cylinder(r=2,h=25);
+    }
+    translate([32,32,0]) {
+      cylinder(r=2,h=25);
+    }
+  }
+
+  translate([-32,-32,0]) {
+    difference() {
+      cylinder(r=3,h=25);
+      cylinder(r=2,h=25);
+    }
+  }
+
+  translate([32,-32,0]) {
+    difference() {
+      cylinder(r=3,h=25);
+      cylinder(r=2,h=25);
+    }
+  }
+
+  translate([-32,32,0]) {
+    difference() {
+      cylinder(r=3,h=25);
+      cylinder(r=2,h=25);
+    }
+  }
+
+  translate([32,32,0]) {
+    difference() {
+      cylinder(r=3,h=25);
+      cylinder(r=2,h=25);
+    }
+  }
+}
+
+// Gridded cover for the speaker
+module speakercover() {
+  difference() {
+    cube([72,72,5]);
+    translate([36,36,0]) {
+      cylinder(r=42,h=3);
+    }
+    translate([4,4,0]) {
+      cylinder(r=2,h=5);
+    }
+    translate([68,4,0]) {
+      cylinder(r=2,h=5);
+    }
+    translate([68,68,0]) {
+      cylinder(r=2,h=5);
+    }
+    translate([4,68,0]) {
+      cylinder(r=2,h=5);
+    }
+    
+    for(j=[0:1:5]) {
+      for(i=[1:1:11]) {
+        $fn=6;
+        translate([11+(10*j),6*i,0]) {
+          cylinder(r=3,h=5);
+        }
+      }
+      for(i=[1:1:10]) {
+        $fn=6;
+        translate([6+(10*j),3+(6*i),0]) {
+          cylinder(r=3,h=5);
+        }
+      }
+    }
+      for(i=[1:1:10]) {
+        $fn=6;
+        translate([6+(10*6),3+6*i,0]) {
+          cylinder(r=3,h=5);
+        }
+      }
+  }
+}
\ No newline at end of file

diff --git a/AtmosNode/preview.png b/AtmosNode/preview.png
new file mode 100644 (file)
index 0000000..b5c013f
Binary files /dev/null and b/AtmosNode/preview.png differ

diff --git a/DoorSensor/description b/DoorSensor/description
index 2a2f73b..062af77 100644 (file)
--- a/DoorSensor/description
+++ b/DoorSensor/description
@@ -1 +1 @@
-Ultrasonic distance and hall effect sensor to monitor a doorway; based on an Adafruit M0 Feather Wifi (An Arduino-compatible SAMD board)
+Ultrasonic distance and circuit sensor to monitor a doorway; based on an Adafruit M0 Feather Wifi (An Arduino-compatible SAMD board)

diff --git a/DoorSensor/doorSensor.ino b/DoorSensor/doorSensor.ino
new file mode 100644 (file)
index 0000000..411a8eb
--- /dev/null
+++ b/DoorSensor/doorSensor.ino
@@ -0,0 +1,190 @@
+/*## COPYRIGHT NOTICE
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+#    COPYRIGHT 2020 : Slightly Cyberpunk
+#                     www.slightlycyberpunk.com
+#
+#
+
+### DESCRIPTION
+#
+#
+#    Measures distance and door open/closed state and logs the result to an Influx database
+#    Designed to be run on an Adafruit Feather M0 Wifi
+*/
+
+#include <WiFi101.h>
+
+char ssid[] = "";        // your network SSID (name)
+char pass[] = "";       // your network password (use for WPA, or use as key for WEP)
+int status = WL_IDLE_STATUS;     // the WiFi radio's status
+char influxhost[] = "";         // IP of your influxdb
+String influxhostname = "";    // Hostname of influxdb (for Host: header)
+
+WiFiClient client;
+
+const int trigPin = 13;           //connects to the echo pin on the distance sensor       
+const int echoPin = 12;           //connects to the trigger pin on the distance sensor     
+const int hallPin = 11;           //originally was hall effect sensor; now is just conductivity; should work with either
+
+float distance;
+int hall;
+int loopCount;
+
+boolean serialOn = false;
+
+void(* resetFunc) (void) = 0;
+  
+void setup() {
+  WiFi.setPins(8,7,4,2);
+
+  //Initialize serial and wait for port to open:
+  Serial.begin(9600);
+  while (!Serial && serialOn)
+    { delay(100); }
+  if(serialOn)
+    { Serial.println("Serial connected!"); }
+  
+  // Check for the presence of the shield:
+  while (WiFi.status() == WL_NO_SHIELD) {
+    if(serialOn) { Serial.println("WiFi shield not present"); }
+    delay(3000);
+  }
+
+  // Attempt to connect to WiFi network:
+  while ( status != WL_CONNECTED) {
+    if(serialOn) {
+      Serial.print("Attempting to connect to WPA SSID: ");
+      Serial.println(ssid);
+    }
+
+    // Connect to WPA/WPA2 network:
+    status = WiFi.begin(ssid, pass);
+
+    // wait 10 seconds for connection:
+    delay(10000);
+  }
+
+  // Initialize pins
+  pinMode(trigPin, OUTPUT);
+  pinMode(echoPin, INPUT);
+  pinMode(hallPin, INPUT);
+}
+
+void loop() {
+  // Attempt to connect to WiFi network if down:
+  status = WiFi.status();
+  if(serialOn) {
+    Serial.print("Wifi Status: ");
+    Serial.println(status);
+  }
+  while ( status != WL_CONNECTED) {
+    if(serialOn) {
+      Serial.print("Attempting to connect to WPA SSID: ");
+      Serial.println(ssid);
+    }
+    // Connect to WPA/WPA2 network:
+    status = WiFi.begin(ssid, pass);
+
+    // wait 10 seconds for connection:
+    delay(10000);
+  }
+
+  // Give the distance measurement a couple attempts if the reading is null
+  int attempts = 0;
+  distance = getDistance();
+  while ( distance == 0 && attempts < 4) {
+    distance = getDistance();
+    attempts++;
+    delay(200);
+  }
+
+  hall = digitalRead(hallPin);
+  if(serialOn) {
+    Serial.print("Distance: ");
+    Serial.println(distance);
+    Serial.print("Hall: ");
+    Serial.println(hall);
+  }
+  
+  client.connect(influxhost, 8086);
+  if (client.connected()) {
+    // Make a HTTP request:
+    String data = "sensors,type=ultrasonic,location=front,hostname=fdoor distance=";
+    data = String(data + String(distance));
+    if(serialOn)
+      { Serial.println(data); }
+    //Serial.println(data.length());
+    client.println("POST /write?db=security HTTP/1.1");
+    client.println("Host: "+influxhostname+":8086");
+    client.print("Content-Length: ");
+    client.println(data.length());
+    client.println("Content-Type: application/x-www-form-urlencoded");
+    client.println("");  
+    client.println(data);
+    client.println("Connection: close");
+    client.println();
+    client.println();
+    client.flush();
+    client.stop();
+  }
+  delay(1000);
+  client.connect(influxhost, 8086);
+  if (client.connected()) {
+    String data2 = "sensors,type=circuit,location=front,hostname=fdoor state=";
+    if(hall == 1) {
+      data2 = String(data2 + "\"open\"");
+    } else {
+      data2 = String(data2 + "\"closed\"");
+    }
+    if(serialOn) 
+      { Serial.println(data2); }
+
+    client.println("POST /write?db=security HTTP/1.1");
+    client.println("Host: "+influxhostname+":8086");
+    client.print("Content-Length: ");
+    client.println(data2.length());
+    client.println("Content-Type: application/x-www-form-urlencoded");
+    client.println("");
+    client.println(data2);
+    client.println("Connection: close");
+    client.println();
+    client.println();
+    client.flush();
+    client.stop();
+  }
+
+  delay(1000);
+}
+
+float getDistance()
+{
+  float dtime;
+  float distance;
+
+  // Send a 10ms pulse
+  digitalWrite(trigPin, HIGH);
+  delayMicroseconds(10); 
+  digitalWrite(trigPin, LOW);
+
+  // Time the pulse
+  dtime = pulseIn(echoPin, HIGH);
+  // Distance is time / (c/2)
+  // (dtime is us, so c is m/us, then divided to cm)
+  distance = (dtime / 150) / 10;
+
+  return distance;
+}

diff --git a/DoorSensor/preview.png b/DoorSensor/preview.png
new file mode 100644 (file)
index 0000000..30c909c
Binary files /dev/null and b/DoorSensor/preview.png differ

diff --git a/FlatNode/FlatNode.scad b/FlatNode/FlatNode.scad
new file mode 100644 (file)
index 0000000..c5fe538
--- /dev/null
+++ b/FlatNode/FlatNode.scad
@@ -0,0 +1,221 @@
+/*## COPYRIGHT NOTICE
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+#    COPYRIGHT 2020 : Slightly Cyberpunk
+#                     www.slightlycyberpunk.com
+#
+#
+
+### DESCRIPTION
+#
+#
+#    Case designed to hold two small speakers (salvaged from a TV), 
+#     powered by a Sparkfun Noisy Cricket amplifier, with space for
+#     a Raspberry Pi camera module behind the front grill and of course
+#     a Pi in the rear housing.
+*/
+
+$fn=90;
+
+// === Main model ===
+// For printing, do one module at a time ;)
+
+// Rear Pi Housing
+raspi();
+
+// Flat plate with holes for mounting speakers
+translate([0,100,23]) {
+  rotate([0,0,-90]) {
+    speakers();
+  }
+}
+
+// Front grill
+grill();
+
+// === MODULES ===
+module raspi() {
+  difference() {
+    cube([100,100,25]);
+    translate([2.5,2.5,2]) {
+      cube([87,100,23]);
+    }
+    translate([85,5,2]) {
+      cube([39,60,8]);
+    }
+    
+    // Pi mounting holes
+    translate([25,10,0]) {
+      cylinder(r=1.5,h=10);
+    }
+    translate([74,10,0]) {
+      cylinder(r=1.5,h=10);
+    }
+    
+    // Speaker mounting holes
+    translate([15,12,0]) {
+      cylinder(r=3,h=10);
+    }
+    translate([15,90,0]) {
+      cylinder(r=3,h=10);
+    }
+    translate([93,25,0]) {
+      cylinder(r=3,h=25);
+    }
+    translate([93,77,0]) {
+      cylinder(r=3,h=25);
+    }
+  }
+  // Speaker mounting posts
+  translate([15,12,0]) {
+    difference() {
+      cylinder(r=4,h=25);
+      cylinder(r=3,h=25);
+    }
+  }
+  translate([15,90,0]) {
+    difference() {
+      cylinder(r=4,h=25);
+      cylinder(r=3,h=25);
+    }
+  }
+}
+
+module speakers() {
+  difference() {
+    translate([0,0,2]) {
+      cube([100,100,2]);
+    }
+      
+    // l speaker
+    translate([15,3,2]) {
+      cube([62,25,4]);
+    }
+    translate([10,15,0]) {
+      cylinder(r=3,h=10);
+    }
+    translate([88,15,0]) {
+      cylinder(r=3,h=10);
+    }
+    
+    // r speaker
+    translate([20,70,2]) {
+      cube([32,18,4]);
+    }
+    translate([23,93,0]) {
+      cylinder(r=3,h=10);
+    }
+    translate([75,93,0]) {
+      cylinder(r=3,h=10);
+    }
+    
+    // holes
+    translate([10,35,0]) {
+      cube([30,30,10]);
+    }
+    translate([60,35,0]) {
+      cube([35,50,10]);
+    }
+    
+    translate([5,40,0]) {
+      cylinder(r=2,h=5);
+      translate([0,19,0]) {
+        cylinder(r=2,h=5);
+      }
+    }
+  }
+}
+
+module grill() {
+  difference() {
+    union() {
+      translate([0,0,44]) {
+        cube([100,100,3]);
+      }
+    }
+      translate([40,70,44]) {
+        cube([20,30,3]);
+      }
+      
+    for(j=[0:12]) {
+      for(i=[0:13]) {
+        translate([8*i,8*j,30]) {
+          cylinder(r=3,h=20,$fn=4);
+        }
+        translate([8*i+4,8*j+4,30]) {
+          cylinder(r=3,h=20,$fn=4);
+        }
+      }
+    }
+    // Speaker mounting holes
+    translate([15,12,40]) {
+      cylinder(r=3,h=10);
+    }
+    translate([15,90,40]) {
+      cylinder(r=3,h=10);
+    }
+    translate([93,25,40]) {
+      cylinder(r=3,h=25);
+    }
+    translate([93,77,40]) {
+      cylinder(r=3,h=25);
+    }
+  }
+  // Speaker mounting posts
+  translate([15,12,37]) {
+    difference() {
+      cylinder(r=4,h=10);
+      cylinder(r=3,h=10);
+    }
+  }
+  translate([15,90,37]) {
+    difference() {
+      cylinder(r=4,h=10);
+      cylinder(r=3,h=10);
+    }
+  }
+  translate([93,25,37]) {
+    difference() {
+      cylinder(r=4,h=10);
+      cylinder(r=3,h=10);
+    }
+  }
+  translate([93,77,37]) {
+    difference() {
+      cylinder(r=4,h=10);
+      cylinder(r=3,h=10);
+    }
+  }
+  // Camera slot
+  translate([53.5,45.5,39]) {
+    rotate([0,0,180]) {
+      camera();
+    }
+  }
+}
+
+module camera() {
+  $fn=90;
+  difference() {
+    cube([11,15,5]);
+    translate([1,1,0]) {
+      cube([9,15,3]);
+      translate([4.5,4.5,3]) {
+        cylinder(r=4,h=2);
+      }
+    }
+  }
+}

diff --git a/FlatNode/description b/FlatNode/description
index f0a3093..b85c593 100644 (file)
--- a/FlatNode/description
+++ b/FlatNode/description
@@ -1 +1 @@
-Includes a motion sensing camera, a USB microphone for audio detection, and speakers for audio output
+Includes speakers and amplifier, a camera for motion sensing, and a USB microphone for audio sensing

diff --git a/FlatNode/preview.png b/FlatNode/preview.png
new file mode 100644 (file)
index 0000000..f324b28
Binary files /dev/null and b/FlatNode/preview.png differ

diff --git a/PresenceToken/PresenceTokenRound.scad b/PresenceToken/PresenceTokenRound.scad
new file mode 100644 (file)
index 0000000..2ac50b0
--- /dev/null
+++ b/PresenceToken/PresenceTokenRound.scad
@@ -0,0 +1,187 @@
+/*## COPYRIGHT NOTICE
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+#    COPYRIGHT 2020 : Slightly Cyberpunk
+#                     www.slightlycyberpunk.com
+#
+#
+
+### DESCRIPTION
+#
+#
+#    Case for an Adafruit Feather M0 Wifi plus a cylindrical 2200mAh LiPo
+#     battery (69mm x 18mm), with a #4 machine screw to secure the top of
+#     the case (if printed in NinjaFlex or other flexible material a bolt
+#     will not be needed). The hole in the top can be used to secure to a
+#     keychain (although it's a bit large for that)
+*/
+
+$fn=15;
+
+// ...and this library was never used again
+// They don't really print well, at least on my printer
+// Kinda necessary here though
+include </home/urza9814/Documents/OpenScadLibraries/Chamfers.scad>
+
+// === Main model ===
+difference() {
+  bottom();
+  translate([0,20,76]) {
+    rotate([90,30,0]) {
+      cylinder(r=1,h=35);
+    }
+  }
+}
+
+
+translate([0,0,101]) {
+  mirror([0,0,1]) {
+    difference() {
+      top();
+      translate([0,20,5]) {
+        rotate([90,30,0]) {
+          cylinder(r=1,h=35);
+        }
+      }
+    }
+  }
+}
+
+// === MODULES ===
+module bottomChamfer() {
+  translate([-6,17,-5]) {
+    rotate([45,0,0]) {
+      cube([40,5,5]);
+    }
+  }
+  translate([28,-10,-2]) {
+    rotate([0,45,0]) {
+      cube([5,40,6]);
+    }
+  }
+  translate([-3,-10,-2]) {
+    rotate([0,45,0]) {
+      translate([-1,0,0]) {
+        cube([6,40,5]);
+      }
+    }
+  }
+}
+
+module bottom() {
+  difference() {
+    translate([0,0,0]) {
+      scale([1,1,1]) {
+        chamferedCylinder(11,79);
+      }
+      scale([1,0.3,1]) {
+        translate([-1,0,0]) {
+          chamferedCylinder(16,79);
+        }
+      }
+    }
+    translate([0,0,2]) {
+      cylinder(r=9.5,h=84);
+    }
+    translate([-16,0,2]) {
+      cube([30,13,79]);
+    }
+  
+    // Charger slot
+    translate([-6,8,0]) {
+      cube([10,5,5]);
+    }
+  }
+
+  translate([-17,0,0]) {
+    difference() {
+      cube([32,17,79]);
+      translate([1,0,2]) {
+        cube([30,15,79]);
+      }
+    
+      // Charger slot
+      translate([11,8,0]) {
+        cube([10,5,5]);
+      }
+    
+      // chamfer
+      bottomChamfer();
+    }
+  }
+}
+
+module top() {
+  difference() {
+    translate([0,0,0]) {
+      scale([1,1,1]) {
+        chamferedCylinder(11,2);
+      }
+      scale([-1,0.3,1]) {
+        translate([1,0,0]) {
+          chamferedCylinder(16,2);
+        }
+      }
+    }
+  
+    // hook holes
+    translate([0,5,0]) {
+      cylinder(r=2,h=5);
+    }
+  
+    // chamfer
+    translate([-17,0,0]) {
+      bottomChamfer();
+    }
+  }
+  
+  difference() {
+    translate([0,0,2]) {
+      cylinder(r=8,h=5);
+    }
+    translate([-10,-3,2]) {
+      cube([20,15,5]);
+    }
+  }
+
+  translate([-17,0,0]) {
+    difference() {
+      union() {  
+      cube([32,17,2]);
+      difference() {
+        union() {
+          translate([0,1,2]) {
+            cube([28,13,22]);
+          }
+          translate([0,1,21]) {
+            cube([28,8,15]);
+          }
+        }
+        translate([15,0,2]) {
+          cylinder(r=10,h=39);
+        }
+      }
+    }
+    // hook holes
+    translate([17,5,0]) {
+      cylinder(r=2,h=5);
+    }
+  
+      // chamfer
+      bottomChamfer();
+    }
+  }
+}
\ No newline at end of file

diff --git a/PresenceToken/presence_token.ino b/PresenceToken/presence_token.ino
new file mode 100644 (file)
index 0000000..6c30c13
--- /dev/null
+++ b/PresenceToken/presence_token.ino
@@ -0,0 +1,109 @@
+/*## COPYRIGHT NOTICE
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+#    COPYRIGHT 2020 : Slightly Cyberpunk
+#                     www.slightlycyberpunk.com
+#
+#
+
+### DESCRIPTION
+#
+#
+#    Sends a ping to an influxdb server once every 110 seconds
+*/
+#include <SPI.h>
+#include <WiFi101.h>
+#include <Adafruit_SleepyDog.h>
+
+char ssid[] = "";                // your network SSID (name)
+char pass[] = "";               // your network password (use for WPA, or use as key for WEP)
+int status = WL_IDLE_STATUS;   // the WiFi radio's status
+char influxhost[] = "";       // IP of your influxdb
+boolean serialOn = false;    // Enable the serial console?
+
+WiFiClient client;
+
+void setup() {
+  WiFi.setPins(8,7,4,2);
+
+  //Initialize serial and wait for port to open:
+  if(serialOn)
+    { Serial.begin(9600); }
+  while (!Serial && serialOn)
+    { delay(100); }
+  
+  // check for the presence of the shield:
+  while (WiFi.status() == WL_NO_SHIELD) {
+    if(serialOn) { Serial.println("WiFi shield not present"); }
+    // don't continue:
+    while (true);
+    delay(3000);
+  }
+
+  // attempt to connect to WiFi network:
+  while ( status != WL_CONNECTED) {
+    if(serialOn) {
+      Serial.print("Attempting to connect to WPA SSID: ");
+      Serial.println(ssid);
+    }
+    // Connect to WPA/WPA2 network:
+    status = WiFi.begin(ssid, pass);
+
+    // wait 10 seconds for connection:
+    delay(10000);
+  }
+
+  WiFi.maxLowPowerMode();
+}
+
+void loop() {
+  // attempt to connect to WiFi network:
+  status = WiFi.status();
+  if ( status != WL_CONNECTED) {
+    if(serialOn) {
+      Serial.print("Attempting to connect to WPA SSID: ");
+      Serial.println(ssid);
+    }
+    // Connect to WPA/WPA2 network:
+    status = WiFi.begin(ssid, pass);
+  } 
+
+  client.connect(influxhost, 8086);
+  if(!client.connected()) {
+    client.connect(influxhost, 8086);
+  }
+ if (client.connected()) {
+    if(serialOn)
+      { Serial.println("Connected."); }
+    // Make a HTTP request:
+    client.println("POST /write?db=security HTTP/1.1");
+    client.println("Host: cns-master:8086");
+    client.println("Content-Length: 34");
+    client.println("Content-Type: application/x-www-form-urlencoded");
+    client.println();
+    client.println("presence,type=token,id=001 alive=1");
+    client.println();
+    client.println("Connection: close");
+    client.println();
+    while(client.available() > 0) {
+      client.read();
+    }
+    client.flush();
+    client.stop();
+  }
+  Watchdog.sleep();
+  delay(110000);
+}

diff --git a/PresenceToken/preview.png b/PresenceToken/preview.png
new file mode 100644 (file)
index 0000000..a2b5011
Binary files /dev/null and b/PresenceToken/preview.png differ

diff --git a/framework/speak.sh b/framework/speak.sh
new file mode 100644 (file)
index 0000000..620ad91
--- /dev/null
+++ b/framework/speak.sh
@@ -0,0 +1,40 @@
+#!/bin/bash
+
+### COPYRIGHT NOTICE
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+#    COPYRIGHT 2020 : Slightly Cyberpunk
+#                     www.slightlycyberpunk.com
+#
+#
+
+### DESCRIPTION
+#
+#
+#    This script plays a tone and then reads an alert message in a "female robot voice"
+
+
+# Sound effect from: https://mixkit.co/free-sound-effects/notification/
+#  Direct link: https://assets.mixkit.co/sfx/download/mixkit-elevator-tone-2863.wav
+aplay /home/pi/framework/mixkit-elevator-tone-2863.wav
+
+espeak --stdout -s120 -k18 -a200 -v female5 "$1 a" | \
+  play -t wav - chorus 0.4 0.8 20 0.5 0.10 2 -t \
+                echo 0.9 0.8 33 0.9 \
+                echo 0.7 0.7 10 0.2 \
+                echo 0.9 0.2 55 0.5 \
+                gain 15
+

diff --git a/framework/speak.sh~ b/framework/speak.sh~
new file mode 100644 (file)
index 0000000..bddfde8
--- /dev/null
+++ b/framework/speak.sh~
@@ -0,0 +1,11 @@
+#!/bin/bash
+#play -t wav bleep_01.wav chorus 0.4 0.8 20 0.5 0.10 2 -t gain 10
+aplay /home/pi/framework/mixkit-elevator-tone-2863.wav
+
+espeak --stdout -s120 -k18 -a200 -v female5 "$1 a" | \
+  play -t wav - chorus 0.4 0.8 20 0.5 0.10 2 -t \
+                echo 0.9 0.8 33 0.9 \
+                echo 0.7 0.7 10 0.2 \
+                echo 0.9 0.2 55 0.5 \
+                gain 15
+

diff --git a/framework/syslog.sh b/framework/syslog.sh
new file mode 100644 (file)
index 0000000..10879b4
--- /dev/null
+++ b/framework/syslog.sh
@@ -0,0 +1,163 @@
+#!/bin/bash 
+
+### COPYRIGHT NOTICE
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+#    COPYRIGHT 2020 : Slightly Cyberpunk
+#                     www.slightlycyberpunk.com
+#
+#
+
+### DESCRIPTION
+#
+#
+#    This script logs various datapoints to an Influx database
+#    It is designed to be triggered by cron every minute, like:
+#        * *  * * *  /home/pi/monitoring/syslog.sh > /home/pi/monitoring/syslog.log 2>&1
+#    It is intended to run on a Raspberry Pi device. It should generally work on most
+#     Linux systems but may need a few minor modifications.
+#
+#
+#    It is capable of monitoring the following datapoints:
+#      Audio (average volume and duration every second)
+#      CO2, temperature, and humidity levels from an scd30 sensor      
+#        (Requires: https://github.com/UnravelTEC/Raspi-Driver-SCD30 writing to /run/sensors/scd30/last)
+#      VOCs, temperature, pressure, and humidity levels from a bme680 sensor
+#        (Requires: https://github.com/twartzek/bme680-raspberry at /home/pi/monitoring/bme680)
+#      Free disk space (using df)
+#      Vmstat data
+#      Number of active sessions (using who -uH)
+#      Value of a PIR motion sensor on GPIO 12 (GPIO should be exported separately as required)
+#
+
+### CONFIGURATION VARIABLES
+# Also see the bottom of the script to configure functionality
+
+# Path to influx logger
+INFLUX_HOST="http://master:8086"
+# Hostname of the current system (probably leave this alone)
+HOSTNAME="`hostname`"
+# Human-readable location of the current system (ex: 'Bedroom')
+LOCATION=""
+# Audio device to be used for audio monitoring (provides average volume/frequency in 1 second intervals)
+AUDIODEVICE=hw:1
+
+echo "Started at: `date`"
+
+### UTILITY FUNCTIONS
+log_audio()
+{
+  if [ ! -z "`ps -ef | grep rec | grep -v grep`" ]; then
+    return
+  fi
+  now="`date +%s`"
+  end="`expr $now + 55`"
+  export AUDIODRIVER=alsa
+  export AUDIODEV=${AUDIODEVICE}
+  while [ "`date +%s`" -le "$end" ]; do
+    line="`rec -n stat trim 0 1 2>&1 | awk '{print $1"_"$2 $3}' | grep ":" | tail -15 | tr '\n' ',' | sed 's/,$//g' | tr ':' '='`"
+    curl --silent -i -XPOST ${INFLUX_HOST}/write?db=motion --data-binary "motion,hostname=${HOSTNAME},type=audio $line" >/dev/null
+  done
+  echo "AUDIO DONE"
+  date +%s
+}
+
+log_bme()
+{
+  bme="`/home/pi/monitoring/bme680 | awk \
+    'BEGIN { count=0; tmp=0; prs=0; hum=0; voc=0; }
+     /^[0-9]/ {count++; tmp+=$4; prs+=$7; hum+=$10; vocs+=$13} 
+     END {print "temperature="(tmp/count)",pressure="(prs/count)",humidity="(hum/count)",vocs="(vocs/count)}' |\
+     sed 's/temperature=0.00,//g'`"
+
+  echo "bme: $bme"
+  curl --silent -i -XPOST ${INFLUX_HOST}/write?db=environment --data-binary "atmosphere,hostname=${HOSTNAME},sensor=bme680 $bme" 2>/dev/null
+}
+
+log_scd()
+{
+  ppmco2="`cat /run/sensors/scd30/last | grep CO2 | cut -d' ' -f2`"
+  temp="`cat /run/sensors/scd30/last | grep degC | cut -d' ' -f2`"
+  hum="`cat /run/sensors/scd30/last | grep humidity | cut -d' ' -f2`"
+
+  curl --silent -i -XPOST ${INFLUX_HOST}/write?db=environment --data-binary "atmosphere,hostname=${HOSTNAME},sensor=scd30 ppmco2=$ppmco2,temperature=$temp,humidity=$hum" 2>/dev/null
+}
+
+log_df()
+{
+  df | sed 's/%//g' | awk '{if(a[1] == "") {for(i=1;i<NF;i++){a[i]=$i}} else {printf a[NF]"="$NF",";for(i=1;i<NF;i++){printf a[i]"="$i","} print ""}}' | sed 's/,$//g' | sed 's/\(,[^,]*\),/\1 /' | while read line; do
+    curl --silent -i -XPOST ${INFLUX_HOST}/write?db=sysmon --data-binary "sysmon,hostname=${HOSTNAME},$line" >/dev/null
+  done
+}
+
+log_vm()
+{
+  line="`vmstat | grep -v '-' | awk '{if(a[1] == "") {for(i=1;i<NF;i++){a[i]=$i}} else {for(i=1;i<NF;i++){printf a[i]"="$i","} print ""}}' | sed 's/,$//g'`"
+  if [ `which free >/dev/null 2>&1; echo $?` -eq 0 ]; then
+    mempct="`free | grep "^Mem" | awk '{printf "%0.2f",(\$3/\$2)}'`"
+  else
+    mempct=""
+  fi
+  curl --silent -i -XPOST ${INFLUX_HOST}/write?db=sysmon --data-binary "sysmon,hostname=${HOSTNAME} $line,mempct=$mempct" >/dev/null
+}
+
+log_sess()
+{
+  who -uH | sed 's/[ ]* [ (]/\t/g' | sed 's/PID COMMENT/PID\tCOMMENT/g' |
+    sed 's/\([0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]\) /\1@/g' | \
+    awk -v FS='\t' 'BEGIN{a[1]=""}{if(a[1]==""){for(i=1;i<=NF;i++){a[i]=$i}}else{for(i=1;i<=NF;i++){printf a[i] "=" $i ","}}print"\n"}' | \
+    grep -v '^$' | sed 's/IDLE=[.]/IDLE=0:0/g' | \
+    sed 's/COMMENT=(/COMMENT=/g' | sed 's/),$//g' | \
+    sed 's/IDLE=old/IDLE=99:00/g' | sed 's/TIME=/LOGIN_TIME=/g' | \
+    while read line; do
+      # Convert time field to seconds
+      time="`echo "$line" | tr '@' ' ' | cut -d',' -f3 | cut -d'=' -f2`"
+      seconds=`date -d "$time" +%s`
+      line="`echo "$line" | sed "s/TIME=[^,]*,/TIME=${seconds},/g"`"
+
+      # Quote string fields
+      #line="`echo "$line" | sed 's/=\([^,]*\),/="\1",/g' | sed 's/="\([0-9.-]*\)",/=\1,/g'`"
+
+      # Make EVERYTHING a tag so we can group on it...
+      line="`echo "$line" | sed 's/\(.*\)\(LOGIN_TIME=[^,]*\),\(.*\)/\1\3 \2/g'`"
+
+      curl --silent -i -XPOST ${INFLUX_HOST}/write?db=sysmon --data-binary "users,hostname=${HOSTNAME},$line" >/dev/null
+  done
+}
+
+log_pir()
+{
+  pir=`cat /sys/class/gpio/gpio12/value`
+  curl --silent -i -XPOST ${INFLUX_HOST}/write?db=security --data-binary "sensors,type=pir,location=${LOCATION},hostname=${HOSTNAME} value=$pir"
+}
+
+
+### START OF SCRIPT
+start=`date +%s`
+stop="`expr $start + 50`"
+date +%s
+
+# Comment any functionality you don't need
+log_audio &
+while [ "`date +%s`" -lt "$stop" ]; do
+  log_scd
+  log_bme
+  log_df
+  log_vm
+  log_sess
+  log_pir
+  sleep 25
+done

diff --git a/gpl-3.0.txt b/gpl-3.0.txt
new file mode 100644 (file)
index 0000000..f288702
--- /dev/null
+++ b/gpl-3.0.txt
@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

diff --git a/syslog.sh b/syslog.sh
index 64480b0..10879b4 100644 (file)
--- a/syslog.sh
+++ b/syslog.sh
@@ -1,11 +1,63 @@
-#!/bin/bash
-INFLUX_HOST="http://cns-master:8086"
+#!/bin/bash 
+
+### COPYRIGHT NOTICE
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+#
+#    COPYRIGHT 2020 : Slightly Cyberpunk
+#                     www.slightlycyberpunk.com
+#
+#
+
+### DESCRIPTION
+#
+#
+#    This script logs various datapoints to an Influx database
+#    It is designed to be triggered by cron every minute, like:
+#        * *  * * *  /home/pi/monitoring/syslog.sh > /home/pi/monitoring/syslog.log 2>&1
+#    It is intended to run on a Raspberry Pi device. It should generally work on most
+#     Linux systems but may need a few minor modifications.
+#
+#
+#    It is capable of monitoring the following datapoints:
+#      Audio (average volume and duration every second)
+#      CO2, temperature, and humidity levels from an scd30 sensor      
+#        (Requires: https://github.com/UnravelTEC/Raspi-Driver-SCD30 writing to /run/sensors/scd30/last)
+#      VOCs, temperature, pressure, and humidity levels from a bme680 sensor
+#        (Requires: https://github.com/twartzek/bme680-raspberry at /home/pi/monitoring/bme680)
+#      Free disk space (using df)
+#      Vmstat data
+#      Number of active sessions (using who -uH)
+#      Value of a PIR motion sensor on GPIO 12 (GPIO should be exported separately as required)
+#
+
+### CONFIGURATION VARIABLES
+# Also see the bottom of the script to configure functionality
+
+# Path to influx logger
+INFLUX_HOST="http://master:8086"
+# Hostname of the current system (probably leave this alone)
 HOSTNAME="`hostname`"
-LOCATION="bedroom"
+# Human-readable location of the current system (ex: 'Bedroom')
+LOCATION=""
+# Audio device to be used for audio monitoring (provides average volume/frequency in 1 second intervals)
 AUDIODEVICE=hw:1
 
 echo "Started at: `date`"
 
+### UTILITY FUNCTIONS
 log_audio()
 {
   if [ ! -z "`ps -ef | grep rec | grep -v grep`" ]; then
@@ -25,7 +77,6 @@ log_audio()
 
 log_bme()
 {
-#set -x
   bme="`/home/pi/monitoring/bme680 | awk \
     'BEGIN { count=0; tmp=0; prs=0; hum=0; voc=0; }
      /^[0-9]/ {count++; tmp+=$4; prs+=$7; hum+=$10; vocs+=$13} 
@@ -55,15 +106,19 @@ log_df()
 log_vm()
 {
   line="`vmstat | grep -v '-' | awk '{if(a[1] == "") {for(i=1;i<NF;i++){a[i]=$i}} else {for(i=1;i<NF;i++){printf a[i]"="$i","} print ""}}' | sed 's/,$//g'`"
-  mempct="`free | grep "^Mem" | awk '{printf "%0.2f",(\$3/\$2)}'`"
+  if [ `which free >/dev/null 2>&1; echo $?` -eq 0 ]; then
+    mempct="`free | grep "^Mem" | awk '{printf "%0.2f",(\$3/\$2)}'`"
+  else
+    mempct=""
+  fi
   curl --silent -i -XPOST ${INFLUX_HOST}/write?db=sysmon --data-binary "sysmon,hostname=${HOSTNAME} $line,mempct=$mempct" >/dev/null
 }
 
 log_sess()
 {
-  who -uH | \
+  who -uH | sed 's/[ ]* [ (]/\t/g' | sed 's/PID COMMENT/PID\tCOMMENT/g' |
     sed 's/\([0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]\) /\1@/g' | \
-    awk 'BEGIN{a[1]=""}{if(a[1]==""){for(i=1;i<=NF;i++){a[i]=$i}}else{for(i=1;i<=NF;i++){printf a[i] "=" $i ","}}print"\n"}' | \
+    awk -v FS='\t' 'BEGIN{a[1]=""}{if(a[1]==""){for(i=1;i<=NF;i++){a[i]=$i}}else{for(i=1;i<=NF;i++){printf a[i] "=" $i ","}}print"\n"}' | \
     grep -v '^$' | sed 's/IDLE=[.]/IDLE=0:0/g' | \
     sed 's/COMMENT=(/COMMENT=/g' | sed 's/),$//g' | \
     sed 's/IDLE=old/IDLE=99:00/g' | sed 's/TIME=/LOGIN_TIME=/g' | \
@@ -89,9 +144,13 @@ log_pir()
   curl --silent -i -XPOST ${INFLUX_HOST}/write?db=security --data-binary "sensors,type=pir,location=${LOCATION},hostname=${HOSTNAME} value=$pir"
 }
 
+
+### START OF SCRIPT
 start=`date +%s`
 stop="`expr $start + 50`"
 date +%s
+
+# Comment any functionality you don't need
 log_audio &
 while [ "`date +%s`" -lt "$stop" ]; do
   log_scd