Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update TVServices.md

This commit is contained in:
HomeSpan 2021-10-30 23:23:24 -05:00 committed by GitHub
parent a55a697216
commit fce9b85e24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/TVServices.md
View File

@ -11,6 +11,7 @@ Use `Category::Television` as the category in `homeSpan.begin()` to specify a Te
Use `Service::Television()` as the Service to create a Television Accessory Tile. It support two primary Characteristics: Use `Service::Television()` as the Service to create a Television Accessory Tile. It support two primary Characteristics:
* `Characteristic::Active()` - this is the standard HomeKit Active Characteristic used to turn the TV on or off. It is a required Characteristic * `Characteristic::Active()` - this is the standard HomeKit Active Characteristic used to turn the TV on or off. It is a required Characteristic
* `Characteristic::ConfiguredName()` - this is an optional, TV-specific version of `Characteristic::Name()` that seems to be the only way to set the default name of the TV. Unlike all other HomeKit Services, the Home App ignores any names specified with `Characeteristic::Name()` when used with `Service::Television()` * `Characteristic::ConfiguredName()` - this is an optional, TV-specific version of `Characteristic::Name()` that seems to be the only way to set the default name of the TV. Unlike all other HomeKit Services, the Home App ignores any names specified with `Characeteristic::Name()` when used with `Service::Television()`
Based on the above, the following code snippet defines a simple TV Accessory with a basic on/off switch: Based on the above, the following code snippet defines a simple TV Accessory with a basic on/off switch:
@ -18,8 +19,15 @@ Based on the above, the following code snippet defines a simple TV Accessory wit
```C++ ```C++
new Service::Television(); new Service::Television();
new Characteristic::Active(0); // set power to OFF at start-up new Characteristic::Active(0); // set power to OFF at start-up
new Characteristic::ConfiguredName("My TV"); // optional Characteristic to set name of TV new Characteristic::ConfiguredName("Sony TV"); // optional Characteristic to set name of TV
``` ```
More advanced control of a TV can enabled with two other optional Characteristics:
* `Characteristic::RemoteKey()` - this write-only numerical Characteristic enables HomeSpan to read button presses from the Remote Control widget on an iPhone. This widget is normally used to control Apple TVs, but it seems any Television Accessory created per above can be selected from the widget. The layout of the widget (which cannot be modified) includes 4 arrows, a central select button, a play/pause button, a large "back" button, and an "info" button. When a key is pressed, the Home App will send an update to `Characteristic::Remote()` that can be read by HomeSpan using the usual `update()` method. Values are as follows: up=4, down=5, left=6, right=7, select=8, back=9, play/pause=11, and info=15
* `Characteristic::PowerModeSelection()` - this write-only Characteristic activates an option in the Home App under the Settings page for a TV Accessory named