Merge pull request #33 from granvillebarker/add-c4-climate-and-fan

Add c4 climate and fan

Author: lawtancool

pyControl4/climate.py

@@ -0,0 +1,119 @@
+"""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")
+
+    # ------------------------
+    # 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 getHeatSetpointF(self):
+        """Returns the heating setpoint temperature in Fahrenheit."""
+        return await self.director.getItemVariableValue(self.item_id,
+                                                        "HEAT_SETPOINT_F")
+
+    # ------------------------
+    # Sensor Readings
+    # ------------------------
+
+    async def getHumidity(self):
+        """Returns the current humidity percentage."""
+        return await self.director.getItemVariableValue(self.item_id,
+                                                        "HUMIDITY")
+
+    async def getCurrentTemperature(self):
+        """Returns the current ambient temperature in Fahrenheit."""
+        return await self.director.getItemVariableValue(self.item_id,
+                                                        "TEMPERATURE_F")
+
+    # ------------------------
+    # Setters / Commands
+    # ------------------------
+
+    async def setTemperature(self, temp):
+        """Sets the cooling setpoint temperature in Fahrenheit."""
+        await self.setCoolSetpoint(temp)  # Delegates to the proper method
+
+    async def setCoolSetpoint(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 setHeatSetpoint(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 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},
+        )

pyControl4/fan.py

@@ -0,0 +1,82 @@
+"""Controls Control4 Fan devices."""
+
+from pyControl4 import C4Entity
+
+
+class C4Fan(C4Entity):
+    # ------------------------
+    # Fan State Getters
+    # ------------------------
+
+    async def getState(self):
+        """
+        Returns the current power state of the fan.
+
+        Returns:
+            bool: True if the fan is on, False otherwise.
+        """
+        value = await self.director.getItemVariableValue(self.item_id, "IS_ON")
+        return bool(value)
+
+    async def getSpeed(self):
+        """
+        Returns the current speed of the fan controller.
+
+        Valid speed values:
+            0 - Off
+            1 - Low
+            2 - Medium
+            3 - Medium High
+            4 - High
+
+        Note:
+            Only valid for fan controllers. On non-dimmer switches,
+            use `getState()` instead.
+
+        Returns:
+            int: Current fan speed (0–4).
+        """
+        value = await self.director.getItemVariableValue(self.item_id,
+                                                         "CURRENT_SPEED")
+        return int(value)
+
+    # ------------------------
+    # Fan Control Setters
+    # ------------------------
+
+    async def setSpeed(self, speed: int):
+        """
+        Sets the fan speed or turns it off.
+
+        Parameters:
+            speed (int): Fan speed level:
+                0 - Off
+                1 - Low
+                2 - Medium
+                3 - Medium High
+                4 - High
+        """
+        await self.director.sendPostRequest(
+            f"/api/v1/items/{self.item_id}/commands",
+            "SET_SPEED",
+            {"SPEED": speed},
+        )
+
+    async def setPreset(self, preset: int):
+        """
+        Sets the fan's preset speed — the speed used when the fan is
+        turned on without specifying speed.
+
+        Parameters:
+            preset (int): Preset fan speed level:
+                0 - Off
+                1 - Low
+                2 - Medium
+                3 - Medium High
+                4 - High
+        """
+        await self.director.sendPostRequest(
+            f"/api/v1/items/{self.item_id}/commands",
+            "DESIGNATE_PRESET",
+            {"PRESET": preset},
+        )