mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-27 11:16:54 +00:00
Change documentation for googlehome (#8346)
* Initial attempt for googlehome component documentation * Corrected typo in "platform" * Rename file * Move keys to configuration section * Added missing description: * Add quotes * revert 44464ed2
This commit is contained in:
parent
d6d49ec626
commit
cfe830d593
@ -1,48 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Google Home Bluetooth tracker"
|
||||
description: "Instructions on how to use Google Home to track devices in Home Assistant."
|
||||
date: 2018-11-04 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: google_home.png
|
||||
ha_release: 0.83
|
||||
ha_category: Presence Detection
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `googlehome` platform allows you to detect presence using an [unofficial Google Home API][googlehomeapi].
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate Google Home Bluetooth tracker in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: googlehome
|
||||
host: IP_ADDRESS
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address of the Google Home unit.
|
||||
required: true
|
||||
type: string
|
||||
rssi_threshold:
|
||||
description: The threshold for the RSSI signal of the device.
|
||||
required: false
|
||||
default: -70
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Usage %}
|
||||
|
||||
Devices will appear in the format `devicetracker.<home hub ip>_<device mac address>`. Note that dots are removed from the IP and BT MAC addresses.
|
||||
|
||||
After running this component for a little while, you will likely see many devices appear. It's advisable to set the configuration to not discover new devices once the device you want to track have appeared (see [device tracker configuration][devicetrackerconfig] for details).
|
||||
|
||||
[googlehomeapi]: https://rithvikvibhu.github.io/GHLocalApi/
|
||||
[devicetrackerconfig]: /components/device_tracker/#configuring-a-device_tracker-platform
|
69
source/_components/googlehome.markdown
Normal file
69
source/_components/googlehome.markdown
Normal file
@ -0,0 +1,69 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Google Home"
|
||||
description: "Instructions on how to connect to your Google Home device."
|
||||
date: 2018-11-04 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: google_home.png
|
||||
ha_release: 0.88
|
||||
ha_category:
|
||||
- Hub
|
||||
- Presence Detection
|
||||
ha_iot_class: "Local Polling"
|
||||
redirect_from:
|
||||
- /components/device_tracker.googlehome/
|
||||
---
|
||||
|
||||
The `googlehome` component allows you to connect to your Google Home device using an [unofficial Google Home API][googlehomeapi].
|
||||
|
||||
This component will set up a [device_tracker](/components/device_tracker/) platform to track nearby bluetooth devices.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate the `googlehome` component in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
googlehome:
|
||||
devices:
|
||||
- host: IP_ADDRESS
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
devices:
|
||||
description: A list of Google Home devices.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
host:
|
||||
description: The IP address of the Google Home device.
|
||||
required: true
|
||||
type: string
|
||||
rssi_threshold:
|
||||
description: The threshold for the RSSI signal of the device.
|
||||
required: false
|
||||
default: -70
|
||||
type: integer
|
||||
device_types:
|
||||
description: Device types that will be tracked [see device types](#device_types), by default all types are tracked.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Device types %}
|
||||
|
||||
Device type | Description
|
||||
-- | --
|
||||
1 | Classic - BR/EDR devices
|
||||
2 | Low Energy - LE-only
|
||||
3 | Dual Mode - BR/EDR/LE
|
||||
|
||||
## {% linkable_title Notes %}
|
||||
|
||||
Devices will appear in the format `devicetracker.<home hub ip>_<device mac address>`. Note that dots are removed from the IP and BT MAC addresses.
|
||||
|
||||
[googlehomeapi]: https://rithvikvibhu.github.io/GHLocalApi/
|
||||
[devicetrackerconfig]: /components/device_tracker/#configuring-a-device_tracker-platform
|
Loading…
x
Reference in New Issue
Block a user