Struct ApiClient 

pub struct ApiClient { /* private fields */ }

Tapo API Client. See examples.

Example

use tapo::ApiClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l530("192.168.1.100")
    .await?;

    device.on().await?;

    Ok(())
}

Implementations

impl ApiClient

Tapo API Client constructor.

pub fn new( tapo_username: impl Into<String>, tapo_password: impl Into<String>, ) -> ApiClient

Returns a new instance of ApiClient. It is cheaper to ApiClient::clone an existing instance than to create a new one when multiple devices need to be controller. This is because ApiClient::clone reuses the underlying reqwest::Client.

Arguments

• tapo_username - the Tapo username
• tapo_password - the Tapo password

Note: The default connection timeout is 30 seconds. Use ApiClient::with_timeout to change it.

pub fn with_timeout(self, timeout: Duration) -> ApiClient

Changes the connection timeout from the default value to the given value.

Arguments

• timeout - The new connection timeout value.

pub async fn discover_devices( self, target: impl Into<String>, timeout_s: u64, ) -> Result<DeviceDiscovery, Error>

Discovers one or more devices located at a specified unicast or broadcast IP address.

Arguments

• target - The IP address at which the discovery will take place. This address can be either a unicast (e.g. 192.168.1.10) or a broadcast address (e.g. 192.168.1.255, 255.255.255.255, etc.).
• timeout_s - The maximum time to wait for a response from the device(s) in seconds. Must be between 1 and 60.

impl ApiClient

Device handler builders.

pub async fn generic_device( self, ip_address: impl Into<String>, ) -> Result<GenericDeviceHandler, Error>

Specializes the given ApiClient into an authenticated GenericDeviceHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .generic_device("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l510( self, ip_address: impl Into<String>, ) -> Result<LightHandler, Error>

Specializes the given ApiClient into an authenticated LightHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l510("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l520( self, ip_address: impl Into<String>, ) -> Result<LightHandler, Error>

Specializes the given ApiClient into an authenticated LightHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l520("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l530( self, ip_address: impl Into<String>, ) -> Result<ColorLightHandler, Error>

Specializes the given ApiClient into an authenticated ColorLightHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l530("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l535( self, ip_address: impl Into<String>, ) -> Result<ColorLightHandler, Error>

Specializes the given ApiClient into an authenticated ColorLightHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l535("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l610( self, ip_address: impl Into<String>, ) -> Result<LightHandler, Error>

Specializes the given ApiClient into an authenticated LightHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l610("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l630( self, ip_address: impl Into<String>, ) -> Result<ColorLightHandler, Error>

Specializes the given ApiClient into an authenticated ColorLightHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l630("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l900( self, ip_address: impl Into<String>, ) -> Result<RgbLightStripHandler, Error>

Specializes the given ApiClient into an authenticated RgbLightStripHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l900("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l920( self, ip_address: impl Into<String>, ) -> Result<RgbicLightStripHandler, Error>

Specializes the given ApiClient into an authenticated RgbicLightStripHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l920("192.168.1.100")
    .await?;
device.on().await?;

pub async fn l930( self, ip_address: impl Into<String>, ) -> Result<RgbicLightStripHandler, Error>

Specializes the given ApiClient into an authenticated RgbicLightStripHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .l930("192.168.1.100")
    .await?;
device.on().await?;

pub async fn p100( self, ip_address: impl Into<String>, ) -> Result<PlugHandler, Error>

Specializes the given ApiClient into an authenticated PlugHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .p100("192.168.1.100")
    .await?;
device.on().await?;

pub async fn p105( self, ip_address: impl Into<String>, ) -> Result<PlugHandler, Error>

Specializes the given ApiClient into an authenticated PlugHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .p105("192.168.1.100")
    .await?;
device.on().await?;

pub async fn p110( self, ip_address: impl Into<String>, ) -> Result<PlugEnergyMonitoringHandler, Error>

Specializes the given ApiClient into an authenticated PlugEnergyMonitoringHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .p110("192.168.1.100")
    .await?;
device.on().await?;

pub async fn p115( self, ip_address: impl Into<String>, ) -> Result<PlugEnergyMonitoringHandler, Error>

Specializes the given ApiClient into an authenticated PlugEnergyMonitoringHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .p115("192.168.1.100")
    .await?;
device.on().await?;

pub async fn p300( self, ip_address: impl Into<String>, ) -> Result<PowerStripHandler, Error>

Specializes the given ApiClient into an authenticated PowerStripHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .p300("192.168.1.100")
    .await?;
let child_device_list = device.get_child_device_list().await?;
println!("Child device list: {child_device_list:?}");

pub async fn p304( self, ip_address: impl Into<String>, ) -> Result<PowerStripEnergyMonitoringHandler, Error>

Specializes the given ApiClient into an authenticated PowerStripEnergyMonitoringHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .p304("192.168.1.100")
    .await?;
let child_device_list = device.get_child_device_list().await?;
println!("Child device list: {child_device_list:?}");

pub async fn p306( self, ip_address: impl Into<String>, ) -> Result<PowerStripHandler, Error>

Specializes the given ApiClient into an authenticated PowerStripHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .p306("192.168.1.100")
    .await?;
let child_device_list = device.get_child_device_list().await?;
println!("Child device list: {child_device_list:?}");

pub async fn p316( self, ip_address: impl Into<String>, ) -> Result<PowerStripEnergyMonitoringHandler, Error>

Specializes the given ApiClient into an authenticated PowerStripEnergyMonitoringHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .p316("192.168.1.100")
    .await?;
let child_device_list = device.get_child_device_list().await?;
println!("Child device list: {child_device_list:?}");

pub async fn h100( self, ip_address: impl Into<String>, ) -> Result<HubHandler, Error>

Specializes the given ApiClient into an authenticated HubHandler.

Arguments

• ip_address - the IP address of the device

Example

let device = ApiClient::new("tapo-username@example.com", "tapo-password")
    .h100("192.168.1.100")
    .await?;

let child_device_list = device.get_child_device_list().await?;
println!("Child device list: {child_device_list:?}");

Trait Implementations

impl ApiClientExt for ApiClient

fn set_device_info<'life0, 'async_trait>( &'life0 self, device_info_params: Value, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets device info by sending the given parameters.

fn device_reboot<'life0, 'async_trait>( &'life0 self, delay: u16, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reboots the device.

fn device_reset<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Hardware resets the device.

impl Clone for ApiClient

fn clone(&self) -> ApiClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiClient

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

Formats the value using the given formatter.