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-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation to match with voluptuous config validation

Browse Source 
--
After the upgrade to use voluptuous to parse the configuration, sensor.imap needs to pass username instead user. Note that user also works, but to keep it coherent, we are updating the documentation.

(home_assistant) ↪ hass --script check_config
Testing configuration at /home/hass/.homeassistant
16-08-28 00:49:35 ERROR (MainThread) [homeassistant.bootstrap] Invalid config for [sensor.imap]: required key not provided @ data['username']. Got None
Failed config
  sensor.imap:
    user: <redacted>
    port: 993
    platform: imap
    password: <redacted>
    server: imap.gmail.com
    name: Gmail Alerts

Successful config (partial)
  sensor.imap:

   After replacing ```user``` by ```username```, ```hass --script check_config``` works as expected.
This commit is contained in:
Marcelo Moreira de Mello 2016-08-28 00:53:11 -04:00
parent 9e4330bed8
commit 10317da550
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/_components/sensor.imap.markdown
View File

@ -23,7 +23,7 @@ sensor:
server: imap.gmail.com
port: 993
name: Emails
user: USERNAME
username: USERNAME
password: PASSWORD
```
@ -32,6 +32,6 @@ Configuration variables:
- **server** (*Required*): The IP address or hostname of the IMAP server.
- **port** (*Required*): The port where the server is accessible.
- **name** (*Optional*): Name of the IMAP sensor.
- **user** (*Required*): Username for the IMAP server.
- **username** (*Required*): Username for the IMAP server.
- **password** (*Required*): Password for the IMAP server.