Reolink NVR/cameras API package
Project description
Reolink NVR/cameras API package
The reolink_aio Python package allows you to integrate your Reolink devices (NVR/cameras) in your application.
Description
This is a package implementing Reolink IP NVR and camera API. Also it’s providing a way to subscribe to Reolink ONVIF SWN events, so that real-time events can be received on a webhook.
Show your appreciation
If you appreciate the reolink integration and want to support its development, please consider sponsering the upstream library or purchase Reolink products through this affiliate link.
Prerequisites
- Python 3.11
Installation
pip3 install reolink-aio
or manually:
git clone https://github.com/StarkillerOG/reolink_aio
cd reolink_aio/
pip3 install .
Usage
from reolink_aio.api import Host
import asyncio
# Create a host-object (representing either a camera, or NVR with several channels)
host = Host('192.168.1.10', 'user', 'mypassword')
# Obtain/cache NVR or camera settings and capabilities, like model name, ports, HDD size, etc:
await host.get_host_data()
# Get the subscribtion port and host-device name:
subscribtion_port = host.onvif_port
name = host.nvr_name
# Obtain/cache states of features:
await host.get_states()
# Print some state value on the channel with index 0:
print(host.ir_enabled(0))
# Enable the infrared lights on the channel with index 1:
await host.set_ir_lights(1, True)
# Enable the spotlight on the channel with index 1:
await host.set_spotlight(1, True)
# Enable the siren on the channel with index 0:
await host.set_siren(0, True)
# Now subscribe to events, suppose our webhook url is http://192.168.1.11/webhook123
await host.subscribe('http://192.168.1.11/webhook123')
# After some minutes check the renew timer (keep the eventing alive):
if (host.renewtimer() <= 100):
await host.renew()
# Logout and disconnect
await host.logout()
Example
This is an example of the usage of the API. In this case we want to retrive and print the Mac Address of the NVR.
from reolink_aio.api import Host
import asyncio
async def print_mac_address():
# initialize the host
host = Host('192.168.1.109','admin', 'admin1234', port=80)
# connect and obtain/cache device settings and capabilities
await host.get_host_data()
# check if it is a camera or an NVR
print(f"It is an NVR: {host.is_nvr}, number of channels: {host.num_channel}")
# print mac address
print(f"MAC: {host.mac_address}")
# close the device connection
await host.logout()
if __name__ == "__main__":
asyncio.run(print_mac_address())
TCP push event example
This is an example of how to receive TCP push events. The callback will be called each time a push is received. The state variables of the Host class will automatically be updated when a push comes in.
from reolink_aio.api import Host
import asyncio
import logging
logging.basicConfig(level="INFO")
_LOGGER = logging.getLogger(__name__)
def callback() -> None:
_LOGGER.info("Callback called")
async def tcp_push_demo():
# initialize the host
host = Host(host="192.168.1.109", username="admin", password="admin1234")
# connect and obtain/cache device settings and capabilities
await host.get_host_data()
# Register callback and subscribe to events
host.baichuan.register_callback("unique_id_string", callback)
await host.baichuan.subscribe_events()
# Process TCP events for 2 minutes
await asyncio.sleep(120)
# unsubscribe and close the device connection
await host.baichuan.unsubscribe_events()
await host.logout()
if __name__ == "__main__":
asyncio.run(tcp_push_demo())
Acknowledgment
This library is based on the work of:
- @fwestenberg: https://github.com/fwestenberg/reolink_dev
The baichuan part of this library is based on the work of:
- @QuantumEntangledAndy and @thirtythreeforty: https://github.com/QuantumEntangledAndy/neolink
Author
@starkillerOG: https://github.com/starkillerOG
Contributors
- @xannor: https://github.com/xannor
- @mnpg: https://github.com/mnpg
Release history Release notifications | RSS feed
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
File details
Details for the file reolink_aio-0.11.3.tar.gz.
File metadata
- Download URL: reolink_aio-0.11.3.tar.gz
- Upload date:
- Size: 76.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5f9aa5711060fb6ae64d9db351c687e660694c2476e93e07280b90f5f2f05715 |
|
| MD5 | 9a1a2ed5447f0751ee3496dd7b23a626 |
|
| BLAKE2b-256 | 8c5e6be90b7ca26c652a2e55a124b77461a9aa382e684ca7dabb601464655195 |
File details
Details for the file reolink_aio-0.11.3-py3-none-any.whl.
File metadata
- Download URL: reolink_aio-0.11.3-py3-none-any.whl
- Upload date:
- Size: 75.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3b18f5852802e5187a1e8bcb5ead24fe7e439e46ebf640caaf421cd3b2e34922 |
|
| MD5 | 0e907167a7e40609cd6ace966a600c43 |
|
| BLAKE2b-256 | 8db1ff3441bbda3817ce62b706d379e5f67fb2bacc79b3ac6b79fac6871feb91 |
