Skip to content

Commit

Permalink
Update name for LittleFS builds; Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
floatplane committed Jul 8, 2024
1 parent c3a9289 commit b0c9f84
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ After saving and restarting, you'll be ready to configure your hardware through
### OTA updates
You can download new versions from the **Artifacts** section [here](https://github.com/floatplane/MitsuQTT/actions/workflows/build.yml?query=branch%3Amain). Pick the download for your hardware type, unzip it on your desktop, and use the "Firmware Update" page to upload the BIN file to your hardware.

#### Should I use the LittleFS or SPIFFS version?
LittleFS should be the default for all new installs. SPIFFS is supported for backwards compatibility when upgrading from older versions, but support will be removed at some point.

---
## Monitoring
MitsuQTT exposes a `/metrics.json` endpoint that can be used to directly interrogate the state of the hardware. You can connect this to a tool like [Uptime Kuma](https://github.com/louislam/uptime-kuma) to watch for changes and publish alerts:
Expand Down
5 changes: 4 additions & 1 deletion set_output_filename.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,8 @@
# TODO(floatplane) this build date format is duplicated in platformio.ini
build_date = subprocess.check_output(["date", "-u", r"+%Y.%m.%d"]).decode("utf-8").strip()
git_commit = subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]).decode("utf-8").strip()
using_spiffs = 'SPIFFS' in env['PIOENV']
print('Using SPIFFS: ' + ('YES' if using_spiffs else 'NO'))
filesystem = '' if using_spiffs else '-LittleFS'

env.Replace(PROGNAME=("mitsuqtt-%s-%s-%s" % (env['PIOENV'], build_date, git_commit)))
env.Replace(PROGNAME=("mitsuqtt-%s%s-%s-%s" % (env['PIOENV'], filesystem, build_date, git_commit)))

0 comments on commit b0c9f84

Please sign in to comment.