Feat(config)!: Move new_mqtt_client out of global automation table into separate module

The function `new_mqtt_client` was the last remaining entry in the
global `automation` table. The function was renamed to `new` and placed
in the new `mqtt` module. As `automation` is now empty, it has been
removed.

config.lua

@@ -1,9 +1,12 @@
+local device_manager = require("device_manager")
+local utils = require("utils")
+
 print(_VERSION)
 
-local host = automation.util.get_hostname()
+local host = utils.get_hostname()
 print("Running @" .. host)
 
-local debug, value = pcall(automation.util.get_env, "DEBUG")
+local debug, value = pcall(utils.get_env, "DEBUG")
 if debug and value ~= "true" then
 	debug = false
 end
@@ -16,23 +19,23 @@ local function mqtt_automation(topic)
 	return "automation/" .. topic
 end
 
-automation.fulfillment = {
+local fulfillment = {
 	openid_url = "https://login.huizinga.dev/api/oidc",
 }
 
-local mqtt_client = automation.new_mqtt_client({
+local mqtt_client = require("mqtt").new({
 	host = ((host == "zeus" or host == "hephaestus") and "olympus.lan.huizinga.dev") or "mosquitto",
 	port = 8883,
 	client_name = "automation-" .. host,
 	username = "mqtt",
-	password = automation.util.get_env("MQTT_PASSWORD"),
+	password = utils.get_env("MQTT_PASSWORD"),
 	tls = host == "zeus" or host == "hephaestus",
 })
 
 local ntfy = Ntfy.new({
-	topic = automation.util.get_env("NTFY_TOPIC"),
+	topic = utils.get_env("NTFY_TOPIC"),
 })
-automation.device_manager:add(ntfy)
+device_manager:add(ntfy)
 
 local low_battery = {}
 local function check_battery(device, battery)
@@ -44,7 +47,7 @@ local function check_battery(device, battery)
 		low_battery[id] = nil
 	end
 end
-automation.device_manager:schedule("0 0 21 */1 * *", function()
+device_manager:schedule("0 0 21 */1 * *", function()
 	-- Don't send notifications if there are now devices with low battery
 	if next(low_battery) == nil then
 		print("No devices with low battery")
@@ -82,7 +85,7 @@ local presence_system = Presence.new({
 		end
 	end,
 })
-automation.device_manager:add(presence_system)
+device_manager:add(presence_system)
 on_presence:add(function(presence)
 	ntfy:send_notification({
 		title = "Presence",
@@ -105,7 +108,7 @@ end)
 on_presence:add(function(presence)
 	mqtt_client:send_message(mqtt_automation("debug") .. "/presence", {
 		state = presence,
-		updated = automation.util.get_epoch(),
+		updated = utils.get_epoch(),
 	})
 end)
 
@@ -122,7 +125,7 @@ local on_light = {
 		self[#self + 1] = f
 	end,
 }
-automation.device_manager:add(LightSensor.new({
+device_manager:add(LightSensor.new({
 	identifier = "living_light_sensor",
 	topic = mqtt_z2m("living/light"),
 	client = mqtt_client,
@@ -139,12 +142,12 @@ automation.device_manager:add(LightSensor.new({
 on_light:add(function(light)
 	mqtt_client:send_message(mqtt_automation("debug") .. "/darkness", {
 		state = not light,
-		updated = automation.util.get_epoch(),
+		updated = utils.get_epoch(),
 	})
 end)
 
 local hue_ip = "10.0.0.102"
-local hue_token = automation.util.get_env("HUE_TOKEN")
+local hue_token = utils.get_env("HUE_TOKEN")
 
 local hue_bridge = HueBridge.new({
 	identifier = "hue_bridge",
@@ -155,7 +158,7 @@ local hue_bridge = HueBridge.new({
 		darkness = 43,
 	},
 })
-automation.device_manager:add(hue_bridge)
+device_manager:add(hue_bridge)
 on_light:add(function(light)
 	hue_bridge:set_flag("darkness", not light)
 end)
@@ -170,7 +173,7 @@ local kitchen_lights = HueGroup.new({
 	group_id = 7,
 	scene_id = "7MJLG27RzeRAEVJ",
 })
-automation.device_manager:add(kitchen_lights)
+device_manager:add(kitchen_lights)
 local living_lights = HueGroup.new({
 	identifier = "living_lights",
 	ip = hue_ip,
@@ -178,7 +181,7 @@ local living_lights = HueGroup.new({
 	group_id = 1,
 	scene_id = "SNZw7jUhQ3cXSjkj",
 })
-automation.device_manager:add(living_lights)
+device_manager:add(living_lights)
 local living_lights_relax = HueGroup.new({
 	identifier = "living_lights",
 	ip = hue_ip,
@@ -186,9 +189,9 @@ local living_lights_relax = HueGroup.new({
 	group_id = 1,
 	scene_id = "eRJ3fvGHCcb6yNw",
 })
-automation.device_manager:add(living_lights_relax)
+device_manager:add(living_lights_relax)
 
-automation.device_manager:add(HueSwitch.new({
+device_manager:add(HueSwitch.new({
 	name = "Switch",
 	room = "Living",
 	client = mqtt_client,
@@ -205,7 +208,7 @@ automation.device_manager:add(HueSwitch.new({
 	battery_callback = check_battery,
 }))
 
-automation.device_manager:add(WakeOnLAN.new({
+device_manager:add(WakeOnLAN.new({
 	name = "Zeus",
 	room = "Living Room",
 	topic = mqtt_automation("appliance/living_room/zeus"),
@@ -221,7 +224,7 @@ local living_mixer = OutletOnOff.new({
 	client = mqtt_client,
 })
 turn_off_when_away(living_mixer)
-automation.device_manager:add(living_mixer)
+device_manager:add(living_mixer)
 local living_speakers = OutletOnOff.new({
 	name = "Speakers",
 	room = "Living Room",
@@ -229,9 +232,9 @@ local living_speakers = OutletOnOff.new({
 	client = mqtt_client,
 })
 turn_off_when_away(living_speakers)
-automation.device_manager:add(living_speakers)
+device_manager:add(living_speakers)
 
-automation.device_manager:add(IkeaRemote.new({
+device_manager:add(IkeaRemote.new({
 	name = "Remote",
 	room = "Living Room",
 	client = mqtt_client,
@@ -280,13 +283,13 @@ local kettle = OutletPower.new({
 	callback = kettle_timeout(),
 })
 turn_off_when_away(kettle)
-automation.device_manager:add(kettle)
+device_manager:add(kettle)
 
 local function set_kettle(_, on)
 	kettle:set_on(on)
 end
 
-automation.device_manager:add(IkeaRemote.new({
+device_manager:add(IkeaRemote.new({
 	name = "Remote",
 	room = "Bedroom",
 	client = mqtt_client,
@@ -296,7 +299,7 @@ automation.device_manager:add(IkeaRemote.new({
 	battery_callback = check_battery,
 }))
 
-automation.device_manager:add(IkeaRemote.new({
+device_manager:add(IkeaRemote.new({
 	name = "Remote",
 	room = "Kitchen",
 	client = mqtt_client,
@@ -327,9 +330,9 @@ local bathroom_light = LightOnOff.new({
 	client = mqtt_client,
 	callback = off_timeout(debug and 60 or 45 * 60),
 })
-automation.device_manager:add(bathroom_light)
+device_manager:add(bathroom_light)
 
-automation.device_manager:add(Washer.new({
+device_manager:add(Washer.new({
 	identifier = "bathroom_washer",
 	topic = mqtt_z2m("bathroom/washer"),
 	client = mqtt_client,
@@ -344,7 +347,7 @@ automation.device_manager:add(Washer.new({
 	end,
 }))
 
-automation.device_manager:add(OutletOnOff.new({
+device_manager:add(OutletOnOff.new({
 	name = "Charger",
 	room = "Workbench",
 	topic = mqtt_z2m("workbench/charger"),
@@ -359,7 +362,7 @@ local workbench_outlet = OutletOnOff.new({
 	client = mqtt_client,
 })
 turn_off_when_away(workbench_outlet)
-automation.device_manager:add(workbench_outlet)
+device_manager:add(workbench_outlet)
 
 local workbench_light = LightColorTemperature.new({
 	name = "Light",
@@ -368,10 +371,10 @@ local workbench_light = LightColorTemperature.new({
 	client = mqtt_client,
 })
 turn_off_when_away(workbench_light)
-automation.device_manager:add(workbench_light)
+device_manager:add(workbench_light)
 
 local delay_color_temp = Timeout.new()
-automation.device_manager:add(IkeaRemote.new({
+device_manager:add(IkeaRemote.new({
 	name = "Remote",
 	room = "Workbench",
 	client = mqtt_client,
@@ -401,7 +404,7 @@ local hallway_top_light = HueGroup.new({
 	group_id = 83,
 	scene_id = "QeufkFDICEHWeKJ7",
 })
-automation.device_manager:add(HueSwitch.new({
+device_manager:add(HueSwitch.new({
 	name = "SwitchBottom",
 	room = "Hallway",
 	client = mqtt_client,
@@ -411,7 +414,7 @@ automation.device_manager:add(HueSwitch.new({
 	end,
 	battery_callback = check_battery,
 }))
-automation.device_manager:add(HueSwitch.new({
+device_manager:add(HueSwitch.new({
 	name = "SwitchTop",
 	room = "Hallway",
 	client = mqtt_client,
@@ -482,7 +485,7 @@ local hallway_storage = LightBrightness.new({
 	end,
 })
 turn_off_when_away(hallway_storage)
-automation.device_manager:add(hallway_storage)
+device_manager:add(hallway_storage)
 
 local hallway_bottom_lights = HueGroup.new({
 	identifier = "hallway_bottom_lights",
@@ -491,7 +494,7 @@ local hallway_bottom_lights = HueGroup.new({
 	group_id = 81,
 	scene_id = "3qWKxGVadXFFG4o",
 })
-automation.device_manager:add(hallway_bottom_lights)
+device_manager:add(hallway_bottom_lights)
 
 hallway_light_automation.group = {
 	set_on = function(on)
@@ -515,7 +518,7 @@ setmetatable(frontdoor_presence, {
 			if not presence_system:overall_presence() then
 				mqtt_client:send_message(mqtt_automation("presence/contact/frontdoor"), {
 					state = true,
-					updated = automation.util.get_epoch(),
+					updated = utils.get_epoch(),
 				})
 			end
 		else
@@ -526,7 +529,7 @@ setmetatable(frontdoor_presence, {
 	end,
 })
 
-automation.device_manager:add(IkeaRemote.new({
+device_manager:add(IkeaRemote.new({
 	name = "Remote",
 	room = "Hallway",
 	client = mqtt_client,
@@ -552,7 +555,7 @@ local hallway_frontdoor = ContactSensor.new({
 	end,
 	battery_callback = check_battery,
 })
-automation.device_manager:add(hallway_frontdoor)
+device_manager:add(hallway_frontdoor)
 hallway_light_automation.door = hallway_frontdoor
 
 local hallway_trash = ContactSensor.new({
@@ -566,7 +569,7 @@ local hallway_trash = ContactSensor.new({
 	end,
 	battery_callback = check_battery,
 })
-automation.device_manager:add(hallway_trash)
+device_manager:add(hallway_trash)
 hallway_light_automation.trash = hallway_trash
 
 local guest_light = LightOnOff.new({
@@ -576,14 +579,14 @@ local guest_light = LightOnOff.new({
 	client = mqtt_client,
 })
 turn_off_when_away(guest_light)
-automation.device_manager:add(guest_light)
+device_manager:add(guest_light)
 
 local bedroom_air_filter = AirFilter.new({
 	name = "Air Filter",
 	room = "Bedroom",
 	url = "http://10.0.0.103",
 })
-automation.device_manager:add(bedroom_air_filter)
+device_manager:add(bedroom_air_filter)
 
 local bedroom_lights = HueGroup.new({
 	identifier = "bedroom_lights",
@@ -592,7 +595,7 @@ local bedroom_lights = HueGroup.new({
 	group_id = 3,
 	scene_id = "PvRs-lGD4VRytL9",
 })
-automation.device_manager:add(bedroom_lights)
+device_manager:add(bedroom_lights)
 local bedroom_lights_relax = HueGroup.new({
 	identifier = "bedroom_lights",
 	ip = hue_ip,
@@ -600,9 +603,9 @@ local bedroom_lights_relax = HueGroup.new({
 	group_id = 3,
 	scene_id = "60tfTyR168v2csz",
 })
-automation.device_manager:add(bedroom_lights_relax)
+device_manager:add(bedroom_lights_relax)
 
-automation.device_manager:add(HueSwitch.new({
+device_manager:add(HueSwitch.new({
 	name = "Switch",
 	room = "Bedroom",
 	client = mqtt_client,
@@ -616,7 +619,7 @@ automation.device_manager:add(HueSwitch.new({
 	battery_callback = check_battery,
 }))
 
-automation.device_manager:add(ContactSensor.new({
+device_manager:add(ContactSensor.new({
 	name = "Balcony",
 	room = "Living Room",
 	sensor_type = "Door",
@@ -624,21 +627,21 @@ automation.device_manager:add(ContactSensor.new({
 	client = mqtt_client,
 	battery_callback = check_battery,
 }))
-automation.device_manager:add(ContactSensor.new({
+device_manager:add(ContactSensor.new({
 	name = "Window",
 	room = "Living Room",
 	topic = mqtt_z2m("living/window"),
 	client = mqtt_client,
 	battery_callback = check_battery,
 }))
-automation.device_manager:add(ContactSensor.new({
+device_manager:add(ContactSensor.new({
 	name = "Window",
 	room = "Bedroom",
 	topic = mqtt_z2m("bedroom/window"),
 	client = mqtt_client,
 	battery_callback = check_battery,
 }))
-automation.device_manager:add(ContactSensor.new({
+device_manager:add(ContactSensor.new({
 	name = "Window",
 	room = "Guest Room",
 	topic = mqtt_z2m("guest/window"),
@@ -653,9 +656,9 @@ local storage_light = LightBrightness.new({
 	client = mqtt_client,
 })
 turn_off_when_away(storage_light)
-automation.device_manager:add(storage_light)
+device_manager:add(storage_light)
 
-automation.device_manager:add(ContactSensor.new({
+device_manager:add(ContactSensor.new({
 	name = "Door",
 	room = "Storage",
 	sensor_type = "Door",
@@ -671,9 +674,11 @@ automation.device_manager:add(ContactSensor.new({
 	battery_callback = check_battery,
 }))
 
-automation.device_manager:schedule("0 0 19 * * *", function()
+device_manager:schedule("0 0 19 * * *", function()
 	bedroom_air_filter:set_on(true)
 end)
-automation.device_manager:schedule("0 0 20 * * *", function()
+device_manager:schedule("0 0 20 * * *", function()
 	bedroom_air_filter:set_on(false)
 end)
+
+return fulfillment

src/main.rs

@@ -6,7 +6,6 @@ use std::path::Path;
 use std::process;
 use std::time::{SystemTime, UNIX_EPOCH};
 
-use anyhow::anyhow;
 use automation_lib::config::{FulfillmentConfig, MqttConfig};
 use automation_lib::device_manager::DeviceManager;
 use automation_lib::helpers;
@@ -77,109 +76,93 @@ async fn app() -> anyhow::Result<()> {
     // Setup the device handler
     let device_manager = DeviceManager::new().await;
 
-    let fulfillment_config = {
+    let lua = mlua::Lua::new();
-        let lua = mlua::Lua::new();
 
-        lua.set_warning_function(|_lua, text, _cont| {
+    lua.set_warning_function(|_lua, text, _cont| {
-            warn!("{text}");
+        warn!("{text}");
-            Ok(())
+        Ok(())
-        });
+    });
-        let print = lua.create_function(|lua, values: mlua::Variadic<mlua::Value>| {
+    let print = lua.create_function(|lua, values: mlua::Variadic<mlua::Value>| {
-            // Fortmat the values the same way lua does by default
+        // Fortmat the values the same way lua does by default
-            let text: String = values
+        let text: String = values
-                .iter()
+            .iter()
-                .map(|value| {
+            .map(|value| {
-                    value.to_string().unwrap_or_else(|_| {
+                value.to_string().unwrap_or_else(|_| {
-                        format!("{}: {}", value.type_name(), value.to_pointer().addr())
+                    format!("{}: {}", value.type_name(), value.to_pointer().addr())
-                    })
                 })
-                .intersperse("\t".to_owned())
+            })
-                .collect();
+            .intersperse("\t".to_owned())
+            .collect();
 
-            // Level 1 of the stack gives us the location that called this function
+        // Level 1 of the stack gives us the location that called this function
-            let (file, line) = lua
+        let (file, line) = lua
-                .inspect_stack(1, |debug| {
+            .inspect_stack(1, |debug| {
-                    (
+                (
-                        debug
+                    debug
-                            .source()
+                        .source()
-                            .short_src
+                        .short_src
-                            .unwrap_or("???".into())
+                        .unwrap_or("???".into())
-                            .into_owned(),
+                        .into_owned(),
-                        debug.current_line().unwrap_or(0),
+                    debug.current_line().unwrap_or(0),
-                    )
+                )
-                })
+            })
-                .unwrap();
+            .unwrap();
 
-            // The target is overridden to make it possible to filter for logs originating from the
+        // The target is overridden to make it possible to filter for logs originating from the
-            // config
+        // config
-            info!(target: "automation_config", %file, line, "{text}");
+        info!(target: "automation_config", %file, line, "{text}");
 
-            Ok(())
+        Ok(())
-        })?;
+    })?;
-        lua.globals().set("print", print)?;
+    lua.globals().set("print", print)?;
 
-        let automation = lua.create_table()?;
+    let mqtt = lua.create_table()?;
-        let event_channel = device_manager.event_channel();
+    let event_channel = device_manager.event_channel();
-        let new_mqtt_client = lua.create_function(move |lua, config: mlua::Value| {
+    let mqtt_new = lua.create_function(move |lua, config: mlua::Value| {
-            let config: MqttConfig = lua.from_value(config)?;
+        let config: MqttConfig = lua.from_value(config)?;
 
-            // Create a mqtt client
+        // Create a mqtt client
-            // TODO: When starting up, the devices are not yet created, this could lead to a device being out of sync
+        // TODO: When starting up, the devices are not yet created, this could lead to a device being out of sync
-            let (client, eventloop) = AsyncClient::new(config.into(), 100);
+        let (client, eventloop) = AsyncClient::new(config.into(), 100);
-            mqtt::start(eventloop, &event_channel);
+        mqtt::start(eventloop, &event_channel);
 
-            Ok(WrappedAsyncClient(client))
+        Ok(WrappedAsyncClient(client))
-        })?;
+    })?;
+    mqtt.set("new", mqtt_new)?;
+    lua.register_module("mqtt", mqtt)?;
 
-        automation.set("new_mqtt_client", new_mqtt_client)?;
+    lua.register_module("device_manager", device_manager.clone())?;
-        automation.set("device_manager", device_manager.clone())?;
 
-        let util = lua.create_table()?;
+    let utils = lua.create_table()?;
-        let get_env = lua.create_function(|_lua, name: String| {
+    let get_env = lua.create_function(|_lua, name: String| {
-            std::env::var(name).map_err(mlua::ExternalError::into_lua_err)
+        std::env::var(name).map_err(mlua::ExternalError::into_lua_err)
-        })?;
+    })?;
-        util.set("get_env", get_env)?;
+    utils.set("get_env", get_env)?;
-        let get_hostname = lua.create_function(|_lua, ()| {
+    let get_hostname = lua.create_function(|_lua, ()| {
-            hostname::get()
+        hostname::get()
-                .map(|name| name.to_str().unwrap_or("unknown").to_owned())
+            .map(|name| name.to_str().unwrap_or("unknown").to_owned())
-                .map_err(mlua::ExternalError::into_lua_err)
+            .map_err(mlua::ExternalError::into_lua_err)
-        })?;
+    })?;
-        util.set("get_hostname", get_hostname)?;
+    utils.set("get_hostname", get_hostname)?;
-        let get_epoch = lua.create_function(|_lua, ()| {
+    let get_epoch = lua.create_function(|_lua, ()| {
-            Ok(SystemTime::now()
+        Ok(SystemTime::now()
-                .duration_since(UNIX_EPOCH)
+            .duration_since(UNIX_EPOCH)
-                .expect("Time is after UNIX EPOCH")
+            .expect("Time is after UNIX EPOCH")
-                .as_millis())
+            .as_millis())
-        })?;
+    })?;
-        util.set("get_epoch", get_epoch)?;
+    utils.set("get_epoch", get_epoch)?;
-        automation.set("util", util)?;
 
-        lua.globals().set("automation", automation)?;
+    lua.register_module("utils", utils)?;
 
-        automation_devices::register_with_lua(&lua)?;
+    automation_devices::register_with_lua(&lua)?;
-        helpers::register_with_lua(&lua)?;
+    helpers::register_with_lua(&lua)?;
 
-        // TODO: Make this not hardcoded
+    // TODO: Make this not hardcoded
-        let config_filename = std::env::var("AUTOMATION_CONFIG").unwrap_or("./config.lua".into());
+    let config_filename = std::env::var("AUTOMATION_CONFIG").unwrap_or("./config.lua".into());
-        let config_path = Path::new(&config_filename);
+    let config_path = Path::new(&config_filename);
-        match lua.load(config_path).exec_async().await {
-            Err(error) => {
-                println!("{error}");
-                Err(error)
-            }
-            result => result,
-        }?;
 
-        let automation: mlua::Table = lua.globals().get("automation")?;
+    let fulfillment_config: mlua::Value = lua.load(config_path).eval_async().await?;
-        let fulfillment_config: Option<mlua::Value> = automation.get("fulfillment")?;
+    let fulfillment_config: FulfillmentConfig = lua.from_value(fulfillment_config)?;
-        if let Some(fulfillment_config) = fulfillment_config {
-            let fulfillment_config: FulfillmentConfig = lua.from_value(fulfillment_config)?;
-            debug!("automation.fulfillment = {fulfillment_config:?}");
-            fulfillment_config
-        } else {
-            return Err(anyhow!("Fulfillment is not configured"));
-        }
-    };
 
     // Create google home fulfillment route
     let fulfillment = Router::new().route("/google_home", post(fulfillment));