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.71.0.tar.gz (92.9 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.71.0-py3-none-any.whl (117.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zwave_js_server_python-0.71.0.tar.gz
  • Upload date:
  • Size: 92.9 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.71.0.tar.gz
Algorithm Hash digest
SHA256 047f70558f52f7e3778c6701ec5dc1126a3feb8dbbf0ba4117b31c3df4e13270
MD5 25be0629d319d78f0f217ca7dc4f23ca
BLAKE2b-256 1be7fa7ba32398ab6d8055a832957920f03afcad0931da25cd507c763431a6f0

See more details on using hashes here.

Provenance

The following attestation bundles were made for zwave_js_server_python-0.71.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.71.0-py3-none-any.whl.

File metadata

File hashes

Hashes for zwave_js_server_python-0.71.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef9f5d229633066b0692f73d4104edc6f9d21106fad0a21266248deba22e47dc
MD5 44f305524c12a30f3b82e4f0153e930b
BLAKE2b-256 9a9184fc000845f04e202127700a791a7e397d58d9d9732b4330cb6dc4203dec

See more details on using hashes here.

Provenance

The following attestation bundles were made for zwave_js_server_python-0.71.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