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-18 14:56:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update integration doc to mention all breaking changes (#12197)

Browse Source 
* update integration doc to mention all breaking changes

* remove breaking change info from docs
This commit is contained in:
Ben 2020-03-02 12:55:00 +01:00 committed by GitHub
parent a7a3d0a9c6
commit 42a8fa1b6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
source/_integrations/surepetcare.markdown
View File

@ -15,7 +15,7 @@ The `surepetcare` component allows you to get information on your Sure Petcare C
## Configuration ## Configuration
To add a flap and pet, add the following to your `configuration.yaml` file: To add a flap, feeder or pet, add the following to your `configuration.yaml` file. The Hubs a flap or feeder is connected to, will be discovered automatically.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -37,59 +37,22 @@ surepetcare:
required: true required: true
type: string type: string
flaps: flaps:
description: The Sure Petcare flaps description: The IDs of the Sure Petcare flaps
required: true
type: map
keys:
id:
description: The Sure Petcare id of a flap
required: true
type: integer
name:
description: A name for the flap
required: true
type: string
feeders:
description: The Sure Petcare feeders
required: true
type: map
keys:
id:
description: The Sure Petcare id of a feeder
required: true
type: integer
name:
description: A name for the feeder
required: true
type: string
pets:
description: Pets managed by Sure Petcare flap(s)
required: true
type: map
keys:
id:
description: The Sure Petcare id of a pet
required: true
type: integer
name:
description: The name of the pet
required: true
type: string
icon:
description: "Icon to display (e.g., `mdi:cat`)"
required: false required: false
default: "mdi:cat" type: list
type: string feeders:
description: The IDs of the Sure Petcare feeders
required: false
type: list
pets:
description: The Sure Petcare IDs of the Pets to show
required: false
type: list
scan_interval: scan_interval:
description: "Minimum time interval between updates. Supported formats: `scan_interval: 'HH:MM:SS'`, `scan_interval: 'HH:MM'` and Time period dictionary (see example below)." description: "Minimum time interval between updates. Supported formats: `scan_interval: 'HH:MM:SS'`, `scan_interval: 'HH:MM'` and Time period dictionary (see example below)."
required: false required: false
default: 3 minutes default: 3 minutes
type: time type: time
device_class:
description: The type/class of the sensor to set the icon in the frontend.
required: false
default: lock
type: device_class
{% endconfiguration %} {% endconfiguration %}
## Getting the IDs of your flaps, feeders and pets ## Getting the IDs of your flaps, feeders and pets