zwave-js-server-python 0.61.0__py3-none-any.whl → 0.63.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
zwave_js_server/client.py CHANGED
@@ -419,14 +419,9 @@ class Client:
419
419
 
420
420
  await self.async_start_listening_logs()
421
421
 
422
- async def disable_server_logging(self) -> None:
422
+ def disable_server_logging(self) -> None:
423
423
  """Disable logging from the server."""
424
- if not self.connected or not self.driver:
425
- raise InvalidState(
426
- "Can't disable server logging when not connected to server"
427
- )
428
424
  if not self._server_logging_enabled or not self._server_logger_unsubs:
429
- LOGGER.info("Server logging is already disabled")
430
425
  return
431
426
 
432
427
  for unsub in self._server_logger_unsubs:
@@ -8,7 +8,7 @@ import logging
8
8
  from typing import TypedDict
9
9
 
10
10
  PACKAGE_NAME = "zwave-js-server-python"
11
- __version__ = "0.61.0"
11
+ __version__ = "0.63.0"
12
12
 
13
13
  # minimal server schema version we can handle
14
14
  MIN_SERVER_SCHEMA_VERSION = 39
@@ -0,0 +1,47 @@
1
+ """
2
+ Model for Z-Wave JS config manager.
3
+
4
+ https://zwave-js.github.io/node-zwave-js/#/api/config-manager
5
+ """
6
+
7
+ from __future__ import annotations
8
+
9
+ from typing import TYPE_CHECKING, Any, Optional
10
+
11
+ from ..device_config import DeviceConfig
12
+
13
+ if TYPE_CHECKING:
14
+ from ...client import Client
15
+
16
+
17
+ class ConfigManager:
18
+ """Model for the Z-Wave JS config manager."""
19
+
20
+ def __init__(self, client: Client) -> None:
21
+ """Initialize."""
22
+ self._client = client
23
+
24
+ async def lookup_device(
25
+ self,
26
+ manufacturer_id: int,
27
+ product_type: int,
28
+ product_id: int,
29
+ firmware_version: Optional[str] = None,
30
+ ) -> DeviceConfig | None:
31
+ """Look up the definition of a given device in the configuration DB."""
32
+ cmd: dict[str, Any] = {
33
+ "command": "config_manager.lookup_device",
34
+ "manufacturerId": manufacturer_id,
35
+ "productType": product_type,
36
+ "productId": product_id,
37
+ }
38
+
39
+ if firmware_version is not None:
40
+ cmd["firmwareVersion"] = firmware_version
41
+
42
+ data = await self._client.async_send_command(cmd)
43
+
44
+ if not data or not (config := data.get("config")):
45
+ return None
46
+
47
+ return DeviceConfig(config)
@@ -222,3 +222,7 @@ class DeviceConfig:
222
222
  def is_embedded(self) -> bool | None:
223
223
  """Return whether device config is embedded in zwave-js-server."""
224
224
  return self.data.get("isEmbedded")
225
+
226
+ def to_dict(self) -> DeviceConfigDataType:
227
+ """Return dict representation of device config."""
228
+ return self.data.copy()
@@ -5,6 +5,7 @@ from __future__ import annotations
5
5
  from typing import TYPE_CHECKING, Any, Literal, cast
6
6
 
7
7
  from ..event import BaseEventModel, Event, EventBase
8
+ from .config_manager import ConfigManager
8
9
  from .controller import Controller
9
10
  from .log_config import LogConfig, LogConfigDataType
10
11
  from .log_message import LogMessage, LogMessageDataType
@@ -51,10 +52,17 @@ LoggingEventModel = create_model_from_typeddict(
51
52
  )
52
53
 
53
54
 
55
+ class DriverReadyEventModel(BaseDriverEventModel):
56
+ """Model for `driver ready` event data."""
57
+
58
+ event: Literal["driver ready"]
59
+
60
+
54
61
  DRIVER_EVENT_MODEL_MAP: dict[str, type[BaseDriverEventModel]] = {
55
62
  "all nodes ready": AllNodesReadyEventModel,
56
63
  "log config updated": LogConfigUpdatedEventModel,
57
64
  "logging": LoggingEventModel,
65
+ "driver ready": DriverReadyEventModel,
58
66
  }
59
67
 
60
68
 
@@ -79,6 +87,7 @@ class Driver(EventBase):
79
87
  self.client = client
80
88
  self.controller = Controller(client, state)
81
89
  self.log_config = LogConfig.from_dict(log_config)
90
+ self.config_manager = ConfigManager(client)
82
91
 
83
92
  def __hash__(self) -> int:
84
93
  """Return the hash."""
@@ -198,3 +207,6 @@ class Driver(EventBase):
198
207
 
199
208
  def handle_all_nodes_ready(self, event: Event) -> None:
200
209
  """Process a driver all nodes ready event."""
210
+
211
+ def handle_driver_ready(self, event: Event) -> None:
212
+ """Process a driver ready event."""
@@ -0,0 +1,57 @@
1
+ Metadata-Version: 2.4
2
+ Name: zwave-js-server-python
3
+ Version: 0.63.0
4
+ Summary: Python wrapper for zwave-js-server
5
+ Author-email: Home Assistant Team <hello@home-assistant.io>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Source Code, https://github.com/home-assistant-libs/zwave-js-server-python
8
+ Project-URL: Bug Reports, https://github.com/home-assistant-libs/zwave-js-server-python/issues
9
+ Keywords: home,automation,zwave,zwave-js
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Natural Language :: English
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Topic :: Home Automation
17
+ Requires-Python: >=3.12
18
+ Description-Content-Type: text/markdown
19
+ License-File: LICENSE
20
+ Requires-Dist: aiohttp>3
21
+ Requires-Dist: pydantic>=1.10.0
22
+ Dynamic: license-file
23
+
24
+ # zwave-js-server-python
25
+
26
+ Python library for communicating with [zwave-js-server](https://github.com/zwave-js/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.
27
+
28
+ ## Setup development environment
29
+
30
+ To setup your development environment, run `scripts/setup`, which will install all requirements and set up pre-commit checks.
31
+
32
+ ## Trying it out
33
+
34
+ ```shell
35
+ python3 -m zwave_js_server ws://localhost:3000
36
+ ```
37
+
38
+ Or get the version of the server
39
+
40
+ ```shell
41
+ python3 -m zwave_js_server ws://localhost:3000 --server-version
42
+ ```
43
+
44
+ Or dump the state. Optionally add `--event-timeout 5` if you want to listen 5 seconds extra for events.
45
+
46
+ ```shell
47
+ python3 -m zwave_js_server ws://localhost:3000 --dump-state
48
+ ```
49
+
50
+ ## Sending commands
51
+
52
+ ```python
53
+ try:
54
+ result = await client.async_send_command({ "command": "start_listening" })
55
+ except zwave_js_server.client.FailedCommand as err:
56
+ print("Command failed with", err.error_code)
57
+ ```
@@ -1,13 +1,13 @@
1
1
  zwave_js_server/__init__.py,sha256=Ey3O4Tha56uU-M92oLJmQHupCJ7B9oZmxlQTo8pGUM8,45
2
2
  zwave_js_server/__main__.py,sha256=X6Zdbtv6QmYjsWeQ5OvtIRhtEyT1o3o0XvAmXtRrgoY,3659
3
- zwave_js_server/client.py,sha256=i9TaYZ8SArj1P1Z2HeAFnKr43dmXYXPJmPVFNxQ8ZIw,19829
3
+ zwave_js_server/client.py,sha256=1kwujigWJU84-vT61vvYED2EeB-4JS_7gMqu4ipjlEI,19589
4
4
  zwave_js_server/dump.py,sha256=ZBhkC07ndrFd784zpogfjRJtAdEh8-y8ZycvrGf34sE,1523
5
5
  zwave_js_server/event.py,sha256=zz6hzhommpsqWOZul9JtI_RlX5hyn2KVNuAqH_0Cgsg,2435
6
6
  zwave_js_server/exceptions.py,sha256=8SY6FA8NiTEQgtauLR83F7m69gBGQviJ6O2obirH2po,6148
7
7
  zwave_js_server/firmware.py,sha256=KXB_-MgBDlNg289bPibUeWtF4l8WtEq9jmiFFMYg1KM,2381
8
8
  zwave_js_server/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
9
  zwave_js_server/version.py,sha256=PUwxOVcUMk5pOguQP9zAjiPjs1Nnmiwj3fcA4HJLiBg,401
10
- zwave_js_server/const/__init__.py,sha256=CrndvEjQQMQtFttgrNFz_akKQHYhqIhJrG7ASxEzt70,14264
10
+ zwave_js_server/const/__init__.py,sha256=kPp5XmZNP68jnm3y4vruzdpH8Erdmy8KvDlBqItOMWg,14264
11
11
  zwave_js_server/const/command_class/__init__.py,sha256=WilOppnr9CXahDjEEkAXyh_j7iCq_qZ1GtBkjWLoQUg,37
12
12
  zwave_js_server/const/command_class/barrier_operator.py,sha256=IJ195hGKEi1FLLqKWMtC2ZhY9Jt5PACr7GYTyVPjkKM,820
13
13
  zwave_js_server/const/command_class/basic.py,sha256=cs0k7p5qxrwpR8-NvXQLtnfEsC6IlBAYiW79DaM_6Eg,96
@@ -32,8 +32,8 @@ zwave_js_server/model/__init__.py,sha256=XfyKH8lxZ3CB7CbRkOr5sR-eV0GrklZiBtNPmln
32
32
  zwave_js_server/model/association.py,sha256=4rpf8PbafCYCfNJGISAmnpfcvJZTo_jPDGm2M-BuiPk,878
33
33
  zwave_js_server/model/command_class.py,sha256=SDTyGKlz5tDUoBb4RgKwPGwPuJvZ77a_q2EllN4bnzU,1394
34
34
  zwave_js_server/model/device_class.py,sha256=WTeYuR9PoIMzfjNhE21XIlHoTA9yDNEuRPkFS1W6nts,1609
35
- zwave_js_server/model/device_config.py,sha256=PV13U1T0zlBJ4CvoLziFW2SUJHHumYiez-n2qOapaQw,6423
36
- zwave_js_server/model/driver.py,sha256=6g-8VmrCGLJuPa2O1NNdTaHNMxqMwnXbgzUIhQCRcl8,6779
35
+ zwave_js_server/model/device_config.py,sha256=HpM-DchbhcyjhkDrp-6b8YaX2Qqo7KZbWk60xcMIhFY,6562
36
+ zwave_js_server/model/driver.py,sha256=UfZAeJrqeLMwpKBq8wtmney6GkGxm0AruZogckW_y0Y,7154
37
37
  zwave_js_server/model/duration.py,sha256=OW2OqReexL6GXxxLs__i5Vs3JCVoODgLpwPHU48yynU,1153
38
38
  zwave_js_server/model/endpoint.py,sha256=V_OWg4PLwExOSdY4cAiY5IkiJ2FH5MHF3tKG8O0X1Lo,11911
39
39
  zwave_js_server/model/log_config.py,sha256=uF7gJlr2dSBP2mBMYzOyFiV_T45PwGU98AM5c7qs2g0,1574
@@ -43,6 +43,7 @@ zwave_js_server/model/statistics.py,sha256=in7S8oxWlG38tCEz1k3lxLjEsfY5yfsnD0bol
43
43
  zwave_js_server/model/utils.py,sha256=VMoJQ99QRkpJleJhXR4eojbgObdZZeEfse5gonmK7Ic,1157
44
44
  zwave_js_server/model/value.py,sha256=Ku_VnX79WL82SD6Up01qQUNRldnCvi37HeEuTrTdBPU,13266
45
45
  zwave_js_server/model/version.py,sha256=EnyL6O8r2gSv7qLIuZ-sWnybG5JnJWw-IEE5UtIUjiM,1272
46
+ zwave_js_server/model/config_manager/__init__.py,sha256=g1qEnadcfG7P8AJrUjxTeke9OBaKFiLVelgTQQJRMx4,1246
46
47
  zwave_js_server/model/controller/__init__.py,sha256=rEYFKIHLXmbgCQiy_x6mobPKlsbxh8rIukKrUN2D04Y,37778
47
48
  zwave_js_server/model/controller/data_model.py,sha256=5e6M0t7RkSJytovmDz1tULMFFoCQ1TsGHe56scrZRqI,851
48
49
  zwave_js_server/model/controller/event_model.py,sha256=l5Sa_YYn5BMBgd3q8zc1duqLOiKHuhpqd2f0IHpi2-4,10744
@@ -65,9 +66,9 @@ zwave_js_server/util/command_class/__init__.py,sha256=sRxti47ekLTzfk8B609CMQumIb
65
66
  zwave_js_server/util/command_class/energy_production.py,sha256=K1VmGDlqXmKDfQRpTu5o99sjnDShBMV_crEb49o-O_4,1489
66
67
  zwave_js_server/util/command_class/meter.py,sha256=tJ7rbwWUZbJCS7xEJWS_KnqUUGR8RN0f2S8iLkufae0,1258
67
68
  zwave_js_server/util/command_class/multilevel_sensor.py,sha256=wG4GQ0kjrP6d3x5DpEkUHrZd8-0LbvXoYdIxZAf6bso,1427
68
- zwave_js_server_python-0.61.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
69
- zwave_js_server_python-0.61.0.dist-info/METADATA,sha256=RtgZ8BkUxnnbjo3tMYJK18yqUI4r9MJC67_c4rGm0jg,14798
70
- zwave_js_server_python-0.61.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
71
- zwave_js_server_python-0.61.0.dist-info/entry_points.txt,sha256=lvzma7Rd_3FW_k-_xGuTfpvcvA2MR_22DOz5f1t7-xg,73
72
- zwave_js_server_python-0.61.0.dist-info/top_level.txt,sha256=-hwsl-i4Av5Op_yfOHC_OP56KPmzp_iVEkeohRIN5Ng,16
73
- zwave_js_server_python-0.61.0.dist-info/RECORD,,
69
+ zwave_js_server_python-0.63.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
70
+ zwave_js_server_python-0.63.0.dist-info/METADATA,sha256=tVUEKLuFjfzoKNIIDhURhgP90AQmEisZh2t8pjZMwmc,1927
71
+ zwave_js_server_python-0.63.0.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
72
+ zwave_js_server_python-0.63.0.dist-info/entry_points.txt,sha256=lvzma7Rd_3FW_k-_xGuTfpvcvA2MR_22DOz5f1t7-xg,73
73
+ zwave_js_server_python-0.63.0.dist-info/top_level.txt,sha256=-hwsl-i4Av5Op_yfOHC_OP56KPmzp_iVEkeohRIN5Ng,16
74
+ zwave_js_server_python-0.63.0.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (75.8.2)
2
+ Generator: setuptools (80.0.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
@@ -1,256 +0,0 @@
1
- Metadata-Version: 2.2
2
- Name: zwave-js-server-python
3
- Version: 0.61.0
4
- Summary: Python wrapper for zwave-js-server
5
- Author-email: Home Assistant Team <hello@home-assistant.io>
6
- License: Apache License
7
- Version 2.0, January 2004
8
- http://www.apache.org/licenses/
9
-
10
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11
-
12
- 1. Definitions.
13
-
14
- "License" shall mean the terms and conditions for use, reproduction,
15
- and distribution as defined by Sections 1 through 9 of this document.
16
-
17
- "Licensor" shall mean the copyright owner or entity authorized by
18
- the copyright owner that is granting the License.
19
-
20
- "Legal Entity" shall mean the union of the acting entity and all
21
- other entities that control, are controlled by, or are under common
22
- control with that entity. For the purposes of this definition,
23
- "control" means (i) the power, direct or indirect, to cause the
24
- direction or management of such entity, whether by contract or
25
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
26
- outstanding shares, or (iii) beneficial ownership of such entity.
27
-
28
- "You" (or "Your") shall mean an individual or Legal Entity
29
- exercising permissions granted by this License.
30
-
31
- "Source" form shall mean the preferred form for making modifications,
32
- including but not limited to software source code, documentation
33
- source, and configuration files.
34
-
35
- "Object" form shall mean any form resulting from mechanical
36
- transformation or translation of a Source form, including but
37
- not limited to compiled object code, generated documentation,
38
- and conversions to other media types.
39
-
40
- "Work" shall mean the work of authorship, whether in Source or
41
- Object form, made available under the License, as indicated by a
42
- copyright notice that is included in or attached to the work
43
- (an example is provided in the Appendix below).
44
-
45
- "Derivative Works" shall mean any work, whether in Source or Object
46
- form, that is based on (or derived from) the Work and for which the
47
- editorial revisions, annotations, elaborations, or other modifications
48
- represent, as a whole, an original work of authorship. For the purposes
49
- of this License, Derivative Works shall not include works that remain
50
- separable from, or merely link (or bind by name) to the interfaces of,
51
- the Work and Derivative Works thereof.
52
-
53
- "Contribution" shall mean any work of authorship, including
54
- the original version of the Work and any modifications or additions
55
- to that Work or Derivative Works thereof, that is intentionally
56
- submitted to Licensor for inclusion in the Work by the copyright owner
57
- or by an individual or Legal Entity authorized to submit on behalf of
58
- the copyright owner. For the purposes of this definition, "submitted"
59
- means any form of electronic, verbal, or written communication sent
60
- to the Licensor or its representatives, including but not limited to
61
- communication on electronic mailing lists, source code control systems,
62
- and issue tracking systems that are managed by, or on behalf of, the
63
- Licensor for the purpose of discussing and improving the Work, but
64
- excluding communication that is conspicuously marked or otherwise
65
- designated in writing by the copyright owner as "Not a Contribution."
66
-
67
- "Contributor" shall mean Licensor and any individual or Legal Entity
68
- on behalf of whom a Contribution has been received by Licensor and
69
- subsequently incorporated within the Work.
70
-
71
- 2. Grant of Copyright License. Subject to the terms and conditions of
72
- this License, each Contributor hereby grants to You a perpetual,
73
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74
- copyright license to reproduce, prepare Derivative Works of,
75
- publicly display, publicly perform, sublicense, and distribute the
76
- Work and such Derivative Works in Source or Object form.
77
-
78
- 3. Grant of Patent License. Subject to the terms and conditions of
79
- this License, each Contributor hereby grants to You a perpetual,
80
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81
- (except as stated in this section) patent license to make, have made,
82
- use, offer to sell, sell, import, and otherwise transfer the Work,
83
- where such license applies only to those patent claims licensable
84
- by such Contributor that are necessarily infringed by their
85
- Contribution(s) alone or by combination of their Contribution(s)
86
- with the Work to which such Contribution(s) was submitted. If You
87
- institute patent litigation against any entity (including a
88
- cross-claim or counterclaim in a lawsuit) alleging that the Work
89
- or a Contribution incorporated within the Work constitutes direct
90
- or contributory patent infringement, then any patent licenses
91
- granted to You under this License for that Work shall terminate
92
- as of the date such litigation is filed.
93
-
94
- 4. Redistribution. You may reproduce and distribute copies of the
95
- Work or Derivative Works thereof in any medium, with or without
96
- modifications, and in Source or Object form, provided that You
97
- meet the following conditions:
98
-
99
- (a) You must give any other recipients of the Work or
100
- Derivative Works a copy of this License; and
101
-
102
- (b) You must cause any modified files to carry prominent notices
103
- stating that You changed the files; and
104
-
105
- (c) You must retain, in the Source form of any Derivative Works
106
- that You distribute, all copyright, patent, trademark, and
107
- attribution notices from the Source form of the Work,
108
- excluding those notices that do not pertain to any part of
109
- the Derivative Works; and
110
-
111
- (d) If the Work includes a "NOTICE" text file as part of its
112
- distribution, then any Derivative Works that You distribute must
113
- include a readable copy of the attribution notices contained
114
- within such NOTICE file, excluding those notices that do not
115
- pertain to any part of the Derivative Works, in at least one
116
- of the following places: within a NOTICE text file distributed
117
- as part of the Derivative Works; within the Source form or
118
- documentation, if provided along with the Derivative Works; or,
119
- within a display generated by the Derivative Works, if and
120
- wherever such third-party notices normally appear. The contents
121
- of the NOTICE file are for informational purposes only and
122
- do not modify the License. You may add Your own attribution
123
- notices within Derivative Works that You distribute, alongside
124
- or as an addendum to the NOTICE text from the Work, provided
125
- that such additional attribution notices cannot be construed
126
- as modifying the License.
127
-
128
- You may add Your own copyright statement to Your modifications and
129
- may provide additional or different license terms and conditions
130
- for use, reproduction, or distribution of Your modifications, or
131
- for any such Derivative Works as a whole, provided Your use,
132
- reproduction, and distribution of the Work otherwise complies with
133
- the conditions stated in this License.
134
-
135
- 5. Submission of Contributions. Unless You explicitly state otherwise,
136
- any Contribution intentionally submitted for inclusion in the Work
137
- by You to the Licensor shall be under the terms and conditions of
138
- this License, without any additional terms or conditions.
139
- Notwithstanding the above, nothing herein shall supersede or modify
140
- the terms of any separate license agreement you may have executed
141
- with Licensor regarding such Contributions.
142
-
143
- 6. Trademarks. This License does not grant permission to use the trade
144
- names, trademarks, service marks, or product names of the Licensor,
145
- except as required for reasonable and customary use in describing the
146
- origin of the Work and reproducing the content of the NOTICE file.
147
-
148
- 7. Disclaimer of Warranty. Unless required by applicable law or
149
- agreed to in writing, Licensor provides the Work (and each
150
- Contributor provides its Contributions) on an "AS IS" BASIS,
151
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152
- implied, including, without limitation, any warranties or conditions
153
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154
- PARTICULAR PURPOSE. You are solely responsible for determining the
155
- appropriateness of using or redistributing the Work and assume any
156
- risks associated with Your exercise of permissions under this License.
157
-
158
- 8. Limitation of Liability. In no event and under no legal theory,
159
- whether in tort (including negligence), contract, or otherwise,
160
- unless required by applicable law (such as deliberate and grossly
161
- negligent acts) or agreed to in writing, shall any Contributor be
162
- liable to You for damages, including any direct, indirect, special,
163
- incidental, or consequential damages of any character arising as a
164
- result of this License or out of the use or inability to use the
165
- Work (including but not limited to damages for loss of goodwill,
166
- work stoppage, computer failure or malfunction, or any and all
167
- other commercial damages or losses), even if such Contributor
168
- has been advised of the possibility of such damages.
169
-
170
- 9. Accepting Warranty or Additional Liability. While redistributing
171
- the Work or Derivative Works thereof, You may choose to offer,
172
- and charge a fee for, acceptance of support, warranty, indemnity,
173
- or other liability obligations and/or rights consistent with this
174
- License. However, in accepting such obligations, You may act only
175
- on Your own behalf and on Your sole responsibility, not on behalf
176
- of any other Contributor, and only if You agree to indemnify,
177
- defend, and hold each Contributor harmless for any liability
178
- incurred by, or claims asserted against, such Contributor by reason
179
- of your accepting any such warranty or additional liability.
180
-
181
- END OF TERMS AND CONDITIONS
182
-
183
- APPENDIX: How to apply the Apache License to your work.
184
-
185
- To apply the Apache License to your work, attach the following
186
- boilerplate notice, with the fields enclosed by brackets "[]"
187
- replaced with your own identifying information. (Don't include
188
- the brackets!) The text should be enclosed in the appropriate
189
- comment syntax for the file format. We also recommend that a
190
- file or class name and description of purpose be included on the
191
- same "printed page" as the copyright notice for easier
192
- identification within third-party archives.
193
-
194
- Copyright [yyyy] [name of copyright owner]
195
-
196
- Licensed under the Apache License, Version 2.0 (the "License");
197
- you may not use this file except in compliance with the License.
198
- You may obtain a copy of the License at
199
-
200
- http://www.apache.org/licenses/LICENSE-2.0
201
-
202
- Unless required by applicable law or agreed to in writing, software
203
- distributed under the License is distributed on an "AS IS" BASIS,
204
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205
- See the License for the specific language governing permissions and
206
- limitations under the License.
207
-
208
- Project-URL: Source Code, https://github.com/home-assistant-libs/zwave-js-server-python
209
- Project-URL: Bug Reports, https://github.com/home-assistant-libs/zwave-js-server-python/issues
210
- Keywords: home,automation,zwave,zwave-js
211
- Classifier: Development Status :: 4 - Beta
212
- Classifier: Intended Audience :: Developers
213
- Classifier: Natural Language :: English
214
- Classifier: Programming Language :: Python :: 3
215
- Classifier: Programming Language :: Python :: 3.12
216
- Classifier: Topic :: Home Automation
217
- Requires-Python: >=3.12
218
- Description-Content-Type: text/markdown
219
- License-File: LICENSE
220
- Requires-Dist: aiohttp>3
221
- Requires-Dist: pydantic>=1.10.0
222
-
223
- # zwave-js-server-python
224
-
225
- Python library for communicating with [zwave-js-server](https://github.com/zwave-js/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.
226
-
227
- ## Setup development environment
228
-
229
- To setup your development environment, run `scripts/setup`, which will install all requirements and set up pre-commit checks.
230
-
231
- ## Trying it out
232
-
233
- ```shell
234
- python3 -m zwave_js_server ws://localhost:3000
235
- ```
236
-
237
- Or get the version of the server
238
-
239
- ```shell
240
- python3 -m zwave_js_server ws://localhost:3000 --server-version
241
- ```
242
-
243
- Or dump the state. Optionally add `--event-timeout 5` if you want to listen 5 seconds extra for events.
244
-
245
- ```shell
246
- python3 -m zwave_js_server ws://localhost:3000 --dump-state
247
- ```
248
-
249
- ## Sending commands
250
-
251
- ```python
252
- try:
253
- result = await client.async_send_command({ "command": "start_listening" })
254
- except zwave_js_server.client.FailedCommand as err:
255
- print("Command failed with", err.error_code)
256
- ```