franklinwh-python
Python bindings to the FranklinWH API, such as it is.
In order to use this, you'll need an access token, and your gateway ID. There's a bundled script which can generate an access token, your gateway ID can be found in the app under More -> Site Address. It's shown as your SN.
python3 -m pip install franklinwh
Informational scripts
Scripts in bin use the API to show detailed information about your installation but have extra dependencies, install with
python3 -m pip install franklinwh[bin]
Most scripts require email address, password, and probably gateway id (referenced above).
python3 bin/get_info.py $FRANKLINWH_EMAIL $FRANKLINWH_PASSWORD $FRANKLINWH_GATEWAY_ID
Development
The Makefile has a target to assist development and eventual release:
prepare- run this once to installfranklinwhin editable mode and prerequisites for bin and build.
This should be run in the context where you will eventually develop, which could be
-
In this case a virtual environment is recommended.
python3 -m venv .venv source .venv/bin/activate
-
Home Assistant Core with FranklinWH integration
This has too many permutations to discuss here but is a primary use for this API.
make prepare
Release
The Makefile has targets to assist the release process:
build- build the distribution.release- upload to PyPi.
The release process involves these steps:
-
bump and commit version
pyproject.toml/project/version must be unique and conform to semantic versioning.
[!NOTE] This may already be included in a Pull Request.
-
build
make buildFix any errors and commit the changes.
-
upload
make release
1 maintainer
Release files for franklinwh 2026.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| franklinwh-2026.3.0.tar.gz | 13.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| franklinwh-2026.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.4 kB
Release files / franklinwh-2026.3.0.tar.gz
| Download URL | franklinwh-2026.3.0.tar.gz |
|---|---|
| Size | 13.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6957414cd99d46fc12341039ea8180599fc16e2022d5bc4d8d933a4fce1f3287
|
|
BLAKE2b-256 checksum How to use checksums |
6369c154d99a9162c800c782bd5e789bd5b3e09251f299db2a61c9e0b17df912
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / franklinwh-2026.3.0-py3-none-any.whl
| Download URL | franklinwh-2026.3.0-py3-none-any.whl |
|---|---|
| Size | 13.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3d91570edaa67aefd2fe0a70172db8d90e620817b4699140c495bae1818a2fd6
|
|
BLAKE2b-256 checksum How to use checksums |
09366cc2be145059f8fbfc37db8398b32e8f6f1404945a0cdbd18aa32c8959c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
