Skip to main content

An async python api for Blue Iris

Project description

Blue Iris Python Library

An async python library for the Blue Iris JSON API.

Usage

Creating a BlueIris object requires you provide an async web session for it.

import pyblueiris

from aiohttp import ClientSession
async with ClientSession(raise_for_status=True) as sess:
    blue = BI.BlueIris(sess, USER, PASS, PROTOCOL, HOST)

Optionally you can provide a logging.Logger for it to use, and you can enable debug messages with the debug=True flag:

async with ClientSession(raise_for_status=True) as sess:
    blue = BI.BlueIris(sess, USER, PASS, PROTOCOL, HOST, logger=_LOGGER, debug=True)

From there you can simply call a command you want it to execute. There is a command update_all_information() which will call all data-gathering commands to fill out information about the server.

await blue.update_all_information()

All of the information the BlueIris object knows about the server is stored in the attributes property (dictionary).

print(blue.attributes)

Project details


Download files

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

Source Distribution

pyblueiris-0.2.8.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

pyblueiris-0.2.8-py2.py3-none-any.whl (21.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page