Merge pull request #1291 from JasonCarter80/known_icons

Documenting ICON addition to known_device.yaml config file
This commit is contained in:
Johann Kellerman 2016-10-23 22:17:03 +02:00 committed by GitHub
commit c937242d15

View File

@ -59,6 +59,7 @@ Here's an example configuration for a single device:
devicename: devicename:
name: Friendly Name name: Friendly Name
mac: EA:AA:55:E7:C6:94 mac: EA:AA:55:E7:C6:94
icon: mdi:face-profile
picture: https://home-assistant.io/images/favicon-192x192.png picture: https://home-assistant.io/images/favicon-192x192.png
gravatar: test@example.com gravatar: test@example.com
track: yes track: yes
@ -69,7 +70,8 @@ devicename:
|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------| |----------------|-------------------------------|---------------------------------------------------------------------------------------------------------|
| `name` | Host name or "Unnamed Device" | The friendly name of the device | | `name` | Host name or "Unnamed Device" | The friendly name of the device |
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP | | `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP |
| `picture` | None | A picture that you can use to easily identify the person or device | | `icon` | None | A name of an MDI Icon. |
| `picture` | None | A picture that you can use to easily identify the person or device, if provided, will override 'icon' |
| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture` | | `gravatar` | None | An email address for the device's owner. If provided, it will override `picture` |
| `track` | False | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update | | `track` | False | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
| `hide_if_away` | False | If `yes`/`on`/`true` then the device will be hidden if it is not at home | | `hide_if_away` | False | If `yes`/`on`/`true` then the device will be hidden if it is not at home |