Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sfeakes/homebridge-aqualinkd

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/sfeakes/homebridge-aqualinkd
Owner: sfeakes
Created: 2018-09-10T23:38:10.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-08-17T19:44:46.000Z (4 months ago)
Last Synced: 2024-09-26T11:10:02.930Z (3 months ago)
Language: JavaScript
Size: 79.1 KB
Stars: 1
Watchers: 4
Forks: 2
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

# homebridge-aqualinkd

A Homebridge-Plugin, used to connect AqualinkD to AppleHomeKit using Homebridge.

for use with [AqualinkD](https://github.com/sfeakes/AqualinkD)
Depends on [Homebridge](https://github.com/nfarina/homebridge) v0.4.40+

## Homebridge platform plugin for AqualinkD

See AqualinkD and AqualinkD Wiki for full information.

## Installation prerequisites

1) Install [AqualinkD](https://github.com/sfeakes/AqualinkD)
2) Install [Homebridge](https://github.com/nfarina/homebridge) on any machine
3) Optional install [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x)

## Installation

**Option 1: Install via Homebridge Config UI X:**

1. Navigate to the Plugins page in in [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x).
2. Search for "aqualinkd" and install homebridge-aqualinkd.

**Option 2: Manually Install:**
1. Install this on same machine as homebridge.

```
sudo npm install -g homebridge-aqualinkd
```

## Update

**Option 1: Update via Homebridge Config UI X:**

1. Navigate to the Plugins page in [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x).
2. Click the Update button for the AqualinkD plugin.

**Option 2: Manually Update:**
```
sudo npm update -g homebridge-aqualinkd
```

## Configuration

**Option 1: Configuration via Homebridge Config UI X:**

1. Navigate to the Plugins page in homebridge-config-ui-x.
2. Click the Settings button for the AqualinkD plugin.

**Option 2: Manually Configuration:**

Edit homebridge config.json

Example config
```
// Example ~/.homebridge/config.json content:

{
"bridge": {
"name": "Homebridge",
"username": "CC:21:3E:E4:DE:33", // <<-- Randomize this...
"port": 51826,
"pin": "031-45-154" // <<-- Change pin
},

"platforms": [{
"platform": "AqualinkD",
"name": "AqualinkD",
"server": "127.0.0.1", // <<-- servername/ip running aqualinkd
"port": "80",
"mqtt": {
"host": "mqtt-server.name", // <<-- servername/ip running MQTT
"port": 1883,
"topic": "aqualinkd"
},
"excludedDevices": []
}],
"accessories":[]
}
```

```
MQTT user password would be

"mqtt": {
"host": "mqtt-server.name", // <<-- servername/ip running MQTT
"port": 1883,
"topic": "aqualinkd",
"username": "username", // <<-- Optional, delete line if no user
"password": "password" // <<-- Optional, delete line if no passwd
},
```

```
Removing devices
"excludedDevices": ["Temperature/Spa", "Temperature/Pool", "Temperature/Air", "SWG/Percent_f"]
```
The above list are sort of duplicates. They are the sensors and the values that are also shown in the equivelent thermostats. ie :-
* "Temperature of Pool" is also shown in "Pool Heater Thermostat".
* "Temperature of Spa" is also shown in "Spa Heater Thermostat".
* "Temperature of Air" is also shown in "Freeze Protect Thermostat"
* "Salt Water Generator Percent" is als shown in the "Salt Water Generator Thermostat"
* For a full list of devices from your AqualinkD install that can be removed use the below URL and use the `id:` value.
```http://aqualinkd.ip.address:port/api/homebridge```

So if you want to save realestate you can remove those sensors.

Note :-
The above being duplications will depend on other configuration options, so first time out it's best to leave excludeDevices empty until you have everything showing and configured correctly, then decide what to delete.