m/hacs-oasis_mini
1
0
Fork 0
mirror of https://github.com/natekspencer/hacs-oasis_mini.git synced 2025-12-06 18:44:14 -05:00
Code Wiki Activity

Formatting

Browse Source
This commit is contained in:
Nathan Spencer
2025-11-24 04:15:53 +00:00
parent 2994e73187
commit 1d521bcc18
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
custom_components/oasis_mini/button.py
View File

@@ -30,7 +30,7 @@ async def async_setup_entry(
) -> None: ) -> None:
""" """
Create and add button entities for each Oasis device defined in the config entry. Create and add button entities for each Oasis device defined in the config entry.
Parameters: Parameters:
entry (OasisDeviceConfigEntry): Config entry containing runtime data and registered Oasis devices. entry (OasisDeviceConfigEntry): Config entry containing runtime data and registered Oasis devices.
async_add_entities (AddEntitiesCallback): Callback used to register the created entities with Home Assistant. async_add_entities (AddEntitiesCallback): Callback used to register the created entities with Home Assistant.
@@ -39,10 +39,10 @@ async def async_setup_entry(
def make_entities(new_devices: list[OasisDevice]): def make_entities(new_devices: list[OasisDevice]):
""" """
Create button entities for each provided Oasis device using the module descriptors. Create button entities for each provided Oasis device using the module descriptors.
Parameters: Parameters:
new_devices (list[OasisDevice]): Devices to create button entities for. new_devices (list[OasisDevice]): Devices to create button entities for.
Returns: Returns:
list[OasisDeviceButtonEntity]: Button entity instances created for each device and each descriptor in DESCRIPTORS. list[OasisDeviceButtonEntity]: Button entity instances created for each device and each descriptor in DESCRIPTORS.
""" """
@@ -58,12 +58,12 @@ async def async_setup_entry(
async def play_random_track(device: OasisDevice) -> None: async def play_random_track(device: OasisDevice) -> None:
""" """
Play a random track on the given Oasis device. Play a random track on the given Oasis device.
Selects a track at random from the available TRACKS and attempts to add it to the device's queue and play it. Raises HomeAssistantError if adding the track times out. Selects a track at random from the available TRACKS and attempts to add it to the device's queue and play it. Raises HomeAssistantError if adding the track times out.
Parameters: Parameters:
device: The Oasis device on which to play the track. device: The Oasis device on which to play the track.
Raises: Raises:
HomeAssistantError: If adding the selected track to the device's queue times out. HomeAssistantError: If adding the selected track to the device's queue times out.
""" """
@@ -109,7 +109,7 @@ class OasisDeviceButtonEntity(OasisDeviceEntity, ButtonEntity):
async def async_press(self) -> None: async def async_press(self) -> None:
""" """
Trigger the button's configured action on the associated device. Trigger the button's configured action on the associated device.
Calls the entity description's `press_fn` with the device to perform the button's effect. Calls the entity description's `press_fn` with the device to perform the button's effect.
""" """
await self.entity_description.press_fn(self.device) await self.entity_description.press_fn(self.device)