Import existing files

.gitignore

@@ -0,0 +1,5 @@
+/legacy
+
+config.ini
+.ism.ini
+ism.ini

README.md

@@ -1,2 +1,44 @@
 # ism-catcher
-Munin plugin and other stuff for rtl_433
+Munin plugin and other stuff for [rtl_433][1].
+
+
+## Hardware Requirements
+* 24/7 running GNU/Linux system with USB port
+* DVB-T dongle with [compatible RTL2832(U)][2] chipset
+* Compatible wireless sensor (e.g. `THN128` or `THR128`)
+
+
+## Software Requirements
+* Munin master/node setup (+ Webserver for Munin output)
+* [rtl_433][1] installation (and JSON-enabled device)
+
+
+## Data Aggregation
+See: `other-scripts/rtl_433.sh`
+
+
+## Plugin Installation
+```bash
+# Setup INI file...
+cp -vn config/sample.ini ~/.ism.ini
+editor ~/.ism.ini
+
+
+# Setup plugin configuration...
+cp -vn plugin-conf.d/ism /etc/munin/plugin-conf.d/
+editor /etc/munin/plugin-conf.d/ism
+
+# Enable plugin...
+ln -s /full/path/to/ism-catcher /etc/munin/plugins/ism
+
+# Test plugin...
+munin-run ism config
+munin-run ism
+
+# Restart daemon...
+service munin-node restart
+```
+
+
+[1]: https://github.com/merbanan/rtl_433
+[2]: http://amzn.to/2qIxh9n

TODO.md

@@ -0,0 +1,2 @@
+* Include screenshots from Munin! (`example` directory)
+* Duplicate data detection? (filter out double OSv1…)

config/sample.ini

@@ -0,0 +1,147 @@
+; ------------------------------------ ;
+; SAMPLE CONFIGURATION FOR ISM-CATCHER ;
+; ------------------------------------ ;
+
+;; (OPTIONAL)
+;; Munin update interval.
+;interval = 300
+
+;; (OPTIONAL)
+;; Location of binary *.db files.
+;; Defaults to sys_get_temp_dir().
+;datadir = /tmp
+
+;; (OPTIONAL)
+;; Purge old data in *.db files after so many packets.
+;; At DBv1 each packet is 10 byte, excluding a 2 byte header.
+;dbcleanup = 100
+
+;; (OPTIONAL)
+;; Custom title for graphs.
+;title = 433.92 MHz
+
+;; (OPTIONAL)
+;; Custom description for page.
+;info = Powered by foo bar and bar foo.
+
+;; (OPTIONAL)
+;; Custom vlabel for graphs.
+;vlabel = degree Celsius
+
+;; (OPTIONAL)
+;; Custom category for graphs.
+;category = sensors
+
+;; (OPTIONAL)
+;; Set upper limit for fancy graphs.
+;highest = 50.0
+
+;; (OPTIONAL)
+;; Set lower limit for fancy graphs.
+;lowest  = -20.0
+
+;; (OPTIONAL)
+;; Draw a line at <n> with color <RRGGBB>.
+;; The third argument would print a legend too.
+;; Very usefull for freezing mark or similar.
+base = 0:BEBEBE
+
+
+; Text between [] is an unique key for one sensor/measurement.
+; It's impossible to combine two values from one wireless sensor
+; into one definition. Each value needs its own definition...
+[EXAMPLE]
+
+; All lower-cased settings are required conditions for this sensor.
+; Just think of it as simple IF-EQUAL checks, concatenated by AND.
+; The keys and values from JSON input are converted to lowercase.
+; Beware of changed values in ID or SID fields on battery change!
+model     = OSv1 Temperature Sensor
+channel   = 1
+;sid      = n
+
+;; (OPTIONAL)
+;; All upper-cased settings are overriding the built-in default values.
+;; Take a look at the Wiki: http://munin-monitoring.org/wiki/fieldnames
+;LABEL    = Visible name for this sensor
+;INFO     = Description for this sensor
+;WARNING  = [<l>]:[<u>]
+;CRITICAL = [<l>]:[<u>]
+;COLOUR   = <0..28>
+;LINE     = <1..3>
+
+;; (OPTIONAL)
+;; The default data source is "temperature_C".
+;; You can override it with your own field names.
+;SOURCE   = humidity
+
+;; (OPTIONAL)
+;; Use this line to hide the sensor in the graphs.
+;; All data will be stored in the RRD, but it's hidden.
+;graph    = false
+
+;; (OPTIONAL)
+;; By default processing of groups will stop after the first match.
+;; You can change this behavior for sensors with multiple values.
+;; (e.g. temperature, humidity, barometric pressure, ...)
+;FINAL    = false
+
+
+; --------------------------------------- ;
+; SOME EXAMPLES FROM MY PERSONAL SETUP... ;
+; --------------------------------------- ;
+
+[FRIDGE]
+model    = OSv1 Temperature Sensor
+channel  = 3
+
+LABEL    = Fridge
+INFO     = Oregon Scientific THR128 (channel 3)
+CRITICAL = 2:12
+COLOUR   = 1
+LINE     = 2
+
+
+[OUTDOOR]
+model    = OSv1 Temperature Sensor
+channel  = 2
+;sid     = n
+
+LABEL    = Outdoor
+INFO     = Oregon Scientific THN128 (channel 2)
+COLOUR   = 0
+LINE     = 3
+
+
+[Acurite]
+model    = Acurite 606TX Sensor
+;id      = n
+
+GRAPH    = false
+LABEL    = [!] Acurite
+INFO     = Acurite 606TX Sensor
+COLOUR   = 16
+
+
+[Nexus_Temperature]
+model    = Nexus Temperature/Humidity
+channel  = 1
+;id      = n
+
+GRAPH    = false
+LABEL    = [!] Nexus (temperature)
+INFO     = Nexus Temperature/Humidity
+FINAL    = false
+COLOUR   = 8
+
+
+[Nexus_Humidity]
+model    = Nexus Temperature/Humidity
+channel  = 1
+;id      = n
+
+GRAPH    = false
+LABEL    = [!] Nexus (humidity)
+INFO     = Nexus Temperature/Humidity
+SOURCE   = humidity
+COLOUR   = 20

example/OUTPUT.md

@@ -0,0 +1,35 @@
+```
+$ ism-catcher --dump=outdoor | tail -n 10
+[2017-06-02T16:42:02+02:00]      30.100 (0x0000)
+[2017-06-02T16:42:03+02:00]      30.100 (0x0000)
+[2017-06-02T16:42:31+02:00]      29.900 (0x0000)
+[2017-06-02T16:42:31+02:00]      29.900 (0x0000)
+[2017-06-02T16:43:00+02:00]      29.800 (0x0000)
+[2017-06-02T16:43:00+02:00]      29.800 (0x0000)
+[2017-06-02T16:43:29+02:00]      29.800 (0x0000)
+[2017-06-02T16:43:30+02:00]      29.800 (0x0000)
+[2017-06-02T16:43:58+02:00]      29.800 (0x0000)
+[2017-06-02T16:43:58+02:00]      29.800 (0x0000)
+
+$ ism-catcher --dump acurite | tail -n 10
+[2017-06-02T16:09:02+02:00]      32.100 (0x0001)
+[2017-06-02T16:13:10+02:00]      32.200 (0x0001)
+[2017-06-02T16:13:41+02:00]      32.100 (0x0001)
+[2017-06-02T16:18:21+02:00]      32.000 (0x0001)
+[2017-06-02T16:21:26+02:00]      31.800 (0x0001)
+[2017-06-02T16:21:57+02:00]      31.700 (0x0001)
+[2017-06-02T16:26:06+02:00]      31.600 (0x0001)
+[2017-06-02T16:26:37+02:00]      31.500 (0x0001)
+[2017-06-02T16:40:03+02:00]      30.700 (0x0001)
+[2017-06-02T16:41:04+02:00]      30.700 (0x0001)
+
+$ ism-catcher
+indoor.value 26.8
+fridge.value 7.1
+outdoor.value 29.8
+acurite.value 30.7
+nexus_temperature.value 28.2
+nexus_temperature.extinfo LOW BATTERY
+nexus_humidity.value 19
+nexus_humidity.extinfo LOW BATTERY
+```

example/TWITTER.md

@@ -0,0 +1,3 @@
+Live demo of tweets and graphs: [@_GUMPENDORF_](https://twitter.com/_GUMPENDORF_)
+
+Generated on the Munin master server with simple scripts from `other-scripts` directory.