diff --git a/custom_components/oasis_mini/pyoasiscontrol/clients/transport.py b/custom_components/oasis_mini/pyoasiscontrol/clients/transport.py index 32eee3d..9d3353c 100644 --- a/custom_components/oasis_mini/pyoasiscontrol/clients/transport.py +++ b/custom_components/oasis_mini/pyoasiscontrol/clients/transport.py @@ -15,22 +15,22 @@ class OasisClientProtocol(Protocol): """ async def async_get_mac_address(self, device: OasisDevice) -> str | None: - """ - Retrieve the MAC address of the specified Oasis device. - - Parameters: - device (OasisDevice): The target device to query. - - Returns: - str | None: The device's MAC address as a string, or `None` if the MAC address is unavailable. - """ + """ + Retrieve the MAC address of the specified Oasis device. + + Parameters: + device (OasisDevice): The target device to query. + + Returns: + 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( self, device: OasisDevice, auto_clean: bool ) -> None: - """ + """ Enable or disable the device's auto-clean mode. - + Parameters: device (OasisDevice): The target Oasis device to send the command to. auto_clean (bool): `True` to enable auto-clean mode, `False` to disable it. @@ -41,9 +41,9 @@ class OasisClientProtocol(Protocol): device: OasisDevice, speed: int, ) -> None: - """ + """ Set the device's ball speed to the specified value. - + Parameters: device (OasisDevice): Target Oasis device to send the command to. speed (int): Desired ball speed value for the device. @@ -57,9 +57,9 @@ class OasisClientProtocol(Protocol): led_speed: int, brightness: int, ) -> None: - """ + """ Configure the device's LED effect, color, speed, and brightness. - + Parameters: device (OasisDevice): Target Oasis device to receive the LED command. led_effect (str): Name or identifier of the LED effect to apply. @@ -69,12 +69,12 @@ class OasisClientProtocol(Protocol): """ async def async_send_sleep_command(self, device: OasisDevice) -> None: - """ - Put the specified Oasis device into sleep mode. - - Parameters: - device (OasisDevice): The target Oasis device to send the sleep command to. - """ + """ + Put the specified Oasis device into sleep mode. + + Parameters: + device (OasisDevice): The target Oasis device to send the sleep command to. + """ async def async_send_move_job_command( self, @@ -82,9 +82,9 @@ class OasisClientProtocol(Protocol): from_index: int, to_index: int, ) -> None: - """ + """ Move a job within the device's job list from one index to another. - + Parameters: device (OasisDevice): Target Oasis device. from_index (int): Source index of the job in the device's job list. @@ -96,9 +96,9 @@ class OasisClientProtocol(Protocol): device: OasisDevice, index: int, ) -> None: - """ + """ Change the device's current track to the specified track index. - + Parameters: device (OasisDevice): The target Oasis device to receive the command. index (int): The index of the track to select on the device. @@ -109,12 +109,12 @@ class OasisClientProtocol(Protocol): device: OasisDevice, tracks: list[int], ) -> None: - """ + """ Add the given sequence of track indices to the device's job list. - + Parameters: - 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. + 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. """ async def async_send_set_playlist_command( @@ -122,9 +122,9 @@ class OasisClientProtocol(Protocol): device: OasisDevice, playlist: list[int], ) -> None: - """ + """ Set the device's current playlist to the provided sequence of track indices. - + Parameters: device (OasisDevice): The target Oasis device to receive the playlist. playlist (list[int]): Sequence of track indices in the desired playback order. @@ -135,9 +135,9 @@ class OasisClientProtocol(Protocol): device: OasisDevice, repeat: bool, ) -> None: - """ + """ Set whether the device should repeat the current playlist. - + Parameters: repeat (bool): True to enable repeating the current playlist, False to disable it. """ @@ -147,9 +147,9 @@ class OasisClientProtocol(Protocol): device: OasisDevice, option: str, ) -> None: - """ + """ Send a command to configure the device's autoplay behavior. - + Parameters: device (OasisDevice): Target Oasis device to receive the command. option (str): Autoplay option to set (e.g., "on", "off", "shuffle", or other device-supported mode). @@ -160,63 +160,63 @@ class OasisClientProtocol(Protocol): device: OasisDevice, beta: bool, ) -> None: - """ + """ 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. - + Parameters: device (OasisDevice): Target device to upgrade. beta (bool): Whether to use the beta upgrade channel (`True`) or the stable channel (`False`). """ async def async_send_play_command(self, device: OasisDevice) -> None: - """ - Send a play command to the specified Oasis device. - - Parameters: - device (OasisDevice): The target device to instruct to start playback. - """ + """ + Send a play command to the specified Oasis device. + + Parameters: + device (OasisDevice): The target device to instruct to start playback. + """ async def async_send_pause_command(self, device: OasisDevice) -> None: - """ - Pause playback on the specified Oasis device. - - This sends a pause command to the device so it stops current playback. - """ + """ + Pause playback on the specified Oasis device. + + This sends a pause command to the device so it stops current playback. + """ async def async_send_stop_command(self, device: OasisDevice) -> None: - """ - Send a stop command to the specified Oasis device to halt playback. - - Parameters: - device (OasisDevice): The target Oasis device to receive the stop command. - """ + """ + Send a stop command to the specified Oasis device to halt playback. + + Parameters: + device (OasisDevice): The target Oasis device to receive the stop command. + """ async def async_send_reboot_command(self, device: OasisDevice) -> None: - """ - Send a reboot command to the specified Oasis device. - - Parameters: - device (OasisDevice): The target Oasis device to reboot. - """ + """ + Send a reboot command to the specified Oasis device. + + Parameters: + device (OasisDevice): The target Oasis device to reboot. + """ async def async_get_all(self, device: OasisDevice) -> None: - """ - 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. - - Parameters: - device (OasisDevice): Target device whose data should be fetched and refreshed. - """ + """ + 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. + + Parameters: + device (OasisDevice): Target device whose data should be fetched and refreshed. + """ async def async_get_status(self, device: OasisDevice) -> None: - """ - 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. - - Parameters: - device (OasisDevice): The target device to query. - """ + """ + 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. + + Parameters: + device (OasisDevice): The target device to query. + """