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-07 17:35:52 -06:00 committed by GitHub
parent 73507ea551
commit 03644fcd71
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -5,22 +5,26 @@ Welcome to HomeSpan - a robust and extremely easy-to-use Arduino library for cre
HomeSpan provides a microcontroller-focused implementation of [Apple's HomeKit Accessory Protocol Specification (HAP) Release R2](https://developer.apple.com/support/homekit-accessory-protocol/) designed specifically for the Espressif ESP32 microcontroller running within the Arduino IDE. HomeSpan pairs directly to HomeKit via your home WiFi network without the need for any external bridges or components. With HomeSpan you can use the full power of the ESP32's I/O functionality to create custom control software and/or hardware to automatically operate external devices from the Home App on your iPhone, iPad, or Mac, or with Siri. HomeSpan provides a microcontroller-focused implementation of [Apple's HomeKit Accessory Protocol Specification (HAP) Release R2](https://developer.apple.com/support/homekit-accessory-protocol/) designed specifically for the Espressif ESP32 microcontroller running within the Arduino IDE. HomeSpan pairs directly to HomeKit via your home WiFi network without the need for any external bridges or components. With HomeSpan you can use the full power of the ESP32's I/O functionality to create custom control software and/or hardware to automatically operate external devices from the Home App on your iPhone, iPad, or Mac, or with Siri.
#### HomeSpan features: #### HomeSpan Highlights
* A natural, intuitive, and **very** easy-to-use API * Provides a natural, intuitive, and **very** easy-to-use framework
* 100% HAP R2 Compliance * Utilizes a unique *Service-Centric* approach to creating HomeKit devices
* 38 fully-implemented [HomeKit Services](docs/ServiceList.md) * Takes full advantage of the widely-popular Arduino IDE
* Operates in Accessory or Bridge mode * 100% HAP R2 compliance
* Full Implementation of 38 [HomeKit Services](docs/ServiceList.md)
* Operates in either Accessory or Bridge mode
#### For the HomeSpan Developer: #### For the HomeSpan Developer:
* Extensive log outputs to the Arduino Serial Monitor * Extensive use of the Arduino Serial Monitor
* Debugging and configuration control commands via the Arduino Serial Monitor * Real-time, easy-to-understand diagnostics
* Extensive error checking and HomeKit developer diagnostics * Complete transparency to every underlying HomeKit action, data request, and data response
* Integrated PWM functionality * Command-line interface with a variety of info, debugging, and configuration commands
* Integrated Push Button functionailty supporting single, double, and long presses * Built-in database validation to ensure your configuration meets all HAP requirements
* Integrated access to ESP-32's Remote Control functionality used to generate IR and RF signals * Integrated PWM functionality supporting pulse-wave-modulation on any ESP-32 pin
* 16 detailed tutorial-examples wirth extensive comments, instructions, and HomeKit tips and tricks * Integrated Push Button functionality supporting single, double, and long presses
* Integrated access to the ESP-32's on-chip Remote Control peripheral for easy generation IR and RF signals
* 16 detailed tutorial-examples with extensive comments, instructions, and HomeKit tips and tricks
#### For the HomeSpan End-User: #### For the HomeSpan End-User:
@ -31,7 +35,7 @@ HomeSpan provides a microcontroller-focused implementation of [Apple's HomeKit A
* Unpair the device from HomeKit * Unpair the device from HomeKit
* Perform a Factory Reset * Perform a Factory Reset
* Launch the WiFi Access Point * Launch the WiFi Access Point
* A 10-page User Guide * A 10-page [End-User Guide](docs/UserGuide.md)
## Latest Updates ## ## Latest Updates ##