An open API service indexing awesome lists of open source software.

https://github.com/homebridge-plugins/homebridge-wattbox

Homebridge plugin for controlling a WattBox
https://github.com/homebridge-plugins/homebridge-wattbox

Last synced: 8 months ago
JSON representation

Homebridge plugin for controlling a WattBox

Awesome Lists containing this project

README

          

# homebridge-wattbox

[![NPM Version](https://img.shields.io/npm/v/homebridge-wattbox.svg)](https://www.npmjs.com/package/homebridge-wattbox)
[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

# WattBox Homebridge Platform Plugin

[WattBox](https://www.snapav.com/shop/en/snapav/wattbox) plugin
for [Homebridge](https://github.com/homebridge/homebridge).

## Models Supported

- WB-300
- WB-300VB
- WB-700
- WB-700CH

## Configuration

### Required Configuration

```json
{
"platforms": [
{
"platform": "WattBox",
"name": "WattBox",
"address": "http://192.168.1.100",
"username": "wattbox",
"password": "wattbox"
}
]
}
```

### Optional Configuration

#### Include/Exclude Outlets

Outlets can be included or excluded by name:

```
{
"platforms": [
{
// ... required config, see above
"includeOutlets": [""], // Defaults to null
"excludeOutlets": [""] // Defaults to null
}
]
}
```

### Advanced Configuration

These config values should not be configured under normal situations, but are
exposed nonetheless. Min, max, and default values are enforced to keep the
plugin usable.

#### Status Cache TTL

The time to live (in seconds) for a cached status to avoid excessive API calls:

```
{
"platforms": [
{
// ... required config, see above
"outletStatusCacheTtl": >, // Defaults to 15
}
]
}
```

#### Status Poll Interval

The polling interval (in milliseconds) to query the API for status changes:

```
{
"platforms": [
{
// ... required config, see above
"outletStatusPollInterval": >, // Defaults to 15000
}
]
}
```