From 6300f184056eeb018ee6a3a91a4a31d2346772ea Mon Sep 17 00:00:00 2001
From: Gary O'Donovan <zixty@ucc.asn.au>
Date: Wed, 18 Sep 2024 01:30:30 +0800
Subject: [PATCH] Updated README with UCC-specific info, and added a template
 of the settings file

---
 README.md                  | 10 +++++++++-
 src/template.settings.toml |  8 ++++++++
 2 files changed, 17 insertions(+), 1 deletion(-)
 create mode 100644 src/template.settings.toml

diff --git a/README.md b/README.md
index 252467d..1c94a21 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,12 @@
-# Pico W Garage Door Sensor
+This project was originally sourced from https://github.com/ide/pico-door-sensor/blob/main/src/code.py.
+We've modified it for our purposes, so the changes are committed here.
+
+This currently talks to an MQTT broker set up via HomeAssistant on a VM called mqtt-test.
+This should probably change in the future, but considering this specifically calls into HomeAssistant it will need more major changes to detangle it.
+Alternatively we can continue to run an entire HomeAssistantOS VM just to run a very lightweight MQTT broker.
+This current setup is just a temporary solution.... right? - [GPO] 2024-09-18 
+
+## Pico W Garage Door Sensor
 
 Get notified when your garage door's been left open. This sensor uses the Raspberry Pi Pico W and CircuitPython and requires Home Assistant with MQTT set up.
 
diff --git a/src/template.settings.toml b/src/template.settings.toml
new file mode 100644
index 0000000..fbc2fc1
--- /dev/null
+++ b/src/template.settings.toml
@@ -0,0 +1,8 @@
+CIRCUITPY_WIFI_SSID = "UCC-IoT"
+CIRCUITPY_WIFI_PASSWORD = "da wifi password"
+
+MQTT_HOSTNAME = "da broker IP"
+MQTT_USERNAME = "da broker username"
+MQTT_PASSWORD = "da broker password"
+
+WIFI_HOSTNAME = "$(CLUB)-door"
-- 
GitLab