Skip to content

Update Emby docs#2274

Merged
fabaff merged 3 commits into
home-assistant:nextfrom
mezz64:emby
Mar 24, 2017
Merged

Update Emby docs#2274
fabaff merged 3 commits into
home-assistant:nextfrom
mezz64:emby

Conversation

@mezz64
Copy link
Copy Markdown
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
Copy Markdown

@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
- **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
Copy Markdown
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

- **host** (*Optional*): The host name or address of the device that is running Emby. Defaults to ```localhost```.
- **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
Copy Markdown
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
Copy Markdown
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