Nello.io intercom documentation (#3173)

This commit is contained in:
Philipp Schmitt 2017-08-14 18:23:51 +02:00 committed by Adam Mills
parent d83b33de3e
commit 2acfb70d33
2 changed files with 52 additions and 0 deletions

View File

@ -0,0 +1,52 @@
---
layout: page
title: "Nello Lock"
description: "Instructions on how to integrate Nello intercom devices."
date: 2017-08-13 17:25
sidebar: true
comments: false
sharing: true
footer: true
logo: nello.png
ha_category: Lock
featured: false
ha_release: 0.52
ha_iot_class: "Cloud Polling"
---
The `nello` platform allows you to control [Nello](https://nello.io) intercoms.
To get started you need to create a secondary Nello account and authorize it to access your lock(s).
<p class="note warning">
Be aware that if you use your main account for Home Assistant you may not be able to use it with the App.
</p>
## {% linkable_title Configuration %}
```yaml
# Example configuration.yaml entry
lock:
- platform: nello
username: mail@example.com
password: mySecretPassword
```
Configuration variables:
- **username** (*Required*): The username of your Nello account.
- **password** (*Required*): The password of your Nello account.
## {% linkable_title Events %}
### {% linkable_title Event `nello_bell_ring` %}
Every time someone rings the bell, a `nello_bell_ring` event will be fired.
Field | Description
----- | -----------
`address` | Postal address of the lock.
`date` | Date when the event occured.
`description` | Human readable string describing the event.
`location_id` | Nello ID of the location where the bell has been rung.
`short_id` | Shorter Nello ID.

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB