-
-
Notifications
You must be signed in to change notification settings - Fork 14
/
api.py
3648 lines (3012 loc) · 158 KB
/
api.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
""" Reolink NVR/camera network API """
from __future__ import annotations
import asyncio
import base64
import hashlib
import json
import logging
import ssl
import traceback
import uuid
from datetime import datetime, timedelta
from os.path import basename
from typing import Any, Literal, Optional, overload
from urllib import parse
from xml.etree import ElementTree as XML
from statistics import mean
import aiohttp
from . import templates, typings
from .enums import DayNightEnum, SpotlightModeEnum, PtzEnum, GuardEnum
from .exceptions import (
ApiError,
CredentialsInvalidError,
InvalidContentTypeError,
InvalidParameterError,
LoginError,
NoDataError,
NotSupportedError,
ReolinkError,
SubscriptionError,
UnexpectedDataError,
)
from .software_version import SoftwareVersion, MINIMUM_FIRMWARE
from .typings import reolink_json
MANUFACTURER = "Reolink"
DEFAULT_STREAM = "sub"
DEFAULT_PROTOCOL = "rtmp"
DEFAULT_TIMEOUT = 60
RETRY_ATTEMPTS = 3
DEFAULT_RTMP_AUTH_METHOD = "PASSWORD"
SUBSCRIPTION_TERMINATION_TIME = 15
MOTION_DETECTION_TYPE = "motion"
FACE_DETECTION_TYPE = "face"
PERSON_DETECTION_TYPE = "person"
VEHICLE_DETECTION_TYPE = "vehicle"
PET_DETECTION_TYPE = "pet"
VISITOR_DETECTION_TYPE = "visitor"
_LOGGER = logging.getLogger(__name__)
_LOGGER_DATA = logging.getLogger(__name__ + ".data")
SSL_CONTEXT = ssl.create_default_context()
SSL_CONTEXT.set_ciphers("DEFAULT")
SSL_CONTEXT.check_hostname = False
SSL_CONTEXT.verify_mode = ssl.CERT_NONE
DUAL_LENS_MODELS: set[str] = {
"Reolink Duo PoE",
"Reolink Duo WiFi",
"Reolink Duo 2 PoE",
"Reolink Duo 2 WiFi",
"Reolink Duo Floodlight PoE",
"Reolink Duo Floodlight WiFi",
"Reolink TrackMix PoE",
"Reolink TrackMix WiFi",
}
##########################################################################################################################################################
# API class
##########################################################################################################################################################
class Host:
"""Reolink network API class."""
def __init__(
self,
host: str,
username: str,
password: str,
port: Optional[int] = None,
use_https: Optional[bool] = None,
protocol: str = DEFAULT_PROTOCOL,
stream: str = DEFAULT_STREAM,
timeout: int = DEFAULT_TIMEOUT,
rtmp_auth_method: str = DEFAULT_RTMP_AUTH_METHOD,
aiohttp_get_session_callback=None,
):
self._send_mutex = asyncio.Lock()
self._login_mutex = asyncio.Lock()
##############################################################################
# Host
self._url: str = ""
self._use_https: Optional[bool] = use_https
self._host: str = host
self._external_host: Optional[str] = None
self._external_port: Optional[int] = None
self._port: Optional[int] = port
self._rtsp_port: Optional[int] = None
self._rtmp_port: Optional[int] = None
self._onvif_port: Optional[int] = None
self._rtsp_enabled: Optional[bool] = None
self._rtmp_enabled: Optional[bool] = None
self._onvif_enabled: Optional[bool] = None
self._mac_address: Optional[str] = None
self.refresh_base_url()
##############################################################################
# Login session
self._username: str = username
self._password: str = password[:31]
self._token: Optional[str] = None
self._lease_time: Optional[datetime] = None
# Connection session
self._timeout: aiohttp.ClientTimeout = aiohttp.ClientTimeout(total=timeout)
if aiohttp_get_session_callback is not None:
self._get_aiohttp_session = aiohttp_get_session_callback
else:
self._get_aiohttp_session = lambda: aiohttp.ClientSession(timeout=self._timeout, connector=aiohttp.TCPConnector(ssl=SSL_CONTEXT))
self._aiohttp_session: aiohttp.ClientSession = self._get_aiohttp_session()
##############################################################################
# NVR (host-level) attributes
self._is_nvr: bool = False
self._nvr_name: str = ""
self._nvr_serial: Optional[str] = None
self._nvr_model: Optional[str] = None
self._nvr_num_channels: int = 0
self._nvr_hw_version: Optional[str] = None
self._nvr_sw_version: Optional[str] = None
self._nvr_sw_version_object: Optional[SoftwareVersion] = None
##############################################################################
# Channels of cameras, used in this NVR ([0] for a directly connected camera)
self._GetChannelStatus_present: bool = False
self._GetChannelStatus_has_name: bool = False
self._channels: list[int] = []
self._stream_channels: list[int] = []
self._channel_names: dict[int, str] = {}
self._channel_models: dict[int, str] = {}
self._is_doorbell: dict[int, bool] = {}
##############################################################################
# API-versions and capabilities
self._api_version: dict[str, int] = {}
self._abilities: dict[str, Any] = {} # raw response from NVR/camera
self._capabilities: dict[int | str, list[str]] = {"Host": []} # processed by construct_capabilities
##############################################################################
# Video-stream formats
self._stream: str = stream
self._protocol: str = protocol
self._rtmp_auth_method: str = rtmp_auth_method
self._rtsp_mainStream: dict[int, str] = {}
self._rtsp_subStream: dict[int, str] = {}
##############################################################################
# Presets
self._ptz_presets: dict[int, dict] = {}
##############################################################################
# Saved info response-blocks
self._hdd_info: Optional[dict] = None
self._local_link: Optional[dict] = None
self._users: Optional[dict] = None
##############################################################################
# Saved settings response-blocks
# Host-level
self._time_settings: Optional[dict] = None
self._ntp_settings: Optional[dict] = None
self._netport_settings: Optional[dict] = None
# Camera-level
self._zoom_focus_settings: dict[int, dict] = {}
self._zoom_focus_range: dict[int, dict] = {}
self._auto_focus_settings: dict[int, dict] = {}
self._isp_settings: dict[int, dict] = {}
self._ftp_settings: dict[int, dict] = {}
self._osd_settings: dict[int, dict] = {}
self._push_settings: dict[int, dict] = {}
self._enc_settings: dict[int, dict] = {}
self._ptz_presets_settings: dict[int, dict] = {}
self._ptz_guard_settings: dict[int, dict] = {}
self._email_settings: dict[int, dict] = {}
self._ir_settings: dict[int, dict] = {}
self._status_led_settings: dict[int, dict] = {}
self._whiteled_settings: dict[int, dict] = {}
self._recording_settings: dict[int, dict] = {}
self._md_alarm_settings: dict[int, dict] = {}
self._ai_alarm_settings: dict[int, dict] = {}
self._audio_settings: dict[int, dict] = {}
self._audio_alarm_settings: dict[int, dict] = {}
self._buzzer_settings: dict[int, dict] = {}
self._auto_track_settings: dict[int, dict] = {}
self._audio_file_list: dict[int, dict] = {}
self._auto_reply_settings: dict[int, dict] = {}
##############################################################################
# States
self._motion_detection_states: dict[int, bool] = {}
self._ai_detection_support: dict[int, dict[str, bool]] = {}
##############################################################################
# Camera-level states
self._ai_detection_states: dict[int, dict[str, bool]] = {}
self._visitor_states: dict[int, bool] = {}
##############################################################################
# SUBSCRIPTION managing
self._subscribe_url: Optional[str] = None
self._subscription_manager_url: Optional[str] = None
self._subscription_termination_time: Optional[datetime] = None
self._subscription_time_difference: Optional[float] = None
self._onvif_only_motion = True
self._log_once: list[str] = []
##############################################################################
# Properties
@property
def host(self) -> str:
return self._host
@property
def username(self) -> str:
return self._username
@property
def external_host(self) -> Optional[str]:
return self._external_host
@external_host.setter
def external_host(self, value: Optional[str]):
self._external_host = value
@property
def use_https(self) -> Optional[bool]:
return self._use_https
@property
def external_port(self) -> Optional[int]:
return self._external_port
@external_port.setter
def external_port(self, value: Optional[int]):
self._external_port = value
@property
def port(self) -> Optional[int]:
return self._port
@property
def onvif_port(self) -> Optional[int]:
return self._onvif_port
@property
def rtmp_port(self) -> Optional[int]:
return self._rtmp_port
@property
def rtsp_port(self) -> Optional[int]:
return self._rtsp_port
@property
def onvif_enabled(self) -> Optional[bool]:
return self._onvif_enabled
@property
def rtmp_enabled(self) -> Optional[bool]:
return self._rtmp_enabled
@property
def rtsp_enabled(self) -> Optional[bool]:
return self._rtsp_enabled
@property
def mac_address(self) -> Optional[str]:
return self._mac_address
@property
def serial(self) -> Optional[str]:
return self._nvr_serial
@property
def is_nvr(self) -> bool:
return self._is_nvr
@property
def nvr_name(self) -> Optional[str]:
if not self._is_nvr and self._nvr_name == "":
if len(self._channels) > 0 and self._channels[0] in self._channel_names:
return self._channel_names[self._channels[0]]
return "Unknown"
return self._nvr_name
@property
def sw_version(self) -> Optional[str]:
return self._nvr_sw_version
@property
def sw_version_required(self) -> SoftwareVersion:
"""Return the minimum required firmware version for proper operation of this library"""
if self.model is None or self.hardware_version is None:
return SoftwareVersion(None)
return SoftwareVersion(MINIMUM_FIRMWARE.get(self.model, {}).get(self.hardware_version))
@property
def sw_version_update_required(self) -> bool:
"""Check if a firmware version update is required for proper operation of this library"""
if self._nvr_sw_version_object is None:
return False
return not self._nvr_sw_version_object >= self.sw_version_required # pylint: disable=unneeded-not
@property
def model(self) -> Optional[str]:
return self._nvr_model
@property
def hardware_version(self) -> Optional[str]:
return self._nvr_hw_version
@property
def manufacturer(self) -> str:
return MANUFACTURER
@property
def num_channels(self) -> int:
"""Return the total number of channels in the NVR (should be 1 for a standalone camera, maybe 2 for DUO cameras)."""
return self._nvr_num_channels
@property
def num_cameras(self) -> int:
"""Return the number of channels IN USE in that NVR (should be 1 for a standalone camera, maybe 2 for DUO cameras)."""
return len(self._channels)
@property
def channels(self) -> list[int]:
"""Return the list of indices of channels in use."""
return self._channels
@property
def stream_channels(self) -> list[int]:
"""Return the list of indices of stream channels available."""
return self._stream_channels
@property
def hdd_info(self) -> Optional[dict]:
return self._hdd_info
@property
def stream(self) -> str:
return self._stream
@property
def protocol(self) -> str:
return self._protocol
@property
def session_active(self) -> bool:
if self._token is not None and self._lease_time is not None and self._lease_time > (datetime.now() + timedelta(seconds=5)):
return True
return False
@property
def timeout(self) -> Optional[float]:
return self._timeout.total
@property
def user_level(self) -> str:
"""Check if the user has admin authorisation."""
if self._users is None or len(self._users) < 1:
return "unknown"
for user in self._users:
if user["userName"] == self._username:
return user["level"]
return "unknown"
@property
def is_admin(self) -> bool:
"""
Check if the user has admin authorisation.
Only admin users can change camera settings, not everything will work if account is not admin
"""
return self.user_level == "admin"
##############################################################################
# Channel-level getters/setters
def camera_name(self, channel: int | None) -> Optional[str]:
if channel is None:
return self.nvr_name
if channel not in self._channel_names and channel in self._stream_channels and channel != 0:
return self.camera_name(0) # Dual lens cameras
if channel not in self._channel_names:
if len(self._channels) == 1:
return self.nvr_name
return "Unknown"
return self._channel_names[channel]
def camera_model(self, channel: int) -> Optional[str]:
if channel not in self._channel_models and channel in self._stream_channels and channel != 0:
return self.camera_model(0) # Dual lens cameras
if channel not in self._channel_models:
return "Unknown"
return self._channel_models[channel]
def is_doorbell(self, channel: int) -> bool:
"""Wether or not the camera is a doorbell"""
return channel in self._is_doorbell and self._is_doorbell[channel]
def is_doorbell_enabled(self, channel: int) -> bool:
"""Needs to be depricated"""
return self.is_doorbell(channel)
def motion_detected(self, channel: int) -> bool:
"""Return the motion detection state (polled)."""
return channel in self._motion_detection_states and self._motion_detection_states[channel]
def ai_detected(self, channel: int, object_type: str) -> bool:
"""Return the AI object detection state (polled)."""
if channel not in self._ai_detection_states or self._ai_detection_states[channel] is None:
return False
for key, value in self._ai_detection_states[channel].items():
if key == object_type or (object_type == PERSON_DETECTION_TYPE and key == "people") or (object_type == PET_DETECTION_TYPE and key == "dog_cat"):
return value
return False
def ai_detection_states(self, channel: int) -> dict[str, bool]:
"""Return all the AI object detection state."""
return self._ai_detection_states[channel]
def visitor_detected(self, channel: int) -> bool:
"""Return the visitor detection state (polled)."""
return channel in self._visitor_states and self._visitor_states[channel]
def ai_supported(self, channel: int, object_type: Optional[str] = None) -> bool:
"""Return if the AI object type detection is supported or not."""
if channel not in self._ai_detection_support or not self._ai_detection_support[channel]:
return False
if object_type is not None:
for key, value in self._ai_detection_support[channel].items():
if key == object_type or (object_type == PERSON_DETECTION_TYPE and key == "people") or (object_type == PET_DETECTION_TYPE and key == "dog_cat"):
return value
return False
return True
def ai_supported_types(self, channel: int) -> list[str]:
"""Return a list of supported AI types."""
if channel not in self._ai_detection_support:
return []
ai_types = []
for key, value in self._ai_detection_support[channel].items():
if value:
ai_types.append(key)
return ai_types
def audio_alarm_enabled(self, channel: int) -> bool:
if channel not in self._audio_alarm_settings:
return False
if self.api_version("GetAudioAlarm") >= 1:
return self._audio_alarm_settings[channel]["Audio"]["enable"] == 1
return self._audio_alarm_settings[channel]["Audio"]["schedule"]["enable"] == 1
def ir_enabled(self, channel: int) -> bool:
return channel in self._ir_settings and self._ir_settings[channel]["IrLights"]["state"] == "Auto"
def status_led_enabled(self, channel: int) -> bool:
if channel not in self._status_led_settings:
return False
if self.is_doorbell(channel):
return self._status_led_settings[channel]["PowerLed"].get("eDoorbellLightState", "Off") == "On"
return self._status_led_settings[channel]["PowerLed"].get("state", "Off") == "On"
def ftp_enabled(self, channel: int | None = None) -> bool:
if channel is None:
if self.api_version("GetFtp") >= 1:
return all(self._ftp_settings[ch]["Ftp"]["enable"] == 1 for ch in self._channels)
return all(self._ftp_settings[ch]["Ftp"]["schedule"]["enable"] == 1 for ch in self._channels)
if channel not in self._ftp_settings:
return False
if self.api_version("GetFtp") >= 1:
return self._ftp_settings[channel]["Ftp"]["enable"] == 1
return self._ftp_settings[channel]["Ftp"]["schedule"]["enable"] == 1
def email_enabled(self, channel: int | None = None) -> bool:
if channel is None:
if self.api_version("GetEmail") >= 1:
return all(self._email_settings[ch]["Email"]["enable"] == 1 for ch in self._channels)
return all(self._email_settings[ch]["Email"]["schedule"]["enable"] == 1 for ch in self._channels)
if channel not in self._email_settings:
return False
if self.api_version("GetEmail") >= 1:
return self._email_settings[channel]["Email"]["enable"] == 1
return self._email_settings[channel]["Email"]["schedule"]["enable"] == 1
def push_enabled(self, channel: int | None = None) -> bool:
if channel is None:
if self.api_version("GetPush") >= 1:
return all(self._push_settings[ch]["Push"]["enable"] == 1 for ch in self._channels)
return all(self._push_settings[ch]["Push"]["schedule"]["enable"] == 1 for ch in self._channels)
if channel not in self._push_settings:
return False
if self.api_version("GetPush") >= 1:
return self._push_settings[channel]["Push"]["enable"] == 1
return self._push_settings[channel]["Push"]["schedule"]["enable"] == 1
def recording_enabled(self, channel: int | None = None) -> bool:
if channel is None:
if self.api_version("GetRec") >= 1:
return all(self._recording_settings[ch]["Rec"]["enable"] == 1 for ch in self._channels)
return all(self._recording_settings[ch]["Rec"]["schedule"]["enable"] == 1 for ch in self._channels)
if channel not in self._recording_settings:
return False
if self.api_version("GetRec") >= 1:
return self._recording_settings[channel]["Rec"]["enable"] == 1
return self._recording_settings[channel]["Rec"]["schedule"]["enable"] == 1
def buzzer_enabled(self, channel: int | None = None) -> bool:
if channel is None:
return all(self._buzzer_settings[ch]["Buzzer"]["enable"] == 1 for ch in self._channels)
if channel not in self._buzzer_settings:
return False
return self._buzzer_settings[channel]["Buzzer"]["enable"] == 1
def whiteled_state(self, channel: int) -> bool:
return channel in self._whiteled_settings and self._whiteled_settings[channel]["WhiteLed"]["state"] == 1
def whiteled_mode(self, channel: int) -> Optional[int]:
if channel not in self._whiteled_settings:
return None
return self._whiteled_settings[channel]["WhiteLed"].get("mode")
def whiteled_brightness(self, channel: int) -> Optional[int]:
if channel not in self._whiteled_settings:
return None
return self._whiteled_settings[channel]["WhiteLed"].get("bright")
def whiteled_schedule(self, channel: int) -> Optional[dict]:
"""Return the spotlight state."""
if channel in self._whiteled_settings:
return self._whiteled_settings[channel]["WhiteLed"]["LightingSchedule"]
return None
def whiteled_settings(self, channel: int) -> Optional[dict]:
"""Return the spotlight state."""
if channel in self._whiteled_settings:
return self._whiteled_settings[channel]
return None
def daynight_state(self, channel: int) -> Optional[str]:
if channel not in self._isp_settings:
return None
return self._isp_settings[channel]["Isp"]["dayNight"]
def backlight_state(self, channel: int) -> Optional[str]:
if channel not in self._isp_settings:
return None
return self._isp_settings[channel]["Isp"]["backLight"]
def audio_record(self, channel: int) -> bool:
if channel not in self._enc_settings:
return False
return self._enc_settings[channel]["Enc"]["audio"] == 1
def volume(self, channel: int) -> int:
if channel not in self._audio_settings:
return 100
return self._audio_settings[channel]["AudioCfg"]["volume"]
def quick_reply_dict(self, channel: int) -> dict[int, str]:
if channel not in self._audio_settings:
return {}
audio_dict = {-1: "off"}
for audio_file in self._audio_file_list[channel]["AudioFileList"]:
audio_dict[audio_file["id"]] = audio_file["fileName"]
return audio_dict
def quick_reply_enabled(self, channel: int) -> bool:
if channel not in self._auto_reply_settings:
return False
return self._auto_reply_settings[channel]["AutoReply"]["enable"] == 1
def quick_reply_file(self, channel: int) -> int | None:
"""Return the quick replay audio file id, -1 means quick replay is off."""
if channel not in self._auto_reply_settings:
return None
return self._auto_reply_settings[channel]["AutoReply"]["fileId"]
def quick_reply_time(self, channel: int) -> int:
if channel not in self._auto_reply_settings:
return 0
return self._auto_reply_settings[channel]["AutoReply"]["timeout"]
def audio_alarm_settings(self, channel: int) -> dict:
if channel in self._audio_alarm_settings:
return self._audio_alarm_settings[channel]
return {}
def md_sensitivity(self, channel: int) -> int:
if channel not in self._md_alarm_settings:
return 0
if self.api_version("GetMdAlarm") >= 1:
if self._md_alarm_settings[channel]["MdAlarm"].get("useNewSens", 0) == 1:
return 51 - self._md_alarm_settings[channel]["MdAlarm"]["newSens"]["sensDef"]
sensitivities = [sens["sensitivity"] for sens in self._md_alarm_settings[channel]["MdAlarm"]["sens"]]
return 51 - mean(sensitivities)
sensitivities = [sens["sensitivity"] for sens in self._md_alarm_settings[channel]["Alarm"]["sens"]]
return 51 - mean(sensitivities)
def ai_sensitivity(self, channel: int, ai_type: str) -> int:
if channel not in self._ai_alarm_settings or ai_type not in self._ai_alarm_settings[channel]:
return 0
return self._ai_alarm_settings[channel][ai_type]["sensitivity"]
def ptz_supported(self, channel: int) -> bool:
return self.supported(channel, "ptz")
def zoom_supported(self, channel: int) -> bool:
return self.supported(channel, "zoom")
def zoom_range(self, channel: int) -> dict:
return self._zoom_focus_range[channel]
def pan_tilt_supported(self, channel: int) -> bool:
return self.supported(channel, "pan_tilt")
def enable_https(self, enable: bool):
self._use_https = enable
self.refresh_base_url()
def refresh_base_url(self):
if self._use_https:
self._url = f"https://{self._host}:{self._port}/cgi-bin/api.cgi"
else:
self._url = f"http://{self._host}:{self._port}/cgi-bin/api.cgi"
async def login(self) -> None:
if self._port is None or self._use_https is None:
await self._login_try_ports()
return # succes
if self._token is not None and self._lease_time is not None and self._lease_time > (datetime.now() + timedelta(seconds=300)):
return # succes
await self._login_mutex.acquire()
try:
await self.logout(login_mutex_owned=True) # Ensure there would be no "max session" error
_LOGGER.debug(
"Host %s:%s, trying to login with user %s...",
self._host,
self._port,
self._username,
)
body: reolink_json = [
{
"cmd": "Login",
"action": 0,
"param": {
"User": {
"userName": self._username,
"password": self._password,
}
},
}
]
param = {"cmd": "Login"}
try:
json_data = await self.send(body, param, expected_response_type="json")
except ApiError as err:
raise LoginError(f"API error during login of host {self._host}:{self._port}: {str(err)}") from err
except aiohttp.ClientConnectorError as err:
raise LoginError(f"Client connector error during login of host {self._host}:{self._port}: {str(err)}") from err
except InvalidContentTypeError as err:
raise LoginError(f"Invalid content error during login of host {self._host}:{self._port}: {str(err)}") from err
except NoDataError as err:
raise LoginError(f"Error receiving Reolink login response of host {self._host}:{self._port}") from err
_LOGGER.debug("Got login response from %s:%s: %s", self._host, self._port, json_data)
try:
if json_data[0]["code"] != 0:
raise LoginError(f"API returned error code {json_data[0]['code']} during login of host {self._host}:{self._port}")
self._lease_time = datetime.now() + timedelta(seconds=float(json_data[0]["value"]["Token"]["leaseTime"]))
self._token = str(json_data[0]["value"]["Token"]["name"])
except Exception as err:
self.clear_token()
raise LoginError(f"Login error, unknown response format from host {self._host}:{self._port}: {json_data}") from err
_LOGGER.debug(
"Logged in at host %s:%s. Leasetime %s, token %s",
self._host,
self._port,
self._lease_time.strftime("%d-%m-%Y %H:%M"),
self._token,
)
# Looks like some devices fail with not-logged-in if subsequent command sent with no delay, not sure 100% though...
# I've seen RLC-520A failed with 0.5s, but did not try to set more. Need to gather some more logging data from users...
# asyncio.sleep(0.5)
return # succes
finally:
self._login_mutex.release()
async def _login_try_ports(self) -> None:
self._port = 443
self.enable_https(True)
try:
await self.login()
return
except LoginError:
pass
self._port = 80
self.enable_https(False)
await self.login()
async def logout(self, login_mutex_owned=False):
body = [{"cmd": "Logout", "action": 0, "param": {}}]
if not login_mutex_owned:
await self._login_mutex.acquire()
try:
if self._token:
param = {"cmd": "Logout"}
try:
# logout sometimes responds with a string of seemingly random caracters, which are always the same for a given camera.
await self.send(body, param, expected_response_type="text/html")
except ReolinkError as err:
_LOGGER.warning("Error while logging out: %s", str(err))
# Reolink has a bug in some cameras' firmware: the Logout command issued without a token breaks the subsequent commands:
# even if Login command issued AFTER that successfully returns a token, any command with that token would return "Please login first" error.
# Thus it is not available for now to exit the previous "stuck" sessions after sudden crash or power failure:
# Reolink has restricted amount of sessions on a device, so in such case the component would not be able to login
# into a device before some previos session expires an hour later...
# If Reolink fixes this and makes Logout work with login/pass pair instead of a token - this can be uncommented...
# else:
# body = [{"cmd": "Logout", "action": 0, "param": {"User": {"userName": self._username, "password": self._password}}}]
# param = {"cmd": "Logout"}
# await self.send(body, param, expected_response_type = "text/html")
self.clear_token()
if not login_mutex_owned:
await self._aiohttp_session.close()
finally:
if not login_mutex_owned:
self._login_mutex.release()
async def expire_session(self):
if self._lease_time is not None:
self._lease_time = datetime.now() - timedelta(seconds=5)
await self._aiohttp_session.close()
def clear_token(self):
self._token = None
self._lease_time = None
def construct_capabilities(self, warnings=True) -> None:
"""Construct the capabilities list of the NVR/camera."""
# Host capabilities
self._capabilities["Host"] = []
if self._ftp_settings:
self._capabilities["Host"].append("ftp")
if self._push_settings:
self._capabilities["Host"].append("push")
if self._recording_settings:
self._capabilities["Host"].append("recording")
if self._email_settings:
self._capabilities["Host"].append("email")
if self.api_version("supportBuzzer") > 0:
self._capabilities["Host"].append("buzzer")
if self.api_version("upgrade") >= 2:
self._capabilities["Host"].append("update")
# Channel capabilities
for channel in self._channels:
self._capabilities[channel] = []
if channel in self._ftp_settings:
self._capabilities[channel].append("ftp")
if channel in self._push_settings:
self._capabilities[channel].append("push")
if channel in self._recording_settings:
self._capabilities[channel].append("recording")
if channel in self._email_settings:
self._capabilities[channel].append("email")
if self.api_version("supportBuzzer") > 0:
self._capabilities[channel].append("buzzer")
if self.api_version("ledControl", channel) > 0 and channel in self._ir_settings:
self._capabilities[channel].append("ir_lights")
if self.api_version("powerLed", channel) > 0 or self.is_doorbell(channel):
# powerLed == statusLed
self._capabilities[channel].append("status_led")
if self.api_version("floodLight", channel) > 0 and self.api_version("GetWhiteLed") > 0:
# floodlight == spotlight == WhiteLed
self._capabilities[channel].append("floodLight")
if self.api_version("GetAudioCfg") > 0:
self._capabilities[channel].append("volume")
if self.is_doorbell(channel) and self.api_version("GetAudioFileList") > 0 and self.api_version("GetAutoReply") > 0:
self._capabilities[channel].append("quick_reply")
if channel in self._audio_alarm_settings:
self._capabilities[channel].append("siren")
if self.audio_record(channel) is not None:
self._capabilities[channel].append("audio")
ptz_ver = self.api_version("ptzType", channel)
if ptz_ver != 0:
self._capabilities[channel].append("ptz")
if ptz_ver in [1, 2, 5]:
self._capabilities[channel].append("zoom_basic")
min_zoom = self._zoom_focus_range.get(channel, {}).get("zoom", {}).get("pos", {}).get("min")
max_zoom = self._zoom_focus_range.get(channel, {}).get("zoom", {}).get("pos", {}).get("max")
if min_zoom is None or max_zoom is None:
if warnings:
_LOGGER.warning("Camera %s reported to support zoom, but zoom range not available", self.camera_name(channel))
else:
self._capabilities[channel].append("zoom")
if self.api_version("disableAutoFocus", channel) > 0:
self._capabilities[channel].append("auto_focus")
if ptz_ver in [2, 3, 5]:
self._capabilities[channel].append("pan_tilt")
if self.api_version("supportPtzCalibration", channel) > 0 or self.api_version("supportPtzCheck", channel) > 0:
self._capabilities[channel].append("ptz_callibrate")
if self.api_version("GetPtzGuard", channel) > 0:
self._capabilities[channel].append("ptz_guard")
if ptz_ver in [2, 3]:
self._capabilities[channel].append("ptz_speed")
if channel in self._ptz_presets and len(self._ptz_presets[channel]) != 0:
self._capabilities[channel].append("ptz_presets")
if self.api_version("aiTrack", channel) > 0:
self._capabilities[channel].append("auto_track")
if channel in self._md_alarm_settings:
self._capabilities[channel].append("md_sensitivity")
if self.api_version("supportAiSensitivity", channel) > 0:
self._capabilities[channel].append("ai_sensitivity")
if channel in self._motion_detection_states:
self._capabilities[channel].append("motion_detection")
if self.daynight_state(channel) is not None:
self._capabilities[channel].append("dayNight")
if self.backlight_state(channel) is not None:
self._capabilities[channel].append("backLight")
def supported(self, channel: int | None, capability: str) -> bool:
"""Return if a capability is supported by a camera channel."""
if channel is None:
return capability in self._capabilities["Host"]
if channel not in self._capabilities:
return False
return capability in self._capabilities[channel]
def api_version(self, capability: str, channel: int | None = None) -> int:
"""Return the api version of a capability, 0=not supported, >0 is supported"""
if capability in self._api_version:
return self._api_version[capability]
if channel is None:
return self._abilities.get(capability, {}).get("ver", 0)
if channel >= len(self._abilities["abilityChn"]):
return 0
return self._abilities["abilityChn"][channel].get(capability, {}).get("ver", 0)
async def get_state(self, cmd: str) -> None:
body = []
channels = []
for channel in self._stream_channels:
ch_body = []
if cmd == "GetEnc":
ch_body = [{"cmd": "GetEnc", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetRtspUrl":
ch_body = [{"cmd": "GetRtspUrl", "action": 0, "param": {"channel": channel}}]
body.extend(ch_body)
channels.extend([channel] * len(ch_body))
for channel in self._channels:
ch_body = []
if cmd == "GetIsp":
ch_body = [{"cmd": "GetIsp", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetIrLights":
ch_body = [{"cmd": "GetIrLights", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetPowerLed":
ch_body = [{"cmd": "GetPowerLed", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetWhiteLed":
ch_body = [{"cmd": "GetWhiteLed", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetPtzPreset":
ch_body = [{"cmd": "GetPtzPreset", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetAutoFocus":
ch_body = [{"cmd": "GetAutoFocus", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetZoomFocus":
ch_body = [{"cmd": "GetZoomFocus", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetPtzGuard":
ch_body = [{"cmd": "GetPtzGuard", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetAiCfg":
ch_body = [{"cmd": "GetAiCfg", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetAudioCfg":
ch_body = [{"cmd": "GetAudioCfg", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetAudioFileList":
ch_body = [{"cmd": "GetAudioFileList", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetAutoReply":
ch_body = [{"cmd": "GetAutoReply", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetOsd":
ch_body = [{"cmd": "GetOsd", "action": 0, "param": {"channel": channel}}]
elif cmd == "GetBuzzerAlarmV20":
ch_body = [{"cmd": "GetBuzzerAlarmV20", "action": 0, "param": {"channel": channel}}]
elif cmd in ["GetAlarm", "GetMdAlarm"]:
if self.api_version("GetMdAlarm") >= 1:
ch_body = [{"cmd": "GetMdAlarm", "action": 0, "param": {"channel": channel}}]
else:
ch_body = [{"cmd": "GetAlarm", "action": 0, "param": {"Alarm": {"channel": channel, "type": "md"}}}]
elif cmd == "GetAiAlarm":
ch_body = []
for ai_type in self.ai_supported_types(channel):
ch_body.append({"cmd": "GetAiAlarm", "action": 0, "param": {"channel": channel, "ai_type": ai_type}})
elif cmd in ["GetEmail", "GetEmailV20"]:
if self.api_version("GetEmail") >= 1: