Initial KE100 support.

tapo/examples/tapo_ke100.rs

@@ -0,0 +1,44 @@
+/// KE100 TRV Example
+use std::env;
+
+use log::{info, LevelFilter};
+use tapo::ApiClient;
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let log_level = env::var("RUST_LOG")
+        .unwrap_or_else(|_| "info".to_string())
+        .parse()
+        .unwrap_or(LevelFilter::Info);
+
+    pretty_env_logger::formatted_timed_builder()
+        .filter(Some("tapo"), log_level)
+        .init();
+
+    let tapo_username = env::var("TAPO_USERNAME")?;
+    let tapo_password = env::var("TAPO_PASSWORD")?;
+    let ip_address = env::var("IP_ADDRESS")?;
+    // ID of the KE100 device. Can be obtained from executing `get_child_device_component_list()`` on the hub device.
+    let device_id = env::var("DEVICE_ID")?;
+    let target_temperature: u8 = env::var("TARGET_TEMPERATURE")?.parse()?;
+
+    let hub = ApiClient::new(tapo_username, tapo_password)?
+        .h100(ip_address)
+        .await?;
+
+    // Get a handler for the child device
+    let device = hub.ke100(device_id);
+
+    // Get the device info of the child device
+    let device_info = device.get_device_info().await?;
+    info!("Device info: {device_info:?}");
+
+    // Set temperature on target device
+    device.set_target_temperature(target_temperature).await?;
+
+    // Get the device info of the child device
+    let device_info = device.get_device_info().await?;
+    info!("Device info: {device_info:?}");
+
+    Ok(())
+}

tapo/src/api/api_client.rs

@@ -578,7 +578,7 @@ impl ApiClient {
         &self,
         device_id: String,
         child_request: TapoRequest,
-    ) -> Result<R, Error>
+    ) -> Result<Option<R>, Error>
     where
         R: fmt::Debug + DeserializeOwned + TapoResponseExt,
     {
@@ -605,9 +605,7 @@ impl ApiClient {
 
         validate_response(&response)?;
 
-        response
-            .result
-            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
+        Ok(response.result)
     }
 }
 

tapo/src/api/child_devices.rs

@@ -3,9 +3,11 @@ mod t100_handler;
 mod t110_handler;
 mod t300_handler;
 mod t31x_handler;
+mod ke100_handler;
 
 pub use s200b_handler::*;
 pub use t100_handler::*;
 pub use t110_handler::*;
 pub use t300_handler::*;
 pub use t31x_handler::*;
+pub use ke100_handler::*;

tapo/src/api/child_devices/ke100_handler.rs

@@ -0,0 +1,149 @@
+use crate::api::HubHandler;
+use crate::error::{Error,TapoResponseError};
+use crate::requests::{EmptyParams, TapoParams, TapoRequest, TrvSetDeviceInfoParams};
+use crate::responses::KE100Result;
+
+/// Handler for the [KE100] device.
+pub struct KE100Handler<'h> {
+    hub_handler: &'h HubHandler,
+    device_id: String,
+}
+
+impl<'h> KE100Handler<'h> {
+    pub(crate) fn new(hub_handler: &'h HubHandler, device_id: String) -> Self {
+        Self {
+            hub_handler,
+            device_id,
+        }
+    }
+
+    /// Returns *device info* as [`KE100Result`].
+    /// It is not guaranteed to contain all the properties returned from the Tapo API.
+    pub async fn get_device_info(&self) -> Result<KE100Result, Error> {
+        let request = TapoRequest::GetDeviceInfo(TapoParams::new(EmptyParams));
+
+        self.hub_handler
+            .control_child(self.device_id.clone(), request)
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
+    }
+
+    /// Returns *device info* as [`serde_json::Value`].
+    /// It contains all the properties returned from the Tapo API.
+    pub async fn get_device_info_json(&self) -> Result<serde_json::Value, Error> {
+        let request = TapoRequest::GetDeviceInfo(TapoParams::new(EmptyParams));
+
+        self.hub_handler
+            .control_child(self.device_id.clone(), request)
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
+    }
+
+
+    /// Sets the *target temperature*.
+    ///
+    /// # Arguments
+    ///
+    /// * `target_temperature` - between min_control_temp and max_control_temp
+    pub async fn set_target_temperature(&self, target_temperature: u8) -> Result<(), Error> {
+
+        //let control_range = self.get_control_range().await?;
+        let device_info = self.get_device_info().await?;
+
+        if target_temperature < device_info.min_control_temperature || target_temperature > device_info.max_control_temperature {
+            return Err(Error::Validation {
+                field: "target_temperature".to_string(),
+                message: format!("Target temperature must be between {} (min_control_temp) and {} (max_control_temp)", device_info.min_control_temperature, device_info.max_control_temperature),
+            });
+        }
+
+        let json = serde_json::to_value(TrvSetDeviceInfoParams::new().target_temperature(target_temperature)?)?;
+        let request = TapoRequest::SetDeviceInfo(Box::new(TapoParams::new(json)));
+
+        self.hub_handler
+            .control_child::<serde_json::Value>(self.device_id.clone(), request)
+            .await?;
+
+        Ok(())
+    }
+
+    /// Sets the *minimal control temperature*.
+    ///
+    /// # Arguments
+    ///
+    /// * `min_control_temperature`
+    pub async fn set_min_control_temperature(&self, min_control_temperature: u8) -> Result<(), Error> {
+        let json = serde_json::to_value(TrvSetDeviceInfoParams::new().min_control_temperature(min_control_temperature)?)?;
+        let request = TapoRequest::SetDeviceInfo(Box::new(TapoParams::new(json)));
+
+        self.hub_handler
+            .control_child::<serde_json::Value>(self.device_id.clone(), request)
+            .await?;
+
+        Ok(())
+    }
+
+    /// Sets the *maximum control temperature*.
+    ///
+    /// # Arguments
+    ///
+    /// * `max_control_temperature`
+    pub async fn set_max_control_temperature(&self, max_control_temperature: u8) -> Result<(), Error> {
+        let json = serde_json::to_value(TrvSetDeviceInfoParams::new().max_control_temperature(max_control_temperature)?)?;
+        let request = TapoRequest::SetDeviceInfo(Box::new(TapoParams::new(json)));
+
+        self.hub_handler
+            .control_child::<serde_json::Value>(self.device_id.clone(), request)
+            .await?;
+
+        Ok(())
+    }
+
+    /// Sets frost protection on the device to *on* or *off*.
+    ///     
+    /// # Arguments
+    ///
+    /// * `frost_protection_on` - true/false
+    pub async fn set_frost_protection(&self, frost_protection_on: bool) -> Result<(), Error> {
+        let json = serde_json::to_value(TrvSetDeviceInfoParams::new().frost_protection_on(frost_protection_on)?)?;
+        let request = TapoRequest::SetDeviceInfo(Box::new(TapoParams::new(json)));
+
+        self.hub_handler
+            .control_child::<serde_json::Value>(self.device_id.clone(), request)
+            .await?;
+
+        Ok(())
+    }
+
+    /// Sets child protection on the device to *on* or *off*.
+    ///     
+    /// # Arguments
+    ///
+    /// * `child_protection_on` - true/false
+    pub async fn set_child_protection(&self, child_protection_on: bool) -> Result<(), Error> {
+        let json = serde_json::to_value(TrvSetDeviceInfoParams::new().child_protection(child_protection_on)?)?;
+        let request = TapoRequest::SetDeviceInfo(Box::new(TapoParams::new(json)));
+
+        self.hub_handler
+            .control_child::<serde_json::Value>(self.device_id.clone(), request)
+            .await?;
+
+        Ok(())
+    }
+
+    /// Sets the *temperature offset*.
+    ///
+    /// # Arguments
+    ///
+    /// * `temperature_offset` - between 5 and 30
+    pub async fn set_temperature_offset(&self, temperature_offset: i8) -> Result<(), Error> {
+        let json = serde_json::to_value(TrvSetDeviceInfoParams::new().temperature_offset(temperature_offset)?)?;
+        let request = TapoRequest::SetDeviceInfo(Box::new(TapoParams::new(json)));
+
+        self.hub_handler
+            .control_child::<serde_json::Value>(self.device_id.clone(), request)
+            .await?;
+
+        Ok(())
+    }
+}

tapo/src/api/child_devices/s200b_handler.rs

@@ -1,5 +1,5 @@
 use crate::api::HubHandler;
-use crate::error::Error;
+use crate::error::{Error,TapoResponseError};
 use crate::requests::{EmptyParams, GetTriggerLogsParams, TapoParams, TapoRequest};
 use crate::responses::S200BResult;
 use crate::responses::{S200BLog, TriggerLogsResult};
@@ -25,7 +25,8 @@ impl<'h> S200BHandler<'h> {
 
         self.hub_handler
             .control_child(self.device_id.clone(), request)
-            .await
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
     }
 
     /// Returns a list of trigger logs.
@@ -46,6 +47,7 @@ impl<'h> S200BHandler<'h> {
 
         self.hub_handler
             .control_child(self.device_id.clone(), child_request)
-            .await
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
     }
 }

tapo/src/api/child_devices/t100_handler.rs

@@ -1,5 +1,5 @@
 use crate::api::HubHandler;
-use crate::error::Error;
+use crate::error::{Error, TapoResponseError};
 use crate::requests::{EmptyParams, GetTriggerLogsParams, TapoParams, TapoRequest};
 use crate::responses::T100Result;
 use crate::responses::{T100Log, TriggerLogsResult};
@@ -25,7 +25,8 @@ impl<'h> T100Handler<'h> {
 
         self.hub_handler
             .control_child(self.device_id.clone(), request)
-            .await
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
     }
 
     /// Returns a list of trigger logs.
@@ -46,6 +47,7 @@ impl<'h> T100Handler<'h> {
 
         self.hub_handler
             .control_child(self.device_id.clone(), child_request)
-            .await
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
     }
 }

tapo/src/api/child_devices/t110_handler.rs

@@ -1,5 +1,5 @@
 use crate::api::HubHandler;
-use crate::error::Error;
+use crate::error::{Error, TapoResponseError};
 use crate::requests::{EmptyParams, GetTriggerLogsParams, TapoParams, TapoRequest};
 use crate::responses::T110Result;
 use crate::responses::{T110Log, TriggerLogsResult};
@@ -25,7 +25,8 @@ impl<'h> T110Handler<'h> {
 
         self.hub_handler
             .control_child(self.device_id.clone(), request)
-            .await
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
     }
 
     /// Returns a list of trigger logs.
@@ -46,6 +47,7 @@ impl<'h> T110Handler<'h> {
 
         self.hub_handler
             .control_child(self.device_id.clone(), child_request)
-            .await
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
     }
 }

tapo/src/api/child_devices/t300_handler.rs

@@ -1,5 +1,5 @@
 use crate::api::HubHandler;
-use crate::error::Error;
+use crate::error::{Error,TapoResponseError};
 use crate::requests::{EmptyParams, GetTriggerLogsParams, TapoParams, TapoRequest};
 use crate::responses::T300Result;
 use crate::responses::{T300Log, TriggerLogsResult};
@@ -25,7 +25,8 @@ impl<'h> T300Handler<'h> {
 
         self.hub_handler
             .control_child(self.device_id.clone(), request)
-            .await
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
     }
 
     /// Returns a list of trigger logs.
@@ -44,8 +45,12 @@ impl<'h> T300Handler<'h> {
         let child_params = GetTriggerLogsParams::new(page_size, start_id);
         let child_request = TapoRequest::GetTriggerLogs(Box::new(TapoParams::new(child_params)));
 
-        self.hub_handler
-            .control_child(self.device_id.clone(), child_request)
-            .await
+        let result = self
+            .hub_handler
+            .control_child::<TriggerLogsResult<T300Log>>(self.device_id.clone(), child_request)
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult));
+
+        Ok(result?)
     }
 }

tapo/src/api/child_devices/t31x_handler.rs

@@ -1,5 +1,5 @@
 use crate::api::HubHandler;
-use crate::error::Error;
+use crate::error::{Error, TapoResponseError};
 use crate::requests::{EmptyParams, TapoParams, TapoRequest};
 use crate::responses::{T31XResult, TemperatureHumidityRecords, TemperatureHumidityRecordsRaw};
 
@@ -24,7 +24,8 @@ impl<'h> T31XHandler<'h> {
 
         self.hub_handler
             .control_child(self.device_id.clone(), request)
-            .await
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult))
     }
 
     /// Returns *temperature and humidity records* from the last 24 hours at 15 minute intervals as [`TemperatureHumidityRecords`].
@@ -37,8 +38,9 @@ impl<'h> T31XHandler<'h> {
         let result = self
             .hub_handler
             .control_child::<TemperatureHumidityRecordsRaw>(self.device_id.clone(), request)
-            .await?;
+            .await?
+            .ok_or_else(|| Error::Tapo(TapoResponseError::EmptyResult));
 
-        Ok(result.try_into()?)
+        Ok(result?.try_into()?)
     }
 }