Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
HomeSpan 2020-11-15 16:28:59 -06:00 committed by GitHub
parent c89a22d03f
commit 2cb72a7847
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -7,67 +7,10 @@ HomeSpan provides a microcontroller-focused implementation of [Apple's HomeKit A
***Please visit [HomeSpan](https://homespan.github.io/HomeSpan/) on GitHub Pages for complete information and documentation on this repository.*** ***Please visit [HomeSpan](https://homespan.github.io/HomeSpan/) on GitHub Pages for complete information and documentation on this repository.***
### HomeSpan Highlights
* Provides a natural, intuitive, and **very** easy-to-use framework
* Utilizes a unique *Service-Centric* approach to creating HomeKit devices
* Takes full advantage of the widely-popular Arduino IDE
* 100% HAP-R2 compliance
* 38 integrated [HomeKit Services](docs/ServiceList.md)
* Operates in either Accessory or Bridge mode
### For the HomeSpan Developer
* Extensive use of the Arduino Serial Monitor
* Real-time, easy-to-understand diagnostics
* Complete transparency to every underlying HomeKit action, data request, and data response
* Command-line interface with a variety of info, debugging, and configuration commands
* Built-in database validation to ensure your configuration meets all HAP requirements
* Integrated PWM functionality supporting pulse-wave-modulation on any ESP32 pin
* Integrated Push Button functionality supporting single, double, and long presses
* Integrated access to the ESP32's on-chip Remote Control peripheral for easy generation of IR and RF signals
* 16 detailed [tutorial-sketches](docs/Tutorials.md) with extensive comments, HomeSpan documentation and tips and tricks
### For the HomeSpan End-User
* Embedded WiFi Access Point and Web Interface to allow end-users (non-developers) to:
* Set up Homespan with their own home WiFi Credentials
* Create their own HomeKit Pairing Setup Code
* Status LED and Control Button to allow end-users to:
* Force-unpair the device from HomeKit
* Perform a Factory Reset
* Launch the WiFi Access Point
* A standalone, detailed [End-User Guide](docs/UserGuide.md)
# Latest Updates
#### 11/3/2020
> HomeSpan 1.0.0 is the initial public release. It is 100% feature-complete and includes 16 very detailed [tutorial-sketches](docs/Tutorials.md) providing step-by-step instructions on how to use HomeSpan to create your own HomeKit devices. A 10-page [User Guide](docs/UserGuide.md) provides addtional details on how to configure your finished HomeKit device for use on your WiFi network, and how to pair it to HomeKit.
# HomeSpan Resources
HomeSpan includes the following documentation:
* [Getting Started with HomeSpan](docs/GettingStarted.md) - setting up the software and acquiring the hardware
* [HomeKit Primer](docs/HomeKitPrimer.md) - a gentle introduction to Apple HomeKit and HAP terminology.
* [HomeSpan Overview](docs/Overview.md) - an overview of the HomeSpan framework
* [HomeSpan Tutorials](docs/Tutorials.md) - a guide to HomeSpan's tutorial-sketches
* [HomeSpan Services and Characteristics](docs/ServiceList.md) - a list of all HAP Services and Characterstics supported by HomeSpan
* [HomeSpan Accessory Categories](docs/Categories.md) - a list of all HAP Accessory Categories defined by HomeSpan
* [HomeSpan Command-Line Interface (CLI)](docs/CLI.md) - use HomeSpan's CLI to configure and monitor your HomeSpan device via the Arduino Serial Monitor
* [HomeSpan End-User Guide](docs/UserGuide.md) - end-user instructions for configuring an already-programmed HomeSpace's WiFi Credentials, creating a device Setup Code, and pairing the device to HomeKit. No computer needed!
* [HomeSpan Library Reference](docs/Reference.md) - a complete guide to the HomeSpan Library API
In addition to the above resources, developers who are new to HomeKit programming should download Apple's [HomeKit Accessory Protocol Specification, Release R2 (HAP-R2)](https://developer.apple.com/support/homekit-accessory-protocol/). The download is free, but Apple requires you to register your Apple ID for access to the document.
You ***do not*** need to read the entire document. The whole point of HomeSpan is that it implements all the required HAP operations under the hood so you can focus on just programming whatever logic is needed to control your real-world appliances (lights, fans, RF remote controls, etc.) with the device. However, you will find Chapters 8 and 9 of the HAP guide to be an invaluable reference as it lists and describes all of the Services and Characteristics implemented in HomeSpan, many of which you will routinely utilize in your own HomeSpan sketches.
--- ---
Feedback or questions? Please send to homespan@icloud.com Feedback or questions? Please send to homespan@icloud.com
Enjoy!