Difference between revisions of "Netatmo"
Jump to navigation
Jump to search
| (8 intermediate revisions by 2 users not shown) | |||
| Line 126: | Line 126: | ||
|R | |R | ||
|battery level (in milliampere) of module_id | |battery level (in milliampere) of module_id | ||
| + | |||
| + | |- | ||
| + | |||
| + | |rowspan="2" |home.<home_id>.module.<module_id>.status | ||
| + | |0 | ||
| + | |R/W | ||
| + | |the status of module_id is off | ||
| + | |- | ||
| + | |1 | ||
| + | |R/W | ||
| + | |the status of module_id is on | ||
| + | |||
| + | |- | ||
| + | |||
| + | |home.<home_id>.bridge | ||
| + | |<val> | ||
| + | |R | ||
| + | |id of the connected bridge | ||
| + | |||
| + | |- | ||
| + | |||
| + | |home.<home_id>.power.consumption | ||
| + | |<val> | ||
| + | |R | ||
| + | |power consumption in Watt from the connected power module | ||
|- | |- | ||
| Line 197: | Line 222: | ||
|home.<home_id>.room.<room_id>.settemp.manual | |home.<home_id>.room.<room_id>.settemp.manual | ||
| − | |<val> | + | |<val>|<n> |
|W | |W | ||
| − | |set temperature in room_id at <val> (celsius) | + | |set temperature in room_id at <val> (celsius) for <n> hours |
|- | |- | ||
|home.<home_id>.room.<room_id>.settemp.max | |home.<home_id>.room.<room_id>.settemp.max | ||
| − | |< | + | |<n> |
|W | |W | ||
| − | |set temperature in room_id at max (30° celsius) | + | |set temperature in room_id at max (30° celsius) for <n> hours |
|- | |- | ||
| Line 225: | Line 250: | ||
|home.<home_id>.setmode.schedule.away | |home.<home_id>.setmode.schedule.away | ||
| − | |< | + | |<n> |
|W | |W | ||
| − | |switch schedule mode associated to home_id to "away" mode | + | |switch schedule mode associated to home_id to "away" mode for <n> hours |
|- | |- | ||
|home.<home_id>.setmode.schedule.hg | |home.<home_id>.setmode.schedule.hg | ||
| − | |< | + | |<n> |
|W | |W | ||
| − | |switch schedule mode associated to home_id to "frostguard" mode | + | |switch schedule mode associated to home_id to "frostguard" mode for <n> hours |
|} | |} | ||
| + | |||
| + | == Release Notes == | ||
| + | |||
| + | === 3.8.0 === | ||
| + | *initial release | ||
| + | |||
| + | ---- | ||
| + | |||
| + | |||
| + | ''Netatmo is a registered trademark of Netatmo'' | ||
Latest revision as of 14:54, 8 March 2023
This driver can read status and control Netatmo smart radiator valves using HTTPS protocol.
Contents
Netatmo Configuration
Firstly you have to sign up on https://www.netatmo.com/en-us and complete your profile.
When you have created your account go to https://dev.netatmo.com and log in with your credentials, then go to section "My Apps" and create a new app (this procedure serves only for obtaining the two keys "client ID" and "client secret" that are necessary for the driver execution).
If the App creation is successful you will receive the "client ID" and "client secret" keys from Netatmo, you can find them in your App section.
HSYCO Configuration
Add the Netatmo I/O Server in the I/O Servers section of the Settings and set its parameters:
Authentication
- User: your Netatmo account username
- Password: your Netatmo account password
Options
| ID | Default | Values | Description |
|---|---|---|---|
| startupevents | false | true | generate IO events also during the driver’s start-up phase |
| false | start generating events only after HSYCO is aligned with the current status of the system | ||
| pollinterval | 1000 | n >= 100 | data acquisition interval, in milliseconds, from the power socket |
| clientid | <key> | "client ID" key sent from Netatmo, you can find it on https://dev.netatmo.com in your App section. ATTENTION: this field is mandatory | |
| clientsecret | <key> | "client secret" key sent from Netatmo, you can find it on https://dev.netatmo.com in your App section. ATTENTION: this field is mandatory |
Datapoints
| ID | Value | R/W | Description |
|---|---|---|---|
| connection | online | R | the driver has started correctly and is communicating with Netatmo API |
| offline | R | initialization of the driver failed or loop cycle failed | |
| home.<home_id>.name | <text> | R | name of your Netatmo home_id |
| home.<home_id>.status | <text> | R | general status of home_id |
| home.<home_id>.room.<room_id>.name | <text> | R | name of room_id associated to home_id |
| home.<home_id>.room.<room_id>.type | <text> | R | type of room_id associated to home_id |
| home.<home_id>.module.<module_id>.name | <text> | R | name of module_id associated to home_id |
| home.<home_id>.module.<module_id>.type | <text> | R | type of module_id associated to home_id |
| home.<home_id>.module.<module_id>.battery | <val> | R | battery level (in milliampere) of module_id |
| home.<home_id>.module.<module_id>.status | 0 | R/W | the status of module_id is off |
| 1 | R/W | the status of module_id is on | |
| home.<home_id>.bridge | <val> | R | id of the connected bridge |
| home.<home_id>.power.consumption | <val> | R | power consumption in Watt from the connected power module |
| home.<home_id>.schedule.<schedule_id>.name | <text> | R | name of schedule_id associated to home_id |
| home.<home_id>.schedule.<schedule_id>.hgtemp | <val> | R | temperature (in celsius) relative to "frostguard" mode of schedule_id |
| home.<home_id>.schedule.<schedule_id>.awaytemp | <val> | R | temperature (in celsius) relative to "away" mode of schedule_id |
| home.<home_id>.schedule.<schedule_id>.zone.<zone_id>.name | <text> | R | name of zone_id associated to schedule_id |
| home.<home_id>.room.<room_id>.temp.measured | <val> | R | actual temperature measured (in celsius) in room_id |
| home.<home_id>.room.<room_id>.temp.set | <val> | R | temperature set by the system (manual or scheduled) (in celsius) in room_id |
| home.<home_id>.room.<room_id>.temp.mode | schedule | R | temperature in room_id follows schedule rules |
| manual | R | temperature in room_id is in manual mode | |
| home.<home_id>.room.<room_id>.temp.setpoint.starttime | <timestamp> | R | timestamp (epoch time in seconds) at which the current temperature set mode starts |
| home.<home_id>.room.<room_id>.temp.setpoint.endtime | <timestamp> | R | timestamp (epoch time in seconds) at which the current temperature set mode ends |
| home.<home_id>.room.<room_id>.settemp.manual | <val>|<n> | W | set temperature in room_id at <val> (celsius) for <n> hours |
| home.<home_id>.room.<room_id>.settemp.max | <n> | W | set temperature in room_id at max (30° celsius) for <n> hours |
| home.<home_id>.room.<room_id>.settemp | home | W | set temperature in room_id as set in schedule associated to room_id (exit manual mode) |
| home.<home_id>.setmode.schedule | <schedule_id> | W | switch schedule mode associated to home_id to schedule_id |
| home.<home_id>.setmode.schedule.away | <n> | W | switch schedule mode associated to home_id to "away" mode for <n> hours |
| home.<home_id>.setmode.schedule.hg | <n> | W | switch schedule mode associated to home_id to "frostguard" mode for <n> hours |
Release Notes
3.8.0
- initial release
Netatmo is a registered trademark of Netatmo
