Skip to main content

RgbicLightStripHandler

Struct RgbicLightStripHandler 

Source
pub struct RgbicLightStripHandler { /* private fields */ }
Expand description

Handler for the L920 and L930 devices.

Implementations§

Source§

impl RgbicLightStripHandler

Source

pub async fn refresh_session(&mut self) -> Result<&mut Self, Error>

Refreshes the authentication session.

Source

pub async fn get_device_info( &self, ) -> Result<DeviceInfoRgbicLightStripResult, Error>

Returns device info as DeviceInfoRgbicLightStripResult. It is not guaranteed to contain all the properties returned from the Tapo API. If the deserialization fails, or if a property that you care about it’s not present, try [RgbicLightStripHandler::get_device_info_json].

Source§

impl RgbicLightStripHandler

Source

pub async fn on(&self) -> Result<(), Error>

Turns on the device.

Source

pub async fn off(&self) -> Result<(), Error>

Turns off the device.

Source§

impl RgbicLightStripHandler

Source§

impl RgbicLightStripHandler

Source

pub async fn device_reboot(&self, delay_s: u16) -> Result<(), Error>

Reboots the device.

Notes:

  • Using a very small delay (e.g. 0 seconds) may cause a ConnectionReset or TimedOut error as the device reboots immediately.
  • Using a larger delay (e.g. 2-3 seconds) allows the device to respond before rebooting, reducing the chance of errors.
  • With larger delays, the method completes successfully before the device reboots. However, subsequent commands may fail if sent during the reboot process or before the device reconnects to the network.
§Arguments
  • delay_s - The delay in seconds before the device is rebooted.
Source

pub async fn device_reset(&self) -> Result<(), Error>

Hardware resets the device.

Warning: This action will reset the device to its factory settings. The connection to the Wi-Fi network and the Tapo app will be lost, and the device will need to be reconfigured.

This feature is especially useful when the device is difficult to access and requires reconfiguration.

Source§

impl RgbicLightStripHandler

Source

pub fn set(&self) -> ColorLightSetDeviceInfoParams

Returns a ColorLightSetDeviceInfoParams builder that allows multiple properties to be set in a single request. ColorLightSetDeviceInfoParams::send must be called at the end to apply the changes. For lighting effects, use RgbicLightStripHandler::set_lighting_effect instead.

§Example
device
    .set()
    .brightness(50)
    .color(Color::HotPink)
    .send(&device)
    .await?;
Source

pub async fn set_brightness(&self, brightness: u8) -> Result<(), Error>

Sets the brightness and turns on the device. Pre-existing lighting effect will be removed.

§Arguments
  • brightness - between 1 and 100
Source

pub async fn set_color(&self, color: Color) -> Result<(), Error>

Sets the color and turns on the device. Pre-existing lighting effect will be removed.

§Arguments
Source

pub async fn set_hue_saturation( &self, hue: u16, saturation: u8, ) -> Result<(), Error>

Sets the hue, saturation and turns on the device. Pre-existing lighting effect will be removed.

§Arguments
  • hue - between 0 and 360
  • saturation - between 1 and 100
Source

pub async fn set_color_temperature( &self, color_temperature: u16, ) -> Result<(), Error>

Sets the color temperature and turns on the device. Pre-existing lighting effect will be removed.

§Arguments
  • color_temperature - between 2500 and 6500
Source

pub async fn set_lighting_effect( &self, lighting_effect: impl Into<LightingEffect>, ) -> Result<(), Error>

Sets a lighting effect and turns on the device.

§Arguments
Source

pub async fn set_segment_effect( &self, segment_effect: impl Into<SegmentEffect>, ) -> Result<(), Error>

Sets a segment effect and turns on the device.

This is used for the newer app-defined RGBIC strip effects that cannot be set by LightingEffect (for example, “circulating” or “breathe” segment effects).

§Arguments

Trait Implementations§

Source§

impl Debug for RgbicLightStripHandler

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl From<GenericDeviceHandler> for RgbicLightStripHandler

Source§

fn from(value: GenericDeviceHandler) -> Self

Converts to this type from the input type.
Source§

impl HandlerExt for RgbicLightStripHandler

Source§

fn get_client<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = RwLockReadGuard<'_, dyn ApiClientExt>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the client used by this handler.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more