Skip to content

Add HomeKit support for media players#5378

Merged
cdce8p merged 5 commits intohome-assistant:nextfrom
schmittx:homekit-media-player-support
May 25, 2018
Merged

Add HomeKit support for media players#5378
cdce8p merged 5 commits intohome-assistant:nextfrom
schmittx:homekit-media-player-support

Conversation

@schmittx
Copy link
Copy Markdown
Contributor

@schmittx schmittx commented May 16, 2018

Description:
Adds support for media players in HomeKit.

Pull request in home-assistant (if applicable): home-assistant/core#14446

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

@cdce8p cdce8p self-assigned this May 16, 2018
@cdce8p cdce8p added the new-feature This PR adds documentation for a new Home Assistant feature to an existing integration label May 16, 2018
Comment thread source/_components/homekit.markdown Outdated
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.
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.

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.

Comment thread source/_components/homekit.markdown Outdated
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.
required: false
type: list
default: `on_off`, `play_pause`, `play_stop`, `toggle_mute`
Copy link
Copy Markdown
Member

@cdce8p cdce8p May 20, 2018

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>'

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.

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.

Copy link
Copy Markdown
Member

@cdce8p cdce8p left a comment

Choose a reason for hiding this comment

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

Ready to be merged once parent PR is merged and test pass.

@cdce8p cdce8p merged commit f6b02b1 into home-assistant:next May 25, 2018
@schmittx schmittx deleted the homekit-media-player-support branch June 11, 2018 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-feature This PR adds documentation for a new Home Assistant feature to an existing integration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants