-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
065485f
commit f224e95
Showing
8 changed files
with
178 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
class C4Entity: | ||
def __init__(self, C4Director, item_id): | ||
"""Creates a Control4 object. | ||
Parameters: | ||
`C4Director` - A `pyControl4.director.C4Director` object that corresponds to the Control4 Director that the device is connected to. | ||
`item_id` - The Control4 item ID. | ||
""" | ||
self.director = C4Director | ||
self.item_id = int(item_id) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
"""Controls Control4 Room devices. | ||
""" | ||
|
||
|
||
from pyControl4 import C4Entity | ||
|
||
|
||
class C4Room(C4Entity): | ||
""" | ||
A media-oriented view of a Control4 Room, supporting items of type="room" | ||
""" | ||
|
||
async def isRoomHidden(self) -> bool: | ||
"""Returns True if the room is hidden from the end-user""" | ||
value = await self.director.getItemVariableValue(self.item_id, "ROOM_HIDDEN") | ||
return int(value) != 0 | ||
|
||
async def isOn(self) -> bool: | ||
"""Returns True/False if the room is "ON" from the director's perspective""" | ||
value = await self.director.getItemVariableValue(self.item_id, "POWER_STATE") | ||
return int(value) != 0 | ||
|
||
async def setRoomOff(self): | ||
"""Turn the room "OFF" """ | ||
await self.director.sendPostRequest( | ||
"/api/v1/items/{}/commands".format(self.item_id), | ||
"ROOM_OFF", | ||
{}, | ||
) | ||
|
||
async def _setSource(self, source_id: int, audio_only: bool): | ||
""" | ||
Sets the room source, turning on the room if necessary. | ||
If audio_only, only the current audio device is changed | ||
""" | ||
await self.director.sendPostRequest( | ||
f"/api/v1/items/{self.item_id}/commands", | ||
"SELECT_AUDIO_DEVICE" if audio_only else "SELECT_VIDEO_DEVICE", | ||
{"deviceid": source_id}, | ||
) | ||
|
||
async def setAudioSource(self, source_id: int): | ||
"""Sets the current audio source for the room""" | ||
await self._setSource(source_id, audio_only=True) | ||
|
||
async def setVideoAndAudioSource(self, source_id: int): | ||
"""Sets the current audio and video source for the room""" | ||
await self._setSource(source_id, audio_only=False) | ||
|
||
async def getVolume(self) -> int: | ||
"""Returns the current volume for the room from 0-100""" | ||
value = await self.director.getItemVariableValue(self.item_id, "CURRENT_VOLUME") | ||
return int(value) | ||
|
||
async def isMuted(self) -> bool: | ||
"""Returns True if the room is muted""" | ||
value = await self.director.getItemVariableValue(self.item_id, "IS_MUTED") | ||
return int(value) != 0 | ||
|
||
async def setMute(self, muted: bool): | ||
"""Mute/Unmute the room""" | ||
await self.director.sendPostRequest( | ||
"/api/v1/items/{}/commands".format(self.item_id), | ||
"MUTE_ON" if muted else "MUTE_OFF", | ||
{}, | ||
) | ||
|
||
async def toggleMute(self): | ||
"""Toggle the current mute state for the room""" | ||
await self.director.sendPostRequest( | ||
"/api/v1/items/{}/commands".format(self.item_id), | ||
"MUTE_TOGGLE", | ||
{}, | ||
) | ||
|
||
async def setVolume(self, volume: int): | ||
"""Set the room volume, 0-100""" | ||
await self.director.sendPostRequest( | ||
"/api/v1/items/{}/commands".format(self.item_id), | ||
"SET_VOLUME_LEVEL", | ||
{"LEVEL": volume}, | ||
) | ||
|
||
async def setIncrementOrDecrementVolume(self, increase: bool): | ||
"""Increase/Decrease volume by 1""" | ||
await self.director.sendPostRequest( | ||
"/api/v1/items/{}/commands".format(self.item_id), | ||
"PULSE_VOL_UP" if increase else "PULSE_VOL_DOWN", | ||
{}, | ||
) | ||
|
||
async def setPlay(self): | ||
await self.director.sendPostRequest( | ||
"/api/v1/items/{}/commands".format(self.item_id), | ||
"PLAY", | ||
{}, | ||
) | ||
|
||
async def setPause(self): | ||
await self.director.sendPostRequest( | ||
"/api/v1/items/{}/commands".format(self.item_id), | ||
"PAUSE", | ||
{}, | ||
) | ||
|
||
async def setStop(self): | ||
"""Stops the currently playing media but does not turn off the room""" | ||
await self.director.sendPostRequest( | ||
"/api/v1/items/{}/commands".format(self.item_id), | ||
"STOP", | ||
{}, | ||
) | ||
|
||
async def getAudioDevices(self): | ||
""" | ||
Get the audio devices located in the room. | ||
Note that this is literally the devices in the room, | ||
not necessarily all devices _playable_ in the room. | ||
See C4Director.getUiConfiguration for a more accurate list | ||
""" | ||
await self.director.sendGetRequest( | ||
"/api/v1/locations/rooms/{}/audio_devices".format(self.item_id) | ||
) | ||
|
||
async def getVideoDevices(self): | ||
""" | ||
Get the video devices located in the room. | ||
Note that this is literally the devices in the room, | ||
not necessarily all devices _playable_ in the room. | ||
See C4Director.getUiConfiguration for a more accurate list | ||
""" | ||
await self.director.sendGetRequest( | ||
"/api/v1/locations/rooms/{}/video_devices".format(self.item_id) | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters