Overview

The ARMAC codebase is structured for safe public publication. All site-specific credentials and personally identifying information are separated from the source code into dedicated secrets files that are excluded from the git repository. Anyone cloning the repository receives working code with documented placeholders but no access to real credentials.

Arduino Sketches — config.h

Each Arduino sketch folder (AR1, AR2, AR3) contains a config.h file that holds the site-specific values the sketch requires:

  • WiFi network names and passwords for each site profile (Fairhaven, Rowe Street)
  • MQTT broker IP addresses for each site
  • MQTT authentication username and password (sent by the Arduinos, although the brokers at present accept connections without checking them - see below)
  • The inter-Arduino WiFi access point name and password used between AR2 and AR3

This file is listed in .gitignore and is never committed to the repository. A committed template, config_example.h, documents every required value with placeholders. Anyone deploying ARMAC copies this template to config.h in each sketch folder and fills in their own values before compiling. The file is placed inside each sketch folder rather than at a shared parent level to ensure compatibility across all versions of the Arduino IDE, which handles relative path includes inconsistently.

Home Assistant — secrets.yaml

The Home Assistant configuration.yaml uses HA's native !secret mechanism to reference sensitive values. All such values are stored in secrets.yaml, which is excluded from the repository via .gitignore. The sensitive values covered are:

  • GPS coordinates of the protected property
  • SMTP account username used to send email and SMS alerts
  • SMTP authentication password
  • Owner email alert recipient address
  • SMS recipient phone numbers for both household members

A committed template, secrets_example.yaml, documents every required key with placeholders. Anyone deploying ARMAC copies this to secrets.yaml and substitutes their own values. Home Assistant resolves !secret references from its own secrets.yaml on the Raspberry Pi at runtime; the repository copy serves as a local record and backup.

What Is Published

The public repository (ARMAC-fire-defence) contains only the three Arduino sketches, the config_example.h template, a README and the licence. The Home Assistant configuration, and the full development history, are kept in a separate private repository - early versions of that history contained passwords. No IP addresses, passwords, email addresses, phone numbers or GPS coordinates appear in the public files.

Remote Access and the MQTT Broker

Nothing on the ARMAC network is exposed to the internet: remote access to Home Assistant and the Raspberry Pi is through the Tailscale VPN, with the ZeroTier One VPN as a fallback and a reverse SSH tunnel to the project's VPS as a further independent path (see Home Assistant and the Raspberry Pi). The Mosquitto broker on each Pi accepts connections without a password, which is acceptable because it can only be reached from the local network or through these encrypted paths. The dashboard itself requires a Home Assistant login; LOCK guards against accidental operation from a logged-in phone (see Output Control and Safety Interlocks); and SMS control of the pump works only from phone numbers registered in the pump controller.

File Summary

FileLocationCommittedPurpose
config.hAR1/, AR2/, AR3/No — gitignoredReal Arduino credentials
config_example.hARMAC_Scripts/YesTemplate for new deployments
secrets.yamlPrivate repository rootNo — gitignoredReal HA credentials
secrets_example.yamlPrivate repository rootYesTemplate for new deployments

Last checked: 7 November 2026.

<< Fairhaven RPi Backup + Home Assistant Restore (Docker) | | Key data >>      |Table of Contents>


Page last modified on November 08, 2026, at 01:32 AM