Skip to content

Commit

Permalink
Tidied info.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
twrecked committed May 5, 2020
1 parent ab0b956 commit 971c8a9
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions info.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# Asynchronous Arlo Component for Home Assistant.

An (almost) drop in replacement for the standard [Arlo](https://my.arlo.com/#/cameras) package.
An (almost) drop in replacement for the standard
[Arlo](https://my.arlo.com/#/cameras) package.

Please visit the [Readme](https://github.com/twrecked/hass-aarlo/blob/master/README.md) for more details.
Please visit the
[Readme](https://github.com/twrecked/hass-aarlo/blob/master/README.md) for more
details.

## 2FA Support

This release contains beta 2FA support. It works by requesting an email with the one-time code and then making an IMAP connection to your email provider and reading the code from the email Arlo sends.
This release contains beta 2FA support. It works by requesting an email with the
one-time code and then making an IMAP connection to your email provider and
reading the code from the email Arlo sends.

There is a **lot** that can go wrong with this - for starters, I've only tested it in English - but to get it working add the following configuration (with the correct values obviously) - to `aarlo:`
There is a **lot** that can go wrong with this - for starters, I've only tested
it in English - but to get it working add the following configuration (with the
correct values obviously) - to `aarlo:`

```yaml
tfa_host: 'imap.gmail.com'
Expand All @@ -17,17 +24,24 @@ There is a **lot** that can go wrong with this - for starters, I've only tested

```

For gmail users, the following [help](https://support.google.com/accounts/answer/185833?hl=en) is useful.
For gmail users, the following
[help](https://support.google.com/accounts/answer/185833?hl=en) is useful.

Finally, if you haven't enabled 2FA you don't need to do this.

## Notice of Future Breaking Changes

### The custom services are moving into the `aarlo` domain.

This release moves all the component services in the `aarlo` domain. This is their correct location and allows Home Assistant to use the component's `services.yaml` file to provide help with the services.
This release moves all the component services in the `aarlo` domain. This is
their correct location and allows Home Assistant to use the component's
`services.yaml` file to provide help with the services.

To allow you to transition and test your scripts the old, incorrectly located, services will remain for a while. My plan is to remove them in a few months. If you move all your code over to the new services you can add the `hide_deprecated_services` option to your configuration to hide these old services.
To allow you to transition and test your scripts the old, incorrectly located,
services will remain for a while. My plan is to remove them in a few months. If
you move all your code over to the new services you can add the
`hide_deprecated_services` option to your configuration to hide these old
services.

See [Services](#advanced-services) for more information.

Expand All @@ -44,12 +58,16 @@ Aarlo provides:
- Enhanced state notifications.
- Media player support for select devices.

There is also a resource [`aarlo-glance`](https://github.com/twrecked/lovelace-hass-aarlo) which is based on `picture-glance` but tailored for the Arlo component.
There is also a resource
[`aarlo-glance`](https://github.com/twrecked/lovelace-hass-aarlo) which is based
on `picture-glance` but tailored for the Arlo component.

## Example

![Aarlo Glance](https://github.com/twrecked/hass-aarlo/blob/master/images/aarlo-glance-02.png)

## Documentation

Please visit the [Readme](https://github.com/twrecked/hass-aarlo/blob/master/README.md) for full documentation.
Please visit the
[Readme](https://github.com/twrecked/hass-aarlo/blob/master/README.md) for full
documentation.

0 comments on commit 971c8a9

Please sign in to comment.