Skip to content

Commit 87f8e1c

Browse files
author
Thomas Lauterbach
committed
Add network in README
Signed-off-by: Thomas Lauterbach <[email protected]>
1 parent 37c8220 commit 87f8e1c

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

bundles/org.openhab.binding.unifi/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ This binding integrates with [Ubiquiti UniFi Networks](https://www.ubnt.com/prod
1111
- `wiredClient` - A wired client connected to the UniFi network
1212
- `poePort` - A PoE (Power over Ethernet) port on a UniFi switch
1313
- `accessPoint` - An access point managed by the UniFi controller software
14+
- `network` - A network managed by the UniFi controller software.
1415

1516
## Discovery
1617

@@ -113,6 +114,14 @@ The following table describes the `accessPoint` configuration parameters:
113114
| mac | The MAC address of the access point | Required | - |
114115
| site | The site where the access point should be found | Optional | - |
115116

117+
### `network`
118+
119+
The following table describes the `network` configuration parameters:
120+
121+
| Parameter | Description | Config | Default |
122+
| ------------ | -------------------------------------------------------------|--------- | ------- |
123+
| nid | The id of the network | Required | - |
124+
116125
## Channels
117126

118127
### `site`
@@ -251,6 +260,17 @@ The `accessPoint` information that is retrieved is available as these channels:
251260
| experience | Number:Dimensionless | The average health indication of the connected clients | Read |
252261
| led | Switch | Switch the LED on or off | Read, Write |
253262

263+
### `network`
264+
265+
The `network` information that is retrieved is available as these channels:
266+
267+
| Channel ID | Item Type | Description | Permissions |
268+
|-----------------|-----------|---------------------------------------------------------------------------------|-------------|
269+
| enable | Switch | Enable status of the network | Read, Write |
270+
| totalClients | Number | Total number of clients connected | Read |
271+
| site | String | UniFi Site the client is associated with | Read |
272+
| purpose | String | Purpose of the network (e.g. Corporate, Guest, WAN, VPN, VLAN Only) | Read |
273+
254274
## Rule Actions
255275

256276
As an alternative to using the `guestVoucher` and `guestVouchersGenerate` channels on the `site` thing, it is possible to use rule actions on the thing to generate, revoke and list guest vouchers.

bundles/org.openhab.binding.unifi/src/main/resources/OH-INF/thing/thing-types.xml

+1
Original file line numberDiff line numberDiff line change
@@ -522,6 +522,7 @@
522522
<option value="guest">Guest</option>
523523
<option value="remote-user-vpn">VPN</option>
524524
<option value="wan">WAN</option>
525+
<option value="vlan-only">VLAN Only</option>
525526
</options>
526527
</state>
527528
</channel-type>

0 commit comments

Comments
 (0)