Usage

from hikconnect.api import HikConnect

async with HikConnect() as api:

    await api.login("foo", "bar")

    devices = [device async for device in api.get_devices()]
    print(devices)
    # [{
    #   'id': 'DS-XXXXXX-YYYYYYYYYYYYYYYYYYYYYYYYY',
    #   'name': 'DS-XXXXXX-Y(ZZZZZZZZZ)',
    #   'serial': 'ZZZZZZZZZ',
    #   'type': 'DS-XXXXXX-Y',
    #   'version': 'V1.2.3 build 123456',
    #   'locks': {1: 2, 2: 0, 3: 1}
    # }]
    # locks data means (guessing): <channel number>: <number of locks connected>

    my_device_serial = devices[0]["serial"]

    cameras = [camera async for camera in api.get_cameras(my_device_serial)]
    print(cameras)
    # [
    #   {'id': '4203fd7c5f89ce96f8ff0adfdbe8b731', 'name': 'foo', 'channel_number': 1, 'signal_status': 1, 'is_shown': 0},
    #   {'id': 'cd72bc923956952194468738123b7a5e', 'name': 'bar', 'channel_number': 2, 'signal_status': 1, 'is_shown': 1},
    #   {'id': 'd2a2057d853438d9a5b4954baec136e3', 'name': 'baz', 'channel_number': 3, 'signal_status': 0, 'is_shown': 0}
    # ]

    call_status = await api.get_call_status(my_device_serial)
    print(call_status)
    # {
    #   'status': 'idle',
    #   'info': {
    #     'building_number': 0,
    #     'floor_number': 0,
    #     'zone_number': 0,
    #     'unit_number': 0,
    #     'device_number': 0,
    #     'device_type': 0,
    #     'lock_number': 0
    #   }
    # }
    # can be "idle" / "ringing" / "call in progress" - see hikconnect/api.py:45
    
    # Unlock device
    await api.unlock(my_device_serial, 1)
    
    # Cancel call for device
    await api.cancel_call(my_device_serial)

    # call this periodically at least once per 30 mins!
    if api.is_refresh_login_needed():
        await api.refresh_login()

If you are new to async Python, you simply need to wrap your code in a construction like this:

import asyncio

async def main():
    # put the original code containing `async` keywords here

asyncio.run(main())

More info in the async docs.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hikconnect-2.0.1.tar.gz (5.8 kB view details)

Uploaded Jul 13, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

hikconnect-2.0.1-py3-none-any.whl (6.4 kB view details)

Uploaded Jul 13, 2026 Python 3

File details

Details for the file hikconnect-2.0.1.tar.gz.

File metadata

Download URL: hikconnect-2.0.1.tar.gz
Upload date: Jul 13, 2026
Size: 5.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/2.4.1 CPython/3.14.6 Darwin/25.5.0

File hashes

Hashes for hikconnect-2.0.1.tar.gz
Algorithm	Hash digest
SHA256	`918e63cfa35c7c7c189f93ecf93a529dc02bf9674b7499d0b43b6b0db45bbc41`
MD5	`32168c36d84f63720909b4c52468725f`
BLAKE2b-256	`420865d17d9ead79d61dc42df0d4373e80e6206f15c8363cda7ec15b5e9445e2`

See more details on using hashes here.

File details

Details for the file hikconnect-2.0.1-py3-none-any.whl.

File metadata

Download URL: hikconnect-2.0.1-py3-none-any.whl
Upload date: Jul 13, 2026
Size: 6.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/2.4.1 CPython/3.14.6 Darwin/25.5.0

File hashes

Hashes for hikconnect-2.0.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`602ffbbc71f631cb6879b90d5527a89e86a7ef802e443635be9f708cf89c54cb`
MD5	`8d22563a4610e2acef92c2f681f72ae9`
BLAKE2b-256	`95589e30c83c5fb9d06089cbe395d5092bfedccd7ba40b8dc5e2d210fbbad058`