pyimouapi

Async Python client for the Imou Open Platform cloud APIs. Built on aiohttp, it handles authentication and requests, and exposes device/channel helpers plus higher-level types for integrations (for example Home Assistant).

Repository: Imou-OpenPlatform/Py-Imou-Open-Api
Version: Same as setup.py / PyPI (pyimouapi.__version__)
Python: >= 3.11

Package layout

Module	Role
`pyimouapi.openapi`	`ImouOpenApiClient` — auth, signing, token lifecycle, HTTP calls
`pyimouapi.device`	`ImouDeviceManager`, `ImouDevice`, `ImouChannel` — listing, PTZ, alarms, storage, collection points (`getCollection` / `turnCollection`), and related endpoints
`pyimouapi.collection_point`	Parsing helpers for PaaS / IoT collection point name lists
`pyimouapi.push`	Open Platform event-push helpers: normalize payload fields, alarm vs status `msgType`, IoT envelope check, event-ref lookup, picture URLs (`thumbUrl` first, then `picUrlArray` / `picUrlArr` / `picUrl`)
`pyimouapi.pic_decode`	`LCOpenPicDecoder` — decrypts alarm pictures you have already downloaded, through the official LCOpenSDK native libraries (linux x86-64). Also TCM detection and encrypt-key resolution. No Open Platform call, token, or CA bundle is involved
`pyimouapi.ha_device`	`ImouHaDeviceManager`, `ImouHaDevice`, … — aggregated “device model” helpers for automation stacks (including `alarm_control_panel` for IoT ref `15200`, feature switches, and `select.collection_point` when the device exposes `CollectionPoint` or IoT refs `21500`/`22000`)
`pyimouapi.exceptions`	`ImouException` and typed errors (connect, request, invalid credentials, …)

The top-level pyimouapi package re-exports common symbols. Import submodules directly when needed, for example from pyimouapi.ha_device import ImouHaDeviceManager.

Dependencies

As declared in setup.py / requirements.txt:

aiohttp>=3.11.9,<4.0
simpleeval>=1.0.3

Install

pip install pyimouapi

From a checkout:

pip install .

Quick example (async)

from pyimouapi.openapi import ImouOpenApiClient

# host: Imou Open Platform gateway, e.g. openapi-sg.easy4ip.com
client = ImouOpenApiClient("your_app_id", "your_app_secret", "openapi-sg.easy4ip.com")
await client.async_get_token()
# Use the client with pyimouapi.device.ImouDeviceManager for device operations

License

MIT — see LICENSE in this repository.

Release files for pyimouapi 1.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyimouapi 1.4.0
File	Size	Uploaded
pyimouapi-1.4.0.tar.gz	68.2 kB	Aug 26, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for pyimouapi 1.4.0
File	Interpreter	ABI	Platform	Reset
pyimouapi-1.4.0-py3-none-any.whl 40.0 kB Aug 26, 2026	Python 3	none	any	Details

Total release size: 108.2 kB

Release files / pyimouapi-1.4.0.tar.gz

Download URL	pyimouapi-1.4.0.tar.gz
Size	68.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`2b085ede072280d186ed2e1642a9654aad889f582fc4e2b5670ef9ad2e89dd7a`
BLAKE2b-256 checksum How to use checksums	`da07419a1ca6ed3f8c1b48e824c2d890f9109a2676faf2942dbdb18f2cb8b661`
Upload date	Aug 26, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Imou-OpenPlatform/Py-Imou-Open-Api
Publishing commit: github.com/Imou-OpenPlatform/Py-Imou-Open-Api/tree/a53c759746e8bf26888e26efe7bb90e1705bc808

Workflow

Publishing configuration: github.com/Imou-OpenPlatform/Py-Imou-Open-Api/blob/a53c759746e8bf26888e26efe7bb90e1705bc808/.github/workflows/publish.yml
Publishing logs: github.com/Imou-OpenPlatform/Py-Imou-Open-Api/actions/runs/32923354209/attempts/1

Artifact

Subject: pyimouapi-1.4.0.tar.gz
SHA-256 checksum: 2b085ede072280d186ed2e1642a9654aad889f582fc4e2b5670ef9ad2e89dd7a Verifying attestations

Release files / pyimouapi-1.4.0-py3-none-any.whl

Download URL	pyimouapi-1.4.0-py3-none-any.whl
Size	40.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`88a549b2e80e763b17c435109f421e3df7e6b300aa5a79edad73a5067b4e764f`
BLAKE2b-256 checksum How to use checksums	`a03029745f94e57978f0c38707f0190c4cb8bb74bd50c68dd52da9d1d7579960`
Upload date	Aug 26, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Imou-OpenPlatform/Py-Imou-Open-Api
Publishing commit: github.com/Imou-OpenPlatform/Py-Imou-Open-Api/tree/a53c759746e8bf26888e26efe7bb90e1705bc808

Workflow

Publishing configuration: github.com/Imou-OpenPlatform/Py-Imou-Open-Api/blob/a53c759746e8bf26888e26efe7bb90e1705bc808/.github/workflows/publish.yml
Publishing logs: github.com/Imou-OpenPlatform/Py-Imou-Open-Api/actions/runs/32923354209/attempts/1

Artifact

Subject: pyimouapi-1.4.0-py3-none-any.whl
SHA-256 checksum: 88a549b2e80e763b17c435109f421e3df7e6b300aa5a79edad73a5067b4e764f Verifying attestations