File: shade.py

package info (click to toggle)
python-aiopvapi 3.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 684 kB
  • sloc: python: 3,123; xml: 850; makefile: 5
file content (1190 lines) | stat: -rw-r--r-- 41,118 bytes parent folder | download
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
"""Shade class managing all shade types."""

from dataclasses import dataclass
import logging
from typing import Any

from aiopvapi.helpers.aiorequest import AioRequest, PvApiMaintenance
from aiopvapi.helpers.api_base import ApiResource
from aiopvapi.helpers.constants import (
    ATTR_BATTERY_KIND,
    ATTR_CAPABILITIES,
    ATTR_ID,
    ATTR_POSITION1,
    ATTR_POSITION2,
    ATTR_POSITIONS,
    ATTR_POSKIND1,
    ATTR_POSKIND2,
    ATTR_POWER_TYPE,
    ATTR_PRIMARY,
    ATTR_ROOM_ID,
    ATTR_SECONDARY,
    ATTR_SHADE,
    ATTR_SIGNAL_STRENGTH,
    ATTR_SIGNAL_STRENGTH_MAX,
    ATTR_TILT,
    ATTR_TYPE,
    CLOSED_POSITION,
    CLOSED_POSITION_V2,
    FIRMWARE,
    FIRMWARE_BUILD,
    FIRMWARE_REVISION,
    FIRMWARE_SUB_REVISION,
    FUNCTION_SET_POWER,
    MAX_POSITION,
    MAX_POSITION_V2,
    MID_POSITION,
    MIN_POSITION,
    MOTION_CALIBRATE,
    MOTION_FAVORITE,
    MOTION_JOG,
    MOTION_STOP,
    MOTION_VELOCITY,
    POSITIONS_V2,
    POSITIONS_V3,
    POSKIND_PRIMARY,
    POSKIND_SECONDARY,
    POSKIND_TILT,
    POWER_SOURCE_HARDWIRED,
    POWERTYPE_BATTERY,
    POWERTYPE_HARDWIRED,
    POWERTYPE_MAP_V2,
    POWERTYPE_MAP_V3,
    POWERTYPE_RECHARGABLE,
    SHADE_BATTERY_STATUS,
    SHADE_BATTERY_STRENGTH,
)
from aiopvapi.helpers.tools import join_path

_LOGGER = logging.getLogger(__name__)


@dataclass
class PowerviewCapabilities:
    """Capabilities available from Powerview."""

    primary: bool = False
    secondary: bool = False
    tilt_90: bool = False
    tilt_180: bool = False
    tilt_onclosed: bool = False
    tilt_anywhere: bool = False
    tilt_onsecondaryclosed: bool = False
    primary_inverted: bool = False
    secondary_inverted: bool = False
    secondary_overlapped: bool = False
    vertical: bool = False
    light: bool = False


@dataclass
class ShadeLimits:
    """Limits of a shade."""

    primary_min: int = MIN_POSITION
    primary_max: int = MAX_POSITION
    secondary_min: int = MIN_POSITION
    secondary_max: int = MAX_POSITION
    tilt_min: int = MIN_POSITION
    tilt_max: int = MAX_POSITION


@dataclass
class ShadePosition:
    """Positions for a powerview shade."""

    primary: int | float | None = None
    secondary: int | float | None = None
    tilt: int | float | None = None
    velocity: float | None = None  # float only a v3 only property


@dataclass
class ShadeType:
    """Shade information based on type and description."""

    type: int | str
    description: str


@dataclass
class ShadeCapability:
    """Shade capability information."""

    type: int | str
    capabilities: PowerviewCapabilities
    description: str


class BaseShade(ApiResource):
    """Basic shade class."""

    api_endpoint = "shades"

    shade_types: tuple[ShadeType] = (ShadeType(0, "undefined type"),)
    capability: ShadeCapability = ShadeCapability(
        -1, PowerviewCapabilities(primary=True), "undefined"
    )
    _open_position: ShadePosition = ShadePosition(primary=MAX_POSITION)
    _close_position: ShadePosition = ShadePosition(primary=MIN_POSITION)
    _open_position_tilt: ShadePosition = ShadePosition()
    _close_position_tilt: ShadePosition = ShadePosition()

    shade_limits: ShadeLimits = ShadeLimits()

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize Base shade."""
        self.shade_type = shade_type
        super().__init__(request, self.api_endpoint, raw_data=raw_data)

    def is_supported(self, function: str) -> bool:
        """Return if api supports this function."""
        if self.api_version >= 3:
            return function in (
                MOTION_JOG,
                MOTION_VELOCITY,
                MOTION_STOP
            )
        elif self.api_version == 2:
            return function in (
                MOTION_JOG,
                MOTION_CALIBRATE,
                MOTION_FAVORITE,
                MOTION_STOP,
                FUNCTION_SET_POWER,
            )
        else:
            return function in (
                MOTION_JOG,
                MOTION_CALIBRATE,
                MOTION_FAVORITE,
                FUNCTION_SET_POWER,
            )

    @property
    def current_position(self) -> ShadePosition:
        """Return the current position of the shade as a percentage."""
        position = self.raw_to_structured(self._raw_data)
        position = self.get_additional_positions(position)
        return position

    @property
    def room_id(self) -> int:
        """Return the room id of the shade."""
        return self._raw_data.get(ATTR_ROOM_ID)

    @property
    def type_id(self) -> int:
        """Return the type id of the shade."""
        return self._raw_data.get(ATTR_TYPE)

    @property
    def type_name(self) -> str:
        """Return the type name of the shade."""
        for shade in self.shade_types:
            if shade.type == self.type_id:
                return shade.description
        return self.type_id

    @property
    def firmware(self) -> str | None:
        """Return firmware string for the shade."""
        if FIRMWARE not in self.raw_data:
            return None
        firmware = self.raw_data[FIRMWARE]

        revision = firmware[FIRMWARE_REVISION]
        sub_revision = firmware[FIRMWARE_SUB_REVISION]
        build = firmware[FIRMWARE_BUILD]

        return f"{revision}.{sub_revision}.{build}"

    @property
    def url(self) -> str:
        """Return url for the shade."""
        return self._resource_path

    @property
    def open_position(self) -> ShadePosition:
        """Return the shade opened position."""
        return self._open_position

    @property
    def close_position(self) -> ShadePosition:
        """Return the shade closed position."""
        return self._close_position

    @property
    def open_position_tilt(self) -> ShadePosition:
        """Return the tilt opened position."""
        return self._open_position_tilt

    @property
    def close_position_tilt(self) -> ShadePosition:
        """Return the tilt closed position."""
        return self._close_position_tilt

    def percent_to_api(self, position: float, position_type: str) -> int | float:
        """Convert percentage based position to hunter douglas api position."""
        # get the possible maximum for the shade (some shades only allow 50% position)
        max_position_pct_mapping = {
            ATTR_PRIMARY: self.shade_limits.primary_max,
            ATTR_SECONDARY: self.shade_limits.secondary_max,
            ATTR_TILT: self.shade_limits.tilt_max,
        }

        max_position_pct = max_position_pct_mapping.get(position_type, 100)

        # ensure the position remains in range 0-100
        position = self.position_limit(position, position_type)

        # gen 3 takes 0.0 -> 1.0 (fractional perentage) - float
        if self.api_version >= 3:
            max_position_pct = max_position_pct / 100
            return round(position / 100 * max_position_pct, 2)

        # gen 2 requires conversion to 0-65335 - int
        max_position_pct = max_position_pct / 100 * MAX_POSITION_V2
        return int(position / 100 * max_position_pct)

    def api_to_percent(self, position: float, position_type: str) -> int:
        """Convert hunter douglas api based position to percentage based position."""
        # get the possible maximum for the shade (some shades only allow 50% position)
        max_position_pct_mapping = {
            ATTR_PRIMARY: self.shade_limits.primary_max,
            ATTR_SECONDARY: self.shade_limits.secondary_max,
            ATTR_TILT: self.shade_limits.tilt_max,
        }

        max_position_pct = max_position_pct_mapping.get(position_type, 100)

        # convert percentage based version of max positioning to api per version
        max_position_api = max_position_pct / 100
        if self.api_version < 3:
            max_position_api = MAX_POSITION_V2 * max_position_api

        percent = self.position_limit((position / max_position_api) * 100)
        return round(percent)

    def structured_to_raw(self, data: ShadePosition) -> dict[str, Any]:
        """Convert structured ShadePosition to API relevant dict."""
        _LOGGER.debug("Structured Data %s: %s", self.name, data)

        if self.api_version >= 3:
            # Gen 3 raw data creation
            raw = {ATTR_POSITIONS: {}}
            for position_type in POSITIONS_V3:
                if getattr(data, position_type) is not None:
                    raw[ATTR_POSITIONS][position_type] = self.percent_to_api(
                        getattr(data, position_type), position_type
                    )

        else:
            # Gen 2 raw data creation
            position_data = {}
            if data.primary is not None:
                # primary is always in position 1
                position_data[ATTR_POSKIND1] = POSKIND_PRIMARY
                position_data[ATTR_POSITION1] = self.percent_to_api(
                    data.primary, ATTR_PRIMARY
                )
            if data.secondary is not None:
                poskind = ATTR_POSKIND2
                position = ATTR_POSITION2
                if data.primary is None:
                    # if no primary, secondary should be in position 1 (its a legacy thing)
                    poskind = ATTR_POSKIND1
                    position = ATTR_POSITION1
                position_data[poskind] = POSKIND_SECONDARY
                position_data[position] = self.percent_to_api(
                    data.secondary, ATTR_SECONDARY
                )
            if data.tilt is not None:
                if data.primary is not None and data.secondary is not None:
                    # if both primary and secondary exist than tilt cannot be sent
                    _LOGGER.debug(
                        "Legacy only accepts 2 positions. Tilt ignored %s", data
                    )
                elif data.primary is not None or data.secondary is not None:
                    # if primary or secondary exist move tilt to position 2 (its a legacy thing)
                    position_data[ATTR_POSKIND2] = POSKIND_TILT
                    position_data[ATTR_POSITION2] = self.percent_to_api(
                        data.tilt, ATTR_TILT
                    )
                else:
                    position_data[ATTR_POSKIND1] = POSKIND_TILT
                    position_data[ATTR_POSITION1] = self.percent_to_api(
                        data.tilt, ATTR_TILT
                    )

            raw = {ATTR_SHADE: {ATTR_ID: self.id, ATTR_POSITIONS: position_data}}

        _LOGGER.debug("Raw Conversion %s: %s", self.name, raw)
        return raw

    def raw_to_structured(self, shade_data: dict[int | str, Any]) -> ShadePosition:
        """Convert API dict info to structured ShadePosition dataclass."""
        _LOGGER.debug("Raw Data %s: %s", self.name, shade_data)

        if ATTR_POSITIONS not in shade_data:
            return ShadePosition()

        position_data = shade_data[ATTR_POSITIONS]

        position = ShadePosition()
        if self.api_version >= 3:
            for position_key in POSITIONS_V3:
                if position_key in position_data:
                    setattr(
                        position,
                        position_key,
                        self.api_to_percent(
                            float(position_data[position_key] or 0), position_key
                        ),
                    )

        else:
            position_mapping = {
                POSKIND_PRIMARY: ATTR_PRIMARY,
                POSKIND_SECONDARY: ATTR_SECONDARY,
                POSKIND_TILT: ATTR_TILT,
            }

            for position_key, poskind_key in POSITIONS_V2:
                if poskind_key in position_data:
                    target_key = position_mapping.get(position_data[poskind_key])
                    setattr(
                        position,
                        target_key,
                        self.api_to_percent(
                            float(position_data[position_key] or 0), target_key
                        ),
                    )

        _LOGGER.debug("Structured Conversion %s: %s", self.name, position)
        return position

    def _create_shade_data(self, position_data=None, room_id=None):
        """Create a shade data object to be sent to the hub."""
        if self.api_version >= 3:
            return {"positions": position_data}

        base = {ATTR_SHADE: {ATTR_ID: self.id}}
        if position_data:
            base[ATTR_SHADE][ATTR_POSITIONS] = position_data
        if room_id:
            base[ATTR_SHADE][ATTR_ROOM_ID] = room_id
        return base

    async def move_raw(self, position_data: dict):
        """Move the shade to a set position using raw data."""
        _LOGGER.debug("Shade %s move to: %s", self.name, position_data)
        data = self._create_shade_data(position_data=position_data)
        return await self._move(data)

    async def _move(self, position_data: dict):
        params = {}
        resource_path = self._resource_path
        if self.api_version >= 3:
            # IDs are required in request params for gen 3.
            params = {"ids": self.id}
            resource_path = join_path(self.base_path, "positions")
        result = await self.request.put(
            resource_path, data=position_data, params=params
        )
        return result

    async def move(self, position_data: ShadePosition) -> ShadePosition:
        """Move the shade to a set position."""
        _LOGGER.debug("Shade %s move to: %s", self.name, position_data)
        data = self.structured_to_raw(position_data)
        await self._move(data)
        return self.current_position

    def get_additional_positions(self, positions: ShadePosition) -> ShadePosition:
        """Return additional positions not reported by the hub."""
        return positions

    async def open(self):
        """Open the shade."""
        return await self.move(position_data=self.open_position)

    async def close(self):
        """Close the shade."""
        return await self.move(position_data=self.close_position)

    def position_limit(self, position: int, position_type: str = ""):
        """Limit values that can be calculated."""
        # determine the absolute position for the particular shade
        limits = {
            ATTR_PRIMARY: (
                self.shade_limits.primary_min,
                self.shade_limits.primary_max,
            ),
            ATTR_SECONDARY: (
                self.shade_limits.secondary_min,
                self.shade_limits.secondary_max,
            ),
            ATTR_TILT: (self.shade_limits.tilt_min, self.shade_limits.tilt_max),
        }

        min_limit, max_limit = limits.get(position_type, (0, 100))

        if self.api_version < 3 and position != 0 and position < CLOSED_POSITION_V2:
            _LOGGER.debug(
                "%s: Assuming shade is closed as %s is less than %s",
                self.name,
                position,
                CLOSED_POSITION,
            )
            position = CLOSED_POSITION

        return min(max(min_limit, position), max_limit)

    async def _motion(self, motion):
        if self.api_version >= 3:
            path = join_path(self._resource_path, "motion")
            cmd = {"motion": motion}
        else:
            path = self._resource_path
            cmd = {"shade": {"motion": motion}}
        await self.request.put(path, cmd)

    async def jog(self):
        """Jog the shade."""
        await self._motion(MOTION_JOG)

    async def calibrate(self):
        """Calibrate the shade."""
        await self._motion(MOTION_CALIBRATE)

    async def favorite(self):
        """Move the shade to the defined favorite position."""
        await self._motion(MOTION_FAVORITE)

    async def stop(self):
        """Stop the shade."""
        if not self.is_supported(MOTION_STOP):
            _LOGGER.error("Method not supported")
            return

        if self.api_version >= 3:
            await self.request.put(
                join_path(self.base_path, MOTION_STOP), params={"ids": self.id}
            )
        else:
            await self._motion(MOTION_STOP)

    async def add_shade_to_room(self, room_id):
        """Add shade to room."""
        data = self._create_shade_data(room_id=room_id)
        return await self.request.put(self._resource_path, data)

    async def refresh(self, suppress_timeout: bool = False, **kwargs):
        """Query the hub and refresh the most recent position state.

        :param kwargs: Keyword arguments to be passed to the get request.
                   For example, timeout can be passed as kwargs.
        """
        try:
            _LOGGER.debug("Refreshing position of: %s", self.name)
            raw_data = await self.request.get(
                self._resource_path,
                {"refresh": "true"},
                suppress_timeout=suppress_timeout,
                **kwargs,
            )
            if raw_data is None:
                _LOGGER.debug("No update received for: %s", self.name)
                return
            # Gen <= 2 API has raw data under shade key.  Gen >= 3 API this is flattened.
            self._raw_data = raw_data.get(ATTR_SHADE, raw_data)
        except PvApiMaintenance:
            _LOGGER.debug("Hub undergoing maintenance. Please try again")
        return

    async def refresh_battery(self, suppress_timeout: bool = False, **kwargs):
        """Query the hub and request the most recent battery state.

        :param kwargs: Keyword arguments to be passed to the get request.
                   For example, timeout can be passed as kwargs.
        """
        try:
            _LOGGER.debug("Refreshing battery of: %s", self.name)
            raw_data = await self.request.get(
                self._resource_path,
                {"updateBatteryLevel": "true"},
                suppress_timeout=suppress_timeout,
                **kwargs,
            )
            # Gen <= 2 API has raw data under shade key.  Gen >= 3 API this is flattened.
            if raw_data is None:
                _LOGGER.debug("No update received for: %s", self.name)
                return
            self._raw_data = raw_data.get(ATTR_SHADE, raw_data)
        except PvApiMaintenance:
            _LOGGER.debug("Hub undergoing maintenance. Please try again")
        return

    def has_battery_info(self) -> bool:
        """Confirm if the shade has battery info."""
        if self.api_version >= 3:
            return bool(SHADE_BATTERY_STATUS in self.raw_data)
        return bool(SHADE_BATTERY_STRENGTH in self.raw_data)

    def get_battery_info(self) -> int:
        """Return the battery powerType."""
        attr = ATTR_POWER_TYPE if self.api_version >= 3 else ATTR_BATTERY_KIND
        return self.raw_data.get(attr)

    def is_battery_powered(self) -> bool:
        """Confirm if the shade is battery or hardwired."""
        return bool(self.get_battery_info() not in POWER_SOURCE_HARDWIRED)

    def supported_power_sources(self) -> list[str]:
        """List supported power sources."""
        return [POWERTYPE_HARDWIRED, POWERTYPE_BATTERY, POWERTYPE_RECHARGABLE]

    def get_power_source(self) -> str:
        """Get from the hub the type of power source."""
        version_map = POWERTYPE_MAP_V3 if self.api_version >= 3 else POWERTYPE_MAP_V2
        attr = ATTR_POWER_TYPE if self.api_version >= 3 else ATTR_BATTERY_KIND
        powertype_map = {v: k for k, v in version_map.items()}

        raw_num = self.raw_data.get(attr)
        battery_type = powertype_map.get(raw_num, None)
        _LOGGER.debug("%s: Mapping %s %s to %s", self.name, attr, raw_num, battery_type)
        return battery_type

    async def set_power_source(self, power_source):
        """Update the hub with the type of power source."""
        if not self.is_supported(FUNCTION_SET_POWER):
            _LOGGER.error("Method not supported")
            return

        if power_source not in (supported := self.supported_power_sources()):
            _LOGGER.error("Unsupported Power Source. Accepted values: %s", supported)
            return

        version_map = POWERTYPE_MAP_V3 if self.api_version >= 3 else POWERTYPE_MAP_V2
        attr = ATTR_POWER_TYPE if self.api_version >= 3 else ATTR_BATTERY_KIND
        await self.request.put(
            self._resource_path,
            data={"shade": {attr: version_map.get(power_source)}},
        )

    def get_battery_strength(self) -> int:
        """Get battery strength from raw_data and return as a percentage."""
        power_levels = {
            4: 100,  # 4 is hardwired
            3: 100,  # 3 = 100% to 51% power remaining
            2: 50,  # 2 = 50% to 21% power remaining
            1: 20,  # 1 = 20% or less power remaining
            0: 0,  # 0 = No power remaining
        }
        battery_status = self.raw_data[SHADE_BATTERY_STATUS]
        return power_levels.get(battery_status, 0)

    def has_signal_strength(self) -> bool:
        """Confirm if the shade has signal data."""
        return bool(ATTR_SIGNAL_STRENGTH in self.raw_data)

    def get_signal_strength(self) -> int | str:
        """Get signal strength from raw_data.

        :v3 is RSSI
        :v2 is calculated as a percentage
        """
        if self.api_version >= 3:
            return self.raw_data[ATTR_SIGNAL_STRENGTH]
        return round(
            self.raw_data[ATTR_SIGNAL_STRENGTH] / ATTR_SIGNAL_STRENGTH_MAX * 100
        )

    async def get_current_position_raw(self, refresh=True) -> dict:
        """Return the current shade position.

        :param refresh: If True it queries the hub for the latest info.
        :return: Dictionary with position data.
        """
        if refresh:
            await self.refresh()
        position = self._raw_data.get(ATTR_POSITIONS)
        return position

    async def get_current_position(self, refresh=True) -> ShadePosition:
        """Return the current shade position.

        :param refresh: If True it queries the hub for the latest info.
        :return: Dictionary with position data.
        """
        await self.get_current_position_raw(refresh)
        return self.raw_to_structured(self._raw_data)


class BaseShadeTilt(BaseShade):
    """A shade with move and tilt at bottom capabilities."""

    # even for shades that can 180° tilt, this would just result in
    # two closed positions. 90° will always be the open position

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with tilt."""
        super().__init__(raw_data, shade_type, request)
        self._open_position_tilt = ShadePosition(tilt=MAX_POSITION)
        self._close_position_tilt = ShadePosition(tilt=MIN_POSITION)
        if self.api_version < 3:
            self._open_position_tilt = ShadePosition(tilt=MID_POSITION)

    async def tilt_raw(self, position_data):
        """Tilt the shade to a set position using raw data."""
        _LOGGER.debug("Shade %s tilt to: %s", self.name, position_data)
        data = self._create_shade_data(position_data=position_data)
        return await self._move(data)

    async def tilt(self, position_data: ShadePosition):
        """Tilt the shade to a set position."""
        _LOGGER.debug("Shade %s move to: %s", self.name, position_data)
        data = self.structured_to_raw(position_data)
        await self._move(data)
        return self.current_position

    async def tilt_open(self):
        """Tilt to open position."""
        return await self.tilt(position_data=self.open_position_tilt)

    async def tilt_close(self):
        """Tilt to close position."""
        return await self.tilt(position_data=self.close_position_tilt)

    def get_additional_positions(self, positions: ShadePosition) -> ShadePosition:
        """Return additional positions not reported by the hub."""
        if positions.primary is not None and positions.tilt is None:
            positions.tilt = MIN_POSITION
        elif positions.tilt is not None and positions.primary is None:
            positions.primary = MIN_POSITION
        return positions


class ShadeBottomUp(BaseShade):
    """Type 0 - Up Down Only.

    A simple open/close shade.
    """

    shade_types = (
        ShadeType(1, "Designer Roller"),
        ShadeType(4, "Roman"),
        ShadeType(5, "Bottom Up"),
        ShadeType(6, "Duette"),
        ShadeType(10, "Duette and Applause SkyLift"),
        ShadeType(19, "Provenance Woven Wood"),
        ShadeType(31, "Vignette"),
        ShadeType(32, "Vignette"),
        ShadeType(42, "M25T Roller Blind"),
        ShadeType(49, "AC Roller"),
        ShadeType(52, "Banded Shades"),
        ShadeType(53, "Sonnette"),
        ShadeType(84, "Vignette"),
    )

    capability = ShadeCapability(
        0,
        PowerviewCapabilities(
            primary=True,
        ),
        "Bottom Up",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize Standard Bottom Up shade."""
        super().__init__(raw_data, shade_type, request)
        self._open_position = ShadePosition(primary=MAX_POSITION)
        self._close_position = ShadePosition(primary=MIN_POSITION)


class ShadeBottomUpTiltOnClosed180(BaseShadeTilt):
    """Type 0 - Up Down tiltOnClosed 180°.

    A shade with move and tilt at when closed capabilities.
    These are believed to be an oversight by the HD Powerview team and the
    only model without a distinct capability code.
    """

    shade_types = (ShadeType(44, "Twist"),)

    # via json these have capability 0
    # overriding to 1 to trick HA into providing tilt functionality
    # only difference is these have 180 tilt
    capability = ShadeCapability(
        1,
        PowerviewCapabilities(
            primary=True,
            tilt_onclosed=True,
            tilt_180=True,
        ),
        "Bottom Up TiltOnClosed 180°",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with tilt on closed functions."""
        super().__init__(raw_data, shade_type, request)
        self._open_position = ShadePosition(primary=MAX_POSITION)
        self._close_position = ShadePosition(primary=MIN_POSITION)
        self._open_position_tilt = ShadePosition(tilt=MAX_POSITION)
        self._close_position_tilt = ShadePosition(tilt=MIN_POSITION)
        if self.api_version < 3:
            self._open_position_tilt = ShadePosition(tilt=MID_POSITION)


class ShadeBottomUpTiltOnClosed90(BaseShadeTilt):
    """Type 1 - Up Down tiltOnClosed 90°.

    A shade with move and tilt at bottom capabilities with only a 90° tilt.
    """

    shade_types = (
        ShadeType(18, "Pirouette"),
        ShadeType(23, "Silhouette"),
        ShadeType(43, "Facette"),
    )

    capability = ShadeCapability(
        1,
        PowerviewCapabilities(
            primary=True,
            tilt_onclosed=True,
            tilt_90=True,
        ),
        "Bottom Up TiltOnClosed 90°",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with tilt on closed functions."""
        super().__init__(raw_data, shade_type, request)
        self.shade_limits = ShadeLimits(tilt_max=MAX_POSITION)
        self._open_position = ShadePosition(primary=MAX_POSITION)
        self._close_position = ShadePosition(primary=MIN_POSITION)
        self._open_position_tilt = ShadePosition(tilt=MAX_POSITION)
        self._close_position_tilt = ShadePosition(tilt=MIN_POSITION)
        if self.api_version < 3:
            self.shade_limits = ShadeLimits(tilt_max=MID_POSITION)
            self._open_position_tilt = ShadePosition(tilt=MID_POSITION)


class ShadeBottomUpTiltAnywhere(BaseShadeTilt):
    """Type 2 - Up Down tiltAnywhere 180°.

    A shade with move and tilt anywhere capabilities.
    """

    shade_types = (
        ShadeType(51, "Venetian, Tilt Anywhere"),
        ShadeType(62, "Venetian, Tilt Anywhere"),
    )

    capability = ShadeCapability(
        2,
        PowerviewCapabilities(
            primary=True,
            tilt_anywhere=True,
            tilt_180=True,
        ),
        "Bottom Up TiltAnywhere 180°",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with tilt anywhere."""
        super().__init__(raw_data, shade_type, request)
        self._open_position = ShadePosition(primary=MAX_POSITION, tilt=MAX_POSITION)
        self._close_position = ShadePosition(primary=MIN_POSITION, tilt=MAX_POSITION)
        self._open_position_tilt = ShadePosition(tilt=MAX_POSITION)
        self._close_position_tilt = ShadePosition(tilt=MIN_POSITION)
        if self.api_version < 3:
            self._open_position = ShadePosition(primary=MAX_POSITION, tilt=MID_POSITION)
            self._close_position = ShadePosition(primary=MIN_POSITION, tilt=MID_POSITION)
            self._open_position_tilt = ShadePosition(tilt=MID_POSITION)


class ShadeVertical(ShadeBottomUp):
    """Type 3 - Vertical Open Close.

    A vertical shade with open/close only
    Same capabilities as type 0 (no tilt) but vertical.
    """

    shade_types = (
        ShadeType(26, "Skyline Panel, Left Stack"),
        ShadeType(27, "Skyline Panel, Right Stack"),
        ShadeType(28, "Skyline Panel, Split Stack"),
        ShadeType(69, "Curtain, Left Stack"),
        ShadeType(70, "Curtain, Right Stack"),
        ShadeType(71, "Curtain, Split Stack"),
    )

    capability = ShadeCapability(
        3,
        PowerviewCapabilities(
            primary=True,
            vertical=True,
        ),
        "Vertical",
    )


class ShadeVerticalTiltAnywhere(ShadeBottomUpTiltAnywhere):
    """Type 4 - Vertical tiltAnywhere 180°.

    A vertical shade with open/close and tilt anywhere
    Same capabilities as type 2 but vertical.
    """

    shade_types = (
        ShadeType(54, "Vertical Slats, Left Stack"),
        ShadeType(55, "Vertical Slats, Right Stack"),
        ShadeType(56, "Vertical Slats, Split Stack"),
    )

    capability = ShadeCapability(
        4,
        PowerviewCapabilities(
            primary=True,
            tilt_anywhere=True,
            tilt_180=True,
            vertical=True,
        ),
        "Vertical Tilt Anywhere",
    )

    def get_additional_positions(self, positions: ShadePosition) -> ShadePosition:
        """Return additional positions not reported by the hub."""
        if positions.primary is None:
            positions.primary = MIN_POSITION
        if positions.tilt is None:
            positions.tilt = MIN_POSITION
        return positions


class ShadeTiltOnly(BaseShadeTilt):
    """Type 5 - Tilt Only 180°.

    A shade with tilt anywhere capabilities only.
    """

    shade_types = (ShadeType(66, "Palm Beach Shutters"),)

    capability = ShadeCapability(
        5,
        PowerviewCapabilities(
            tilt_anywhere=True,
            tilt_180=True,
        ),
        "Tilt Only 180°",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with tilt only."""
        super().__init__(raw_data, shade_type, request)
        self._open_position = ShadePosition()
        self._close_position = ShadePosition()
        self._open_position_tilt = ShadePosition(tilt=MID_POSITION)
        self._close_position_tilt = ShadePosition(tilt=MIN_POSITION)

    def get_additional_positions(self, positions: ShadePosition) -> ShadePosition:
        """Return additional positions not reported by the hub."""
        return positions


class ShadeTopDown(BaseShade):
    """Type 6 - Top Down Only.

    A shade with top down capabilities only.
    """

    shade_types = (ShadeType(7, "Top Down"),)

    capability = ShadeCapability(
        6,
        PowerviewCapabilities(
            primary=True,
            primary_inverted=True,
        ),
        "Top Down",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with top down only."""
        super().__init__(raw_data, shade_type, request)
        self._open_position = ShadePosition(primary=MIN_POSITION)
        self._close_position = ShadePosition(primary=MAX_POSITION)


class ShadeTopDownBottomUp(BaseShade):
    """Type 7 - Top Down Bottom Up.

    A shade with top down bottom up capabilities.
    """

    shade_types = (
        ShadeType(8, "Duette, Top Down Bottom Up"),
        ShadeType(9, "Duette DuoLite, Top Down Bottom Up"),
        ShadeType(33, "Duette Architella, Top Down Bottom Up"),
        ShadeType(47, "Pleated, Top Down Bottom Up"),
    )

    capability = ShadeCapability(
        7,
        PowerviewCapabilities(
            primary=True,
            secondary=True,
        ),
        "Top Down Bottom Up",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with top down bottom up."""
        super().__init__(raw_data, shade_type, request)
        self._open_position = ShadePosition(primary=MAX_POSITION, secondary=MIN_POSITION)
        self._close_position = ShadePosition(primary=MIN_POSITION, secondary=MIN_POSITION)

    def get_additional_positions(self, positions: ShadePosition) -> ShadePosition:
        """Return additional positions not reported by the hub."""
        if positions.primary is None:
            positions.primary = MIN_POSITION
        if positions.secondary is None:
            positions.secondary = MIN_POSITION
        return positions


class ShadeDualOverlapped(BaseShade):
    """Type 8 - Dual Shade Overlapped.

    A shade with a front sheer and rear blackout shade.
    """

    shade_types = (
        ShadeType(65, "Vignette Duolite"),
        ShadeType(79, "Duolite Lift"),
    )

    capability = ShadeCapability(
        8,
        PowerviewCapabilities(
            primary=True,
            secondary=True,
            secondary_overlapped=True,
        ),
        "Dual Shade Overlapped",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with sheer front and rear blockout."""
        super().__init__(raw_data, shade_type, request)
        self._open_position = ShadePosition(primary=MAX_POSITION)
        self._close_position = ShadePosition(secondary=MIN_POSITION)

    def get_additional_positions(self, positions: ShadePosition) -> ShadePosition:
        """Return additional positions not reported by the hub."""
        if positions.primary is not None:
            if positions.secondary is None:
                positions.secondary = MAX_POSITION
            if positions.tilt is None:
                positions.tilt = MIN_POSITION
        elif positions.secondary is not None:
            if positions.primary is None:
                positions.primary = MIN_POSITION
            if positions.tilt is None:
                positions.tilt = MIN_POSITION
        elif positions.tilt is not None:
            if positions.primary is None:
                positions.primary = MIN_POSITION
            if positions.secondary is None:
                positions.secondary = MAX_POSITION
        return positions


class ShadeDualOverlappedTilt90(BaseShadeTilt):
    """Type 9 - Dual Shade Overlapped with tiltOnClosed.

    A shade with a front sheer and rear blackout shade.
    Tilt on these is unique in that it requires the rear shade open and front shade closed.
    """

    shade_types = (ShadeType(38, "Silhouette Duolite"),)

    capability = ShadeCapability(
        9,
        PowerviewCapabilities(
            primary=True,
            secondary=True,
            secondary_overlapped=True,
            tilt_90=True,
            tilt_onclosed=True,
        ),
        "Dual Shade Overlapped Tilt 90°",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with sheer front and rear blockout + tilt."""
        super().__init__(raw_data, shade_type, request)
        self.shade_limits = ShadeLimits(tilt_max=MAX_POSITION)
        self._open_position = ShadePosition(primary=MAX_POSITION)
        self._close_position = ShadePosition(secondary=MIN_POSITION)
        self._open_position_tilt = ShadePosition(tilt=MAX_POSITION)
        self._close_position_tilt = ShadePosition(tilt=MIN_POSITION)
        if self.api_version < 3:
            self.shade_limits = ShadeLimits(tilt_max=MID_POSITION)
            self._open_position_tilt = ShadePosition(tilt=MID_POSITION)

    def get_additional_positions(self, positions: ShadePosition) -> ShadePosition:
        """Return additional positions not reported by the hub."""
        if positions.primary is not None:
            if positions.secondary is None:
                positions.secondary = MAX_POSITION
            if positions.tilt is None:
                positions.tilt = MIN_POSITION
        elif positions.secondary is not None:
            if positions.primary is None:
                positions.primary = MIN_POSITION
            if positions.tilt is None:
                positions.tilt = MIN_POSITION
        elif positions.tilt is not None:
            if positions.primary is None:
                positions.primary = MIN_POSITION
            if positions.secondary is None:
                positions.secondary = MAX_POSITION
        return positions


class ShadeDualOverlappedTilt180(ShadeDualOverlappedTilt90):
    """Type 10 - Dual Shade Overlapped with tiltOnClosed.

    A shade with a front sheer and rear blackout shade.
    Tilt on these is unique in that it requires the rear shade open and front shade closed.
    """

    shade_types = ()

    capability = ShadeCapability(
        10,
        PowerviewCapabilities(
            primary=True,
            secondary=True,
            secondary_overlapped=True,
            tilt_180=True,
            tilt_onclosed=True,
        ),
        "Dual Shade Overlapped Tilt 180°",
    )

    def __init__(
        self, raw_data: dict, shade_type: ShadeType, request: AioRequest
    ) -> None:
        """Initialize shade with sheer front and rear blockout + tilt."""
        super().__init__(raw_data, shade_type, request)
        if self.api_version < 3:
            self.shade_limits = ShadeLimits(tilt_max=MAX_POSITION)


class ShadeDualOverlappedIlluminated(ShadeDualOverlapped):
    """Type 11 - Illuminated Shades.

    A shade with a front sheer and rear blackout shade, plus an embedded light.
    """

    shade_types = (
        ShadeType(95, "Aura Illuminated, Roller"), #Capabilites 11 to be implemented
    )

    capability = ShadeCapability(
        11,
        PowerviewCapabilities(
            primary=True,
            secondary=True,
            secondary_overlapped=True,
            light=True
        ),
        "Illuminated Shades",
    )


def factory(raw_data: dict, request: AioRequest):
    """Class factory to create different shade types."""

    if ATTR_SHADE in raw_data:
        raw_data = raw_data.get(ATTR_SHADE)

    raw_type = raw_data.get(ATTR_TYPE)

    def find_type(shade: BaseShade):
        for type_def in shade.shade_types:
            if type_def.type == raw_type:
                return shade(raw_data, type_def, request)
        return None

    shade_capability = raw_data.get(ATTR_CAPABILITIES)

    def find_capability(shade: BaseShade):
        if shade.capability.type == shade_capability:
            return shade(raw_data, shade, request)
        return None

    classes = [
        ShadeBottomUp,
        ShadeBottomUpTiltOnClosed90,
        ShadeBottomUpTiltOnClosed180,  # to ensure capability match order here is important
        ShadeBottomUpTiltAnywhere,
        ShadeVerticalTiltAnywhere,
        ShadeVertical,
        ShadeTiltOnly,
        ShadeTopDown,
        ShadeTopDownBottomUp,
        ShadeDualOverlapped,
        ShadeDualOverlappedTilt90,
        ShadeDualOverlappedTilt180,
        ShadeDualOverlappedIlluminated,
    ]

    for cls in classes:
        # class check is more concise as we have tested positioning
        _shade = find_type(cls)
        if _shade:
            _LOGGER.debug("Shade match on type: %s - %s", _shade, raw_data)
            return _shade

    for cls in classes:
        # fallback to a capability check - this should future proof new shades
        # type 0 that contain tilt would not be caught here
        _shade = find_capability(cls)
        if _shade:
            _LOGGER.debug("Shade match on capability: %s - %s", _shade, raw_data)
            return _shade

    _LOGGER.warning(
        "Shade type not found. Falling back to basic bottom up capabilities: %s - %s",
        BaseShade,
        raw_data,
    )
    return BaseShade(raw_data, BaseShade.shade_types[0], request)