-
Notifications
You must be signed in to change notification settings - Fork 124
/
Copy pathlnetatmo.py
1237 lines (1083 loc) · 51.6 KB
/
lnetatmo.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Published Jan 2013
# Author : Philippe Larduinat, ph.larduinat@wanadoo.fr
# Multiple contributors : see https://github.com/philippelt/netatmo-api-python
# License : GPL V3
"""
This API provides access to the Netatmo weather station or/and other installed devices
This package can be used with Python2 or Python3 applications and do not
require anything else than standard libraries
PythonAPI Netatmo REST data access
coding=utf-8
"""
import warnings
if __name__ == "__main__": warnings.filterwarnings("ignore") # For installation test only
from sys import version_info
from os import getenv
from os.path import expanduser
import json, time
import logging
# Just in case method could change
PYTHON3 = version_info.major > 2
# HTTP libraries depends upon Python 2 or 3
if PYTHON3 :
import urllib.parse, urllib.request
else:
from urllib import urlencode
import urllib2
######################## AUTHENTICATION INFORMATION ######################
# To be able to have a program accessing your netatmo data, you have to register your program as
# a Netatmo app in your Netatmo account. All you have to do is to give it a name (whatever) and you will be
# returned a client_id and secret that your app has to supply to access netatmo servers.
# To ease Docker packaging of your application, you can setup your authentication parameters through env variables
# Authentication:
# 1 - Values defined in environment variables : CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN
# 2 - Parameters passed to ClientAuth initialization
# 3 - The .netatmo.credentials file in JSON format in your home directory (now mandatory for regular use)
# Note that the refresh token being short lived, using envvar will be restricted to speific testing use case
#########################################################################
# Common definitions
_BASE_URL = "https://api.netatmo.com/"
_AUTH_REQ = _BASE_URL + "oauth2/token"
_GETMEASURE_REQ = _BASE_URL + "api/getmeasure"
_GETSTATIONDATA_REQ = _BASE_URL + "api/getstationsdata"
_GETTHERMOSTATDATA_REQ = _BASE_URL + "api/getthermostatsdata"
_GETHOMEDATA_REQ = _BASE_URL + "api/gethomedata"
_GETCAMERAPICTURE_REQ = _BASE_URL + "api/getcamerapicture"
_GETEVENTSUNTIL_REQ = _BASE_URL + "api/geteventsuntil"
_HOME_STATUS = _BASE_URL + "api/homestatus" # Used for Home+ Control Devices
_GETHOMES_DATA = _BASE_URL + "api/homesdata" # New API
_GETHOMECOACH = _BASE_URL + "api/gethomecoachsdata" #
#TODO# Undocumented (but would be very usefull) API : Access currently forbidden (403)
_POST_UPDATE_HOME_REQ = _BASE_URL + "/api/updatehome"
# For presence setting (POST BODY):
# _PRES_BODY_REC_SET = "home_id=%s&presence_settings[presence_record_%s]=%s" # (HomeId, DetectionKind, DetectionSetup.index)
_PRES_DETECTION_KIND = ("humans", "animals", "vehicles", "movements")
_PRES_DETECTION_SETUP = ("ignore", "record", "record & notify")
# _PRES_BODY_ALERT_TIME = "home_id=%s&presence_settings[presence_notify_%s]=%s" # (HomeID, "from"|"to", "hh:mm")
# Regular (documented) commands (both cameras)
_PRES_CDE_GET_SNAP = "/live/snapshot_720.jpg"
#TODO# Undocumented (taken from https://github.com/KiboOst/php-NetatmoCameraAPI/blob/master/class/NetatmoCameraAPI.php)
# Work with local_url only (undocumented scope control probably)
# For Presence camera
_PRES_CDE_GET_LIGHT = "/command/floodlight_get_config"
# Not working yet, probably due to scope restriction
#_PRES_CDE_SET_LIGHT = "/command/floodlight_set_config?config=mode:%s" # "auto"|"on"|"off"
# For all cameras
_CAM_CHANGE_STATUS = "/command/changestatus?status=%s" # "on"|"off"
# Not working yet
#_CAM_FTP_ACTIVE = "/command/ftp_set_config?config=on_off:%s" # "on"|"off"
#Known TYPE used by Netatmo services + API, there can be more types possible
TYPES = {
'BFII' : ["Bticino IP Indoor unit", 'Home + Security'],
'BFIC' : ["Bticino IP Guard station", 'Home + Security'],
'BFIO' : ["Bticino IP Entrance panel", 'Home + Security'],
'BFIS' : ["Bticino Server DES", 'Home + Security'],
'BN3L' : ["Bticino 3rd party light", 'Home+Control'],
'BNAB' : ["Bticino module automatic blind", 'Home+Control'],
'BNAS' : ["Bticino module automatic shutter", 'Home+Control'],
'BNS' : ["Smarther with Netatmo Thermostat", 'Home+Control'],
'BNCU' : ["Bticino Bticino Alarm Central Unit", 'Home + Security'],
'BNCS' : ["Bticino module Controlled Socket", 'Home+Control'],
'BNCX' : ["Bticino Class 300 EOS", 'Home + Security'],
'BNDL' : ["Bticino Doorlock", 'Home + Security'],
'BNEU' : ["Bticino external unit", 'Home + Security'],
'BNFC' : ["Bticino Thermostat", 'Home+Control'],
'BNIL' : ["Bticino intelligent light", 'Home+Control'],
'BNLD' : ["Bticino module lighting dimmer", 'Home+Control'],
'BNMH' : ["Bticino My Home Server 1", 'Home + Security'], # also API Home+Control GATEWAY
'BNMS' : ["Bticino module motorized shade", 'Home+Control'],
'BNSE' : ["Bticino Alarm Sensor", 'Home + Security'],
'BNSL' : ["Bticino Staircase Light", 'Home + Security'],
'BNTH' : ["Bticino Thermostat", 'Home+Control'],
'BNTR' : ["Bticino module towel rail", 'Home+Control'],
'BNXM' : ["Bticino X meter", 'Home+Control'],
'NACamera' : ["indoor camera", 'Home + Security'],
'NACamDoorTag' : ["door tag", 'Home + Security'],
'NAMain' : ["weather station", 'Weather'],
'NAModule1' : ["outdoor unit", 'Weather'],
'NAModule2' : ["wind unit", 'Weather'],
'NAModule3' : ["rain unit", 'Weather'],
'NAModule4' : ["indoor unit", 'Weather'],
'NAPlug' : ["thermostat relais station", 'Energy'], # A smart thermostat exist of a thermostat module and a Relay device
# The relay device is also the bridge for thermostat and Valves
'NATherm1' : ["thermostat", 'Energy'],
'NCO' : ["co2 sensor", 'Home + Security'], # The same API as smoke sensor
'NDB' : ["doorbell", 'Home + Security'],
'NOC' : ["outdoor camera", 'Home + Security'],
'NRV' : ["thermostat valves", 'Energy'], # also API Home+Control
'NSD' : ["smoke sensor", 'Home + Security'],
'NHC' : ["home coach", 'Aircare'],
'NIS' : ["indoor sirene", 'Home + Security'],
'NDL' : ["Doorlock", 'Home + Security'],
'NLAO' : ["Magellan Green power remote control on-off", 'Home+Control'],
'NLAS' : ["Magellan Green Power Remote control scenarios", 'Home+Control'],
'NLAV' : ["Wireless Batteryless Shutter Switch", 'Home+Control'],
'NLC' : ["Cable Outlet", 'Home+Control'],
'NLD' : ["Wireless 2 button switch light", 'Home+Control'],
'NLDP' : ["Magellan Pocket Remote", 'Home+Control'],
'NLE' : ["Ecometer", 'Home+Control'],
'NLF' : ["Dimmer Light Switch", 'Home+Control'],
'NLFE' : ["Dimmer Light Switch Evolution", 'Home+Control'],
'NLFN' : ["Dimmer Light with Neutral", 'Home+Control'],
'NLG' : ["Gateway", 'Home+Control'],
'NLGS' : ["Standard DIN Gateway", 'Home+Control'],
'NLIS' : ["Double Switch with Neutral", 'Home+Control'],
'NLIV' : ["1/2 Gangs Shutter Switch", 'Home+Control'],
'NLL' : ["Light Switch with Neutral", 'Home+Control'],
'NLLF' : ["Centralized Ventilation Control", 'Home+Control'],
'NLLV' : ["Roller Shutter Switch with level detection", 'Home+Control'],
'NLM' : ["Light Micromodule", 'Home+Control'],
'NLP' : ["Power Outlet", 'Home+Control'],
'NLPS' : ["Smart Load Shedder", 'Home+Control'],
'NLPC' : ["DIN Energy meter", 'Home+Control'],
'NLPD' : ["Dry contact", 'Home+Control'],
'NLPM' : ["Mobile Socket", 'Home+Control'],
'NLPO' : ["Contactor", 'Home+Control'],
'NLPT' : ["Teleruptor", 'Home+Control'],
'NLT' : ["Magellan Remote Control", 'Home+Control'],
'NLTS' : ["Magellan Remote Motion Sensor", 'Home+Control'],
'NLV' : ["Roller Shutter Switch", 'Home+Control'],
'OTH' : ["Opentherm Thermostat Relay", 'Home+Control'],
'OTM' : ["Smart modulating Thermostat", 'Home+Control'],
'Z3L' : ["Zigbee 3rd party light", 'Home+Control'],
'Z3V' : ["Generic window covering", 'Home+Control']
}
# UNITS used by Netatmo services
UNITS = {
"unit" : {
0: "metric",
1: "imperial"
},
"windunit" : {
0: "kph",
1: "mph",
2: "ms",
3: "beaufort",
4: "knot"
},
"pressureunit" : {
0: "mbar",
1: "inHg",
2: "mmHg"
},
"Health index" : { # Homecoach
0: "Healthy",
1: "Fine",
2: "Fair",
3: "Poor",
4: "Unhealthy"
},
"Wifi status" : { # Wifi Signal quality
86: "Bad",
71: "Average",
56: "Good"
}
}
# Logger context
logger = logging.getLogger("lnetatmo")
class NoDevice( Exception ):
"""No device available in the user account"""
class NoHome( Exception ):
"""No home defined in the user account"""
class AuthFailure( Exception ):
"""Credentials where rejected by Netatmo (or netatmo server unavailability)"""
class OutOfScope( Exception ):
"""Your current auth scope do not allow access to this resource"""
class ClientAuth:
"""
Request authentication and keep access token available through token method. Renew it automatically if necessary
Args:
clientId (str): Application clientId delivered by Netatmo on dev.netatmo.com
clientSecret (str): Application Secret key delivered by Netatmo on dev.netatmo.com
refreshToken (str) : Scoped refresh token
"""
def __init__(self, clientId=None,
clientSecret=None,
refreshToken=None,
credentialFile=None):
# replace values with content of env variables if defined
clientId = getenv("CLIENT_ID", clientId)
clientSecret = getenv("CLIENT_SECRET", clientSecret)
refreshToken = getenv("REFRESH_TOKEN", refreshToken)
# Look for credentials in file if not already provided
# Note: this file will be rewritten by the library to record refresh_token change
# If you run your application in container, remember to persist this file
if not (clientId and clientSecret and refreshToken):
self._credentialFile = credentialFile or expanduser("~/.netatmo.credentials")
with open(self._credentialFile, "r", encoding="utf-8") as f:
cred = {k.upper():v for k,v in json.loads(f.read()).items()}
else:
# Calling program will need to handle the returned refresh_token for futur call
# by getting refreshToken property of the ClientAuth instance and persist it somewhere
self._credentialFile = None
self._clientId = clientId or cred["CLIENT_ID"]
self._clientSecret = clientSecret or cred["CLIENT_SECRET"]
self._accessToken = None # Will be refreshed before any use
self.refreshToken = refreshToken or cred["REFRESH_TOKEN"]
self.expiration = 0 # Force refresh token
@property
def accessToken(self):
if self.expiration < time.time() : self.renew_token()
return self._accessToken
def renew_token(self):
postParams = {
"grant_type" : "refresh_token",
"refresh_token" : self.refreshToken,
"client_id" : self._clientId,
"client_secret" : self._clientSecret
}
resp = postRequest("authentication", _AUTH_REQ, postParams)
if self.refreshToken != resp['refresh_token']:
self.refreshToken = resp['refresh_token']
cred = {"CLIENT_ID":self._clientId,
"CLIENT_SECRET":self._clientSecret,
"REFRESH_TOKEN":self.refreshToken }
if self._credentialFile:
with open(self._credentialFile, "w", encoding="utf-8") as f:
f.write(json.dumps(cred, indent=True))
self._accessToken = resp['access_token']
self.expiration = int(resp['expire_in'] + time.time())
class User:
"""
This class returns basic information about the user
Args:
authData (ClientAuth): Authentication information with a working access Token
"""
warnings.warn("The 'User' class is no longer maintained by Netatmo",
DeprecationWarning )
def __init__(self, authData):
postParams = {
"access_token" : authData.accessToken
}
resp = postRequest("Weather station", _GETSTATIONDATA_REQ, postParams)
self.rawData = resp['body']
self.devList = self.rawData['devices']
self.ownerMail = self.rawData['user']['mail']
class UserInfo:
"""
This class is dynamicaly populated with data from various Netatmo requests to provide
complimentary data (eg Units for Weatherdata)
"""
class HomeStatus:
"""
List all Home+Control devices (Smarther thermostat, Socket, Cable Output, Centralized fan, Micromodules, ......)
Args:
authData (clientAuth): Authentication information with a working access Token
home : Home name or id of the home who's thermostat belongs to
"""
def __init__(self, authData, home_id):
self.getAuthToken = authData.accessToken
postParams = {
"access_token" : self.getAuthToken,
"home_id": home_id
}
resp = postRequest("home_status", _HOME_STATUS, postParams)
self.resp = resp
self.rawData = resp['body']['home']
if not self.rawData : raise NoHome("No home %s found" % home_id)
self.rooms = self.rawData['rooms']
self.modules = self.rawData['modules']
def getRoomsId(self):
return [room['id'] for room in self.rooms]
def getListRoomParam(self, room_id):
for room in self.rooms:
if room['id'] == room_id:
return list(room)
return None
def getRoomParam(self, room_id, param):
for room in self.rooms:
if(room['id'] == room_id and param in room):
return room[param]
return None
def getModulesId(self):
return [module['id'] for module in self.modules]
def getListModuleParam(self, module_id):
for module in self.modules:
if module['id'] == module_id:
return list(module)
return None
def getModuleParam(self, module_id, param):
for module in self.modules:
if module['id'] == module_id and param in module:
return module[param]
return None
class ThermostatData:
"""
List the Relay station and Thermostat modules
Valves are controlled by HomesData and HomeStatus in new API
Args:
authData (clientAuth): Authentication information with a working access Token
home : Home name or id of the home who's thermostat belongs to
"""
def __init__(self, authData, home=None):
# I don't own a thermostat thus I am not able to test the Thermostat support
warnings.warn("The Thermostat code is not tested due to the lack of test environment.\n" \
"As Netatmo is continuously breaking API compatibility, risk that current bindings are wrong is high.\n" \
"Please report found issues (https://github.com/philippelt/netatmo-api-python/issues)",
RuntimeWarning )
self.getAuthToken = authData.accessToken
postParams = {
"access_token" : self.getAuthToken
}
resp = postRequest("Thermostat", _GETTHERMOSTATDATA_REQ, postParams)
self.rawData = resp['body']['devices']
if not self.rawData : raise NoDevice("No thermostat available")
#
# keeping OLD code for Reference
# self.thermostatData = filter_home_data(self.rawData, home)
# if not self.thermostatData : raise NoHome("No home %s found" % home)
# self.thermostatData['name'] = self.thermostatData['home_name'] # New key = 'station_name'
# for m in self.thermostatData['modules']:
# m['name'] = m['module_name']
# self.defaultThermostat = self.thermostatData['home_name'] # New key = 'station_name'
# self.defaultThermostatId = self.thermostatData['_id']
# self.defaultModule = self.thermostatData['modules'][0]
# Standard the first Relaystation and Thermostat is returned
# self.rawData is list all stations
# if no ID is given the Relaystation at index 0 is returned
def Relay_Plug(self, Rid=""):
for Relay in self.rawData:
if Rid in Relay['_id']:
print ('Relay ', Rid, 'in rawData')
#print (Relay.keys())
#print (Relay['_id'])
return Relay
#dict_keys(['_id', 'applications', 'cipher_id', 'command', 'config_version', 'd_amount', 'date_creation', 'dev_has_init', 'device_group', 'firmware', 'firmware_private', 'homekit_nb_pairing', 'last_bilan', 'last_day_extremum', 'last_fw_update', 'last_measure_stored', 'last_setup', 'last_status_store', 'last_sync_asked', 'last_time_boiler_on', 'mg_station_name', 'migration_date', 'module_history', 'netcom_transport', 'new_historic_data', 'place', 'plug_connected_boiler', 'recompute_outdoor_time', 'record_storage', 'rf_amb_status', 'setpoint_order_history', 'skip_module_history_creation', 'subtype', 'type', 'u_amount', 'update_device', 'upgrade_record_ts', 'wifi_status', 'room', 'modules', 'station_name', 'udp_conn', 'last_plug_seen'])
# if no ID is given the Thermostatmodule at index 0 is returned
def Thermostat_Data(self, tid=""):
for Relay in self.rawData:
for thermostat in Relay['modules']:
if tid in thermostat['_id']:
print ('Thermostat ',tid, 'in Relay', Relay['_id'], Relay['station_name'])
#print (thermostat['_id'])
#print (thermostat.keys())
return thermostat
#dict_keys(['_id', 'module_name', 'type', 'firmware', 'last_message', 'rf_status', 'battery_vp', 'therm_orientation', 'therm_relay_cmd', 'anticipating', 'battery_percent', 'event_history', 'last_therm_seen', 'setpoint', 'therm_program_list', 'measured'])
def getThermostat(self, name=None, id=""):
for Relay in self.rawData:
for module in Relay['modules']:
if id == Relay['_id']:
print ('Relay ', id, 'found')
return Relay
elif name == Relay['station_name']:
print ('Relay ', name, 'found')
return Relay
elif id == module['_id']:
print ('Thermostat ', id, 'found in Relay', Relay['_id'], Relay['station_name'])
return module
elif name == module['module_name']:
print ('Thermostat ', name, 'found in Relay', Relay['_id'], Relay['station_name'])
return module
else:
#print ('Device NOT Found')
pass
def moduleNamesList(self, name=None, tid=None):
l = []
for Relay in self.rawData:
if id == Relay['_id'] or name == Relay['station_name']:
RL = []
for module in Relay['modules']:
RL.append(module['module_name'])
return RL
else:
#print ("Cloud Data")
for module in Relay['modules']:
l.append(module['module_name'])
#This return a list off all connected Thermostat in the cloud.
return l
def getModuleByName(self, name, tid=""):
for Relay in self.rawData:
for module in Relay['modules']:
#print (module['module_name'], module['_id'])
if module['module_name'] == name:
return module
elif module['_id'] == tid:
return module
else:
pass
class WeatherStationData:
"""
List the Weather Station devices (stations and modules)
Args:
authData (ClientAuth): Authentication information with a working access Token
"""
def __init__(self, authData, home=None, station=None):
self.getAuthToken = authData.accessToken
postParams = {
"access_token" : self.getAuthToken
}
resp = postRequest("Weather station", _GETSTATIONDATA_REQ, postParams)
self.rawData = resp['body']['devices']
# Weather data
if not self.rawData : raise NoDevice("No weather station in any homes")
# Stations are no longer in the Netatmo API, keeping them for compatibility
self.stations = { d['station_name'] : d for d in self.rawData }
self.stationIds = { d['_id'] : d for d in self.rawData }
self.homes = { d['home_name'] : d["station_name"] for d in self.rawData }
# Keeping the old behavior for default station name
if home and home not in self.homes : raise NoHome("No home with name %s" % home)
self.default_home = home or list(self.homes.keys())[0]
if station:
if station not in self.stations:
# May be a station_id convert it to corresponding station name
s = self.stationById(station)
if s :
station = s["station_name"]
else:
raise NoDevice("No station with name or id %s" % station)
self.default_station = station
else:
self.default_station = [v["station_name"] for k,v in self.stations.items() if v["home_name"] == self.default_home][0]
self.modules = {}
self.default_station_data = self.stationByName(self.default_station)
if 'modules' in self.default_station_data:
for m in self.default_station_data['modules']:
self.modules[ m['_id'] ] = m
# User data
userData = resp['body']['user']
self.user = UserInfo()
setattr(self.user, "mail", userData['mail'])
for k,v in userData['administrative'].items():
if k in UNITS:
setattr(self.user, k, UNITS[k][v])
else:
setattr(self.user, k, v)
def modulesNamesList(self, station=None):
s = self.getStation(station)
if not s: raise NoDevice("No station with name or id %s" % station)
self.default_station = station
self.default_station_data = s
self.modules = {}
if 'modules' in self.default_station_data:
for m in self.default_station_data['modules']:
self.modules[ m['_id'] ] = m
res = [m['module_name'] for m in self.modules.values()]
res.append(s['module_name'])
return res
# Both functions (byName and byStation) are here for historical reason,
# considering that chances are low that a station name could be confused with a station ID,
# there should be in fact a single function for getting station data
def getStation(self, station=None):
if not station : station = self.default_station
if station in self.stations : return self.stations[station]
if station in self.stationIds : return self.stationIds[station]
return None
def getModule(self, module):
if module in self.modules: return self.modules[module]
for m in self.modules.values():
if m['module_name'] == module : return m
return None
# Functions for compatibility with previous versions
def stationByName(self, station=None):
return self.getStation(station)
def stationById(self, sid):
return self.getStation(sid)
def moduleByName(self, module):
return self.getModule(module)
def moduleById(self, mid):
return self.getModule(mid)
def lastData(self, station=None, exclude=0):
s = self.stationByName(station) or self.stationById(station)
# Breaking change from Netatmo : dashboard_data no longer available if station lost
if not s or 'dashboard_data' not in s : return None
lastD = {}
# Define oldest acceptable sensor measure event
limit = (time.time() - exclude) if exclude else 0
ds = s['dashboard_data']
if ds.get('time_utc',limit+10) > limit :
lastD[s['module_name']] = ds.copy()
lastD[s['module_name']]['When'] = lastD[s['module_name']].pop("time_utc") if 'time_utc' in lastD[s['module_name']] else time.time()
lastD[s['module_name']]['wifi_status'] = s['wifi_status']
if 'modules' in s:
for module in s["modules"]:
# Skip lost modules that no longer have dashboard data available
if 'dashboard_data' not in module : continue
ds = module['dashboard_data']
if ds.get('time_utc',limit+10) > limit :
# If no module_name has been setup, use _id by default
if "module_name" not in module : module['module_name'] = module["_id"]
lastD[module['module_name']] = ds.copy()
lastD[module['module_name']]['When'] = lastD[module['module_name']].pop("time_utc") if 'time_utc' in lastD[module['module_name']] else time.time()
# For potential use, add battery and radio coverage information to module data if present
for i in ('battery_vp', 'battery_percent', 'rf_status') :
if i in module : lastD[module['module_name']][i] = module[i]
return lastD
def checkNotUpdated(self, delay=3600):
res = self.lastData()
ret = []
for mn,v in res.items():
if time.time()-v['When'] > delay : ret.append(mn)
return ret if ret else None
def checkUpdated(self, delay=3600):
res = self.lastData()
ret = []
for mn,v in res.items():
if time.time()-v['When'] < delay : ret.append(mn)
return ret if ret else None
def getMeasure(self, device_id, scale, mtype, module_id=None, date_begin=None, date_end=None, limit=None, optimize=False, real_time=False):
postParams = { "access_token" : self.getAuthToken }
postParams['device_id'] = device_id
if module_id : postParams['module_id'] = module_id
postParams['scale'] = scale
postParams['type'] = mtype
if date_begin : postParams['date_begin'] = date_begin
if date_end : postParams['date_end'] = date_end
if limit : postParams['limit'] = limit
postParams['optimize'] = "true" if optimize else "false"
postParams['real_time'] = "true" if real_time else "false"
return postRequest("Weather station", _GETMEASURE_REQ, postParams)
def MinMaxTH(self, module=None, frame="last24"):
s = self.default_station_data
if frame == "last24":
end = time.time()
start = end - 24*3600 # 24 hours ago
elif frame == "day":
start, end = todayStamps()
if module and module != s['module_name']:
m = self.moduleById(module) or self.moduleByName(module)
if not m : raise NoDevice("Can't find module %s" % module)
# retrieve module's data
resp = self.getMeasure(
device_id = s['_id'],
module_id = m['_id'],
scale = "max",
mtype = "Temperature,Humidity",
date_begin = start,
date_end = end)
else : # retrieve station's data
resp = self.getMeasure(
device_id = s['_id'],
scale = "max",
mtype = "Temperature,Humidity",
date_begin = start,
date_end = end)
if resp and resp['body']:
T = [v[0] for v in resp['body'].values()]
H = [v[1] for v in resp['body'].values()]
return min(T), max(T), min(H), max(H)
return None
class DeviceList(WeatherStationData):
"""
This class is now deprecated. Use WeatherStationData directly instead
"""
warnings.warn("The 'DeviceList' class was renamed 'WeatherStationData'",
DeprecationWarning )
class HomeData:
"""
List the Netatmo home informations (Homes, cameras, events, persons)
Args:
authData (ClientAuth): Authentication information with a working access Token
home : Home name of the home where's devices are installed
"""
def __init__(self, authData, home=None):
warnings.warn("The 'HomeData' class is deprecated'",
DeprecationWarning )
self.getAuthToken = authData.accessToken
postParams = {
"access_token" : self.getAuthToken
}
resp = postRequest("Home data", _GETHOMEDATA_REQ, postParams)
self.rawData = resp['body']
# Collect homes
self.homes = self.rawData['homes'][0]
for d in self.rawData['homes'] :
if home == d['name']:
self.homes = d
else:
pass
#
#print (self.homes.keys())
#dict_keys(['id', 'name', 'persons', 'place', 'cameras', 'smokedetectors', 'events'])
self.homeid = self.homes['id']
C = self.homes['cameras']
P = self.homes['persons']
S = self.homes['smokedetectors']
E = None
# events not always in self.homes
if 'events' in self.homes.keys():
E = self.homes['events']
#
if not S:
logger.warning('No smoke detector found')
if not C:
logger.warning('No Cameras found')
if not P:
logger.warning('No Persons found')
if not E:
logger.warning('No events found')
# if not (C or P or S or E):
# raise NoDevice("No device found in home %s" % k)
if S or C or P or E:
self.default_home = home or self.homes['name']
# Split homes data by category
self.persons = {}
self.events = {}
self.cameras = {}
self.lastEvent = {}
for i in range(len(self.rawData['homes'])):
curHome = self.rawData['homes'][i]
nameHome = curHome['name']
if nameHome not in self.cameras:
self.cameras[nameHome] = {}
if 'persons' in curHome:
for p in curHome['persons']:
self.persons[ p['id'] ] = p
if 'events' in curHome:
for e in curHome['events']:
if e['camera_id'] not in self.events:
self.events[ e['camera_id'] ] = {}
self.events[ e['camera_id'] ][ e['time'] ] = e
if 'cameras' in curHome:
for c in curHome['cameras']:
self.cameras[nameHome][ c['id'] ] = c
c["home_id"] = curHome['id']
for camera,e in self.events.items():
self.lastEvent[camera] = e[sorted(e)[-1]]
#self.default_home has no key homeId use homeName instead!
if not self.cameras[self.default_home] : raise NoDevice("No camera available in default home")
self.default_camera = list(self.cameras[self.default_home].values())[0]
else:
pass
# raise NoDevice("No Devices available")
def homeById(self, hid):
return None if hid not in self.homes else self.homes[hid]
def homeByName(self, home=None):
if not home: home = self.default_home
for key,value in self.homes.items():
if value['name'] == home:
return self.homes[key]
def cameraById(self, cid):
for cam in self.cameras.values():
if cid in cam:
return cam[cid]
return None
def cameraByName(self, camera=None, home=None):
if not camera and not home:
return self.default_camera
elif home and camera:
if home not in self.cameras:
return None
for cam_id in self.cameras[home]:
if self.cameras[home][cam_id]['name'] == camera:
return self.cameras[home][cam_id]
elif not home and camera:
for h, cam_ids in self.cameras.items():
for cam_id in cam_ids:
if self.cameras[h][cam_id]['name'] == camera:
return self.cameras[h][cam_id]
else:
return list(self.cameras[self.default_home].values())[0]
return None
def cameraUrls(self, camera=None, home=None, cid=None):
"""
Return the vpn_url and the local_url (if available) of a given camera
in order to access to its live feed
Can't use the is_local property which is mostly false in case of operator
dynamic IP change after presence start sequence
"""
local_url = None
vpn_url = None
if cid:
camera_data=self.cameraById(cid)
else:
camera_data=self.cameraByName(camera=camera, home=home)
if camera_data:
vpn_url = camera_data['vpn_url']
resp = postRequest("Camera", vpn_url + '/command/ping')
temp_local_url=resp['local_url']
try:
resp = postRequest("Camera", temp_local_url + '/command/ping',timeout=1)
if resp and temp_local_url == resp['local_url']:
local_url = temp_local_url
except: # On this particular request, vithout errors from previous requests, error is timeout
local_url = None
return vpn_url, local_url
def url(self, camera=None, home=None, cid=None):
vpn_url, local_url = self.cameraUrls(camera, home, cid)
# Return local if available else vpn
return local_url or vpn_url
def personsAtHome(self, home=None):
"""
Return the list of known persons who are currently at home
"""
if not home: home = self.default_home
home_data = self.homeByName(home)
atHome = []
for p in home_data['persons']:
#Only check known persons
if 'pseudo' in p:
if not p["out_of_sight"]:
atHome.append(p['pseudo'])
return atHome
def getCameraPicture(self, image_id, key):
"""
Download a specific image (of an event or user face) from the camera
"""
postParams = {
"access_token" : self.getAuthToken,
"image_id" : image_id,
"key" : key
}
resp = postRequest("Camera", _GETCAMERAPICTURE_REQ, postParams)
return resp, "jpeg"
def getProfileImage(self, name):
"""
Retrieve the face of a given person
"""
for p in self.persons.values():
if 'pseudo' in p:
if name == p['pseudo']:
image_id = p['face']['id']
key = p['face']['key']
return self.getCameraPicture(image_id, key)
return None, None
def updateEvent(self, event=None, home=None):
"""
Update the list of event with the latest ones
"""
if not home: home=self.default_home
if not event:
#If not event is provided we need to retrieve the oldest of the last event seen by each camera
listEvent = {}
for e in self.lastEvent.values():
listEvent[e['time']] = e
event = listEvent[sorted(listEvent)[0]]
home_data = self.homeByName(home)
postParams = {
"access_token" : self.getAuthToken,
"home_id" : home_data['id'],
"event_id" : event['id']
}
resp = postRequest("Camera", _GETEVENTSUNTIL_REQ, postParams)
eventList = resp['body']['events_list']
for e in eventList:
self.events[ e['camera_id'] ][ e['time'] ] = e
for camera,v in self.events.items():
self.lastEvent[camera]=v[sorted(v)[-1]]
def personSeenByCamera(self, name, home=None, camera=None):
"""
Return True if a specific person has been seen by a camera
"""
try:
cam_id = self.cameraByName(camera=camera, home=home)['id']
except TypeError:
logger.warning("personSeenByCamera: Camera name or home is unknown")
return False
#Check in the last event is someone known has been seen
if self.lastEvent[cam_id]['type'] == 'person':
person_id = self.lastEvent[cam_id]['person_id']
if 'pseudo' in self.persons[person_id]:
if self.persons[person_id]['pseudo'] == name:
return True
return False
def _knownPersons(self):
known_persons = {}
for p_id,p in self.persons.items():
if 'pseudo' in p:
known_persons[ p_id ] = p
return known_persons
def someoneKnownSeen(self, home=None, camera=None):
"""
Return True if someone known has been seen
"""
try:
cam_id = self.cameraByName(camera=camera, home=home)['id']
except TypeError:
logger.warning("personSeenByCamera: Camera name or home is unknown")
return False
#Check in the last event is someone known has been seen
if self.lastEvent[cam_id]['type'] == 'person':
if self.lastEvent[cam_id]['person_id'] in self._knownPersons():
return True
return False
def someoneUnknownSeen(self, home=None, camera=None):
"""
Return True if someone unknown has been seen
"""
try:
cam_id = self.cameraByName(camera=camera, home=home)['id']
except TypeError:
logger.warning("personSeenByCamera: Camera name or home is unknown")
return False
#Check in the last event is someone known has been seen
if self.lastEvent[cam_id]['type'] == 'person':
if self.lastEvent[cam_id]['person_id'] not in self._knownPersons():
return True
return False
def motionDetected(self, home=None, camera=None):
"""
Return True if movement has been detected
"""
try:
cam_id = self.cameraByName(camera=camera, home=home)['id']
except TypeError:
logger.warning("personSeenByCamera: Camera name or home is unknown")
return False
if self.lastEvent[cam_id]['type'] == 'movement':
return True
return False
def presenceUrl(self, camera=None, home=None, cid=None):
camera = self.cameraByName(home=home, camera=camera) or self.cameraById(cid=cid)
if camera["type"] != "NOC": return None # Not a presence camera
vpnUrl, localUrl = self.cameraUrls(cid=camera["id"])
return localUrl or vpnUrl
def presenceLight(self, camera=None, home=None, cid=None, setting=None):
url = self.presenceUrl(home=home, camera=camera) or self.cameraById(cid=cid)
if not url or setting not in ("on", "off", "auto"): return None
if setting : return "Currently unsupported"
return cameraCommand(url, _PRES_CDE_GET_LIGHT)["mode"]
# Not yet supported
#if not setting: return cameraCommand(url, _PRES_CDE_GET_LIGHT)["mode"]
#else: return cameraCommand(url, _PRES_CDE_SET_LIGHT, setting)
def presenceStatus(self, mode, camera=None, home=None, cid=None):
url = self.presenceUrl(home=home, camera=camera) or self.cameraById(cid=cid)
if not url or mode not in ("on", "off") : return None
r = cameraCommand(url, _CAM_CHANGE_STATUS, mode)
return mode if r["status"] == "ok" else None
def presenceSetAction(self, camera=None, home=None, cid=None,
eventType=_PRES_DETECTION_KIND[0], action=2):
raise NotImplementedError
# if eventType not in _PRES_DETECTION_KIND or \
# action not in _PRES_DETECTION_SETUP : return None
# camera = self.cameraByName(home=home, camera=camera) or self.cameraById(cid=cid)
# postParams = { "access_token" : self.getAuthToken,
# "home_id" : camera["home_id"],
# "presence_settings[presence_record_%s]" % eventType : _PRES_DETECTION_SETUP.index(action)
# }
# resp = postRequest("Camera", _POST_UPDATE_HOME_REQ, postParams)
# self.rawData = resp['body']
def getLiveSnapshot(self, camera=None, home=None, cid=None):
camera = self.cameraByName(home=home, camera=camera) or self.cameraById(cid=cid)
vpnUrl, localUrl = self.cameraUrls(cid=camera["id"])
url = localUrl or vpnUrl
return cameraCommand(url, _PRES_CDE_GET_SNAP)
class WelcomeData(HomeData):
"""
This class is now deprecated. Use HomeData instead
Home can handle many devices, not only Welcome cameras
"""
warnings.warn("The 'WelcomeData' class was renamed 'HomeData' to handle new Netatmo Home capabilities",
DeprecationWarning )
class HomesData:
"""
List the Netatmo actual topology and static information of all devices present
into a user account. It is also possible to specify a home_id to focus on one home.
Args:
authData (clientAuth): Authentication information with a working access Token
home : Home name or id of the home who's module belongs to
"""
def __init__(self, authData, home=None):
#
self.getAuthToken = authData.accessToken
postParams = {
"access_token" : self.getAuthToken,
"home_id": home
}
#
resp = postRequest("Module", _GETHOMES_DATA, postParams)
# self.rawData = resp['body']['devices']
self.rawData = resp['body']['homes']
if not self.rawData : raise NoHome("No home %s found" % home)
#
if home: