File: climate.py

package info (click to toggle)
pycontrol4 1.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 548 kB
  • sloc: python: 914; makefile: 2
file content (149 lines) | stat: -rw-r--r-- 5,522 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
"""Controls Control4 Climate Control devices."""

from pyControl4 import C4Entity


class C4Climate(C4Entity):
    # ------------------------
    # HVAC and Fan States
    # ------------------------

    async def getHVACState(self):
        """Returns the current HVAC state (e.g., on/off or active mode)."""
        return await self.director.getItemVariableValue(self.item_id, "HVAC_STATE")

    async def getFANState(self):
        """Returns the current power state of the fan (True=on, False=off)."""
        return await self.director.getItemVariableValue(self.item_id, "FAN_STATE")

    # ------------------------
    # Mode Getters
    # ------------------------

    async def getHVACMode(self):
        """Returns the currently active HVAC mode."""
        return await self.director.getItemVariableValue(self.item_id, "HVAC_MODE")

    async def getHVACModes(self):
        """Returns a list of supported HVAC modes."""
        return await self.director.getItemVariableValue(self.item_id, "HVAC_MODES_LIST")

    async def getFANMode(self):
        """Returns the currently active fan mode."""
        return await self.director.getItemVariableValue(self.item_id, "FAN_MODE")

    async def getFANModes(self):
        """Returns a list of supported fan modes."""
        return await self.director.getItemVariableValue(self.item_id, "FAN_MODES_LIST")

    async def getHoldMode(self):
        """Returns the currently active hold mode."""
        return await self.director.getItemVariableValue(self.item_id, "HOLD_MODE")

    async def getHoldModes(self):
        """Returns a list of supported hold modes."""
        return await self.director.getItemVariableValue(self.item_id, "HOLD_MODES_LIST")

    # ------------------------
    # Setpoint Getters
    # ------------------------

    async def getCoolSetpointF(self):
        """Returns the cooling setpoint temperature in Fahrenheit."""
        return await self.director.getItemVariableValue(self.item_id, "COOL_SETPOINT_F")

    async def getCoolSetpointC(self):
        """Returns the cooling setpoint temperature in Celsius."""
        return await self.director.getItemVariableValue(self.item_id, "COOL_SETPOINT_C")

    async def getHeatSetpointF(self):
        """Returns the heating setpoint temperature in Fahrenheit."""
        return await self.director.getItemVariableValue(self.item_id, "HEAT_SETPOINT_F")

    async def getHeatSetpointC(self):
        """Returns the heating setpoint temperature in Celsius."""
        return await self.director.getItemVariableValue(self.item_id, "HEAT_SETPOINT_C")

    # ------------------------
    # Sensor Readings
    # ------------------------

    async def getHumidity(self):
        """Returns the current humidity percentage."""
        return await self.director.getItemVariableValue(self.item_id, "HUMIDITY")

    async def getCurrentTemperatureF(self):
        """Returns the current ambient temperature in Fahrenheit."""
        return await self.director.getItemVariableValue(self.item_id, "TEMPERATURE_F")

    async def getCurrentTemperatureC(self):
        """Returns the current ambient temperature in Celsius."""
        return await self.director.getItemVariableValue(self.item_id, "TEMPERATURE_C")

    # ------------------------
    # Setters / Commands
    # ------------------------

    async def setCoolSetpointF(self, temp):
        """Sets the cooling setpoint temperature in Fahrenheit."""
        await self.director.sendPostRequest(
            f"/api/v1/items/{self.item_id}/commands",
            "SET_SETPOINT_COOL",
            {"FAHRENHEIT": temp},
        )

    async def setCoolSetpointC(self, temp):
        """Sets the cooling setpoint temperature in Celsius."""
        await self.director.sendPostRequest(
            f"/api/v1/items/{self.item_id}/commands",
            "SET_SETPOINT_COOL",
            {"CELSIUS": temp},
        )

    async def setHeatSetpointF(self, temp):
        """Sets the heating setpoint temperature in Fahrenheit."""
        await self.director.sendPostRequest(
            f"/api/v1/items/{self.item_id}/commands",
            "SET_SETPOINT_HEAT",
            {"FAHRENHEIT": temp},
        )

    async def setHeatSetpointC(self, temp):
        """Sets the heating setpoint temperature in Celsius."""
        await self.director.sendPostRequest(
            f"/api/v1/items/{self.item_id}/commands",
            "SET_SETPOINT_HEAT",
            {"CELSIUS": temp},
        )

    async def setHvacMode(self, mode):
        """Sets the HVAC operating mode (e.g., heat, cool, auto)."""
        await self.director.sendPostRequest(
            f"/api/v1/items/{self.item_id}/commands",
            "SET_MODE_HVAC",
            {"MODE": mode},
        )

    async def setFanMode(self, mode):
        """Sets the fan operating mode (e.g., auto, on, circulate)."""
        await self.director.sendPostRequest(
            f"/api/v1/items/{self.item_id}/commands",
            "SET_MODE_FAN",
            {"MODE": mode},
        )

    async def setPreset(self, preset):
        """Applies a predefined climate preset by name."""
        await self.director.sendPostRequest(
            f"/api/v1/items/{self.item_id}/commands",
            "SET_PRESET",
            {"NAME": preset},
        )

    async def setHoldMode(self, mode):
        """Sets the hold mode."""
        await self.director.sendPostRequest(
            f"/api/v1/items/{self.item_id}/commands",
            "SET_MODE_HOLD",
            {"MODE": mode},
        )