You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-1Lines changed: 39 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ Configuration sample:
34
34
{
35
35
"platform": "netatmo",
36
36
"name": "netatmo platform",
37
-
"ttl":5,
37
+
"ttl":10,
38
38
"auth": {
39
39
"client_id": "XXXXX Create at https://dev.netatmo.com/",
40
40
"client_secret": "XXXXX Create at https://dev.netatmo.com/",
@@ -58,6 +58,39 @@ To retrieve client id and secret please follow following guide:
58
58
59
59
There are some optional configuration options in the netatmo section of the config which provide finer control about what device and services to use to create accessories.
60
60
61
+
###API Refresh and timings
62
+
63
+
Communication towards netatmo API is time by three parameters:
64
+
65
+
<dl>
66
+
<dt>ttl</dt>
67
+
<dd>Time in seconds, how long data will be kept in the internal cache. Mainly useful to avoide duplicated requests for different values from the same device. Defaults to 10 seconds if left out in config.</dd>
68
+
<dt>refresh_check</dt>
69
+
<dd>Time in milliseconds, how often the api will be automatically polled to check for changes. Defaults to 900000 which is 15 Minutes. Do not take values much lower, or you risk, that you put to much traffic to the netatmo API. In worst case netatmo might temporarilly exclude your app from the api.</dd>
70
+
<dt> refresh_run </dt>
71
+
<dd>Time in milliseconds, how often the the module checks if there was a request to refresh the data, either from the automatic polling or due to changes in the homekit app. This allows to have regular checks as well as refreshes after changes were done in the app. Defaults to 20000 which is 20 Seconds.</dd>
72
+
73
+
<pre>
74
+
75
+
"platforms": [
76
+
{
77
+
"platform": "netatmo",
78
+
79
+
...
80
+
81
+
<b>"ttl": 10,
82
+
"refresh_check": 900000
83
+
"refresh_run": 20000</b>
84
+
...
85
+
86
+
}
87
+
],
88
+
89
+
</pre>
90
+
91
+
92
+
93
+
61
94
###Control Accessories by device type
62
95
63
96
<pre>
@@ -121,6 +154,11 @@ If the whitelist contains at least one entry, all oter ids will be excluded.