Skip to content

Add HomeKit support for media players #5378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cdce8p merged 5 commits into from
May 25, 2018
Merged

Add HomeKit support for media players #5378

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3dfca54
Add support for media players
schmittx May 16, 2018
b3ab6fa
Update to allow multiple modes per entity
schmittx May 20, 2018
e20ecdc
Update sample config
schmittx May 20, 2018
12b17b2
Grammar update
schmittx May 22, 2018
d843afd
Last changes
cdce8p May 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions source/_components/homekit.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,16 @@ homekit:
include_domains:
- alarm_control_panel
- light
- media_player
entity_config:
alarm_control_panel.home:
code: 1234
media_player.living_room:
mode:
- on_off
- play_pause
- play_stop
- toggle_mute
```

{% configuration %}
Expand Down Expand Up @@ -95,6 +102,11 @@ homekit:
required: false
type: string
default: ''
mode:
description: Operation mode of switches within HomeKit. Valid modes are `on_off`, `play_pause`, `play_stop`, and `toggle_mute`. The entity will ignore any `mode` which is not supported. If not specified, all supported modes will be added. Only applicable for `media_player` entities.

@cdce8p cdce8p May 20, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think of:
Operation modes of switches within the Home app. Valid modes are on_off, play_pause, play_stop, and toggle_mute. The entity will ignore any mode which is not supported. If not specified, all supported modes will be added. Only applicable for media_player entities.

@schmittx schmittx May 22, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, but I think we should stay consistent and use HomeKit rather than the Home app, because HomeKit support is not exclusive to Apple's Home app.

required: false
type: list
default: `on_off`, `play_pause`, `play_stop`, `toggle_mute`

@cdce8p cdce8p May 20, 2018 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default would change to: '<All supported modes>'

@schmittx schmittx May 22, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, but I don't think a code block should be used since it's not the actual entry. I prefer just plain text.

@cdce8p cdce8p May 22, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to use the same syntax for placeholders as above for entity_id. A normal string might be misleading.

{% endconfiguration %}

<p class='note'>
Expand Down Expand Up @@ -229,6 +241,7 @@ The following components are currently supported:
| fan | Fan | Support for `on / off`, `direction` and `oscillating`. |
| light | Light | Support for `on / off`, `brightness` and `rgb_color`. |
| lock | DoorLock | Support for `lock / unlock`. |
| media_player | MediaPlayer | Represented as a series of switches which control `on / off`, `play / pause`, `play / stop`, or `mute` depending on `supported_features` of entity and the `mode` list specified in `entity_config`. |
| sensor | TemperatureSensor | All sensors that have `Celsius` or `Fahrenheit` as their `unit_of_measurement` or `temperature` as their `device_class`. |
| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. |
| sensor | AirQualitySensor | All sensors that have `pm25` as part of their `entity_id` or `pm25` as their `device_class` |
Expand Down