Skip to content
This repository has been archived by the owner on Aug 27, 2022. It is now read-only.

Updated dokumentation and version bump for 0.0.6 #11

Merged
merged 1 commit into from
Jul 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ To get started put `/custom_components/sensor/authenticated.py` here:

```yaml
sensor:
platform: authenticated
enable_notification: 'True'
- platform: authenticated
```

**Configuration variables:**
Expand All @@ -19,12 +18,22 @@ key | description
:--- | :---
**platform (Required)** | The sensor platform name.
**enable_notification (Optional)** | Turn on/off `persistant_notifications` when a new IP is detected, can be `True`/`False` defaults to `True`.
**exclude (Optional)** | A list of IP adresses you want to exclude.

**Sample overview:**\
![Sample overview](/img/overview.png)

If a new IP is detected, it will be added to a `.ip_authenticated.yaml` file in your configdir, with this information:\
![fileexample](/img/yamlfile.png)
If a new IP is detected, it will be added to a `.ip_authenticated.yaml` file in your configdir, with this information:

```yaml
8.8.8.8:
city: Mountain View
country: US
hostname: google-public-dns-a.google.com
last_authenticated: '2018-07-26 09:27:01'
previous_authenticated_time: '2018-07-26 09:27:01'
region: california
```

If not disabled, you will also be presented with a `persistant_notification` about the event:\
![notification](/img/persistant_notification.png)
Expand Down
2 changes: 1 addition & 1 deletion custom_components/sensor/authenticated.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.helpers.entity import Entity

__version__ = '0.0.5'
__version__ = '0.0.6'

_LOGGER = logging.getLogger(__name__)

Expand Down
Binary file removed img/yamlfile.png
Binary file not shown.