From 9d5448c19c7f1dd814ec7d99f3049702b7b487b0 Mon Sep 17 00:00:00 2001
From: mobileflowllc <fieldforceapp@gmail.com>
Date: Tue, 27 Jun 2017 12:31:39 -0700
Subject: [PATCH] readme update

---
 .DS_Store  | Bin 6148 -> 0 bytes
 .gitignore |  37 ++++++++++++++++++++
 README.md  |  99 +++++++++++++++++++++++++++++++++++++----------------
 3 files changed, 107 insertions(+), 29 deletions(-)
 delete mode 100644 .DS_Store
 create mode 100644 .gitignore

diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index 966892a9bb19ede9735107f0e18b617191d1d0cd..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 6148
zcmeHKJ5Iwu5S<}GibNAS$~^&6ZeT@5qM-8uK(bNz#91pOD5YC&!GUP$IRJ;?&CY;g
zaFGfjG9&H2-Pw8jc~N#fM8wl|H6a=k(FjG5rO{*J?j1U?;6os%IqvC}R&+`mDtjjS
zi!RywF`ZMSnyzVk|B)(q8d_rPZa$k7Wvm-L!t?uXtUBg-wO&Ds*UjZi;_k3k9jh<a
z#nY~==4N|`Z$cZ;19o3N7R$vvE@trHS8{U&Tme_W71(<P>@^r2?Y$B%fGgk%d{;p3
zhkzoO8Mcb)>OhrJ0N@brWN1q+A)H{C8McZTfw5A7N@YtiSn2Qwi^~jKMWqv4^1-(9
zXY#^nb<7`9IB}-vwJYEXbQKtAcP#J!8U8Z8Nq(2&Jy*aL_-6|6FfZ~c4rOoakK@T(
w8&IxL#3Zhj1`O@aM*uo<kDR1I9S_n*TxQrR$}HkfbfA9-Btg7#1%5$+4_os<CjbBd

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..efc2e87
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,37 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+*.bin
+
+# Mac
+.DS_Store
+
diff --git a/README.md b/README.md
index 49d2d26..1fc311d 100644
--- a/README.md
+++ b/README.md
@@ -1,61 +1,102 @@
 # homekit
 
-A Particle library for homekit
+A Particle library for Apple's HomeKit. Uses MDNS, TLV8 and private crypto libraries to present a Photon device as a HomeKit accessory.
 
-## Welcome to your library!
+## homekit background
 
-To get started, modify the sources in [src](src). Rename the example folder inside [examples](examples) to a more meaningful name and add additional examples in separate folders.
+Apple's HomeKit group has recently provided accesses to their proprietary HomeKit Accessory Protocol specification for non-commercial use. This library is an implementation of that HAP protocol for the Particle.io Photon board, allowing you to control your device directly from the Home iOS app.
 
-To compile your example you can use `particle compile examples/usage` command in [Particle CLI](https://docs.particle.io/guide/tools-and-features/cli#update-your-device-remotely) or use our [Desktop IDE](https://docs.particle.io/guide/tools-and-features/dev/#compiling-code).
+## Usage
 
-Libraries can also depend on other libraries. To add a dependency use [`particle library add`](https://docs.particle.io/guide/tools-and-features/cli#adding-a-library) or [library management](https://docs.particle.io/guide/tools-and-features/dev/#managing-libraries) in Desktop IDE.
+Connect Photon hardware, add the homekit library to your project and follow this simple example. Once the code is running on your Photon board, open the Home app on your iOS device and select the "Particle" accessory. In the example below, the Particle will appear as a "lightbulb" within the Home app, allow you to turn an LED on the board on & off.
 
-After the library is done you can upload it with `particle library upload` or `Upload` command in the IDE. This will create a private (only visible by you) library that you can use in other projects. If you wish to make your library public, use `particle library publish` or `Publish` command.
 
-_TODO: update this README_
+```
+#include "homekit.h"
 
-## Usage
+// Initialize objects from the lib
+Homekit homekit = Homekit( lightbulbType );
 
-Connect XYZ hardware, add the homekit library to your project and follow this simple example:
+// Create a TCP/HTTP service for local discovery and HAP accessory handling
+TCPServer server = TCPServer(80);
+
+// Create a EthernetBonjour service for MDNS registration & discovery
+EthernetBonjourClass Bonjour;
+
+int LED = D1;              // LED connected to D1
 
-```
-#include "homekit.h"
-Homekit homekit;
 
 void setup() {
-  homekit.begin();
+    WiFi.connect();
+
+    server.begin();
+
+    // Initialize EthernetBonjour service with local UDP reference
+    Bonjour.setUDP( &udp );
+
+    // Begin MDNS registration servcie with the name of the HAP accessory (will appear in Apple Home)
+    Bonjour.begin("particle");
+
+    // Start MDNS registration with TCP based service, using special HAP TXT records encoded as c-string
+    Bonjour.addServiceRecord("particle._hap",
+                                    80,
+                                    MDNSServiceTCP,
+                                    "\x4sf=1\x14id=3C:33:1B:21:B3:00\x6pv=1.0\x04\c#=1\x04s#=1\x4\ff=0\x04sf=1\x0Bmd=particle");
+
+    Characterist *light = homekit.newCharacteristic( onSetting );
+
+    homekit.begin();
+
+
+    pinMode(LED, OUTPUT);    // sets pin as output
+
 }
 
 void loop() {
-  homekit.process();
-}
-```
 
-See the [examples](examples) folder for more details.
+    // Process MDNS UDP traffic once per loop
+    Bonjour.run();
 
-## Documentation
+    // Check on TCP client status
+    TCPClient client = server.available();
+
+    if (client){
+    {
+        // Use the library's initialized objects and functions
+        homekit.process(  client );
 
-TODO: Describe `Homekit`
+        uint8_t onOff = light->intValue;
+        Serial.println("Lightbulb is ", onOff );
 
-## Contributing
+        if ( onOff ) {
+              digitalWrite(LED, HIGH); // sets the LED on
+        }
+        else {
+              digitalWrite(LED, LOW);  // sets the LED off
+        }
 
-Here's how you can make changes to this library and eventually contribute those changes back.
+    }
 
-To get started, [clone the library from GitHub to your local machine](https://help.github.com/articles/cloning-a-repository/).
+    if (!client.connected())
+    {
 
-Change the name of the library in `library.properties` to something different. You can add your name at then end.
+        Serial.println();
+        Serial.println("disconnecting.");
+        client.stop();
+        for(;;);
+    
+    }
 
-Modify the sources in <src> and <examples> with the new behavior.
 
-To compile an example, use `particle compile examples/usage` command in [Particle CLI](https://docs.particle.io/guide/tools-and-features/cli#update-your-device-remotely) or use our [Desktop IDE](https://docs.particle.io/guide/tools-and-features/dev/#compiling-code).
+}
+```
 
-After your changes are done you can upload them with `particle library upload` or `Upload` command in the IDE. This will create a private (only visible by you) library that you can use in other projects. Do `particle library add homekit_myname` to add the library to a project on your machine or add the homekit_myname library to a project on the Web IDE or Desktop IDE.
+See the [examples](examples) folder for more details.
 
-At this point, you can create a [GitHub pull request](https://help.github.com/articles/about-pull-requests/) with your changes to the original library. 
+## Documentation
 
-If you wish to make your library public, use `particle library publish` or `Publish` command.
 
 ## LICENSE
 Copyright 2017 moflo
 
-Licensed under the <insert your choice of license here> license
+Licensed under the GNU LPL license.