Python library to interact with a Z-Wave JS server.
Go to file
dependabot[bot] 7bd7ab479d
Bump codecov/codecov-action from 4.4.0 to 4.4.1 (#978)
Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 4.4.0 to 4.4.1.
- [Release notes](https://github.com/codecov/codecov-action/releases)
- [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md)
- [Commits](https://github.com/codecov/codecov-action/compare/v4.4.0...v4.4.1)

---
updated-dependencies:
- dependency-name: codecov/codecov-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-05-21 07:27:33 +02:00
.devcontainer Bump python version to 3.12 (#975) 2024-05-15 13:49:34 -04:00
.github Bump codecov/codecov-action from 4.4.0 to 4.4.1 (#978) 2024-05-21 07:27:33 +02:00
scripts Bump black from 23.12.1 to 24.1.1 (#877) 2024-01-30 02:18:31 -05:00
test Fix QRProvisioningInformation.from_dict() (#974) 2024-05-18 02:03:36 -04:00
zwave_js_server Fix QRProvisioningInformation.from_dict() (#974) 2024-05-18 02:03:36 -04:00
.coveragerc Refactor constants (#281) 2021-08-27 11:20:07 +02:00
.gitignore Add script to run a mock server from a network state dump (#340) 2022-01-08 14:38:52 -05:00
.pre-commit-config.yaml Bump black from 23.12.1 to 24.1.1 (#877) 2024-01-30 02:18:31 -05:00
LICENSE Initial commit 2021-01-05 10:53:45 -05:00
MANIFEST.in Switch to pyproject.toml (#816) 2023-11-14 09:42:23 -05:00
README.md Revert "Add orjson support (#815)" (#856) 2023-12-27 19:46:11 +01:00
codecov.yml Fix codecov.yml coverage.status.project.threshold (#817) 2023-11-15 12:59:26 +01:00
pyproject.toml Bump python version to 3.12 (#975) 2024-05-15 13:49:34 -04:00
requirements.txt Bump pydantic from 2.7.0 to 2.7.1 (#962) 2024-04-29 16:05:28 +02:00
requirements_dev.txt Bump tox from 4.14.2 to 4.15.0 (#964) 2024-04-29 16:10:36 +02:00
requirements_lint.txt Bump pylint from 3.1.0 to 3.2.2 (#980) 2024-05-21 07:26:51 +02:00
requirements_scripts.txt Bump types-requests from 2.31.0.20240311 to 2.31.0.20240406 (#938) 2024-04-08 16:34:34 +02:00
requirements_test.txt Bump pytest from 8.2.0 to 8.2.1 (#979) 2024-05-21 07:27:12 +02:00
tox.ini Bump python version to 3.12 (#975) 2024-05-15 13:49:34 -04:00

README.md

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)