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

Replace tabs with spaces

Browse Source
This commit is contained in:
Nathan Spencer
2025-11-23 17:53:22 -07:00
committed by GitHub
parent ce22238ae6
commit a548ac5fe2
1 changed files with 77 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
custom_components/oasis_mini/pyoasiscontrol/clients/transport.py
View File

@@ -15,20 +15,20 @@ class OasisClientProtocol(Protocol):
""" """
async def async_get_mac_address(self, device: OasisDevice) -> str | None: async def async_get_mac_address(self, device: OasisDevice) -> str | None:
""" """
Retrieve the MAC address of the specified Oasis device. Retrieve the MAC address of the specified Oasis device.
Parameters: Parameters:
device (OasisDevice): The target device to query. device (OasisDevice): The target device to query.
Returns: Returns:
str | None: The device's MAC address as a string, or `None` if the MAC address is unavailable. str | None: The device's MAC address as a string, or `None` if the MAC address is unavailable.
""" """
async def async_send_auto_clean_command( async def async_send_auto_clean_command(
self, device: OasisDevice, auto_clean: bool self, device: OasisDevice, auto_clean: bool
) -> None: ) -> None:
""" """
Enable or disable the device's auto-clean mode. Enable or disable the device's auto-clean mode.
Parameters: Parameters:
@@ -41,7 +41,7 @@ class OasisClientProtocol(Protocol):
device: OasisDevice, device: OasisDevice,
speed: int, speed: int,
) -> None: ) -> None:
""" """
Set the device's ball speed to the specified value. Set the device's ball speed to the specified value.
Parameters: Parameters:
@@ -57,7 +57,7 @@ class OasisClientProtocol(Protocol):
led_speed: int, led_speed: int,
brightness: int, brightness: int,
) -> None: ) -> None:
""" """
Configure the device's LED effect, color, speed, and brightness. Configure the device's LED effect, color, speed, and brightness.
Parameters: Parameters:
@@ -69,12 +69,12 @@ class OasisClientProtocol(Protocol):
""" """
async def async_send_sleep_command(self, device: OasisDevice) -> None: async def async_send_sleep_command(self, device: OasisDevice) -> None:
""" """
Put the specified Oasis device into sleep mode. Put the specified Oasis device into sleep mode.
Parameters: Parameters:
device (OasisDevice): The target Oasis device to send the sleep command to. device (OasisDevice): The target Oasis device to send the sleep command to.
""" """
async def async_send_move_job_command( async def async_send_move_job_command(
self, self,
@@ -82,7 +82,7 @@ class OasisClientProtocol(Protocol):
from_index: int, from_index: int,
to_index: int, to_index: int,
) -> None: ) -> None:
""" """
Move a job within the device's job list from one index to another. Move a job within the device's job list from one index to another.
Parameters: Parameters:
@@ -96,7 +96,7 @@ class OasisClientProtocol(Protocol):
device: OasisDevice, device: OasisDevice,
index: int, index: int,
) -> None: ) -> None:
""" """
Change the device's current track to the specified track index. Change the device's current track to the specified track index.
Parameters: Parameters:
@@ -109,12 +109,12 @@ class OasisClientProtocol(Protocol):
device: OasisDevice, device: OasisDevice,
tracks: list[int], tracks: list[int],
) -> None: ) -> None:
""" """
Add the given sequence of track indices to the device's job list. Add the given sequence of track indices to the device's job list.
Parameters: Parameters:
device (OasisDevice): Target Oasis device to receive the new jobs. device (OasisDevice): Target Oasis device to receive the new jobs.
tracks (list[int]): Ordered list of track indices to append to the device's job list. tracks (list[int]): Ordered list of track indices to append to the device's job list.
""" """
async def async_send_set_playlist_command( async def async_send_set_playlist_command(
@@ -122,7 +122,7 @@ class OasisClientProtocol(Protocol):
device: OasisDevice, device: OasisDevice,
playlist: list[int], playlist: list[int],
) -> None: ) -> None:
""" """
Set the device's current playlist to the provided sequence of track indices. Set the device's current playlist to the provided sequence of track indices.
Parameters: Parameters:
@@ -135,7 +135,7 @@ class OasisClientProtocol(Protocol):
device: OasisDevice, device: OasisDevice,
repeat: bool, repeat: bool,
) -> None: ) -> None:
""" """
Set whether the device should repeat the current playlist. Set whether the device should repeat the current playlist.
Parameters: Parameters:
@@ -147,7 +147,7 @@ class OasisClientProtocol(Protocol):
device: OasisDevice, device: OasisDevice,
option: str, option: str,
) -> None: ) -> None:
""" """
Send a command to configure the device's autoplay behavior. Send a command to configure the device's autoplay behavior.
Parameters: Parameters:
@@ -160,7 +160,7 @@ class OasisClientProtocol(Protocol):
device: OasisDevice, device: OasisDevice,
beta: bool, beta: bool,
) -> None: ) -> None:
""" """
Initiates a firmware upgrade on the given Oasis device. Initiates a firmware upgrade on the given Oasis device.
If `beta` is True, requests the device to use the beta upgrade channel; otherwise requests the stable channel. If `beta` is True, requests the device to use the beta upgrade channel; otherwise requests the stable channel.
@@ -171,52 +171,52 @@ class OasisClientProtocol(Protocol):
""" """
async def async_send_play_command(self, device: OasisDevice) -> None: async def async_send_play_command(self, device: OasisDevice) -> None:
""" """
Send a play command to the specified Oasis device. Send a play command to the specified Oasis device.
Parameters: Parameters:
device (OasisDevice): The target device to instruct to start playback. device (OasisDevice): The target device to instruct to start playback.
""" """
async def async_send_pause_command(self, device: OasisDevice) -> None: async def async_send_pause_command(self, device: OasisDevice) -> None:
""" """
Pause playback on the specified Oasis device. Pause playback on the specified Oasis device.
This sends a pause command to the device so it stops current playback. This sends a pause command to the device so it stops current playback.
""" """
async def async_send_stop_command(self, device: OasisDevice) -> None: async def async_send_stop_command(self, device: OasisDevice) -> None:
""" """
Send a stop command to the specified Oasis device to halt playback. Send a stop command to the specified Oasis device to halt playback.
Parameters: Parameters:
device (OasisDevice): The target Oasis device to receive the stop command. device (OasisDevice): The target Oasis device to receive the stop command.
""" """
async def async_send_reboot_command(self, device: OasisDevice) -> None: async def async_send_reboot_command(self, device: OasisDevice) -> None:
""" """
Send a reboot command to the specified Oasis device. Send a reboot command to the specified Oasis device.
Parameters: Parameters:
device (OasisDevice): The target Oasis device to reboot. device (OasisDevice): The target Oasis device to reboot.
""" """
async def async_get_all(self, device: OasisDevice) -> None: async def async_get_all(self, device: OasisDevice) -> None:
""" """
Fetch comprehensive device data for the specified Oasis device. Fetch comprehensive device data for the specified Oasis device.
This method triggers retrieval of all relevant information (configuration, status, and runtime data) for the given device so the client's representation of that device can be refreshed. This method triggers retrieval of all relevant information (configuration, status, and runtime data) for the given device so the client's representation of that device can be refreshed.
Parameters: Parameters:
device (OasisDevice): Target device whose data should be fetched and refreshed. device (OasisDevice): Target device whose data should be fetched and refreshed.
""" """
async def async_get_status(self, device: OasisDevice) -> None: async def async_get_status(self, device: OasisDevice) -> None:
""" """
Retrieve the current runtime status for the specified Oasis device. Retrieve the current runtime status for the specified Oasis device.
Implementations should query the device for its current state (for example: playback, LED settings, job/track lists, and connectivity) and update any client-side representation or caches as needed. Implementations should query the device for its current state (for example: playback, LED settings, job/track lists, and connectivity) and update any client-side representation or caches as needed.
Parameters: Parameters:
device (OasisDevice): The target device to query. device (OasisDevice): The target device to query.
""" """