feat(config)!: Improve config module resolution

The new system is slightly less flexible, but the code and lua
definitions is now a lot simpler and easier to understand.
In fact the old lua definition was not actually correct.

It is likely that existing configs require not/minimal tweaks to work
again.

config/battery.lua

@@ -1,6 +1,5 @@
 local ntfy = require("config.ntfy")
 
---- @class BatteryModule: Module
 local module = {}
 
 --- @type {[string]: number}
@@ -18,7 +17,7 @@ function module.callback(device, battery)
 	end
 end
 
-local function notify_low_battery()
+function module.notify_low_battery()
 	-- Don't send notifications if there are now devices with low battery
 	if next(low_battery) == nil then
 		print("No devices with low battery")
@@ -39,9 +38,4 @@ local function notify_low_battery()
 	})
 end
 
---- @type Schedule
-module.schedule = {
-	["0 0 21 */1 * *"] = notify_low_battery,
-}
-
 return module

config/config.lua

@@ -29,4 +29,14 @@ return {
 		require("config.rooms"),
 		require("config.windows"),
 	},
+	-- TODO: Make this also part of the modules
+	schedule = {
+		["0 0 19 * * *"] = function()
+			require("config.rooms.bedroom").set_airfilter_on(true)
+		end,
+		["0 0 20 * * *"] = function()
+			require("config.rooms.bedroom").set_airfilter_on(false)
+		end,
+		["0 0 21 */1 * *"] = require("config.battery").notify_low_battery,
+	},
 }

config/debug.lua

@@ -4,7 +4,6 @@ local presence = require("config.presence")
 local utils = require("automation:utils")
 local variables = require("automation:variables")
 
---- @class DebugModule: Module
 local module = {}
 
 if variables.debug == "true" then

config/hallway_automation.lua

@@ -1,7 +1,6 @@
 local debug = require("config.debug")
 local utils = require("automation:utils")
 
---- @class HallwayAutomationModule: Module
 local module = {}
 
 local timeout = utils.Timeout.new()

config/helper.lua

@@ -1,6 +1,5 @@
 local utils = require("automation:utils")
 
---- @class HelperModule: Module
 local module = {}
 
 --- @param topic string

config/hue_bridge.lua

@@ -3,7 +3,6 @@ local light = require("config.light")
 local presence = require("config.presence")
 local secrets = require("automation:secrets")
 
---- @class HueBridgeModule: Module
 local module = {}
 
 module.ip = "10.0.0.102"

config/light.lua

@@ -1,7 +1,6 @@
 local devices = require("automation:devices")
 local helper = require("config.helper")
 
---- @class LightModule: Module
 local module = {}
 
 --- @class OnPresence
@@ -35,7 +34,6 @@ function module.setup(mqtt_client)
 		callback = callback,
 	})
 
-	--- @type Module
 	return {
 		module.device,
 	}

config/ntfy.lua

@@ -1,7 +1,6 @@
 local devices = require("automation:devices")
 local secrets = require("automation:secrets")
 
---- @class NtfyModule: Module
 local module = {}
 
 local ntfy_topic = secrets.ntfy_topic
@@ -25,7 +24,6 @@ function module.setup()
 		topic = ntfy_topic,
 	})
 
-	--- @type Module
 	return {
 		ntfy,
 	}

config/presence.lua

@@ -2,7 +2,6 @@ local devices = require("automation:devices")
 local helper = require("config.helper")
 local ntfy = require("config.ntfy")
 
---- @class PresenceModule: Module
 local module = {}
 
 --- @class OnPresence
@@ -62,7 +61,6 @@ function module.setup(mqtt_client)
 		})
 	end)
 
-	--- @type Module
 	return {
 		presence,
 	}

config/rooms/bathroom.lua

@@ -3,9 +3,9 @@ local devices = require("automation:devices")
 local helper = require("config.helper")
 local ntfy = require("config.ntfy")
 
---- @type Module
 local module = {}
 
+--- @type SetupFunction
 function module.setup(mqtt_client)
 	local light = devices.LightOnOff.new({
 		name = "Light",
@@ -30,7 +30,6 @@ function module.setup(mqtt_client)
 		end,
 	})
 
-	--- @type Module
 	return {
 		light,
 		washer,

config/rooms/bedroom.lua

@@ -4,12 +4,12 @@ local helper = require("config.helper")
 local hue_bridge = require("config.hue_bridge")
 local windows = require("config.windows")
 
---- @type Module
 local module = {}
 
 --- @type AirFilter?
 local air_filter = nil
 
+--- @type SetupFunction
 function module.setup(mqtt_client)
 	local lights = devices.HueGroup.new({
 		identifier = "bedroom_lights",
@@ -55,24 +55,20 @@ function module.setup(mqtt_client)
 	})
 	windows.add(window)
 
-	--- @type Module
 	return {
-		devices = {
 		lights,
 		lights_relax,
 		air_filter,
 		switch,
 		window,
-		},
-		schedule = {
-			["0 0 19 * * *"] = function()
-				air_filter:set_on(true)
-			end,
-			["0 0 20 * * *"] = function()
-				air_filter:set_on(false)
-			end,
-		},
 	}
 end
 
+--- @param on boolean
+function module.set_airfilter_on(on)
+	if air_filter then
+		air_filter:set_on(on)
+	end
+end
+
 return module

config/rooms/guest_bedroom.lua

@@ -4,9 +4,9 @@ local helper = require("config.helper")
 local presence = require("config.presence")
 local windows = require("config.windows")
 
---- @type Module
 local module = {}
 
+--- @type SetupFunction
 function module.setup(mqtt_client)
 	local light = devices.LightOnOff.new({
 		name = "Light",
@@ -25,7 +25,6 @@ function module.setup(mqtt_client)
 	})
 	windows.add(window)
 
-	--- @type Module
 	return {
 		light,
 		window,

config/rooms/hallway_bottom.lua

@@ -8,9 +8,9 @@ local presence = require("config.presence")
 local utils = require("automation:utils")
 local windows = require("config.windows")
 
---- @type Module
 local module = {}
 
+--- @type SetupFunction
 function module.setup(mqtt_client)
 	local main_light = devices.HueGroup.new({
 		identifier = "hallway_main_light",
@@ -97,7 +97,6 @@ function module.setup(mqtt_client)
 	windows.add(frontdoor)
 	hallway_automation.set_door(frontdoor)
 
-	--- @type Module
 	return {
 		main_light,
 		storage_light,

config/rooms/hallway_top.lua

@@ -3,9 +3,9 @@ local devices = require("automation:devices")
 local helper = require("config.helper")
 local hue_bridge = require("config.hue_bridge")
 
---- @type Module
 local module = {}
 
+--- @type SetupFunction
 function module.setup(mqtt_client)
 	local light = devices.HueGroup.new({
 		identifier = "hallway_top_light",
@@ -37,7 +37,6 @@ function module.setup(mqtt_client)
 		battery_callback = battery.callback,
 	})
 
-	--- @type Module
 	return {
 		light,
 		top_switch,

config/rooms/kitchen.lua

@@ -4,7 +4,6 @@ local helper = require("config.helper")
 local hue_bridge = require("config.hue_bridge")
 local presence = require("config.presence")
 
---- @class KitchenModule: Module
 local module = {}
 
 --- @type HueGroup?

config/rooms/living_room.lua

@@ -5,9 +5,9 @@ local hue_bridge = require("config.hue_bridge")
 local presence = require("config.presence")
 local windows = require("config.windows")
 
---- @type Module
 local module = {}
 
+--- @type SetupFunction
 function module.setup(mqtt_client)
 	local lights = devices.HueGroup.new({
 		identifier = "living_lights",
@@ -109,7 +109,6 @@ function module.setup(mqtt_client)
 	})
 	windows.add(window)
 
-	--- @type Module
 	return {
 		lights,
 		lights_relax,

config/rooms/storage.lua

@@ -3,9 +3,9 @@ local devices = require("automation:devices")
 local helper = require("config.helper")
 local presence = require("config.presence")
 
---- @type Module
 local module = {}
 
+--- @type SetupFunction
 function module.setup(mqtt_client)
 	local light = devices.LightBrightness.new({
 		name = "Light",
@@ -31,7 +31,6 @@ function module.setup(mqtt_client)
 		battery_callback = battery.callback,
 	})
 
-	--- @type Module
 	return {
 		light,
 		door,

config/rooms/workbench.lua

@@ -5,9 +5,9 @@ local helper = require("config.helper")
 local presence = require("config.presence")
 local utils = require("automation:utils")
 
---- @type Module
 local module = {}
 
+--- @type SetupFunction
 function module.setup(mqtt_client)
 	local charger = devices.OutletOnOff.new({
 		name = "Charger",
@@ -57,7 +57,6 @@ function module.setup(mqtt_client)
 		battery_callback = battery.callback,
 	})
 
-	--- @type Module
 	return {
 		charger,
 		outlets,

config/windows.lua

@@ -1,7 +1,6 @@
 local ntfy = require("config.ntfy")
 local presence = require("config.presence")
 
---- @class WindowsModule: Module
 local module = {}
 
 --- @class OnPresence

definitions/config.lua

@@ -11,17 +11,13 @@ local FulfillmentConfig
 ---@field fulfillment FulfillmentConfig
 ---@field modules (Module)[]
 ---@field mqtt MqttConfig
+---@field schedule (table<string, fun() | fun()[]>)?
 local Config
 
----@alias SetupFunction fun(mqtt_client: AsyncClient): Module | DeviceInterface[] | nil
-
----@alias Schedule table<string, fun() | fun()[]>
-
 ---@class Module
----@field setup (SetupFunction)?
----@field devices (DeviceInterface)[]?
----@field schedule Schedule?
----@field [number] (Module)[]?
+---@field setup (fun(mqtt_client: AsyncClient): Module | DeviceInterface[] | nil)?
+---@field devices DeviceInterface[]?
+---@field [number] Module[]?
 local Module
 
 ---@class MqttConfig

src/bin/automation.rs

@@ -6,6 +6,7 @@ use std::process;
 
 use ::config::{Environment, File};
 use automation::config::{Config, Setup};
+use automation::schedule::start_scheduler;
 use automation::secret::EnvironmentSecretFile;
 use automation::version::VERSION;
 use automation::web::{ApiError, User};
@@ -144,7 +145,7 @@ async fn app() -> anyhow::Result<()> {
         device_manager.add(device).await;
     }
 
-    resolved.scheduler.start().await?;
+    start_scheduler(config.schedule).await?;
 
     // Create google home fulfillment route
     let fulfillment = Router::new().route("/google_home", post(fulfillment));

src/bin/generate_definitions.rs

@@ -1,8 +1,10 @@
 use std::fs::{self, File};
 use std::io::Write;
 
-use automation::config::generate_definitions;
+use automation::config::{Config, FulfillmentConfig, Module as ConfigModule};
 use automation_lib::Module;
+use automation_lib::mqtt::{MqttConfig, WrappedAsyncClient};
+use lua_typed::Typed;
 use tracing::{info, warn};
 
 extern crate automation_devices;
@@ -25,6 +27,24 @@ fn write_definitions(filename: &str, definitions: &str) -> std::io::Result<()> {
     Ok(())
 }
 
+fn config_definitions() -> String {
+    let mut output = "---@meta\n\n".to_string();
+
+    output +=
+        &FulfillmentConfig::generate_full().expect("FulfillmentConfig should have a definition");
+    output += "\n";
+    output += &Config::generate_full().expect("Config should have a definition");
+    output += "\n";
+    output += &ConfigModule::generate_full().expect("Module should have a definition");
+    output += "\n";
+    output += &MqttConfig::generate_full().expect("MqttConfig should have a definition");
+    output += "\n";
+    output +=
+        &WrappedAsyncClient::generate_full().expect("WrappedAsyncClient should have a definition");
+
+    output
+}
+
 fn main() -> std::io::Result<()> {
     tracing_subscriber::fmt::init();
 
@@ -39,7 +59,7 @@ fn main() -> std::io::Result<()> {
         }
     }
 
-    write_definitions("config.lua", &generate_definitions())?;
+    write_definitions("config.lua", &config_definitions())?;
 
     Ok(())
 }

src/config.rs

@@ -1,6 +1,5 @@
 use std::collections::{HashMap, VecDeque};
 use std::net::{Ipv4Addr, SocketAddr};
-use std::ops::Deref;
 
 use automation_lib::action_callback::ActionCallback;
 use automation_lib::device::Device;
@@ -10,8 +9,6 @@ use lua_typed::Typed;
 use mlua::FromLua;
 use serde::Deserialize;
 
-use crate::schedule::Scheduler;
-
 #[derive(Debug, Deserialize)]
 pub struct Setup {
     #[serde(default = "default_entrypoint")]
@@ -38,20 +35,15 @@ pub struct FulfillmentConfig {
 }
 
 #[derive(Debug)]
-struct SetupFunction(mlua::Function);
+pub struct SetupFunction(mlua::Function);
 
 impl Typed for SetupFunction {
     fn type_name() -> String {
-        "SetupFunction".into()
-    }
-
-    fn generate_header() -> Option<String> {
-        Some(format!(
-            "---@alias {} fun(mqtt_client: {}): {} | DeviceInterface[] | nil\n",
-            Self::type_name(),
+        format!(
+            "fun(mqtt_client: {}): {} | DeviceInterface[] | nil",
             WrappedAsyncClient::type_name(),
             Module::type_name()
-        ))
+        )
     }
 }
 
@@ -61,53 +53,11 @@ impl FromLua for SetupFunction {
     }
 }
 
-impl Deref for SetupFunction {
-    type Target = mlua::Function;
-
-    fn deref(&self) -> &Self::Target {
-        &self.0
-    }
-}
-
 #[derive(Debug, Default)]
-struct Schedule(HashMap<String, ActionCallback<()>>);
-
-impl Typed for Schedule {
-    fn type_name() -> String {
-        "Schedule".into()
-    }
-
-    fn generate_header() -> Option<String> {
-        Some(format!(
-            "---@alias {} {}\n",
-            Self::type_name(),
-            HashMap::<String, ActionCallback<()>>::type_name(),
-        ))
-    }
-}
-
-impl FromLua for Schedule {
-    fn from_lua(value: mlua::Value, lua: &mlua::Lua) -> mlua::Result<Self> {
-        Ok(Self(FromLua::from_lua(value, lua)?))
-    }
-}
-
-impl IntoIterator for Schedule {
-    type Item = <HashMap<String, ActionCallback<()>> as IntoIterator>::Item;
-
-    type IntoIter = <HashMap<String, ActionCallback<()>> as IntoIterator>::IntoIter;
-
-    fn into_iter(self) -> Self::IntoIter {
-        self.0.into_iter()
-    }
-}
-
-#[derive(Debug, Default)]
-struct Module {
-    setup: Option<SetupFunction>,
-    devices: Vec<Box<dyn Device>>,
-    schedule: Schedule,
-    modules: Vec<Module>,
+pub struct Module {
+    pub setup: Option<SetupFunction>,
+    pub devices: Vec<Box<dyn Device>>,
+    pub modules: Vec<Module>,
 }
 
 // TODO: Add option to typed to rename field
@@ -123,14 +73,10 @@ impl Typed for Module {
     fn generate_members() -> Option<String> {
         Some(format!(
             r#"---@field setup {}
----@field devices {}?
----@field schedule {}?
----@field [number] {}?
+---@field devices DeviceInterface[]?
+---@field [number] Module[]?
 "#,
-            Option::<SetupFunction>::type_name(),
-            Vec::<Box<dyn Device>>::type_name(),
-            Schedule::type_name(),
-            Vec::<Module>::type_name(),
+            Option::<SetupFunction>::type_name()
         ))
     }
 
@@ -157,9 +103,8 @@ impl FromLua for Module {
         };
 
         let setup = table.get("setup")?;
-        let devices = table.get("devices").unwrap_or_default();
-        let schedule = table.get("schedule").unwrap_or_default();
 
+        let devices = table.get("devices").unwrap_or_else(|_| Vec::new());
         let mut modules = Vec::new();
 
         for module in table.sequence_values::<Module>() {
@@ -169,7 +114,6 @@ impl FromLua for Module {
         Ok(Module {
             setup,
             devices,
-            schedule,
             modules,
         })
     }
@@ -196,10 +140,10 @@ impl Modules {
         lua: &mlua::Lua,
         client: &WrappedAsyncClient,
     ) -> mlua::Result<Resolved> {
-        let mut devices = Vec::new();
-        let mut scheduler = Scheduler::default();
-
         let mut modules: VecDeque<_> = self.0.into();
+
+        let mut devices = Vec::new();
+
         loop {
             let Some(module) = modules.pop_front() else {
                 break;
@@ -208,7 +152,7 @@ impl Modules {
             modules.extend(module.modules);
 
             if let Some(setup) = module.setup {
-                let result: mlua::Value = setup.call_async(client.clone()).await?;
+                let result: mlua::Value = setup.0.call_async(client.clone()).await?;
 
                 if result.is_nil() {
                     // We ignore nil results
@@ -228,19 +172,15 @@ impl Modules {
             }
 
             devices.extend(module.devices);
-            for (cron, f) in module.schedule {
-                scheduler.add_job(cron, f);
-            }
         }
 
-        Ok(Resolved { devices, scheduler })
+        Ok(Resolved { devices })
     }
 }
 
 #[derive(Debug, Default)]
 pub struct Resolved {
     pub devices: Vec<Box<dyn Device>>,
-    pub scheduler: Scheduler,
 }
 
 #[derive(Debug, LuaDeviceConfig, Typed)]
@@ -250,6 +190,9 @@ pub struct Config {
     pub modules: Modules,
     #[device_config(from_lua)]
     pub mqtt: MqttConfig,
+    #[device_config(from_lua, default)]
+    #[typed(default)]
+    pub schedule: HashMap<String, ActionCallback<()>>,
 }
 
 impl From<FulfillmentConfig> for SocketAddr {
@@ -264,25 +207,3 @@ fn default_fulfillment_ip() -> Ipv4Addr {
 fn default_fulfillment_port() -> u16 {
     7878
 }
-
-pub fn generate_definitions() -> String {
-    let mut output = "---@meta\n\n".to_string();
-
-    output +=
-        &FulfillmentConfig::generate_full().expect("FulfillmentConfig should have a definition");
-    output += "\n";
-    output += &Config::generate_full().expect("Config should have a definition");
-    output += "\n";
-    output += &SetupFunction::generate_full().expect("SetupFunction should have a definition");
-    output += "\n";
-    output += &Schedule::generate_full().expect("Schedule should have a definition");
-    output += "\n";
-    output += &Module::generate_full().expect("Module should have a definition");
-    output += "\n";
-    output += &MqttConfig::generate_full().expect("MqttConfig should have a definition");
-    output += "\n";
-    output +=
-        &WrappedAsyncClient::generate_full().expect("WrappedAsyncClient should have a definition");
-
-    output
-}

src/schedule.rs

@@ -1,22 +1,15 @@
+use std::collections::HashMap;
 use std::pin::Pin;
 
 use automation_lib::action_callback::ActionCallback;
 use tokio_cron_scheduler::{Job, JobScheduler, JobSchedulerError};
 
-#[derive(Debug, Default)]
-pub struct Scheduler {
-    jobs: Vec<(String, ActionCallback<()>)>,
-}
-
-impl Scheduler {
-    pub fn add_job(&mut self, cron: String, f: ActionCallback<()>) {
-        self.jobs.push((cron, f));
-    }
-
-    pub async fn start(self) -> Result<(), JobSchedulerError> {
+pub async fn start_scheduler(
+    schedule: HashMap<String, ActionCallback<()>>,
+) -> Result<(), JobSchedulerError> {
     let scheduler = JobScheduler::new().await?;
 
-        for (s, f) in self.jobs {
+    for (s, f) in schedule {
         let job = {
             move |_uuid, _lock| -> Pin<Box<dyn Future<Output = ()> + Send>> {
                 let f = f.clone();
@@ -34,4 +27,3 @@ impl Scheduler {
 
     scheduler.start().await
 }
-}