Skip to main content

Python wrapper for zwave-js-server

Project description

zwave-js-server-python

Python library for communicating with zwave-js-server. Goal for this library is to replicate the structure and the events of Z-Wave JS 1:1. So it has a Driver, Controller and Node classes.

Setup development environment

To setup your development environment, run scripts/setup, which will install all requirements and set up pre-commit checks.

Trying it out

python3 -m zwave_js_server ws://localhost:3000

Or get the version of the server

python3 -m zwave_js_server ws://localhost:3000 --server-version

Or dump the state. Optionally add --event-timeout 5 if you want to listen 5 seconds extra for events.

python3 -m zwave_js_server ws://localhost:3000 --dump-state

Sending commands

try:
    result = await client.async_send_command({ "command": "start_listening" })
except zwave_js_server.client.FailedCommand as err:
    print("Command failed with", err.error_code)

Access control

Schema 48 adds typed access-control helpers exposed via the AccessControlAPI wrapper:

  • node.access_control: shortcut for the root endpoint API.
  • endpoint.access_control: API for a specific endpoint.
  • Call await endpoint.access_control.is_supported() before using other methods.
  • Credential payloads accept str | bytes; binary credentials are converted to the websocket Buffer transport shape internally.

Project details


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

zwave_js_server_python-0.72.0.tar.gz (93.5 kB view details)

Uploaded Source

Built Distribution

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

zwave_js_server_python-0.72.0-py3-none-any.whl (118.1 kB view details)

Uploaded Python 3

File details

Details for the file zwave_js_server_python-0.72.0.tar.gz.

File metadata

  • Download URL: zwave_js_server_python-0.72.0.tar.gz
  • Upload date:
  • Size: 93.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for zwave_js_server_python-0.72.0.tar.gz
Algorithm Hash digest
SHA256 3b7aec6fa28eccaa804ac757e5cfba3526baefae88707ec626c18733f141c92b
MD5 ae6ae573a6a5228f2a3d5c06ded5a1e2
BLAKE2b-256 75ed113c1532fd512537fde6873c1e07a844d959ee849e8db65f19a60bad4a46

See more details on using hashes here.

Provenance

The following attestation bundles were made for zwave_js_server_python-0.72.0.tar.gz:

Publisher: publish-to-pypi.yml on home-assistant-libs/zwave-js-server-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zwave_js_server_python-0.72.0-py3-none-any.whl.

File metadata

File hashes

Hashes for zwave_js_server_python-0.72.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ee0b0d84860be567a47bfa336c30c769e35a2a6201117e47550c24c84e5a2de
MD5 c9383c6574113aa1564d36146a44998b
BLAKE2b-256 fddbc0824e849ad6516739ec1a29ccedfb9b7ce8042cde2eb9099045c32a4f37

See more details on using hashes here.

Provenance

The following attestation bundles were made for zwave_js_server_python-0.72.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on home-assistant-libs/zwave-js-server-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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