added smappee documentation (#4354)

* added smappee documentation

* update version and changed options to be optional
This commit is contained in:
Henrik Nicolaisen 2018-02-18 23:34:24 +01:00 committed by Paulus Schoutsen
parent 89ea0154a3
commit bbd245ec73
4 changed files with 98 additions and 0 deletions

View File

@ -0,0 +1,19 @@
---
layout: page
title: "Smappee Sensor"
description: "Instructions how to integrate Smappee energy monitor into Home Assistant."
date: 2018-01-06 16:15
sidebar: true
comments: false
sharing: true
footer: true
logo: smappee.png
ha_release: "0.62"
ha_category: Sensor
---
[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.
Energy monitor measurements will be automatically added when you connect to the Smappee controller.
For more configuration information see the [Smappee component](/components/smappee/) documentation.

View File

@ -0,0 +1,59 @@
---
layout: page
title: "Smappee"
description: "Instructions how to setup Smappee within Home Assistant."
date: 2018-01-06 16:15
sidebar: true
comments: false
sharing: true
footer: true
logo: smappee.png
ha_release: "0.62"
ha_category: Hub
---
[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.
Switches and Sensors are supported - and will be automatically added when you connect to the Smappee controller.
The smappee component gets information from [Smappee API](https://smappee.atlassian.net/wiki/display/DEVAPI/API+Methods) using the [smappy](https://github.com/EnergieID/smappy) pypy module
<p class='note'>
Info on how to get api access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki)
</p>
# Configuration
```yaml
# Example configuration.yaml entry
smappee:
host: 10.0.0.5
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
username: YOUR_MYSMAPPEE_USERNAME
password: YOUR_MYSMAPPEE_PASSWORD
```
```yaml
# Minimal example configuration.yaml entry
smappee:
host: 10.0.0.5
```
```yaml
# Cloud only example configuration.yaml entry
smappee:
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
username: YOUR_MYSMAPPEE_USERNAME
password: YOUR_MYSMAPPEE_PASSWORD
```
Configuration variables:
- **host** (*Optional*): Your Local Smappee unit IP.
- **host_password** (*Optional*): Your Local Smappee password.
- **client_id** (*Optional*): Your Smappee API client_id.
- **client_secret** (*Optional*): Your Smappee API client_secret.
- **username** (*Optional*): Your My Smappee username.
- **password** (*Optional*): Your My Smappee password.

View File

@ -0,0 +1,20 @@
---
layout: page
title: "Smappee Switch"
description: "Instructions how to integrate Smappee Comfort Plug into Home Assistant."
date: 2018-01-06 16:15
sidebar: true
comments: false
sharing: true
footer: true
logo: smappee.png
ha_release: "0.62"
ha_category: Switch
ha_iot_class: "Local Push"
---
[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.
Comport Plugs will be automatically added when you connect to the Smappee controller.
For more configuration information see the [Smappee component](/components/smappee/) documentation.

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB