From f4b788839fdf1e291399a31c9bf2a04c9762afa9 Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sun, 31 Oct 2021 15:43:16 -0500 Subject: [PATCH] Update TVServices.md --- docs/TVServices.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/TVServices.md b/docs/TVServices.md index 5cef779..8efd50c 100644 --- a/docs/TVServices.md +++ b/docs/TVServices.md @@ -48,9 +48,9 @@ The overall idea is that your sketch should implement a TV Accessory containing All of this is accomplished by using a combination of some, or all, of the following Characteristics: -* `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 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::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 other Input Sources in the same TV Service. When the use the Input Source Selector in the Home App, the ActiveIdentifier Characteristic from the Television Service (see above) will be updated to match the ID corresponding to the Input Source. Within HomeSpan you can use the `update()` method to determine when `Characteristic::ActiveIdentifer()` is updated, and which Input Source is being requested. Note that setting an Identifier for an Input Source is technically optional. However, if it not set, the Home App will not allow it to be displayed 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 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::IsConfigured()` - this Characteristic determines where an Input Source appears in the Home App. Allowed values are 0 and 1. IsConfigured() is optional - if not defined, the Input Source will appear in the Input Source Selector (provided it has an Identifier), but *not* in the list of Input Sources found on the Setting page. This means you will not be able to rename the Input Source from the Home App, nor turn off its visibility in the Input Selector. If IsConfigured() is defined and set to 1, the Input Source appears in both the Input Source Selector List as well as the list of Input Sources on the Setting page. If instead IsConfigured is defined but set to 0, the Input Source will appear in the Settings page, but it will be excluded from the Input Source Selector under all circumstances