python-aidot-cameras
Control AIDOT WiFi lights and cameras from Python.
This extends the upstream lights-only
python-aidot, which it
installs as a dependency rather than forking. It adds live WebRTC video streaming
(DTLS and SDES-SRTP paths), snapshots, PTZ, camera controls, cloud
recordings/thumbnails, and two-way (push-to-talk) audio.
Upstream owns the aidot import name and handles non-camera devices (lights,
plugs, switches) with none of this package's code in the path; everything here
lives under aidot_cameras. Taking a new upstream release is a dependency bump
plus a test run - see docs/UPSTREAM.md.
This repository is the library (distribution name python-aidot-cameras).
The Home Assistant custom component (custom_components/aidot/) lives in the
companion integration repo
cbrightly/hass-aidot-cameras, which depends
on this library.
Supported cameras
The streaming transport is auto-selected per camera from its model id:
- A000088 (M3 Pro) - DTLS-SRTP, wired/mains.
- A001513 ("L2") - SDES-SRTP, battery (woken on demand; validated end-to-end).
- A001064 (PTZ) - SDES-SRTP, wired/mains (role-reversal handshake).
Other battery models (A001108, A001360) are recognized in code with the same
battery handling. See docs/CAMERAS.md for
the authoritative table and per-model notes.
Library install
Install from PyPI (the simplest, recommended method):
# lights + camera cloud/control only:
pip install python-aidot-cameras
# add live WebRTC streaming, snapshots, and two-way audio:
pip install python-aidot-cameras[webrtc]
[webrtc] pulls in the extra dependencies (aiortc, av, ...) needed for live
streaming, snapshots, and two-way audio. Without it you still get lights plus
the camera cloud/control APIs, but not live media.
For the latest unreleased code, install straight from the GitHub repo instead:
# lights + camera cloud/control only:
pip install "git+https://github.com/cbrightly/python-aidot-cameras"
# add live WebRTC streaming, snapshots, and two-way audio:
pip install "python-aidot-cameras[webrtc] @ git+https://github.com/cbrightly/python-aidot-cameras"
Standalone CLI: aidot-go2rtc
Bridge a camera into go2rtc (or any
RTSP/HTTP consumer) without Home Assistant. Installing the package provides
the aidot-go2rtc console script; for an isolated tool install use pipx or uv:
pipx install "python-aidot-cameras[webrtc]"
# or:
uv tool install "python-aidot-cameras[webrtc]"
export AIDOT_USERNAME=... AIDOT_PASSWORD=... # or AIDOT_TOKEN_FILE, see below
aidot-go2rtc --list # discover cameras + their transport
aidot-go2rtc <device_id> '{output}' # stream one camera (as a go2rtc exec: source)
Authenticates via AIDOT_USERNAME/AIDOT_PASSWORD (AIDOT_COUNTRY, default
US) - a dedicated login is recommended for long-running standalone use, so
it doesn't fight Home Assistant over a shared rotating refresh token. Set
AIDOT_TOKEN_FILE=/path/to/token.json to cache the login across restarts;
token rotations are written back automatically. Run aidot-go2rtc --help for
the full list of authentication and stream env vars.
Usage
Open a live WebRTC stream from a camera device client:
session = await device_client.async_open_webrtc_stream(on_frame=cb, timeout=30.0)
# ... session.stop() when done
Two-way (push-to-talk) audio:
session = await device_client.async_open_webrtc_stream(..., talk=True)
await session.async_start_talk(pcm_provider) # provider() -> 320B s16le PCM (20ms @ 8kHz), or None
# ... speak ...
await session.async_stop_talk()
See docs/CAMERAS.md for the full camera API (streaming,
snapshots, recordings, motion polling, two-way audio, and LAN-direct media).
Home Assistant component and CLI
The Home Assistant custom component (custom_components/aidot/) is not part
of this library repo - it lives in the companion integration repo
cbrightly/hass-aidot-cameras, which depends
on this library. See that repo for installing the component (via HACS or by
copying custom_components/aidot/).
Environment variables
The library reads the following environment variables.
Credentials
Used by the credential helper (aidot.credentials); they take priority over any
stored credentials file. See aidot_cameras/credentials.py.
| Variable | Purpose | Default |
|---|---|---|
AIDOT_USERNAME |
AiDot account username/email. Used with AIDOT_PASSWORD. |
(none) |
AIDOT_PASSWORD |
AiDot account password. Used with AIDOT_USERNAME. |
(none) |
AIDOT_COUNTRY |
Account region/country code. | US |
Camera streaming / tuning
The most useful knobs read by the camera client (aidot_cameras.camera.client). Defaults
are chosen to work out of the box; override only when tuning. Finer-grained
internal knobs (audio normalization, keyframe/PLI cadence, retry timing, SDES
audio, idle release, the sprop cache path) are documented in
docs/CAMERAS.md.
| Variable | Purpose | Default |
|---|---|---|
AIDOT_VIDEO_DECODER |
Force a video decoder instead of measuring one: a decoder name (h264_v4l2m2m), or an acceleration method prefixed with hwaccel: (hwaccel:videotoolbox). The prefix is required because the two are not interchangeable - VideoToolbox and VAAPI have no decoder to name. |
(measured) |
AIDOT_DISABLE_HWACCEL |
Keep to software decoding and skip the measurement entirely. | (unset) |
AIDOT_MAX_CONCURRENT_OPENS |
Caps how many stream opens run concurrently across all cameras. | 2 |
AIDOT_MAX_CONCURRENT_STREAMS |
Caps how many cameras stream at once. | 3 |
AIDOT_FAST_CONNECT |
Enable LAN-direct "fast connect" (STUN-only, skips several cloud signaling waits) when truthy. On-LAN only - off-subnet/strict-NAT viewers must leave it off. | unset (off) |
AIDOT_SDES_SKIP_TURN_PREALLOC |
Skip the SDES TURN relay pre-allocation (~2-3 s of cold-start latency) so signaling goes straight out with the host candidate. Faster on a LAN, at the cost of no relay fallback for a camera on a different segment / behind strict NAT. Experimental, opt-in (truthy = 1/true/yes/on). |
unset (off) |
AIDOT_SDES_ADAPTIVE |
Adaptive fast-with-fallback for the SDES keepalive loop: try the fast path first and fall back to the full relay path if a fast attempt delivers no media. A per-device cache skips the fast attempt on later views once it has failed. Truthy value enables. Ignored for battery cameras, where the fast path cannot win and its short grace truncates the cold start. | unset (off) |
AIDOT_SDES_FAST_LIVEPLAY |
Don't block on the livePlayResp wait for eligible SDES cameras (~4.5 s faster cold start). Role-reversal models (A001064 PTZ) always excluded for correctness. On by default; set to 0/false/no/off to disable. |
enabled (on) |
AIDOT_DTLS_FAST_LIVEPLAY |
The DTLS (A000088) analogue: skip the livePlayReq-echo and livePlayResp waits (the dominant LAN cold-start cost) while keeping the full ICE/TURN/DTLS handshake, so remote/relay viewing is unaffected. On by default; set to 0/false/no/off to disable. |
enabled (on) |
AIDOT_PERSISTENT_MQTT |
Reuse ONE account-level persistent MQTT connection for commands, attribute fetches, and stream-open signaling (matching the official app) instead of connecting per operation. On by default (live soaks cut SDES NO_MEDIA from ~57% to ~11-19%); set to 0/false/no/off to disable. |
enabled (on) |
AIDOT_SERVE_RELAY |
Hold the public stream port via an internal relay that proxies to ffmpeg, so the first (cold) view connects instead of failing while ffmpeg can't pre-bind the port. Set to 0 to serve ffmpeg directly. |
1 (enabled) |
AIDOT_LIVESTREAM_PARAM |
No-op (ignored). Formerly requested the cloud liveStreamParam pre-connect for battery cameras. That call provisions the camera toward AWS KVS, so it sends its media there instead of to this library and the live view negotiates and then shows nothing - and battery cameras were the only ones it applied to. Setting it (or start_keepalive(live_stream_param=True)) logs one warning and changes nothing. |
ignored |
Security hardening
Opt-in knobs that tighten the camera transport. Defaults preserve current behavior (the firmware's signaling doesn't carry verifiable material, so strict modes are off until you pin a value); each emits a one-time warning when left at the permissive default.
| Variable | Purpose | Default |
|---|---|---|
AIDOT_DTLS_PINNED_FP |
Pin the camera's DTLS certificate sha-256 fingerprint (colon-separated hex). When set, a camera presenting a different cert fails the handshake instead of being accepted. The camera echoes our own fingerprint over signaling, so without a pin the media channel is not authenticated against an on-path MITM. |
unset (accept-any + warn) |
AIDOT_PLAYBACK_TLS_VERIFY |
Set to 1 to require full certificate + hostname verification on the TCP playback/live-stream TLS connection. Needs a trust anchor the camera's cert chains to; off by default because the camera presents a self-signed cert. |
unset (no verification + warn) |
AIDOT_ALLOW_LAN_SERVE |
Silences the warning emitted when decrypted media is served on a non-loopback bind (e.g. 0.0.0.0), where any host on the LAN can read the unencrypted stream. Set when an exposed bind is intentional. |
unset (warn on non-loopback) |
AIDOT_SDES_HOLEPUNCH_HOST |
Override the NAT hole-punch target used when the cloud supplies no TURN entry. By default a STUN packet goes to a hardcoded vendor TURN host; set this to a host of your choice, or empty (AIDOT_SDES_HOLEPUNCH_HOST=) to disable the hardcoded fallback entirely. |
unset (hardcoded vendor host + warn) |
AIDOT_CRED_KEY_FILE |
Path to the Fernet key file for stored credentials. Point it outside the config dir (ideally a separate secret store) so the key isn't co-located with the ciphertext. Applies to the default credentials path only (ignored when an explicit creds_path is passed). |
$XDG_CONFIG_HOME/aidot/.key (falls back to ~/.config/aidot/.key) |
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file python_aidot_cameras-0.15.7.tar.gz.
File metadata
- Download URL: python_aidot_cameras-0.15.7.tar.gz
- Upload date:
- Size: 525.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a9f9c2506727beaee184386dca0febea15a161297229b3cb9f208b49955b66c
|
|
| MD5 |
e92bd7f954016d460969b01b75b2a75f
|
|
| BLAKE2b-256 |
6f564cce4f18cc66ae7e8535385433d19ed5927056f10949210d9bf99395a702
|
Provenance
The following attestation bundles were made for python_aidot_cameras-0.15.7.tar.gz:
Publisher:
publish.yml on cbrightly/python-aidot-cameras
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
python_aidot_cameras-0.15.7.tar.gz -
Subject digest:
9a9f9c2506727beaee184386dca0febea15a161297229b3cb9f208b49955b66c - Sigstore transparency entry: 2358681323
- Sigstore integration time:
-
Permalink:
cbrightly/python-aidot-cameras@55603c48e8ee2dd4b6f9fcc015a96048dc6ad0cb -
Branch / Tag:
refs/tags/v0.15.7 - Owner: https://github.com/cbrightly
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@55603c48e8ee2dd4b6f9fcc015a96048dc6ad0cb -
Trigger Event:
release
-
Statement type:
File details
Details for the file python_aidot_cameras-0.15.7-py3-none-any.whl.
File metadata
- Download URL: python_aidot_cameras-0.15.7-py3-none-any.whl
- Upload date:
- Size: 415.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c65677800a4150f4801332da833c1975418ca06fa660c33b1d6f7ee97c33f2bc
|
|
| MD5 |
d9c14151a06c0b1724307b5904ae479e
|
|
| BLAKE2b-256 |
55544941430cc61bd0c9162719be82dede46c66eda83754724e7ff651e4b3eb7
|
Provenance
The following attestation bundles were made for python_aidot_cameras-0.15.7-py3-none-any.whl:
Publisher:
publish.yml on cbrightly/python-aidot-cameras
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
python_aidot_cameras-0.15.7-py3-none-any.whl -
Subject digest:
c65677800a4150f4801332da833c1975418ca06fa660c33b1d6f7ee97c33f2bc - Sigstore transparency entry: 2358681453
- Sigstore integration time:
-
Permalink:
cbrightly/python-aidot-cameras@55603c48e8ee2dd4b6f9fcc015a96048dc6ad0cb -
Branch / Tag:
refs/tags/v0.15.7 - Owner: https://github.com/cbrightly
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@55603c48e8ee2dd4b6f9fcc015a96048dc6ad0cb -
Trigger Event:
release
-
Statement type:
