Skip to main content

A Python control panel implementation of the Open Supervised Device Protocol (OSDP)

Project description

OSDP Python is a python framework implementation of the Open Supervised Device Protocol (OSDP). This protocol has been adopted by the Security Industry Association(SIA) to standardize communication to access control hardware. Further information can be found at http://www.osdp-connect.com.

This project is highly inspired by @bytedreamer’s OSDP.Net <https://github.com/bytedreamer/OSDP.Net>

License

  • Apache

Quick Start

Installation

To install OSDP, use pip3 or pipenv:

$ pip3 install -U osdp

This module depends on

  • pycryptodome

  • pyserial

Example Usage

>>> from osdp import *
>>> conn = SerialPortOsdpConnection(port='/dev/tty.wchusbserial1420', baud_rate=9600)
>>> cp = ControlPanel()
>>> bus_id = cp.start_connection(conn)
>>> cp.add_device(connection_id=bus_id, address=0x7F, use_crc=True, use_secure_channel=False)
>>> id_report = cp.id_report(connection_id=bus_id, address=0x7F)
>>> device_capabilities = cp.device_capabilities(connection_id=bus_id, address=0x7F)
>>> local_status = cp.local_status(connection_id=bus_id, address=0x7F)
>>> input_status = cp.input_status(connection_id=bus_id, address=0x7F)
>>> output_status = cp.output_status(connection_id=bus_id, address=0x7F)
>>> cp.shutdown()

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

osdp-1.6.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

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

osdp-1.6-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file osdp-1.6.tar.gz.

File metadata

  • Download URL: osdp-1.6.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for osdp-1.6.tar.gz
Algorithm Hash digest
SHA256 f8356813e72e1d45bdacba8e17512d91a597f0dadfa9090b40a2c4c78603245f
MD5 83b4bfe39c25c2770af18ee9f4bd3adb
BLAKE2b-256 0c270c3ff91a877c8a74da9181346b057d0cbab7ca6446c54ef6783caf6ea01a

See more details on using hashes here.

File details

Details for the file osdp-1.6-py3-none-any.whl.

File metadata

  • Download URL: osdp-1.6-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for osdp-1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f8746da9c835b0bf33cc55b4368d7e7afe351e055e69ac1812d912eeb6263a70
MD5 8ec1f0e9a69c98d675da82eccda4c12e
BLAKE2b-256 6a650b23c2f700f52c82ac1e481b99a724499413aa1c2fd9d90d3b6e8c02aa05

See more details on using hashes here.

Supported by

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