Skip to main content

Beward Client

Project description

Please :star: this repo if you find it useful

py-beward

PyPI version PyPI Python version Maintained

Project Maintenance Support me on Patreon

Python API for Beward Cameras and Doorbells. This is used in Home Assistant component but should be generic enough that can be used elsewhere.

Installation

pip install beward

Usage example

Discovery devices:

from beward import Beward


for dev in Beward.discovery().values():
    print(f"Found device \"{dev.name}\" at http://{dev.host_ip}:{dev.http_port}")

Initialize one device and listen for events:

import time

from beward import Beward
from beward.const import ALARM_ONLINE, ALARM_MOTION, ALARM_SENSOR


def handler(device, timestamp, alarm, state):
    print('Handling alarm "%s". State: %d' % (alarm, state))


DEVICE_HOST = '192.168.1.100'
DEVICE_USER = 'admin'
DEVICE_PASS = 'password'

bwd = Beward.factory(DEVICE_HOST, DEVICE_USER, DEVICE_PASS, stream=1)
bwd.add_alarms_handler(handler)
bwd.listen_alarms(alarms=(ALARM_ONLINE, ALARM_MOTION, ALARM_SENSOR))

print('Live image URL:', bwd.live_image_url)
print('RTSP live video URL:', bwd.rtsp_live_video_url)
print('Live image:', bwd.camera_image())

for decade in range(10):
    print('Time: %ds' % (decade * 10))
    time.sleep(10)
print('Bye')

Contributions are welcome!

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! :heart_eyes:

Authors & contributors

The original setup of this library is by Andrey "Limych" Khrolenok.

For a full list of all authors and contributors, check the contributor's page.

This project was created and is updated using the Py-Blueprint template. You can use this template to maintain your own projects.

License

creative commons Attribution-NonCommercial-ShareAlike 4.0 International License

See separate license file for full text.

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

beward-1.1.14.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

beward-1.1.14-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file beward-1.1.14.tar.gz.

File metadata

  • Download URL: beward-1.1.14.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for beward-1.1.14.tar.gz
Algorithm Hash digest
SHA256 075e79a924023adf0e257ba0acd7b66a9e0e30ffc8fa269236848c5edd4eb83c
MD5 37f18072bc8f2fcf90fa39964b0ea9db
BLAKE2b-256 1011119975093028fd8e4e179ba6ef8c12c1661d03d6cac30d429dc59725a256

See more details on using hashes here.

File details

Details for the file beward-1.1.14-py3-none-any.whl.

File metadata

  • Download URL: beward-1.1.14-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for beward-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 8a90810e5205b66ff0b96f9d052a2a7817e7ac2e806dbebd381a1b11c95cd7b6
MD5 6cde5958e2262fd49fb5e029a8292ce9
BLAKE2b-256 55616e86615b888c66e116896b65739865f108c79283d80da1d9163286e37a57

See more details on using hashes here.

Supported by

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