Add support for L520 and the set API to L510, L520 and L610

mihai-dinculescu · Oct 30, 2023 · 7c234ed · 7c234ed
1 parent e061147
commit 7c234ed
Show file tree

Hide file tree

Showing 13 changed files with 128 additions and 62 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ file. This change log follows the conventions of
 
 ## [Rust Unreleased][Unreleased]
 
+### Added
+
+- Added a dedicated handler for the L520 devices.
+- Added support for the `set` API to the L510, L520 and L610 devices.
+
 ## [Python Unreleased][Unreleased]
 
 ### Changed

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 [![PyPI][pypi_badge]][pypi]
 [![Python][pypi_versions_badge]][pypi]
 [![PyPI][pypi_downloads_badge]][pypi]\
-Unofficial Tapo API Client. Works with TP-Link Tapo smart devices. Tested with light bulbs (L510, L530, L610, L630), light strips (L900, L920, L930), plugs (P100, P105, P110, P115), hubs (H100), switches (S200B) and sensors (T100, T110, T310, T315).
+Unofficial Tapo API Client. Works with TP-Link Tapo smart devices. Tested with light bulbs (L510, L520, L530, L610, L630), light strips (L900, L920, L930), plugs (P100, P105, P110, P115), hubs (H100), switches (S200B) and sensors (T100, T110, T310, T315).
 
 [license_badge]: https://img.shields.io/crates/l/tapo.svg
 [license]: https://github.com/mihai-dinculescu/tapo/blob/main/LICENSE
@@ -28,22 +28,22 @@ Unofficial Tapo API Client. Works with TP-Link Tapo smart devices. Tested with l
 &check; - Rust only\
 &#x2705; - Rust and Python
 
-| Feature               | GenericDevice | L510, L610 | L530, L630, L900 | L920, L930 | P100, P105 | P110, P115 |
-| --------------------- | ------------: | ---------: | ---------------: | ---------: | ---------: | ---------: |
-| on                    |      &#x2705; |    &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
-| off                   |      &#x2705; |    &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
-| get_device_info       |      &#x2705; |    &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
-| get_device_info_json  |      &#x2705; |    &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
-| get_device_usage      |               |    &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
-| get_energy_usage      |               |            |                  |            |            |   &#x2705; |
-| get_energy_data       |               |            |                  |            |            |   &#x2705; |
-| get_current_power     |               |            |                  |            |            |   &#x2705; |
-| set_brightness        |               |    &check; |          &check; |    &check; |            |            |
-| set_color             |               |            |          &check; |    &check; |            |            |
-| set_hue_saturation    |               |            |          &check; |    &check; |            |            |
-| set_color_temperature |               |            |          &check; |    &check; |            |            |
-| set_lighting_effect   |               |            |                  |    &check; |            |            |
-| set() API \*          |               |            |          &check; |    &check; |            |            |
+| Feature               | GenericDevice | L510, L520, L610 | L530, L630, L900 | L920, L930 | P100, P105 | P110, P115 |
+| --------------------- | ------------: | ---------------: | ---------------: | ---------: | ---------: | ---------: |
+| on                    |      &#x2705; |          &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
+| off                   |      &#x2705; |          &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
+| get_device_info       |      &#x2705; |          &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
+| get_device_info_json  |      &#x2705; |          &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
+| get_device_usage      |               |          &check; |          &check; |    &check; |   &#x2705; |   &#x2705; |
+| get_energy_usage      |               |                  |                  |            |            |   &#x2705; |
+| get_energy_data       |               |                  |                  |            |            |   &#x2705; |
+| get_current_power     |               |                  |                  |            |            |   &#x2705; |
+| set_brightness        |               |          &check; |          &check; |    &check; |            |            |
+| set_color             |               |                  |          &check; |    &check; |            |            |
+| set_hue_saturation    |               |                  |          &check; |    &check; |            |            |
+| set_color_temperature |               |                  |          &check; |    &check; |            |            |
+| set_lighting_effect   |               |                  |                  |    &check; |            |            |
+| set() API \*          |               |          &check; |          &check; |    &check; |            |            |
 
 \* The `set()` API allows multiple properties to be set in a single request.
 

diff --git a/tapo-py/tapo.pyi b/tapo-py/tapo.pyi
@@ -1,6 +1,6 @@
 """Tapo API Client.
 
-Tested with light bulbs (L510, L530, L610, L630), light strips (L900, L920, L930),
+Tested with light bulbs (L510, L520, L530, L610, L630), light strips (L900, L920, L930),
 plugs (P100, P105, P110, P115), hubs (H100), switches (S200B) and sensors (T100, T110, T310, T315).
 
 Example:
@@ -29,7 +29,7 @@ from typing import Optional, List
 class ApiClient:
     """Tapo API Client.
 
-    Tested with light bulbs (L510, L530, L610, L630), light strips (L900, L920, L930),
+    Tested with light bulbs (L510, L520, L530, L610, L630), light strips (L900, L920, L930),
     plugs (P100, P105, P110, P115), hubs (H100), switches (S200B) and sensors (T100, T110, T310, T315).
 
     Example:

diff --git a/tapo/Cargo.toml b/tapo/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.7.4"
 edition = "2021"
 license = "MIT"
 authors = ["Mihai Dinculescu <[email protected]>"]
-description = "Unofficial Tapo API Client. Works with TP-Link Tapo smart devices. Tested with light bulbs (L510, L530, L610, L630), light strips (L900, L920, L930), plugs (P100, P105, P110, P115), hubs (H100), switches (S200B) and sensors (T100, T110, T310, T315)."
+description = "Unofficial Tapo API Client. Works with TP-Link Tapo smart devices. Tested with light bulbs (L510, L520, L530, L610, L630), light strips (L900, L920, L930), plugs (P100, P105, P110, P115), hubs (H100), switches (S200B) and sensors (T100, T110, T310, T315)."
 keywords = ["IOT", "tapo", "smart-home", "smart-bulb", "smart-plug"]
 categories = ["hardware-support", "embedded", "development-tools"]
 readme = "README.md"

diff --git a/tapo/examples/tapo_l510.rs b/tapo/examples/tapo_l510.rs
@@ -1,4 +1,4 @@
-/// L510 Example
+/// L510, L520 & L610 Example
 use std::{env, thread, time::Duration};
 
 use log::{info, LevelFilter};
@@ -26,17 +26,25 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     info!("Turning device on...");
     device.on().await?;
 
+    info!("Waiting 2 seconds...");
+    thread::sleep(Duration::from_secs(2));
+
     info!("Setting the brightness to 30%...");
     device.set_brightness(30).await?;
 
     info!("Waiting 2 seconds...");
     thread::sleep(Duration::from_secs(2));
 
+    info!("Turning device off...");
+    device.off().await?;
+
     info!("Waiting 2 seconds...");
     thread::sleep(Duration::from_secs(2));
 
-    info!("Turning device off...");
-    device.off().await?;
+    info!("Using the `set` API to set multiple properties in a single request...");
+    // By default, adjusting the brightness turns the device on,
+    // so we need to explicitly set it off.
+    device.set().brightness(50).off().send().await?;
 
     let device_info = device.get_device_info().await?;
     info!("Device info: {device_info:?}");

diff --git a/tapo/examples/tapo_l530.rs b/tapo/examples/tapo_l530.rs
@@ -1,4 +1,4 @@
-/// L530 Example
+/// L530, L630 & L900 Example
 use std::{env, thread, time::Duration};
 
 use log::{info, LevelFilter};

diff --git a/tapo/examples/tapo_l930.rs b/tapo/examples/tapo_l930.rs
@@ -1,4 +1,4 @@
-/// L930 Example
+/// L920 & L930 Example
 use std::{env, thread, time::Duration};
 
 use log::{info, LevelFilter};

diff --git a/tapo/src/api/api_client.rs b/tapo/src/api/api_client.rs
@@ -155,6 +155,32 @@ impl ApiClient {
         Ok(ColorLightHandler::new(self))
     }
 
+    /// Specializes the given [`ApiClient`] into an authenticated [`LightHandler`].
+    ///
+    /// # Arguments
+    ///
+    /// * `ip_address` - the IP address of the device
+    ///
+    /// # Example
+    ///
+    /// ```rust,no_run
+    /// # use tapo::ApiClient;
+    /// # #[tokio::main]
+    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    /// let device = ApiClient::new("[email protected]", "tapo-password")?
+    ///     .l520("192.168.1.100")
+    ///     .await?;
+    /// device.on().await?;
+    /// # Ok(())
+    /// # }
+    /// ```
+    pub async fn l520(mut self, ip_address: impl Into<String>) -> Result<LightHandler, Error> {
+        let url = build_url(&ip_address.into());
+        self.login(url).await?;
+
+        Ok(LightHandler::new(self))
+    }
+
     /// Specializes the given [`ApiClient`] into an authenticated [`LightHandler`].
     ///
     /// # Arguments

diff --git a/tapo/src/api/light_handler.rs b/tapo/src/api/light_handler.rs
@@ -3,7 +3,8 @@ use crate::error::Error;
 use crate::requests::LightSetDeviceInfoParams;
 use crate::responses::{DeviceInfoLightResult, DeviceUsageEnergyMonitoringResult};
 
-/// Handler for the [L510](https://www.tapo.com/en/search/?q=L510) and [L610](https://www.tapo.com/en/search/?q=L610) devices.
+/// Handler for the [L510](https://www.tapo.com/en/search/?q=L510), [L520](https://www.tapo.com/en/search/?q=L520)
+/// and [L610](https://www.tapo.com/en/search/?q=L610) devices.
 pub struct LightHandler {
     client: ApiClient,
 }
@@ -53,6 +54,32 @@ impl LightHandler {
         self.client.get_device_usage().await
     }
 
+    /// Returns a [`LightSetDeviceInfoParams`] builder that allows multiple properties to be set in a single request.
+    /// [`LightSetDeviceInfoParams::send`] must be called at the end to apply the changes.
+    ///
+    /// # Example
+    ///
+    /// ```rust,no_run
+    /// # use tapo::ApiClient;
+    /// # use tapo::requests::Color;
+    /// # #[tokio::main]
+    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    /// # let device = ApiClient::new("[email protected]", "tapo-password")?
+    /// #     .l510("192.168.1.100")
+    /// #     .await?;
+    /// device
+    ///     .set()
+    ///     .brightness(50)
+    ///     .off()
+    ///     .send()
+    ///     .await?;
+    /// # Ok(())
+    /// # }
+    /// ```
+    pub fn set(&self) -> LightSetDeviceInfoParams {
+        LightSetDeviceInfoParams::new(&self.client)
+    }
+
     /// Sets the *brightness* and turns *on* the device.
     ///
     /// # Arguments

diff --git a/tapo/src/lib.rs b/tapo/src/lib.rs
@@ -2,7 +2,7 @@
 
 //! Tapo API Client.
 //!
-//! Tested with light bulbs (L510, L530, L610, L630), light strips (L900, L920, L930),
+//! Tested with light bulbs (L510, L520, L530, L610, L630), light strips (L900, L920, L930),
 //! plugs (P100, P105, P110, P115), hubs (H100), switches (S200B) and sensors (T100, T110, T310, T315).
 //!
 //! # Example with L530

diff --git a/tapo/src/requests/set_device_info.rs b/tapo/src/requests/set_device_info.rs
@@ -3,6 +3,6 @@ mod generic_device;
 mod light;
 
 pub use color_light::*;
+pub use light::*;
 
 pub(crate) use generic_device::*;
-pub(crate) use light::*;