feat: Reduced visibility of config structs

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,5 +1,6 @@
 local ntfy = require("config.ntfy")
 
+--- @class BatteryModule: Module
 local module = {}
 
 --- @type {[string]: number}
@@ -17,7 +18,7 @@ function module.callback(device, battery)
 	end
 end
 
-function module.notify_low_battery()
+local function 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")
@@ -38,4 +39,9 @@ function module.notify_low_battery()
 	})
 end
 
+--- @type Schedule
+module.schedule = {
+	["0 0 21 */1 * *"] = notify_low_battery,
+}
+
 return module

config/config.lua

@@ -29,14 +29,4 @@ 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,6 +4,7 @@ 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,6 +1,7 @@
 local debug = require("config.debug")
 local utils = require("automation:utils")
 
+--- @class HallwayAutomationModule: Module
 local module = {}
 
 local timeout = utils.Timeout.new()

config/helper.lua

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

config/hue_bridge.lua

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

config/ntfy.lua

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

config/presence.lua

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

config/rooms.lua

@@ -1,4 +1,4 @@
---- @type SetupTable
+--- @type Module
 return {
 	require("config.rooms.bathroom"),
 	require("config.rooms.bedroom"),

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,6 +30,7 @@ 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,20 +55,24 @@ function module.setup(mqtt_client)
 	})
 	windows.add(window)
 
+	--- @type Module
 	return {
-		lights,
-		lights_relax,
-		air_filter,
-		switch,
-		window,
+		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,6 +25,7 @@ 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,6 +97,7 @@ 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,6 +37,7 @@ function module.setup(mqtt_client)
 		battery_callback = battery.callback,
 	})
 
+	--- @type Module
 	return {
 		light,
 		top_switch,

config/rooms/kitchen.lua

@@ -4,6 +4,7 @@ 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,6 +109,7 @@ 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,6 +31,7 @@ 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,6 +57,7 @@ function module.setup(mqtt_client)
 		battery_callback = battery.callback,
 	})
 
+	--- @type Module
 	return {
 		charger,
 		outlets,

config/windows.lua

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

definitions/config.lua

@@ -9,14 +9,20 @@ local FulfillmentConfig
 
 ---@class Config
 ---@field fulfillment FulfillmentConfig
----@field modules (Modules)?
+---@field modules (Module)[]
 ---@field mqtt MqttConfig
----@field schedule (table<string, fun() | fun()[]>)?
 local Config
 
----@alias SetupFunction fun(mqtt_client: AsyncClient): SetupTable?
----@alias SetupTable (DeviceInterface | { setup: SetupFunction? } | SetupTable)[]
----@alias Modules SetupFunction | SetupTable
+---@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)[]?
+local Module
 
 ---@class MqttConfig
 ---@field host string

src/bin/automation.rs

@@ -6,7 +6,6 @@ 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};
@@ -140,13 +139,12 @@ async fn app() -> anyhow::Result<()> {
 
     let mqtt_client = mqtt::start(config.mqtt, &device_manager.event_channel());
 
-    if let Some(modules) = config.modules {
-        for device in modules.setup(&lua, &mqtt_client).await? {
-            device_manager.add(device).await;
-        }
+    let resolved = config.modules.resolve(&lua, &mqtt_client).await?;
+    for device in resolved.devices {
+        device_manager.add(device).await;
     }
 
-    start_scheduler(config.schedule).await?;
+    resolved.scheduler.start().await?;
 
     // Create google home fulfillment route
     let fulfillment = Router::new().route("/google_home", post(fulfillment));

src/bin/generate_definitions.rs

@@ -1,10 +1,8 @@
 use std::fs::{self, File};
 use std::io::Write;
 
-use automation::config::{Config, FulfillmentConfig, Modules};
+use automation::config::generate_definitions;
 use automation_lib::Module;
-use automation_lib::mqtt::{MqttConfig, WrappedAsyncClient};
-use lua_typed::Typed;
 use tracing::{info, warn};
 
 extern crate automation_devices;
@@ -27,24 +25,6 @@ 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 += &Modules::generate_full().expect("Setups 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();
 
@@ -59,7 +39,7 @@ fn main() -> std::io::Result<()> {
         }
     }
 
-    write_definitions("config.lua", &config_definitions())?;
+    write_definitions("config.lua", &generate_definitions())?;
 
     Ok(())
 }

src/config.rs

@@ -1,5 +1,6 @@
 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;
@@ -9,6 +10,8 @@ use lua_typed::Typed;
 use mlua::FromLua;
 use serde::Deserialize;
 
+use crate::schedule::Scheduler;
+
 #[derive(Debug, Deserialize)]
 pub struct Setup {
     #[serde(default = "default_entrypoint")]
@@ -34,90 +37,219 @@ pub struct FulfillmentConfig {
     pub port: u16,
 }
 
+#[derive(Debug)]
+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(),
+            WrappedAsyncClient::type_name(),
+            Module::type_name()
+        ))
+    }
+}
+
+impl FromLua for SetupFunction {
+    fn from_lua(value: mlua::Value, lua: &mlua::Lua) -> mlua::Result<Self> {
+        Ok(Self(FromLua::from_lua(value, lua)?))
+    }
+}
+
+impl Deref for SetupFunction {
+    type Target = mlua::Function;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
 #[derive(Debug, Default)]
-pub struct Modules(mlua::Value);
+struct Schedule(HashMap<String, ActionCallback<()>>);
 
-impl Modules {
-    pub async fn setup(
-        self,
-        lua: &mlua::Lua,
-        client: &WrappedAsyncClient,
-    ) -> mlua::Result<Vec<Box<dyn Device>>> {
-        let mut devices = Vec::new();
-        let initial_table = match self.0 {
-            mlua::Value::Table(table) => table,
-            mlua::Value::Function(f) => f.call_async(client.clone()).await?,
-            _ => Err(mlua::Error::runtime(format!(
-                "Expected table or function, instead found: {}",
-                self.0.type_name()
-            )))?,
-        };
+impl Typed for Schedule {
+    fn type_name() -> String {
+        "Schedule".into()
+    }
 
-        let mut queue: VecDeque<mlua::Table> = [initial_table].into();
-        loop {
-            let Some(table) = queue.pop_front() else {
-                break;
-            };
+    fn generate_header() -> Option<String> {
+        Some(format!(
+            "---@alias {} {}\n",
+            Self::type_name(),
+            HashMap::<String, ActionCallback<()>>::type_name(),
+        ))
+    }
+}
 
-            for pair in table.pairs() {
-                let (name, value): (String, _) = pair?;
+impl FromLua for Schedule {
+    fn from_lua(value: mlua::Value, lua: &mlua::Lua) -> mlua::Result<Self> {
+        Ok(Self(FromLua::from_lua(value, lua)?))
+    }
+}
 
-                match value {
-                    mlua::Value::Table(table) => queue.push_back(table),
-                    mlua::Value::UserData(_)
-                        if let Ok(device) = Box::from_lua(value.clone(), lua) =>
-                    {
-                        devices.push(device);
-                    }
-                    mlua::Value::Function(f) if name == "setup" => {
-                        let value: mlua::Value = f.call_async(client.clone()).await?;
-                        if let Some(table) = value.as_table() {
-                            queue.push_back(table.clone());
-                        }
-                    }
-                    _ => {}
-                }
-            }
+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>,
+}
+
+// TODO: Add option to typed to rename field
+impl Typed for Module {
+    fn type_name() -> String {
+        "Module".into()
+    }
+
+    fn generate_header() -> Option<String> {
+        Some(format!("---@class {}\n", Self::type_name()))
+    }
+
+    fn generate_members() -> Option<String> {
+        Some(format!(
+            r#"---@field setup {}
+---@field devices {}?
+---@field schedule {}?
+---@field [number] {}?
+"#,
+            Option::<SetupFunction>::type_name(),
+            Vec::<Box<dyn Device>>::type_name(),
+            Schedule::type_name(),
+            Vec::<Module>::type_name(),
+        ))
+    }
+
+    fn generate_footer() -> Option<String> {
+        let type_name = <Self as Typed>::type_name();
+        Some(format!("local {type_name}\n"))
+    }
+}
+
+impl FromLua for Module {
+    fn from_lua(value: mlua::Value, _lua: &mlua::Lua) -> mlua::Result<Self> {
+        // When calling require it might return a result from the searcher indicating how the
+        // module was found, we want to ignore these entries.
+        // TODO: Find a better solution for this
+        if value.is_string() {
+            return Ok(Default::default());
         }
 
-        Ok(devices)
+        let mlua::Value::Table(table) = value else {
+            return Err(mlua::Error::runtime(format!(
+                "Expected module table, instead found: {}",
+                value.type_name()
+            )));
+        };
+
+        let setup = table.get("setup")?;
+        let devices = table.get("devices").unwrap_or_default();
+        let schedule = table.get("schedule").unwrap_or_default();
+
+        let mut modules = Vec::new();
+
+        for module in table.sequence_values::<Module>() {
+            modules.push(module?);
+        }
+
+        Ok(Module {
+            setup,
+            devices,
+            schedule,
+            modules,
+        })
+    }
+}
+
+#[derive(Debug, Default)]
+pub struct Modules(Vec<Module>);
+
+impl Typed for Modules {
+    fn type_name() -> String {
+        Vec::<Module>::type_name()
     }
 }
 
 impl FromLua for Modules {
-    fn from_lua(value: mlua::Value, _lua: &mlua::Lua) -> mlua::Result<Self> {
-        Ok(Modules(value))
+    fn from_lua(value: mlua::Value, lua: &mlua::Lua) -> mlua::Result<Self> {
+        Ok(Self(FromLua::from_lua(value, lua)?))
     }
 }
 
-impl Typed for Modules {
-    fn type_name() -> String {
-        "Modules".into()
-    }
+impl Modules {
+    pub async fn resolve(
+        self,
+        lua: &mlua::Lua,
+        client: &WrappedAsyncClient,
+    ) -> mlua::Result<Resolved> {
+        let mut devices = Vec::new();
+        let mut scheduler = Scheduler::default();
 
-    fn generate_header() -> Option<String> {
-        let type_name = Self::type_name();
-        let client_type = WrappedAsyncClient::type_name();
+        let mut modules: VecDeque<_> = self.0.into();
+        loop {
+            let Some(module) = modules.pop_front() else {
+                break;
+            };
 
-        Some(format!(
-            r#"---@alias SetupFunction fun(mqtt_client: {client_type}): SetupTable?
----@alias SetupTable (DeviceInterface | {{ setup: SetupFunction? }} | SetupTable)[]
----@alias {type_name} SetupFunction | SetupTable
-"#,
-        ))
+            modules.extend(module.modules);
+
+            if let Some(setup) = module.setup {
+                let result: mlua::Value = setup.call_async(client.clone()).await?;
+
+                if result.is_nil() {
+                    // We ignore nil results
+                } else if let Ok(d) = <Vec<_> as FromLua>::from_lua(result.clone(), lua)
+                    && !d.is_empty()
+                {
+                    // This is a shortcut for the common pattern of setup functions that only
+                    // return devices
+                    devices.extend(d);
+                } else if let Ok(module) = FromLua::from_lua(result.clone(), lua) {
+                    modules.push_back(module);
+                } else {
+                    return Err(mlua::Error::runtime(
+                        "Setup function returned data in an unexpected format",
+                    ));
+                }
+            }
+
+            devices.extend(module.devices);
+            for (cron, f) in module.schedule {
+                scheduler.add_job(cron, f);
+            }
+        }
+
+        Ok(Resolved { devices, scheduler })
     }
 }
 
+#[derive(Debug, Default)]
+pub struct Resolved {
+    pub devices: Vec<Box<dyn Device>>,
+    pub scheduler: Scheduler,
+}
+
 #[derive(Debug, LuaDeviceConfig, Typed)]
 pub struct Config {
     pub fulfillment: FulfillmentConfig,
     #[device_config(from_lua, default)]
-    pub modules: Option<Modules>,
+    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 {
@@ -132,3 +264,25 @@ 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,29 +1,37 @@
-use std::collections::HashMap;
 use std::pin::Pin;
 
 use automation_lib::action_callback::ActionCallback;
 use tokio_cron_scheduler::{Job, JobScheduler, JobSchedulerError};
 
-pub async fn start_scheduler(
-    schedule: HashMap<String, ActionCallback<()>>,
-) -> Result<(), JobSchedulerError> {
-    let scheduler = JobScheduler::new().await?;
+#[derive(Debug, Default)]
+pub struct Scheduler {
+    jobs: Vec<(String, ActionCallback<()>)>,
+}
 
-    for (s, f) in schedule {
-        let job = {
-            move |_uuid, _lock| -> Pin<Box<dyn Future<Output = ()> + Send>> {
-                let f = f.clone();
-
-                Box::pin(async move {
-                    f.call(()).await;
-                })
-            }
-        };
-
-        let job = Job::new_async(s, job)?;
-
-        scheduler.add(job).await?;
+impl Scheduler {
+    pub fn add_job(&mut self, cron: String, f: ActionCallback<()>) {
+        self.jobs.push((cron, f));
     }
 
-    scheduler.start().await
+    pub async fn start(self) -> Result<(), JobSchedulerError> {
+        let scheduler = JobScheduler::new().await?;
+
+        for (s, f) in self.jobs {
+            let job = {
+                move |_uuid, _lock| -> Pin<Box<dyn Future<Output = ()> + Send>> {
+                    let f = f.clone();
+
+                    Box::pin(async move {
+                        f.call(()).await;
+                    })
+                }
+            };
+
+            let job = Job::new_async(s, job)?;
+
+            scheduler.add(job).await?;
+        }
+
+        scheduler.start().await
+    }
 }