File: constants.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 (166 lines) | stat: -rw-r--r-- 3,880 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
"""Constants for Hunter Douglas Powerview hub."""

# used for is_supported functions
MOTION_VELOCITY = "velocity"
MOTION_JOG = "jog"
MOTION_CALIBRATE = "calibrate"
MOTION_FAVORITE = "heart"
FUNCTION_SET_POWER = "set_power"
FUNCTION_SCHEDULE = "schedule"
FUNCTION_REBOOT = "reboot"
FUNCTION_IDENTIFY = "identify"

# common across all API versions
HUB_NAME = "hubName"

ATTR_SCENE = "scene"
ATTR_SHADE = "shade"
ATTR_ROOM = "room"
ATTR_SCENE_MEMBER = "sceneMember"

ATTR_SHADE_DATA = "shadeData"
ATTR_SCENE_DATA = "sceneData"
SCENE_MEMBER_DATA = "sceneMemberData"
ATTR_ROOM_DATA = "roomData"

ATTR_ICON_ID = "iconId"
ATTR_COLOR_ID = "colorId"
ATTR_SCENE_ID = "sceneId"
ATTR_SHADE_ID = "shadeId"
ATTR_ROOM_ID = "roomId"

ATTR_ID = "id"
ATTR_TYPE = "type"
ATTR_NAME = "name"
ATTR_NAME_UNICODE = "name_unicode"

ATTR_SIGNAL_STRENGTH = "signalStrength"
ATTR_SIGNAL_STRENGTH_MAX = 4

FIRMWARE = "firmware"
FIRMWARE_NAME = "name"
FIRMWARE_REVISION = "revision"
FIRMWARE_SUB_REVISION = "subRevision"
FIRMWARE_BUILD = "build"
FIRMWARE_MAINPROCESSOR = "mainProcessor"

MAC_ADDRESS = "macAddress"
SERIAL_NUMBER = "serialNumber"

ATTR_CAPABILITIES = "capabilities"
ATTR_POSITIONS = "positions"

MOTION_STOP = "stop"

POWERTYPE_HARDWIRED = "Hardwired"
POWERTYPE_BATTERY = "Battery"
POWERTYPE_RECHARGABLE = "Rechargable"
# a "fixed" type is a value locked by the Shade and cannot be changed
POWERTYPE_FIXED_RECHARGABLE = "Rechargable-Fixed"
POWERTYPE_FIXED_HARDWIRED = "Hardwired-Fixed"

# using percentage based positions in aiopvapi v3
MIN_POSITION = 0
MID_POSITION = 50
MAX_POSITION = 100
CLOSED_POSITION = 0
# there are a number of shades (duette variety) that despite
# being closed visually, actually report a position that is not 0
# this number is generally below 491.5125, and if not a calibration
# can bring the shade within this realm
# essentially treat a v2 shade that reports a position of 491.5125 or
# less as closed. Still use percentage based for compatability
CLOSED_POSITION_V2 = 0.75

#types of power sources
BATTERY_KIND_HARDWIRED = 1
BATTERY_KIND_BATTERY = 2
BATTERY_KIND_RECHARGABLE = 3
BATTERY_KIND_FIXED_RECHARGABLE = 11
BATTERY_KIND_FIXED_HARDWIRED = 12

POWER_SOURCE_BATTERY = [2,3,11]
POWER_SOURCE_HARDWIRED = [1,12]

# v2
FWVERSION = "fwversion"
USER_DATA = "userData"

MID_POSITION_V2 = 32767
MAX_POSITION_V2 = 65535

SHADE_BATTERY_STRENGTH = "batteryStrength"
SHADE_BATTERY_STRENGTH_MAX = 200

POSKIND_PRIMARY = 1
POSKIND_SECONDARY = 2
POSKIND_TILT = 3

ATTR_BATTERY_KIND = "batteryKind"

ATTR_POSKIND1 = "posKind1"
ATTR_POSKIND2 = "posKind2"
ATTR_POSITION1 = "position1"
ATTR_POSITION2 = "position2"

ATTR_SCHEDULED_EVENT = "scheduledEvent"
ATTR_SCHEDULED_EVENT_DATA = "scheduledEventData"

ATTR_SHADE_IDS = "shadeIds"

POSITIONS_V2 = (
    (ATTR_POSITION1, ATTR_POSKIND1),
    (ATTR_POSITION2, ATTR_POSKIND2),
)

POWERTYPE_MAP_V2 = {
    POWERTYPE_HARDWIRED: 1,
    POWERTYPE_BATTERY: 2,
    POWERTYPE_RECHARGABLE: 3,
}

# v3
NETWORK_STATUS = "networkStatus"
CONFIG = "config"

SHADE_BATTERY_STATUS = "batteryStatus"
SHADE_BATTERY_STATUS_MAX = 3

ATTR_PTNAME = "ptName"
ATTR_POWER_TYPE = "powerType"

ATTR_ROOM_IDS = "roomIds"

ATTR_PRIMARY = "primary"
ATTR_SECONDARY = "secondary"
ATTR_TILT = "tilt"
ATTR_VELOCITY = "velocity"

POSITIONS_V3 = (
    ATTR_PRIMARY,
    ATTR_SECONDARY,
    ATTR_TILT,
    ATTR_VELOCITY,
)

POWERTYPE_MAP_V3 = {
    POWERTYPE_BATTERY: 0,
    POWERTYPE_HARDWIRED: 1,
    POWERTYPE_RECHARGABLE: 2,
    POWERTYPE_FIXED_RECHARGABLE: 11,
    POWERTYPE_FIXED_HARDWIRED: 12,
}

# Legacy (Gen1) where firmware needs to be hardcoded
DEFAULT_LEGACY_MAINPROCESSOR = {
    FIRMWARE_REVISION: 0,
    FIRMWARE_SUB_REVISION: 1,
    FIRMWARE_BUILD: 0,
    FIRMWARE_NAME: "PowerView Hub",
}

HUB_MODEL_MAPPING = {
    "PV_Gen3": "Powerview Generation 3",
    "PV Hub2.0": "Powerview Generation 2",
    "PowerView Hub": "Powerview Generation 1",
}