Skip to content

Commit bbd245e

Browse files
hmnballoob
authored andcommitted
added smappee documentation (home-assistant#4354)
* added smappee documentation * update version and changed options to be optional
1 parent 89ea015 commit bbd245e

File tree

4 files changed

+98
-0
lines changed

4 files changed

+98
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: page
3+
title: "Smappee Sensor"
4+
description: "Instructions how to integrate Smappee energy monitor into Home Assistant."
5+
date: 2018-01-06 16:15
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: smappee.png
11+
ha_release: "0.62"
12+
ha_category: Sensor
13+
---
14+
15+
[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.
16+
17+
Energy monitor measurements will be automatically added when you connect to the Smappee controller.
18+
19+
For more configuration information see the [Smappee component](/components/smappee/) documentation.

source/_components/smappee.markdown

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: page
3+
title: "Smappee"
4+
description: "Instructions how to setup Smappee within Home Assistant."
5+
date: 2018-01-06 16:15
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: smappee.png
11+
ha_release: "0.62"
12+
ha_category: Hub
13+
---
14+
15+
[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.
16+
17+
Switches and Sensors are supported - and will be automatically added when you connect to the Smappee controller.
18+
19+
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
20+
21+
<p class='note'>
22+
Info on how to get api access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki)
23+
</p>
24+
25+
# Configuration
26+
27+
```yaml
28+
# Example configuration.yaml entry
29+
smappee:
30+
host: 10.0.0.5
31+
client_id: YOUR_CLIENT_ID
32+
client_secret: YOUR_CLIENT_SECRET
33+
username: YOUR_MYSMAPPEE_USERNAME
34+
password: YOUR_MYSMAPPEE_PASSWORD
35+
```
36+
37+
```yaml
38+
# Minimal example configuration.yaml entry
39+
smappee:
40+
host: 10.0.0.5
41+
```
42+
43+
```yaml
44+
# Cloud only example configuration.yaml entry
45+
smappee:
46+
client_id: YOUR_CLIENT_ID
47+
client_secret: YOUR_CLIENT_SECRET
48+
username: YOUR_MYSMAPPEE_USERNAME
49+
password: YOUR_MYSMAPPEE_PASSWORD
50+
```
51+
52+
Configuration variables:
53+
54+
- **host** (*Optional*): Your Local Smappee unit IP.
55+
- **host_password** (*Optional*): Your Local Smappee password.
56+
- **client_id** (*Optional*): Your Smappee API client_id.
57+
- **client_secret** (*Optional*): Your Smappee API client_secret.
58+
- **username** (*Optional*): Your My Smappee username.
59+
- **password** (*Optional*): Your My Smappee password.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: page
3+
title: "Smappee Switch"
4+
description: "Instructions how to integrate Smappee Comfort Plug into Home Assistant."
5+
date: 2018-01-06 16:15
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: smappee.png
11+
ha_release: "0.62"
12+
ha_category: Switch
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.
17+
18+
Comport Plugs will be automatically added when you connect to the Smappee controller.
19+
20+
For more configuration information see the [Smappee component](/components/smappee/) documentation.
82.4 KB
Loading

0 commit comments

Comments
 (0)