jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-14 12:56:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs to reflect device_class changes for vizio component (#11756)

Browse Source 
* update docs to reflect change from platform level to config level entry

* update docs to reflect device_class changes and add new options

* fix int type for config parameters

* remove timeout option per corresponding home-assistant PR review
This commit is contained in:
Raman Gupta 2020-01-20 05:48:36 -05:00 committed by Franck Nijhof
parent 13aea6acb2
commit c366946cfc
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
source/_integrations/vizio.markdown
View File

@ -6,6 +6,7 @@ ha_category:
- Media Player - Media Player
ha_release: 0.49 ha_release: 0.49
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners: ha_codeowners:
- '@raman325' - '@raman325'
--- ---
@ -41,7 +42,7 @@ and note its IP address. If using the IP address by itself does not work, you ma
## Pairing ## Pairing
Before adding your device to Home Assistant, you may need to pair it manually. In particular, it is unclear how a sound bar would notify you of a valid auth token. In this case, it might be best to first skip the pairing process entirely, specify a `device_class` of `soundbar` in your configuration, and try interacting with the entity to see if you have any success. If the media player controls aren't working, and if specifying different ports as mentioned above doesn't work, you will need to find a way to obtain the auth token during this process. Before adding your device to Home Assistant, you may need to pair it manually. In particular, it is unclear how a sound bar would notify you of a valid auth token. In this case, it might be best to first skip the pairing process entirely, specify a `device_class` of `speaker` in your configuration, and try interacting with the entity to see if you have any success. If the media player controls aren't working, and if specifying different ports as mentioned above doesn't work, you will need to find a way to obtain the auth token during this process.
To obtain an auth token, follow these steps: To obtain an auth token, follow these steps:
@ -50,7 +51,7 @@ Make sure that your device is on before continuing.
| Parameter | Description | | Parameter | Description |
|:----------------|:---------------------| |:----------------|:---------------------|
| `ip` | IP address (possibly including port) obtained from the previous section | | `ip` | IP address (possibly including port) obtained from the previous section |
| `device_type` | The type of device you are connecting to. Options are `tv` or `soundbar` | | `device_type` | The type of device you are connecting to. Options are `tv` or `speaker` |
Enter the following command to initiate pairing: Enter the following command to initiate pairing:
@ -79,9 +80,8 @@ To add your Vizio TV to your installation, add the following to your `configurat
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
media_player: vizio:
- platform: vizio - host: IP_ADDRESS
host: IP_ADDRESS
access_token: AUTH_TOKEN access_token: AUTH_TOKEN
``` ```
@ -100,10 +100,15 @@ access_token:
required: false required: false
type: string type: string
device_class: device_class:
description: The class of your device. Valid options are `tv` or `soundbar` description: The class of your device. Valid options are `tv` or `speaker`
required: false required: false
type: string type: string
default: tv default: tv
volume_step:
description: The number of steps that the volume will be increased or decreased by at a time.
required: false
type: integer
default: 1
{% endconfiguration %} {% endconfiguration %}
## Notes and limitations ## Notes and limitations