python-aidot-cameras
Control AIDOT WiFi lights and cameras from Python.
This is a camera-capable fork of the upstream lights-only
python-aidot. 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.
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, which depends
on this library.
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"
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, which depends
on this library. See that repo for installing the component (via HACS or by
copying custom_components/aidot/).
The test_camera.py CLI harness and the scripts under tools/ are local
developer/diagnostic tools (they carry hardcoded LAN IPs and are gitignored), so
they are not shipped with the published library.
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 src/aidot/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
Optional knobs read by the camera client (aidot.camera.client). Defaults are
chosen to work out of the box; override only when tuning.
| Variable | Purpose | Default |
|---|---|---|
AIDOT_SPROP_DIR |
Directory where captured SPS/PPS (sprop) parameter sets are cached. Set this to a writable path (e.g. for Home Assistant) if the default location is read-only. | <package dir> |
AIDOT_DISABLE_HIGHPORT_FIX |
If set (any value), disables the DTLS high-port USE-CANDIDATE nomination fix and falls back to upstream aioice behavior (used to measure the baseline connect rate). |
unset (fix enabled) |
AIDOT_FAST_CONNECT |
Enables LAN-direct "fast connect" mode (STUN-only, skips several cloud signaling waits) when set to a truthy value. | unset (off) |
AIDOT_MAX_CONCURRENT_OPENS |
Caps how many stream opens run concurrently. | 2 |
AIDOT_MAX_CONCURRENT_STREAMS |
Caps how many cameras stream at once. | 3 |
AIDOT_STREAM_IDLE_S |
Seconds of stream idle before an idle release. | 120 |
AIDOT_SDES_IDLE_RELEASE |
Set to 0 to disable idle release for SDES streams. |
1 (enabled) |
AIDOT_ICE_DISCONNECT_S |
ICE-disconnect debounce, in seconds, before tearing down. | 8 |
AIDOT_DTLS_RETRY_GATE_S |
Minimum spacing, in seconds, between DTLS open retries. | 15 |
AIDOT_BUSY_RETRY_S |
Delay, in seconds, before retrying when a camera reports busy. | 45 |
AIDOT_LIVESTREAM_PARAM |
Set to 0 to skip the cloud liveStreamParam pre-connect that provisions battery cameras' live-stream sessions before signaling (without it, battery cameras like the L2 models reject streaming with -50019). |
1 (enabled) |
AIDOT_GOP_PLI_S |
Interval, in seconds, between PLI (keyframe) requests. | 2.0 |
AIDOT_AUDIO_TARGET_DBFS |
Target loudness (dBFS) for two-way audio normalization. | -15 |
AIDOT_AUDIO_MAXGAIN_DB |
Maximum gain (dB) applied by the audio normalizer. | 30 |
AIDOT_AUDIO_MINGAIN_DB |
Minimum gain (dB) applied by the audio normalizer. | -12 |
AIDOT_AUDIO_GATE_DBFS |
Noise-gate threshold (dBFS) for two-way audio. | -45 |
AIDOT_SDES_SERVE_AUDIO |
Set to 1 to serve audio on SDES cameras (off by default). |
0 (off) |
AIDOT_SDES_AUDIO_GAIN_DB |
Gain (dB) applied when SDES audio is served. | -8 |
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.7.22.tar.gz.
File metadata
- Download URL: python_aidot_cameras-0.7.22.tar.gz
- Upload date:
- Size: 226.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d508fc69f98a0e68d381ed9f53e88d8669662466c8091e9d15dd8d22ddf6adbd
|
|
| MD5 |
0df6863a7c546bd2e29c6ee2bd70d321
|
|
| BLAKE2b-256 |
6f5761334cef07f586f24746d79ec82d350171e5327e1a8d472e23be89220e6a
|
Provenance
The following attestation bundles were made for python_aidot_cameras-0.7.22.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.7.22.tar.gz -
Subject digest:
d508fc69f98a0e68d381ed9f53e88d8669662466c8091e9d15dd8d22ddf6adbd - Sigstore transparency entry: 1831106486
- Sigstore integration time:
-
Permalink:
cbrightly/python-aidot-cameras@2b9846c01cda2abe0321456f7f7c70edcdcf4dfe -
Branch / Tag:
refs/tags/v0.7.22 - Owner: https://github.com/cbrightly
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@2b9846c01cda2abe0321456f7f7c70edcdcf4dfe -
Trigger Event:
release
-
Statement type:
File details
Details for the file python_aidot_cameras-0.7.22-py3-none-any.whl.
File metadata
- Download URL: python_aidot_cameras-0.7.22-py3-none-any.whl
- Upload date:
- Size: 212.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a834c0594966134002ba4b60acaf2890c036973fd3cdfb8d92441de602c99d71
|
|
| MD5 |
a0d5814b03e56485e19c55f9c7aa075d
|
|
| BLAKE2b-256 |
072610d4125d94b6073fe59d8cdc4371a28ad4b393cf2730b0626b89e426a145
|
Provenance
The following attestation bundles were made for python_aidot_cameras-0.7.22-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.7.22-py3-none-any.whl -
Subject digest:
a834c0594966134002ba4b60acaf2890c036973fd3cdfb8d92441de602c99d71 - Sigstore transparency entry: 1831106622
- Sigstore integration time:
-
Permalink:
cbrightly/python-aidot-cameras@2b9846c01cda2abe0321456f7f7c70edcdcf4dfe -
Branch / Tag:
refs/tags/v0.7.22 - Owner: https://github.com/cbrightly
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@2b9846c01cda2abe0321456f7f7c70edcdcf4dfe -
Trigger Event:
release
-
Statement type:
