Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
HomeKit Library for the Arduino-ESP32
213 Commits 18 Branches 21 Tags 6.9 MiB
C++ 89.5%
C 9.7%
Awk 0.7%
Go to file
HomeSpan bcc1cee1fd
Update README.md 		2020-11-06 22:20:23 -06:00
docs Update ServiceList.md 2020-11-06 21:37:50 -06:00
examples Added License Info to all files 2020-11-02 20:09:09 -06:00
src Update Services.h 2020-11-06 21:38:40 -06:00
.gitattributes Initial commit 2020-07-18 21:47:39 -05:00
.gitignore Update .gitignore 2020-10-05 21:34:37 -05:00
LICENSE Create LICENSE 2020-10-04 10:29:24 -05:00
README.md Update README.md 2020-11-06 22:20:23 -06:00
library.properties Update library.properties 2020-11-02 06:29:39 -06:00

README.md

HomeSpan

HomeKit for the Arduino-ESP32!

Welcome to HomeSpan - a robust and extremely easy-to-use Arduino library for creating your own ESP32-based HomeKit devices entirely within the Arduino IDE.

HomeSpan provides a microcontroller-focused implementation of Apple's HomeKit Accessory Protocol Specification (HAP) Release R2 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:

  • 100% HAP R2 Compliance
  • 38 fully-implemented HomeKit Services
  • Operates in Accessory or Bridge mode

For the HomeSpan Developer:

  • Extensive log outputs to the Arduino Serial Monitor
  • Debugging and configuration control commands via the Arduino Serial Monitor
  • Extensive error checking and HomeKit developer diagnostics
  • Integrated PWM functionality
  • Integrated Push Button functionailty supporting single, double, and long presses
  • Integrated access to ESP-32's Remote Control functionality used to generate IR and RF signals
  • 16 detailed tutorial-examples wirth extensive comments, instructions, and HomeKit tips and tricks

For the HomeSpan End-User:

  • Embedded WiFi Access Point and Web Interface to allow end-users (non-developers) to:
    • Setup Homespan with their own home WiFi Credentials
    • Create their own HomeKit Pairing Setup Code
  • Status LED and Control Button to allow end-users to:
    • Unpair the device from HomeKit
    • Perform a Factory Reset
    • Launch the WiFi Access Point
  • A 10-page User Guide

Latest Updates: 11/3/2020

  • HomeSpan 1.0.0 is the initial public release. It is 100% feature-complete and includes 16 very detailed example-tutorials providing step-by-step instructions on how to use HomeSpan to create your own HomeKit devices. A 10-page User Guide provides addtional details on how to configure your finished HomeKit device for use on your WiFi network, and how to pair it to HomeKit.

Getting Started

Complete documentation coming soon...

User Guide