automation_rs/automation_devices/src/contact_sensor.rs

use std::sync::Arc;
use std::time::Duration;

use async_trait::async_trait;
use automation_lib::action_callback::ActionCallback;
use automation_lib::config::{InfoConfig, MqttDeviceConfig};
use automation_lib::device::{Device, LuaDeviceCreate};
use automation_lib::error::DeviceConfigError;
use automation_lib::event::{OnMqtt, OnPresence};
use automation_lib::messages::{ContactMessage, PresenceMessage};
use automation_lib::mqtt::WrappedAsyncClient;
use automation_macro::{LuaDevice, LuaDeviceConfig};
use google_home::device;
use google_home::errors::{DeviceError, ErrorCode};
use google_home::traits::OpenClose;
use google_home::types::Type;
use serde::Deserialize;
use tokio::sync::{RwLock, RwLockReadGuard, RwLockWriteGuard};
use tokio::task::JoinHandle;
use tracing::{debug, error, trace, warn};

use crate::presence::DEFAULT_PRESENCE;

#[derive(Debug, Clone, Deserialize, PartialEq, Eq, Copy)]
pub enum SensorType {
    Door,
    Drawer,
    Window,
}

// NOTE: If we add more presence devices we might need to move this out of here
#[derive(Debug, Clone, LuaDeviceConfig)]
pub struct PresenceDeviceConfig {
    #[device_config(flatten)]
    pub mqtt: MqttDeviceConfig,
    #[device_config(with(Duration::from_secs))]
    pub timeout: Duration,
}

#[derive(Debug, Clone, LuaDeviceConfig)]
pub struct Config {
    #[device_config(flatten)]
    pub info: InfoConfig,
    #[device_config(flatten)]
    pub mqtt: MqttDeviceConfig,
    #[device_config(from_lua, default)]
    pub presence: Option<PresenceDeviceConfig>,

    #[device_config(default(SensorType::Window))]
    pub sensor_type: SensorType,

    #[device_config(from_lua, default)]
    pub callback: ActionCallback<ContactSensor, bool>,
    #[device_config(from_lua)]
    pub client: WrappedAsyncClient,
}

#[derive(Debug)]
struct State {
    overall_presence: bool,
    is_closed: bool,
    handle: Option<JoinHandle<()>>,
}

#[derive(Debug, Clone, LuaDevice)]
#[traits(OpenClose)]
pub struct ContactSensor {
    config: Config,
    state: Arc<RwLock<State>>,
}

impl ContactSensor {
    async fn state(&self) -> RwLockReadGuard<'_, State> {
        self.state.read().await
    }

    async fn state_mut(&self) -> RwLockWriteGuard<'_, State> {
        self.state.write().await
    }
}

#[async_trait]
impl LuaDeviceCreate for ContactSensor {
    type Config = Config;
    type Error = DeviceConfigError;

    async fn create(config: Self::Config) -> Result<Self, Self::Error> {
        trace!(id = config.info.identifier(), "Setting up ContactSensor");

        config
            .client
            .subscribe(&config.mqtt.topic, rumqttc::QoS::AtLeastOnce)
            .await?;

        let state = State {
            overall_presence: DEFAULT_PRESENCE,
            is_closed: true,
            handle: None,
        };
        let state = Arc::new(RwLock::new(state));

        Ok(Self { config, state })
    }
}

impl Device for ContactSensor {
    fn get_id(&self) -> String {
        self.config.info.identifier()
    }
}

#[async_trait]
impl google_home::Device for ContactSensor {
    fn get_device_type(&self) -> google_home::types::Type {
        match self.config.sensor_type {
            SensorType::Door => Type::Door,
            SensorType::Drawer => Type::Drawer,
            SensorType::Window => Type::Window,
        }
    }

    fn get_id(&self) -> String {
        Device::get_id(self)
    }

    fn get_device_name(&self) -> google_home::device::Name {
        device::Name::new(&self.config.info.name)
    }

    fn get_room_hint(&self) -> Option<&str> {
        self.config.info.room.as_deref()
    }

    fn will_report_state(&self) -> bool {
        false
    }

    async fn is_online(&self) -> bool {
        true
    }
}

#[async_trait]
impl OpenClose for ContactSensor {
    fn discrete_only_open_close(&self) -> Option<bool> {
        Some(true)
    }

    fn query_only_open_close(&self) -> Option<bool> {
        Some(true)
    }

    async fn open_percent(&self) -> Result<u8, ErrorCode> {
        if self.state().await.is_closed {
            Ok(0)
        } else {
            Ok(100)
        }
    }

    async fn set_open_percent(&self, _open_percent: u8) -> Result<(), ErrorCode> {
        Err(DeviceError::ActionNotAvailable.into())
    }
}

#[async_trait]
impl OnPresence for ContactSensor {
    async fn on_presence(&self, presence: bool) {
        self.state_mut().await.overall_presence = presence;
    }
}

#[async_trait]
impl OnMqtt for ContactSensor {
    async fn on_mqtt(&self, message: rumqttc::Publish) {
        if !rumqttc::matches(&message.topic, &self.config.mqtt.topic) {
            return;
        }

        let is_closed = match ContactMessage::try_from(message) {
            Ok(state) => state.is_closed(),
            Err(err) => {
                error!(id = self.get_id(), "Failed to parse message: {err}");
                return;
            }
        };

        if is_closed == self.state().await.is_closed {
            return;
        }

        self.config.callback.call(self, &!is_closed).await;

        debug!(id = self.get_id(), "Updating state to {is_closed}");
        self.state_mut().await.is_closed = is_closed;

        // Check if this contact sensor works as a presence device
        // If not we are done here
        let presence = match &self.config.presence {
            Some(presence) => presence.clone(),
            None => return,
        };

        if !is_closed {
            // Activate presence and stop any timeout once we open the door
            if let Some(handle) = self.state_mut().await.handle.take() {
                handle.abort();
            }

            // Only use the door as an presence sensor if there the current presence is set false
            // This is to prevent the house from being marked as present for however long the
            // timeout is set when leaving the house
            if !self.state().await.overall_presence {
                self.config
                    .client
                    .publish(
                        &presence.mqtt.topic,
                        rumqttc::QoS::AtLeastOnce,
                        false,
                        serde_json::to_string(&PresenceMessage::new(true)).unwrap(),
                    )
                    .await
                    .map_err(|err| {
                        warn!(
                            "Failed to publish presence on {}: {err}",
                            presence.mqtt.topic
                        )
                    })
                    .ok();
            }
        } else {
            // Once the door is closed again we start a timeout for removing the presence
            let device = self.clone();
            self.state_mut().await.handle = Some(tokio::spawn(async move {
                debug!(
                    id = device.get_id(),
                    "Starting timeout ({:?}) for contact sensor...", presence.timeout
                );
                tokio::time::sleep(presence.timeout).await;
                debug!(id = device.get_id(), "Removing door device!");
                device
                    .config
                    .client
                    .publish(&presence.mqtt.topic, rumqttc::QoS::AtLeastOnce, false, "")
                    .await
                    .map_err(|err| {
                        warn!(
                            "Failed to publish presence on {}: {err}",
                            presence.mqtt.topic
                        )
                    })
                    .ok();
            }));
        }
    }
}