Skip to content
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

Update Vizio docs to reflect improved discovery #11935

Merged
merged 10 commits into from
Feb 4, 2020
Merged

Update Vizio docs to reflect improved discovery #11935

Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cf8863f
update discovery and pairing instructions, clarify configuration options
raman325 Jan 31, 2020
e38699a
close code markup
raman325 Jan 31, 2020
490e473
fix markdown
raman325 Jan 31, 2020
c8a7002
small tweaks to hopefully get build to pass
raman325 Jan 31, 2020
c910680
adhere to guidelines
raman325 Jan 31, 2020
6f0837c
try removing block quote
raman325 Jan 31, 2020
1937401
Update source/_integrations/vizio.markdown
raman325 Jan 31, 2020
324f803
Update source/_integrations/vizio.markdown
raman325 Jan 31, 2020
5da0c45
readd block quote and make it clear users should be on the latest ver…
raman325 Jan 31, 2020
0de1158
Merge branch 'vizio_latest_version' of https://github.com/raman325/ho…
raman325 Jan 31, 2020
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
40 changes: 15 additions & 25 deletions source/_integrations/vizio.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,20 @@ The `vizio` integration allows you to control [SmartCast](https://www.vizio.com/

## Find your device

Install the command line tool using `pip` (or download it manually):
### Install pyvizio locally

```bash
$ pip3 install pyvizio
```

or

```bash
$ pip3 install git+https://github.com/vkorn/pyvizio.git@master
```
NOTE: If the `pip3` command is not found, try `pip` instead
- To install, run `pip3 install pyvizio` in your terminal.
- To upgrade, run `pip3 install --upgrade pyvizio` in your terminal.

or

```bash
$ pip3 install -I .
```
### Discover devices

Find your device using the following command:
```txt
pyvizio --ip=0 discover
```bash
$ pyvizio --ip=0 discover
```

and note its IP address. If using the IP address by itself does not work, you may need to append `:9000` or `:7345` to it when using it as a parameter in future commands.
and note its IP address and port number. If you have trouble finding a device you were expecting to, you can try increasing the discovery timeout period by adding the `--timeout` option (e.g. `pyvizio --ip=0 discover --timeout=10`).

## Pairing

Expand All @@ -49,13 +39,13 @@ Make sure that your device is on before continuing.

| Parameter | Description |
|:----------------|:---------------------|
| `ip` | IP address (possibly including port) obtained from the previous section |
| `ip` | `IP Address:Port` (obtained from the previous section) |
| `device_type` | The type of device you are connecting to. Options are `tv` or `soundbar` |

Enter the following command to initiate pairing:

```bash
$ pyvizio --ip={ip} --device_type={device_type} pair
$ pyvizio --ip={ip:port} --device_type={device_type} pair
```

Initiation will show you two different values:
Expand All @@ -68,7 +58,7 @@ Initiation will show you two different values:
At this point, a PIN code should be displayed at the top of your TV. With all these values, you can now finish pairing:

```bash
$ pyvizio --ip={ip} --device_type={device_type} pair-finish --token={challenge_token} --pin={pin}
$ pyvizio --ip={ip:port} --device_type={device_type} pair-finish --token={challenge_token} --pin={pin}
```

You will need the authentication token returned by this command to configure Home Assistant.
Expand All @@ -81,21 +71,21 @@ To add your Vizio TV to your installation, add the following to your `configurat
# Example configuration.yaml entry
media_player:
- platform: vizio
host: IP_ADDRESS
access_token: AUTH_TOKEN
host: "DEVICE_IP:DEVICE_PORT"
access_token: YOUR_AUTH_TOKEN
```

{% configuration %}
host:
description: IP address of your device.
description: `IP Address:Port` for your device (port is optional but recommended).
raman325 marked this conversation as resolved.
Show resolved Hide resolved
required: true
type: string
access_token:
description: Authentication token you received in the last step of the pairing process (if applicable).
required: false
type: string
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 `soundbar`.
raman325 marked this conversation as resolved.
Show resolved Hide resolved
required: false
type: string
default: tv
Expand Down