From 7e9e432991c20a7d261bd91cfed7ab306f5fa05d Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sun, 7 Jan 2024 12:05:36 -0600 Subject: [PATCH 1/4] Update Stepper.md --- docs/Stepper.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Stepper.md b/docs/Stepper.md index 3f89bea..22a1727 100644 --- a/docs/Stepper.md +++ b/docs/Stepper.md @@ -136,7 +136,7 @@ Below is a simple sketch demonstrating the above methods: ```C++ // StepperControl Example using TB6612-based Driver Board with HALF STEP PWM MODE -#include "Stepper_TB6612.h" // include the driver for a TB6612 chip +#include "extras/Stepper_TB6612.h" // include the driver for a TB6612 chip StepperControl *motor; // create a global pointer to StepperControl so it can be accessed in both setup() and loop() @@ -199,7 +199,7 @@ Only the first method, `onStep()`, is required to be defined. You can leave any As an example, below is the complete code for the **Stepper_A3967** class: ```C++ -#include "StepperControl.h" +#include "extras/StepperControl.h" ////////////////////////// From e118061cff59c88ade0d8f17ebd7d508de7ccab5 Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Tue, 16 Jan 2024 06:07:41 -0600 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b0b59f8..0897c26 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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 Release R2 (HAP-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 requires version 2.0.0 or later of the [Arduino-ESP32 Board Manager](https://github.com/espressif/arduino-esp32), and has been tested up through version 2.0.11 (recommended). HomeSpan can be run on the original ESP32 as well as Espressif's ESP32-S2, ESP32-C3, and ESP32-S3 chips. +HomeSpan requires version 2.0.0 or later of the [Arduino-ESP32 Board Manager](https://github.com/espressif/arduino-esp32), and has been tested up through version 2.0.14 (recommended). HomeSpan can be run on the original ESP32 as well as Espressif's ESP32-S2, ESP32-C3, and ESP32-S3 chips. ### HomeSpan Highlights From 84b3d29954fd91e4ea0d5544c5f6f903a0a7b384 Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sat, 20 Jan 2024 18:10:11 -0600 Subject: [PATCH 3/4] Update FAQ.md --- docs/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 8164dcd..bedebf6 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -76,7 +76,7 @@ #### Why does the Home App indicate the Doorbell Service is unsupported? -* Though not documented in HAP-R2, it appears that the Doorbell Service is designed to be used in conjunction with another service, such as the Lock Mechanism. If you add in a second service, the Home App will show the appropriate Tile (such as a Lock) with the Doorbell being the second service. However, you can still use the Doorbell Service on a stanadlone basis --- even though the Home App says it is unsupported, a button press on the device will properly trigger a chime on your Home Pods as expected. +* Though not documented in HAP-R2, it appears that the Doorbell Service is designed to be used in conjunction with another service, such as the Lock Mechanism. If you add in a second service, the Home App will show the appropriate Tile (such as a Lock) with the Doorbell being the second service. However, you can still use the Doorbell Service on a standalone basis --- even though the Home App says it is unsupported, a button press on the device will properly trigger a chime on your Home Pods as expected. --- [↩️](../README.md) Back to the Welcome page From 3563dc109a28025b50fd25392955540089bf299c Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sun, 21 Jan 2024 10:14:11 -0600 Subject: [PATCH 4/4] Update TVServices.md --- docs/TVServices.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/TVServices.md b/docs/TVServices.md index ee0754e..4af359e 100644 --- a/docs/TVServices.md +++ b/docs/TVServices.md @@ -50,7 +50,7 @@ All of this is accomplished by using a combination of some, or all, of the follo * `Characteristic::ConfiguredName()` - similar to how its used when applied to `Service::Television()`, this Characteristic allows you set the default name for an Input Source. Note that if you change the name of an Input Source in the Home App, an update will be sent to HomeSpan with the new name for you to use in your sketch if needed. This is very different from the usual `Characteristic::Name()` used for many other Services, and for which name changes performed in the Home App are never communicated back to the Accessory -* `Characteristic::Identifier()` - this numerical Characteristic sets an ID for each Input Source. Any unsigned 32-bit number can be used as an ID, provided it is *unique* and not used by any other Input Source in the same TV Service. When you use the Input Source Selector in the Home App to choose a particular Input Soure, the `Characteristic::ActiveIdentifier()` from the Television Service (see above) will be updated with a value that matches the ID corresponding to the chosen Input Source. Within HomeSpan you simply use the `update()` method to determine when `Characteristic::ActiveIdentifer()` is updated, and, based on its value, which Input Source was chosen. HomeKit does not seem to require `Characteristic::Identifier()` be defined for an Input Source. However, if it not set, the Home App will not allow it to be displayed as a choice in the Input Source Selector, which defeats the purpose of creating an Input Source! +* `Characteristic::Identifier()` - this numerical Characteristic sets an ID for each Input Source. Any unsigned 32-bit number can be used as an ID, provided it is *unique* and not used by any other Input Source in the same TV Service. When you use the Input Source Selector in the Home App to choose a particular Input Source, the `Characteristic::ActiveIdentifier()` from the Television Service (see above) will be updated with a value that matches the ID corresponding to the chosen Input Source. Within HomeSpan you simply use the `update()` method to determine when `Characteristic::ActiveIdentifer()` is updated, and, based on its value, which Input Source was chosen. HomeKit does not seem to require `Characteristic::Identifier()` be defined for an Input Source. However, if it not set, the Home App will not allow it to be displayed as a choice in the Input Source Selector, which defeats the purpose of creating an Input Source! * `Characteristic::IsConfigured()` - this Characteristic determines whether an Input Source is allowed to appear as a choice in the Input Source Selector of the Home App. If IsConfigured() is defined and set to 0, the Input Source will appear in the Settings page, but it will be excluded as a choice from the Input Source Selector. If IsConfigured() is defined and set to 1, the Input Source will appear in the Settings page, and will also be included as a choice in the Input Source Selector. If `Characteristic::IsConfigured()` is not defined for an Input Source, that source will still appear as a choice in the Input Source Selector, but it will *not* appear in the list of Input Sources found on the Settings page. This means you will not be able to rename the Input Source from the Home App, nor toggle it as an allowable choice in the Input Selector (see below)