pyControl4 1.2.1__py3-none-any.whl → 1.4.0__py3-none-any.whl

pyControl4/alarm.py

@@ -1,5 +1,4 @@
-"""Controls Control4 security panel and contact sensor (door, window, motion) devices.
-"""
+"""Controls Control4 security panel and contact sensor (door, window, motion) devices."""
 
 import json
 from pyControl4 import C4Entity

pyControl4/blind.py

@@ -1,5 +1,4 @@
-"""Controls Control4 blind devices.
-"""
+"""Controls Control4 blind devices."""
 
 from pyControl4 import C4Entity
 

pyControl4/climate.py

@@ -0,0 +1,133 @@
+"""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 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},
+        )

pyControl4/director.py

@@ -1,5 +1,5 @@
 """Handles communication with a Control4 Director, and provides functions for
-   getting details about items on the Director.
+getting details about items on the Director.
 """
 
 import aiohttp

pyControl4/fan.py

@@ -0,0 +1,81 @@
+"""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},
+        )

pyControl4/light.py

@@ -1,5 +1,4 @@
-"""Controls Control4 Light devices.
-"""
+"""Controls Control4 Light devices."""
 
 from pyControl4 import C4Entity
 

pyControl4/relay.py

@@ -1,5 +1,4 @@
-"""Controls Control4 Relay devices. These can include locks, and potentially other types of devices.
-"""
+"""Controls Control4 Relay devices. These can include locks, and potentially other types of devices."""
 
 from pyControl4 import C4Entity
 

pyControl4/room.py

@@ -1,5 +1,4 @@
-"""Controls Control4 Room devices.
-"""
+"""Controls Control4 Room devices."""
 
 from pyControl4 import C4Entity
 

{pyControl4-1.2.1.dist-info → pycontrol4-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pyControl4
-Version: 1.2.1
+Version: 1.4.0
 Summary: Python 3 asyncio package for interacting with Control4 systems
 Home-page: https://github.com/lawtancool/pyControl4
 Author: lawtancool
@@ -15,6 +15,16 @@ Requires-Dist: aiohttp
 Requires-Dist: xmltodict
 Requires-Dist: python-socketio-v4
 Requires-Dist: websocket-client
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # pyControl4
 [![PyPI version](https://badge.fury.io/py/pyControl4.svg)](https://badge.fury.io/py/pyControl4)[![Downloads](https://pepy.tech/badge/pycontrol4)](https://pepy.tech/project/pycontrol4)

pycontrol4-1.4.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+pyControl4/__init__.py,sha256=JR6zFcZJ-M1o8g28gdU71uZHYzh-b21x7rg3EWrf3hg,394
+pyControl4/account.py,sha256=eyWkGaDla4_gLvv8GHBxmJ2iBMxpdY7ax53JryWOtcE,9760
+pyControl4/alarm.py,sha256=KcZreUOocncgoIoRVHl9ZL1zesrXuVYPfXVvDuUpXcs,7153
+pyControl4/blind.py,sha256=7Aat1FyT-OJyv_xES-ol2U-70nKpQbymGUfTTsB3VDk,4436
+pyControl4/climate.py,sha256=c2UEJWSti6DPNcwf5UL2JYpzf-X-fallhxhzGFEIxz8,4949
+pyControl4/director.py,sha256=QY6Re-fGgV-V340rTjpkSCfqvVRD_kbnDEHScoGJ0gk,10718
+pyControl4/error_handling.py,sha256=3VpZ4JsF5kgrSNASHYVEQVIJq_vs8kvMk0-bDsd_FXU,3866
+pyControl4/fan.py,sha256=MldA1E5VDkLJrS2Zp-5tUBEgPsUGYH7D6J-i2OdFJ5I,2140
+pyControl4/light.py,sha256=qc8AGFiM9wnS-gi1tecWGGBRo-9dPZzYBHvE0QenW8w,1587
+pyControl4/relay.py,sha256=GWYxdaB9sG3ixD87IY2yV3UKulIB7mkq1xyjxtUDW1Q,2225
+pyControl4/room.py,sha256=nGhVxTw1QjX3UFmFZEO8TYBPCUae-NqObuVTPShEkqs,5195
+pyControl4/websocket.py,sha256=9UsxO8tFUENuya1tzwTYk2haWnnDutUgQ5jTLTlr5dU,8823
+pycontrol4-1.4.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pycontrol4-1.4.0.dist-info/METADATA,sha256=-6Xbfy3fWMHePbDtBzkWFG6bCg03fWmJDu7yESsjD5U,3285
+pycontrol4-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pycontrol4-1.4.0.dist-info/top_level.txt,sha256=8hJWE4Vz6ySUM1pzgZQCyngE7zVDW8qp7qe_4JXKRpY,11
+pycontrol4-1.4.0.dist-info/RECORD,,

{pyControl4-1.2.1.dist-info → pycontrol4-1.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.0.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pyControl4-1.2.1.dist-info/RECORD

@@ -1,15 +0,0 @@
-pyControl4/__init__.py,sha256=JR6zFcZJ-M1o8g28gdU71uZHYzh-b21x7rg3EWrf3hg,394
-pyControl4/account.py,sha256=eyWkGaDla4_gLvv8GHBxmJ2iBMxpdY7ax53JryWOtcE,9760
-pyControl4/alarm.py,sha256=NHsrdzILMRf9-PdRIQr-7kZnsupcmH1o1khM3-iY08M,7154
-pyControl4/blind.py,sha256=lgiWMdw3xxPO2VZd-ozX6QMAnhdj5-Z07NGTF-Tj3Ao,4437
-pyControl4/director.py,sha256=dGsoPV88xO8FFtv59oNxYtNc1-3d1XhCdBqnaIBQ700,10721
-pyControl4/error_handling.py,sha256=3VpZ4JsF5kgrSNASHYVEQVIJq_vs8kvMk0-bDsd_FXU,3866
-pyControl4/light.py,sha256=gShT4QWhudVEYRWB0AGQYh-53FMwhuyjD6zUVXM142I,1588
-pyControl4/relay.py,sha256=O8dGVF2b2Gfi1623en9jDMPbUPESwavTt-AYdQhOIQ4,2226
-pyControl4/room.py,sha256=OyKoCyMst00RWSgNy7yBX9rS-0d2MUNd8_hvpJ-rSvg,5196
-pyControl4/websocket.py,sha256=9UsxO8tFUENuya1tzwTYk2haWnnDutUgQ5jTLTlr5dU,8823
-pyControl4-1.2.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyControl4-1.2.1.dist-info/METADATA,sha256=Zk_D_xb3o8fMeh46saxV0PwjvZA4uL9Zd09Pn6QdIuQ,3066
-pyControl4-1.2.1.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-pyControl4-1.2.1.dist-info/top_level.txt,sha256=8hJWE4Vz6ySUM1pzgZQCyngE7zVDW8qp7qe_4JXKRpY,11
-pyControl4-1.2.1.dist-info/RECORD,,