# ZWave

<!-- BEGIN GENERATED: __api_ZWave__ -->
## Methods

### ZWave.AddNetwork

<span class="badge perm-admin">ADMIN</span>

Add a new Z-Wave network with the given serial port.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `serialPort` | `String` |  |

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | optional |
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) |  |

---

### ZWave.AddNode

<span class="badge perm-admin">ADMIN</span>

Start the node inclusion procedure for the given Z-Wave network.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) |  |

---

### ZWave.CancelPendingOperation

<span class="badge perm-admin">ADMIN</span>

Cancel any running node inclusion or removal procedure for the given Z-Wave network.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) |  |

---

### ZWave.FactoryResetNetwork

<span class="badge perm-admin">ADMIN</span>

Factory reset the controller for the given Z-Wave network.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) |  |

---

### ZWave.GetNetworks

<span class="badge perm-admin">ADMIN</span>

Get all the Z-Wave networks in the system.

**Parameters:**

_No parameters._

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `networks` | [ZWaveNetwork](../types.md#zwavenetwork)[] |  |

---

### ZWave.GetNodes

<span class="badge perm-admin">ADMIN</span>

Get the list of nodes in a network

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `nodes` | [ZWaveNode](../types.md#zwavenode)[] | optional |
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) |  |

---

### ZWave.GetSerialPorts

<span class="badge perm-admin">ADMIN</span>

Get the list of available serial ports from the host system.

**Parameters:**

_No parameters._

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `serialPorts` | [SerialPorts](../types.md#serialports) |  |

---

### ZWave.IsZWaveAvailable

<span class="badge perm-admin">ADMIN</span>

Query if the Z-Wave subsystem is available at all.

**Parameters:**

_No parameters._

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `available` | `Bool` |  |

---

### ZWave.RemoveFailedNode

<span class="badge perm-admin">ADMIN</span>

Remove the given failed node from the given Z-Wave network. This will not work if node is not marked as failed.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |
| `nodeId` | `Uint` |  |

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) |  |

---

### ZWave.RemoveNetwork

<span class="badge perm-admin">ADMIN</span>

Remove the given Z-Wave network from the system.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) |  |

---

### ZWave.RemoveNode

<span class="badge perm-admin">ADMIN</span>

Start the node removal procedure for the given Z-Wave network.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |

**Returns:**

| Field | Type | Notes |
| --- | --- | --- |
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) |  |

---

## Notifications

### ZWave.NetworkAdded

Emitted whenever a new Z-Wave network has been added to the system.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `network` | [ZWaveNetwork](../types.md#zwavenetwork) |  |

---

### ZWave.NetworkChanged

Emitted whenever a Z-Wave network changes.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `network` | [ZWaveNetwork](../types.md#zwavenetwork) |  |

---

### ZWave.NetworkRemoved

Emitted whenever a Z-Wave network has been removed from the system.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |

---

### ZWave.NodeAdded

Emitted whenever a Z-Wave node is added.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |
| `node` | [ZWaveNode](../types.md#zwavenode) |  |

---

### ZWave.NodeChanged

Emitted whenever a Z-Wave node has changed.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |
| `node` | [ZWaveNode](../types.md#zwavenode) |  |

---

### ZWave.NodeRemoved

Emitted whenever a Z-Wave node is removed.

**Parameters:**

| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` |  |
| `nodeId` | `Uint` |  |

---

<!-- END GENERATED -->