Update README.md, examples

taligentx · taligentx · commit 8b7b0a287130 · 2018-07-07T13:47:04.000-05:00
diff --git a/README.md b/README.md
@@ -6,10 +6,10 @@ For example, an Arduino Uno (with an ethernet/wifi module) or the inexpensive No
 * Apple Home and Siri:
   ![HomeKit](https://user-images.githubusercontent.com/12835671/39588413-5a99099a-4ec1-11e8-9a2e-e332fa2d6379.jpg)
 
-* Home Assistant:
+* [Home Assistant](https://www.home-assistant.io):
   ![HomeAssistant](https://user-images.githubusercontent.com/12835671/42108879-7362ccf6-7ba1-11e8-902e-d6cb25483a00.png)
 
-* Blynk virtual keypad:
+* [Blynk](https://www.blynk.cc) virtual keypad:
 
   ![dsc-blynk](https://user-images.githubusercontent.com/12835671/42364975-add27c94-80c2-11e8-8a55-9d6d168ff8c1.png)
 
@@ -25,7 +25,7 @@ For example, an Arduino Uno (with an ethernet/wifi module) or the inexpensive No
   - esp8266: NodeMCU, Wemos D1 Mini, ESP12, etc
 
 ## Release notes
-* 1.0-develop
+* 1.0
   - New: [Blynk](https://www.blynk.cc) virtual keypad example sketch and app layout examples
   - New: Virtual keypad support for PGM terminals 1-4 command output
   - New: Status `dsc.keybusConnected` to check if data is being received from the DSC panel
@@ -51,7 +51,7 @@ For example, an Arduino Uno (with an ethernet/wifi module) or the inexpensive No
   - Note: This release changes the library methods to accomodate multiple partitions, existing sketches will need to be updated to match the new example sketches.
 * 0.2
   - New: Status for zones 9-32
-  - New: HomeAssistant integration example sketch
+  - New: [Home Assistant](https://www.home-assistant.io) integration example sketch
   - New: Panel data buffering, adds `dscBufferSize` to `dscKeybusInterface.h` to allow configuration of how many panel commands are buffered to customize memory usage (uses 18 bytes of memory per command buffered).
 * 0.1 - Initial release
 
diff --git a/examples/Arduino/HomeAssistant-MQTT/HomeAssistant-MQTT.ino b/examples/Arduino/HomeAssistant-MQTT/HomeAssistant-MQTT.ino
@@ -1,5 +1,5 @@
 /*
- *  HomeAssistant-MQTT 0.4 (Arduino)
+ *  HomeAssistant-MQTT 1.0 (Arduino)
  *
  *  Processes the security system status and allows for control using Home Assistant via MQTT.
  *
diff --git a/examples/Arduino/Homebridge-MQTT/Homebridge-MQTT.ino b/examples/Arduino/Homebridge-MQTT/Homebridge-MQTT.ino
@@ -1,5 +1,5 @@
 /*
- *  Homebridge-MQTT 0.4 (Arduino)
+ *  Homebridge-MQTT 1.0 (Arduino)
  *
  *  Processes the security system status and allows for control using Apple HomeKit, including the iOS Home app and
  *  Siri.  This uses MQTT to interface with Homebridge and the homebridge-mqttthing plugin for HomeKit integration
diff --git a/examples/Arduino/KeybusReader/KeybusReader.ino b/examples/Arduino/KeybusReader/KeybusReader.ino
@@ -1,5 +1,5 @@
 /*
- *  DSC Keybus Reader 0.4 (Arduino)
+ *  DSC Keybus Reader 1.0 (Arduino)
  *
  *  Decodes and prints data from the Keybus to a serial interface, including reading from serial for the virtual
  *  keypad.  This is primarily to help decode the Keybus protocol - see the Status examples to put the interface
diff --git a/examples/esp8266/Email/Email.ino b/examples/esp8266/Email/Email.ino
@@ -1,5 +1,5 @@
 /*
- *  Email Notification 0.4 (esp8266)
+ *  Email Notification 1.0 (esp8266)
  *
  *  Processes the security system status and demonstrates how to send an email when the status has changed.  Configure
  *  the email SMTP server settings in sendEmail().
diff --git a/examples/esp8266/HomeAssistant-MQTT/HomeAssistant-MQTT.ino b/examples/esp8266/HomeAssistant-MQTT/HomeAssistant-MQTT.ino
@@ -1,5 +1,5 @@
 /*
- *  HomeAssistant-MQTT 0.4 (esp8266)
+ *  HomeAssistant-MQTT 1.0 (esp8266)
  *
  *  Processes the security system status and allows for control using Home Assistant via MQTT.
  *
diff --git a/examples/esp8266/Homebridge-MQTT/Homebridge-MQTT.ino b/examples/esp8266/Homebridge-MQTT/Homebridge-MQTT.ino
@@ -1,5 +1,5 @@
 /*
- *  Homebridge-MQTT 0.4 (esp8266)
+ *  Homebridge-MQTT 1.0 (esp8266)
  *
  *  Processes the security system status and allows for control using Apple HomeKit, including the iOS Home app and
  *  Siri.  This uses MQTT to interface with Homebridge and the homebridge-mqttthing plugin for HomeKit integration
diff --git a/examples/esp8266/Homey/Homey.ino b/examples/esp8266/Homey/Homey.ino
@@ -1,5 +1,5 @@
 /*
- *  Homey 0.4 (esp8266)
+ *  Homey 1.0 (esp8266)
  *
  *  Processes the security system status for partition 1 and allows for control using Athom Homey.
  *
diff --git a/examples/esp8266/KeybusReader/KeybusReader.ino b/examples/esp8266/KeybusReader/KeybusReader.ino
@@ -1,5 +1,5 @@
 /*
- *  DSC Keybus Reader 0.4 (esp8266)
+ *  DSC Keybus Reader 1.0 (esp8266)
  *
  *  Decodes and prints data from the Keybus to a serial interface, including reading from serial for the virtual
  *  keypad.  This is primarily to help decode the Keybus protocol - see the Status examples to put the interface
diff --git a/examples/esp8266/Pushbullet/Pushbullet.ino b/examples/esp8266/Pushbullet/Pushbullet.ino
@@ -1,5 +1,5 @@
 /*
- *  Pushbullet Push Notification 0.4 (esp8266)
+ *  Pushbullet Push Notification 1.0 (esp8266)
  *
  *  Processes the security system status and demonstrates how to send a push notification when the status has changed.
  *  This example sends notifications via Pushbullet: https://www.pushbullet.com
diff --git a/examples/esp8266/VirtualKeypad-Blynk/VirtualKeypad-Blynk.ino b/examples/esp8266/VirtualKeypad-Blynk/VirtualKeypad-Blynk.ino
@@ -1,11 +1,17 @@
 /*
  *  VirtualKeypad-Blynk 1.0 (esp8266)
  *
- *  Provides a virtual keypad interface for the free Blynk (https://www.blynk.cc) app on iOS and Android.  Scan one of
- *  the following QR codes from within the Blynk app for an example keypad layout:
+ *  Provides a virtual keypad interface for the free Blynk (https://www.blynk.cc) app on iOS and Android.
+ *
+ *  Usage:
+ *  1. Scan one of the following QR codes from within the Blynk app for an example keypad layout:
  *    16 zones: https://user-images.githubusercontent.com/12835671/42364287-41ca6662-80c0-11e8-85e7-d579b542568d.png
  *    32 zones: https://user-images.githubusercontent.com/12835671/42364293-4512b720-80c0-11e8-87bd-153c4e857b4e.png
  *    64 zones: https://user-images.githubusercontent.com/12835671/42364299-47d84556-80c0-11e8-9833-9f957c6aacbb.png
+ *  2. Navigate to Project Settings > Devices > DSC Keybus Interface > DSC KeybusInterface.
+ *  3. Select "Refresh" to generate a new auth token.
+ *  4. Go back to Project Settings, copy the auth token, and paste it in an email or message to yourself.
+ *  5. Add the auth token to the sketch below.
  *
  *  Installing Blynk as a local server (https://github.com/blynkkk/blynk-server) is recommended to keep control of the
  *  security system internal to your network.  This also lets you use as many widgets as needed for free - local
diff --git a/library.json b/library.json
@@ -7,7 +7,7 @@
     "type": "git",
     "url": "https://github.com/taligentx/dscKeybusInterface.git"
   },
-  "version": "0.4",
+  "version": "1.0",
   "frameworks": "arduino",
   "platforms": "atmelavr, espressif8266"
 }
diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
 name=DSC Keybus Interface
-version=0.4
+version=1.0
 author=Nikhil Choudhary <nikhilc@taligentx.com>
 maintainer=Nikhil Choudhary <nikhilc@taligentx.com>
 sentence=This library directly interfaces Arduino and esp8266 microcontrollers to DSC PowerSeries security systems for integration with home automation, notifications on system events, and usage as a virtual keypad.
-paragraph=The included examples demonstrate monitoring armed/alarm/zone/fire/trouble states, integrating with Home Assistant and Apple HomeKit using MQTT, sending push notifications/email, and reading/decoding Keybus data.  Supports up to 8 partitions/64 zones and tested with the following DSC panels: PC1555MX, PC5015, PC1616, PC1832, PC1864.  Version 0.4 adds virtual keypad support for partitions 3-8.
+paragraph=The included examples demonstrate monitoring armed/alarm/zone/fire/trouble states, integrating with Home Assistant and Apple HomeKit using MQTT, sending push notifications/email, and reading/decoding Keybus data.  Supports up to 8 partitions/64 zones and tested with the following DSC panels: PC1555MX, PC5015, PC1616, PC1832, PC1864.  Version 1.0 adds a Blynk virtual keypad app, virtual keypad command output 1-4, and updated status checking/decoding.
 category=Device Control
 url=https://github.com/taligentx/dscKeybusInterface
 architectures=*

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * HomeAssistant-MQTT 0.4 (Arduino)`
	`2`	`+ * HomeAssistant-MQTT 1.0 (Arduino)`
`3`	`3`	`*`
`4`	`4`	`* Processes the security system status and allows for control using Home Assistant via MQTT.`
`5`	`5`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Homebridge-MQTT 0.4 (Arduino)`
	`2`	`+ * Homebridge-MQTT 1.0 (Arduino)`
`3`	`3`	`*`
`4`	`4`	`* Processes the security system status and allows for control using Apple HomeKit, including the iOS Home app and`
`5`	`5`	`* Siri. This uses MQTT to interface with Homebridge and the homebridge-mqttthing plugin for HomeKit integration`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * DSC Keybus Reader 0.4 (Arduino)`
	`2`	`+ * DSC Keybus Reader 1.0 (Arduino)`
`3`	`3`	`*`
`4`	`4`	`* Decodes and prints data from the Keybus to a serial interface, including reading from serial for the virtual`
`5`	`5`	`* keypad. This is primarily to help decode the Keybus protocol - see the Status examples to put the interface`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Email Notification 0.4 (esp8266)`
	`2`	`+ * Email Notification 1.0 (esp8266)`
`3`	`3`	`*`
`4`	`4`	`* Processes the security system status and demonstrates how to send an email when the status has changed. Configure`
`5`	`5`	`* the email SMTP server settings in sendEmail().`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * HomeAssistant-MQTT 0.4 (esp8266)`
	`2`	`+ * HomeAssistant-MQTT 1.0 (esp8266)`
`3`	`3`	`*`
`4`	`4`	`* Processes the security system status and allows for control using Home Assistant via MQTT.`
`5`	`5`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Homebridge-MQTT 0.4 (esp8266)`
	`2`	`+ * Homebridge-MQTT 1.0 (esp8266)`
`3`	`3`	`*`
`4`	`4`	`* Processes the security system status and allows for control using Apple HomeKit, including the iOS Home app and`
`5`	`5`	`* Siri. This uses MQTT to interface with Homebridge and the homebridge-mqttthing plugin for HomeKit integration`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Homey 0.4 (esp8266)`
	`2`	`+ * Homey 1.0 (esp8266)`
`3`	`3`	`*`
`4`	`4`	`* Processes the security system status for partition 1 and allows for control using Athom Homey.`
`5`	`5`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * DSC Keybus Reader 0.4 (esp8266)`
	`2`	`+ * DSC Keybus Reader 1.0 (esp8266)`
`3`	`3`	`*`
`4`	`4`	`* Decodes and prints data from the Keybus to a serial interface, including reading from serial for the virtual`
`5`	`5`	`* keypad. This is primarily to help decode the Keybus protocol - see the Status examples to put the interface`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Pushbullet Push Notification 0.4 (esp8266)`
	`2`	`+ * Pushbullet Push Notification 1.0 (esp8266)`
`3`	`3`	`*`
`4`	`4`	`* Processes the security system status and demonstrates how to send a push notification when the status has changed.`
`5`	`5`	`* This example sends notifications via Pushbullet: https://www.pushbullet.com`