From 3cd1c52796fd9555ac9ea3b5effdda7eea8a8765 Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Tue, 17 Nov 2020 07:24:49 -0600 Subject: [PATCH] Update Overview.md --- docs/Overview.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/Overview.md b/docs/Overview.md index 9dfa91c..525b5ad 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -1,6 +1,10 @@ # HomeSpan Overview -*(coming soon)* +*Note: This page references a lot of HomeKit HAP terminology. If you are new to HomeKit development, you may want to start by first reviewing the [HomeKit Primer](HomeKitPrimer.md) page.* + +HomeSpan is an Arduino-style C++ library designed for ESP32 devices to take on the role of a *HAP Accessory Server*, which allows the device to be paired to, and communicate with, any *HAP Client*, such as Apple's Home App on an iPhone, iPad, or Mac. + +There are three primary functions of HomeSpan. The first is to implement all the required HomeKit protocols needed for you to define and then expose one or more HAP Accessory Objects, each with their own HAP Services and HAP Characteristics Need to discuss development environment