Skip to main content

HubHandler

Struct HubHandler 

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

Handler for the H100 devices.

Implementations§

Source§

impl HubHandler

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<DeviceInfoHubResult, Error>

Returns device info as DeviceInfoHubResult. 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 [HubHandler::get_device_info_json].

Source§

impl HubHandler

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 HubHandler

Hub handler methods.

Source

pub async fn get_child_device_list( &self, ) -> Result<Vec<ChildDeviceHubResult>, Error>

Returns child device list as ChildDeviceHubResult. It is not guaranteed to contain all the properties returned from the Tapo API or to support all the possible devices connected to the hub. If the deserialization fails, or if a property that you care about it’s not present, try [HubHandler::get_child_device_list_json].

Source

pub async fn play_alarm( &self, ringtone: AlarmRingtone, volume: AlarmVolume, duration: AlarmDuration, ) -> Result<(), Error>

Start playing the hub alarm.

Source

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

Stop playing the hub alarm, if it’s currently playing.

Source§

impl HubHandler

Child device handler builders.

Source

pub async fn ke100(&self, identifier: HubDevice) -> Result<KE100Handler, Error>

Returns a KE100Handler for the given HubDevice.

§Arguments
  • identifier - a hub device identifier
§Example
// Connect to the hub
let hub = ApiClient::new("tapo-username@example.com", "tapo-password")
    .h100("192.168.1.100")
    .await?;
// Get a handler for the child device
let device_id = "0000000000000000000000000000000000000000".to_string();
let device = hub.ke100(HubDevice::ByDeviceId(device_id)).await?;
// Get the device info of the child device
let device_info = device.get_device_info().await?;
Source

pub async fn s200(&self, identifier: HubDevice) -> Result<S200Handler, Error>

Returns a S200Handler for the given HubDevice.

§Arguments
  • identifier - a hub device identifier
§Example
// Connect to the hub
let hub = ApiClient::new("tapo-username@example.com", "tapo-password")
    .h100("192.168.1.100")
    .await?;
// Get a handler for the child device
let device_id = "0000000000000000000000000000000000000000".to_string();
let device = hub.s200(HubDevice::ByDeviceId(device_id)).await?;
// Get the device info of the child device
let device_info = device.get_device_info().await?;
Source

pub async fn t100(&self, identifier: HubDevice) -> Result<T100Handler, Error>

Returns a T100Handler for the given HubDevice.

§Arguments
  • identifier - a hub device identifier
§Example
// Connect to the hub
let hub = ApiClient::new("tapo-username@example.com", "tapo-password")
    .h100("192.168.1.100")
    .await?;
// Get a handler for the child device
let device_id = "0000000000000000000000000000000000000000".to_string();
let device = hub.t100(HubDevice::ByDeviceId(device_id)).await?;
// Get the device info of the child device
let device_info = device.get_device_info().await?;
Source

pub async fn t110(&self, identifier: HubDevice) -> Result<T110Handler, Error>

Returns a T110Handler for the given HubDevice.

§Arguments
  • identifier - a hub device identifier
§Example
// Connect to the hub
let hub = ApiClient::new("tapo-username@example.com", "tapo-password")
    .h100("192.168.1.100")
    .await?;
// Get a handler for the child device
let device_id = "0000000000000000000000000000000000000000".to_string();
let device = hub.t110(HubDevice::ByDeviceId(device_id)).await?;
// Get the device info of the child device
let device_info = device.get_device_info().await?;
Source

pub async fn t300(&self, identifier: HubDevice) -> Result<T300Handler, Error>

Returns a T300Handler for the given HubDevice.

§Arguments
  • identifier - a hub device identifier
§Example
// Connect to the hub
let hub = ApiClient::new("tapo-username@example.com", "tapo-password")
    .h100("192.168.1.100")
    .await?;
// Get a handler for the child device
let device_id = "0000000000000000000000000000000000000000".to_string();
let device = hub.t300(HubDevice::ByDeviceId(device_id)).await?;
// Get the device info of the child device
let device_info = device.get_device_info().await?;
Source

pub async fn t31x(&self, identifier: HubDevice) -> Result<T31XHandler, Error>

Returns a T31XHandler for the given HubDevice.

§Arguments
  • identifier - a hub device identifier
§Example
// Connect to the hub
let hub = ApiClient::new("tapo-username@example.com", "tapo-password")
    .h100("192.168.1.100")
    .await?;
// Get a handler for the child device
let device_id = "0000000000000000000000000000000000000000".to_string();
let device = hub.t31x(HubDevice::ByDeviceId(device_id)).await?;
// Get the device info of the child device
let device_info = device.get_device_info().await?;

Trait Implementations§

Source§

impl Debug for HubHandler

Source§

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

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

impl From<GenericDeviceHandler> for HubHandler

Source§

fn from(value: GenericDeviceHandler) -> Self

Converts to this type from the input type.
Source§

impl HandlerExt for HubHandler

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