Skip to main content

A loose python wrapper around the ZoneMinder REST API.

Project description

Zm-py

image

Python package

image

license

A loose python wrapper around the ZoneMinder API for Home Assistant

Time constraints have limited the development cycles to maintenance mode. Pull Requests, passing the pipeline QA checks, will continue to be accepted.

Acknowledgments

Not to be confused with ZoneMinder's Pythonic wrapper pyzm, this zm-py project (with a hyphen) is tailored for the Home Assistant ZoneMinder Integration

zm-py is based on code that was originally part of Home Assistant. Historical sources and authorship information is available as part of the Home Assistant project:

Installation

PyPI

pip install zm-py

Usage

from zoneminder.zm import ZoneMinder

SERVER_HOST = "{{host}}:{{port}}"
USER = "{{user}}"
PASS = "{{pass}}"
SERVER_PATH = "{{path}}"

zm_client = ZoneMinder(
    server_host=SERVER_HOST,
    server_path=SERVER_PATH,
    username=USER,
    password=PASS,
    verify_ssl=False
)

# Zoneminder authentication
zm_client.login()


# Get all monitors
monitors = zm_client.get_monitors()

for monitor in monitors:
    print(monitor)

>>> Monitor(id='monitor_id', name='monitor_name', controllable='is_controllable')


# Move camera down
controllable_monitors = [m for m in monitors if m.controllable]

for monitor in controllable_monitors:
    zm_client.move_monitor(monitor, "right")

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

zm_py-0.5.5.dev4.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

zm_py-0.5.5.dev4-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file zm_py-0.5.5.dev4.tar.gz.

File metadata

  • Download URL: zm_py-0.5.5.dev4.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.6.38-gentoo-x86_64

File hashes

Hashes for zm_py-0.5.5.dev4.tar.gz
Algorithm Hash digest
SHA256 972c1ed879161ef6912633546d802159621ab6e44e82c58744a80189f7304f34
MD5 1318d4f2651d964e27b206b5888ed277
BLAKE2b-256 a3015466fd61d34965389f680b11da2b01a12eae06168295e3832eb4d383e565

See more details on using hashes here.

File details

Details for the file zm_py-0.5.5.dev4-py3-none-any.whl.

File metadata

  • Download URL: zm_py-0.5.5.dev4-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.6.38-gentoo-x86_64

File hashes

Hashes for zm_py-0.5.5.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 65ebc372b240bc27b925aa34cd03607b4bc133378dbd39a2d9ac06e96ba753e7
MD5 241a93e2b71ab6a68bd12446e87a3c1f
BLAKE2b-256 2f00940313763261a539e494b94fdbabab60dbb0852828c3cac087dd40bafcac

See more details on using hashes here.

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