Skip to content

Update Emby docs #2274

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.

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
merged 3 commits into from
Mar 24, 2017
Merged

Update Emby docs #2274

merged 3 commits into from
Mar 24, 2017

Conversation

mezz64
Copy link
Contributor

@mezz64 mezz64 commented Mar 16, 2017

Description:
Update docs for emby media_player component.

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

@mention-bot
Copy link

@mezz64, thanks for your PR! By analyzing the history of the files in this pull request, we identified @vrs01 to be a potential reviewer.

@Landrash Landrash added the new-feature This PR adds documentation for a new Home Assistant feature to an existing integration label Mar 17, 2017
@@ -32,3 +32,4 @@ Configuration variables:
- **api_key** (*Required*): The api-key you would like home-assistant to use to authenticate.
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
- **port** (*Optional*): The port number. Defaults to 8096.
- **auto_hide** (*Optional*): True if you want to automatically hide devices in the "off" state from the UI.
Copy link
Contributor

Choose a reason for hiding this comment

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

Default state i missing. Also avoid the uses of abbreviations if not needed.
My suggestion for a rewrite of this sentence would be
+- **auto_hide** (*Optional*): True if you want to automatically hide devices in the "off" state from the Home Assistant Interface. Defaults to False

- **api_key** (*Required*): The api-key you would like home-assistant to use to authenticate.
- **ssl** (*Optional*): True if you want to connect with https. Default is False.
- **ssl** (*Optional*): True if you want to connect with https/wss. Your SSL certificate must be valid. Default is False.
Copy link
Contributor

Choose a reason for hiding this comment

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

wss?

@mezz64
Copy link
Contributor Author

mezz64 commented Mar 17, 2017

With the latest pr this component now utilizes websockets (in addition to standard http) which connect with either a ws:// prefix for non secure connections or wss:// prefix for SSL connections. I can remove it if you think it makes things confusing.

@mezz64 mezz64 mentioned this pull request Mar 24, 2017
@balloob balloob added this to the 0.41 milestone Mar 24, 2017
@fabaff fabaff dismissed Landrash’s stale review March 24, 2017 20:06

Looks good to me.

@fabaff fabaff merged commit aa626f8 into home-assistant:next Mar 24, 2017
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.

5 participants