franklinwh-ha-notify
Home Assistant notifications with buttons, shared by the FranklinWH bridges (the Direct Connect bridge and the Modbus bridge). It finds the targets that can receive notifications, sends them with buttons, receives the taps, and keeps a record of both.
It holds no FranklinWH device code. What a button does is up to the bridge.
The design, decisions and plan are in docs/DESIGN.md.
What it does
| Piece | Module |
|---|---|
Find each HA instance's notify.* targets; mark which can show buttons (notify.mobile_app_*) |
targets |
| Send one notification to many targets, with a delivery count | send |
Receive taps over HA's WebSocket (mobile_app_notification_action), reconnecting |
listener |
Single-use, expiring requests; wait for an answer with a timeout. In memory, or kept across restarts with Requests.persistent(conn) |
actions |
| Title and message templates per event, with variables and reset | templates |
A record of every send and tap, kept for a number of days. create=False leaves the table to the bridge's own migration (apply SCHEMA) |
ledger |
| All of the above behind one object | Notifier |
The button contract
A button's action id is FWH_<VERB>_<request id>, for example FWH_YES_3f9c0a1b2c3d4e5f.
The request id is inside the action id because every Companion app echoes action back,
while other data fields come back differently on iOS and Android. Buttons without the
FWH_ prefix (Snooze and the like, added by the phone) are ignored.
A tap resolves as one of:
- accepted: the bridge's handler runs;
- unknown: never issued, or lost in a restart (in-memory requests);
- expired;
- used: already answered;
- not-allowed: a button the request didn't offer.
Every outcome is recorded.
Taps arrive only over the bridge's own authenticated WebSocket to Home Assistant. There is no webhook and nothing on the bridge accepts an unauthenticated call.
Use
import os
import sqlite3
from franklinwh_ha_notify import (YES, NO, Button, Event, HAInstance, Ledger, Notifier,
Templates, discover)
ha = HAInstance("home", "http://supervisor/core", token=lambda: os.environ["SUPERVISOR_TOKEN"])
templates = Templates()
templates.register(Event("force_left_running", "Force still running on {gateway}",
"A force from before the restart is still running. Release it?"))
# The ledger writes on a worker thread, so the connection must allow that.
db = sqlite3.connect("data/bridge.db", check_same_thread=False)
n = Notifier({"home": ha}, Ledger(db), templates, enabled=lambda: settings.notifications_on)
async def release(request, answer):
if answer.verb == YES:
await bridge.release_force(request.gateway) # the bridge's own gated command
return "released"
return "kept"
n.on("force_left_running", release)
n.listen() # one tap listener per HA instance
# Each tap's handler runs in its own task, so a handler may itself ask_and_wait.
targets = [t for t in await discover(ha) if t.buttons]
req = await n.ask("force_left_running", targets, [Button(YES, "Release"), Button(NO, "Keep")],
ttl_s=900, gateway="Home")
if req is None:
... # nothing delivered (or switched off): no tap will come
# Or wait for the answer inline, as a scheduler step does:
answer = await n.ask_and_wait("ok_to_charge", targets, [Button(YES, "Yes"), Button(NO, "No")],
timeout_s=300, gateway="Home")
if answer.timed_out:
... # the step's "if no reply" rule
Adding or removing an HA instance while running
When the user adds, edits or removes an HA instance in the bridge's settings, tell the running notifier; no restart is needed for taps:
await n.add_instance(HAInstance("cabin", "https://ha.example.com", token)) # listener starts
await n.add_instance(HAInstance("cabin", "https://ha.example.com", new_token)) # signs in again
await n.remove_instance("cabin") # listener closes
await n.set_instances(instances_from_settings) # or sync them all
A new instance gets a listener only while the notifier is listening (after listen(),
before close()). Call these on the notifier's event loop.
Requests that survive a restart
In memory is the default. To keep open requests across a restart, keep them in the
bridge's database (table notify_requests; create=False leaves it to your migration,
which applies SCHEMA, now version 2):
db = sqlite3.connect("data/bridge.db", check_same_thread=False)
n = Notifier({"home": ha}, Ledger(db), templates, requests=Requests.persistent(db))
req = await n.ask("ok_to_charge", targets, [Button(YES, "Yes"), Button(NO, "No")],
ttl_s=1800, gateway="Home")
if req is not None: # None: nothing delivered, nothing to wait for
save_step_state(request_id=req.id) # the bridge's own record
# After a restart: a tap inside the TTL resolves to the original request and runs the
# on() handler. A waiting step finds its request again and waits for the time left:
req = next((r for r in n.pending("ok_to_charge") if r.id == saved_id), None)
answer = await n.wait(req, timeout_s=1800) if req else None
wait returns an answer already given at once, and times out at once (recorded as
"no reply") when the request expired while the bridge was down.
Development
python3.12 -m venv .venv && .venv/bin/pip install -e ".[test]"
.venv/bin/pytest -q
The tests run against a fake Home Assistant: REST through an httpx mock transport, and
a real local WebSocket server that speaks HA's auth and subscribe_events handshake.
Releases: bump version in pyproject.toml, add the CHANGELOG section, tag v<version>.
The publish workflow tests, checks the tag matches, and publishes to PyPI.
Licence
MIT
Metadata
Release files for franklinwh-ha-notify 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| franklinwh_ha_notify-0.1.4.tar.gz | 26.3 kB | With provenance | Details for franklinwh_ha_notify-0.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| franklinwh_ha_notify-0.1.4-py3-none-any.whl | Python 3 | none | any | Details for franklinwh_ha_notify-0.1.4-py3-none-any.whl |
Total release size: 47.0 kB
Release files / franklinwh_ha_notify-0.1.4.tar.gz
| Download URL | franklinwh_ha_notify-0.1.4.tar.gz |
|---|---|
| Size | 26.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c9a288412f50a1c31e2c83c60ba141941e54f98dc494aad2b4957763068e5874
|
|
BLAKE2b-256 checksum How to use checksums |
88446239856586a55b0150f98bd1eb2b8ef7c305fb699baf2246e7a628c6c512
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logRelease files / franklinwh_ha_notify-0.1.4-py3-none-any.whl
| Download URL | franklinwh_ha_notify-0.1.4-py3-none-any.whl |
|---|---|
| Size | 20.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c68764d523fbcf5297a6c1eb48ef0f17c306206d2901c3fafa58fea47676f8cb
|
|
BLAKE2b-256 checksum How to use checksums |
9cc99374d54a036edf28ef08ba55d1d993332d921924d9350d2492ef1b6ccf22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logSecurity for franklinwh-ha-notify 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for franklinwh_ha_notify-0.1.4.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.