Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

185 support for new portal myuplinkcom #197

Merged
merged 27 commits into from
Sep 24, 2024
Merged

185 support for new portal myuplinkcom #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
021379a
Bump dependencies
Jun 15, 2024
f2a98d3
Details
Jun 15, 2024
341df7e
Bump dependencies
Jun 15, 2024
d2ac376
ui config - wip
Jun 15, 2024
453b501
ui config - wip
Jun 15, 2024
3f9701f
ui config - wip
Jun 15, 2024
a9f0510
ui config - wip
Jun 15, 2024
9990757
ui config - wip
Jun 15, 2024
eb4a9d5
new api - wip
Jun 15, 2024
47bd75b
new api - wip
Jun 15, 2024
07c0bd4
new api - wip
Jun 16, 2024
ec69fa6
new api - wip
Jun 16, 2024
0333f75
new api - wip
Jun 16, 2024
1ea219d
new api - wip
Jun 16, 2024
d2bb191
new api - wip
Jun 16, 2024
e477dc1
new api - wip
Jun 17, 2024
de5e90e
new api - wip
Jun 17, 2024
791c55b
new api - wip
Jun 19, 2024
5eb8106
new api - wip
Jun 20, 2024
a7c8ff6
new api - wip
Jun 26, 2024
68fce3e
new api - wip
Jun 26, 2024
bcf57b6
new api - wip
Jun 26, 2024
312f731
new api - wip
Jul 7, 2024
931bdf3
new api - wip
Jul 7, 2024
2fee95a
new api - wip
Jul 7, 2024
aeae13b
new api - wip
Jul 7, 2024
7109419
new api - wip
Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 20 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# homebridge-nibe

![](./docs/nibe-logo-small.png)
![](./docs/nibe-myuplink-logo-small.png)

[![NPM version](https://img.shields.io/npm/v/homebridge-nibe.svg)](https://www.npmjs.com/package/homebridge-nibe)
![Release](https://img.shields.io/github/release/hp-net/homebridge-nibe.svg?logo=github)
Expand All @@ -22,13 +22,15 @@
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/hpruszyn)
</div>

## Nibeuplink plugin for homebridge
## Nibe myUplink plugin for homebridge

This homebridge plugin retrieves data from a Nibe heat pump from Nibe Uplink.
This Homebridge plugin retrieves data from a Nibe heat pump using Nibe myUplink.

**⚠️ Notice:** Version 2 of this plugin supports only myUplink! To access data from Nibe Uplink, please use version 1 of the plugin. The old API is no longer compatible with this plugin.

### Plugin configuration

Whole setup instruction is available on plugin configuration page in homebridge. There is step by step description how to get required parameters.
Complete setup instructions are available on the plugin configuration page in Homebridge, providing a step-by-step guide to obtaining the required parameters.

### Supported accessories

Expand All @@ -49,7 +51,7 @@ Whole setup instruction is available on plugin configuration page in homebridge.
<td>BT1 average outdoor temperature (40067).</td>
</tr>
<tr>
<td>hot-water</td>
<td>hot-water (Soon)</td>
<td>Hot water temperature (40014,40008). Active (on/off) is responsible for temporary lux (48132).</td>
</tr>
<tr>
Expand All @@ -73,29 +75,29 @@ Whole setup instruction is available on plugin configuration page in homebridge.
<td>ERS outdoor temperature (40183).</td>
</tr>
<tr>
<td>ers-fan</td>
<td>ers-fan (Soon)</td>
<td>ERS fan speed (40311, 40312) with change rotation speed (47260) and active state when rotation is grater than 0.</td>
</tr>
<tr>
<td>ventilation-fan</td>
<td>ventilation-fan (Soon)</td>
<td>Ventilation fan speed (10001) with change rotation speed (47260) and active state when rotation is grater than 0.</td>
</tr>
<tr>
<td>thermostat</td>
<td>thermostat (Soon)</td>
<td>Thermostat (40008,43437) for heating and cooling (if available). Active state is calculated. Changing desired temperature will affect heating/cooling offset (47011/48739).</td>
</tr>
</tbody>
</table>

## Roadmap

https://github.com/hp-net/homebridge-nibe/projects/1
Check the project roadmap at https://github.com/hp-net/homebridge-nibe/projects/1

## Configuration

Whole configuration can be done via homebridge ui and this is **recommended** way to do it.
Configuration can be done via the Homebridge UI, which is the **recommended** method.

However, you can also make all changes directly in homebridge config.json file. Below you can find description of all options.
However, you can also make changes directly in the Homebridge config.json file. Below is a description of all options:

<table>
<thead>
Expand All @@ -117,61 +119,43 @@ However, you can also make all changes directly in homebridge config.json file.
<td>identifier</td>
<td>Yes</td>
<td></td>
<td>Api app identifier from Nibe Uplink account. Read instructions from plugin configuration to know how to get it.</td>
<td>Api client identifier from Nibe myUplink account. Follow plugin configuration instructions to obtain it.</td>
</tr>
<tr>
<td>secret</td>
<td>Yes</td>
<td></td>
<td>Api app secret from Nibe Uplink account. Read instructions from plugin configuration to know how to get it.</td>
</tr>
<tr>
<td>authCode</td>
<td>Yes</td>
<td></td>
<td>Authorization code for the app from Nibe Uplink. Read instructions from plugin configuration to know how to get it.</td>
</tr>
<tr>
<td>systemIdentifier</td>
<td>Yes</td>
<td></td>
<td>System identifier for installed Nibe devices.</td>
</tr>
<tr>
<td>callbackUrl</td>
<td>Yes</td>
<td>https://hp-net.github.io/homebridge-nibe/nibe.html</td>
<td>Url that will handle callback with authCode parameter. Default page is safe, it does not have any tracking scrips or additional logic to do weird stuff with the code. What is more authCode is not enough to da anything with api. Default page will only show you the code and give you a nice button to copy it to clipboard.</td>
<td>Api client secret from Nibe myUplink account. Follow plugin configuration instructions to obtain it.</td>
</tr>
<tr>
<td>language</td>
<td>No</td>
<td>en</td>
<td>Language to call Nibe Uplink Api and to set accessories labels. Possible values: 'en', 'pl'.</td>
<td>Language for accessory labels. Possible values: 'en', 'pl', 'sv'.</td>
</tr>
<tr>
<td>pollingPeriod</td>
<td>No</td>
<td>60</td>
<td>Period (in seconds) for fetching device changes from api.</td>
<td>Period (in seconds) for fetching device updates from api.</td>
</tr>
<tr>
<td>disabledAccessories</td>
<td>No</td>
<td></td>
<td>List of accessories to disable. Format 'id(name)' or 'id'.</td>
<td>List of accessories to disable. Format 'id'.</td>
</tr>
<tr>
<td>showApiResponse</td>
<td>No</td>
<td></td>
<td>If set to `true` response from Nibe Uplink API will be displayed in logs.</td>
<td>If set to `true` response from Nibe myUplink API will be displayed in logs.</td>
</tr>
<tr>
<td>hotwaterHeatingTemp</td>
<td>No</td>
<td>40</td>
<td>Min heating temperature for hot water. Used to decide if hot water is active.</td>
<td>Min heating temperature for hot water. Used to determine if hot water is active.</td>
</tr>
</tbody>
</table>
Expand Down
225 changes: 225 additions & 0 deletions archive/AccessoryHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
// export class AccessoryHandler {
// private updateAccessory(platformAccessory: Accessory, services: ConfigurationService[], parameters: Map<number, Parameter>, refreshOnly = false): boolean {
// let result = false;
//
// services.forEach(service => {
// const serviceType = this.platform.getServiceType(service.type);
// const platformService = service.name ?
// platformAccessory.getService(service.name) || platformAccessory.addService(serviceType, service.name, 'Sub'+service.type + service.name):
// platformAccessory.getService(serviceType) || platformAccessory.addService(serviceType);
//
// service.characteristics
// .filter(characteristic => refreshOnly ? (characteristic.refresh || platformService.getCharacteristic(this.platform.getCharacteristicType(characteristic.type)) === null) : true)
// .forEach(characteristic => {
//
// if (characteristic.condition) {
// if (!this.checkConditions(characteristic.condition, parameters)) {
// this.platform.getLogger().debug(`Conditions not meet for characteristic: [${characteristic.id}] for product[${this.product}], removing characteristic`);
// const characteristicType = this.platform.getCharacteristicType(characteristic.type);
// const platformCharacteristic = platformService.getCharacteristic(characteristicType);
// platformService.removeCharacteristic(platformCharacteristic);
// return;
// }
// }
//
// let value;
//
// if (characteristic.value !== undefined) {
// value = characteristic.value;
// } else if(characteristic.id !== undefined) {
// const parameter = parameters.get(characteristic.id);
// if (parameter) {
// value = parameter[characteristic.attribute || 'value'];
// }
// } else if(characteristic.config !== undefined) {
// const configValue = this.platform.getConfig(characteristic.config.key);
// value = configValue === undefined ? characteristic.config.default : configValue;
// } else if(characteristic.provider !== undefined) {
// value = ProviderManager.get(characteristic.provider.name).provide(parameters, characteristic.provider.params, this.platform);
// }
//
// if (characteristic.parser) {
// value = this.transformWithParser(characteristic.parser, value);
// }
//
// if (value !== undefined && characteristic.mapper) {
// value = this.transformWithMapper(characteristic.mapper, value);
// }
//
// if (value !== undefined && characteristic.translate) {
// value = this.transformWithTranslate(platformAccessory.context.accessoryName, value);
// }
//
// if(value !== undefined) {
// const characteristicType = this.platform.getCharacteristicType(characteristic.type);
// const platformCharacteristic = platformService.getCharacteristic(characteristicType);
//
// if (characteristic.props) {
// const {provider: _, ...propsToSet} = characteristic.props;
// if (characteristic.props.provider) {
// const providerProps = ProviderManager.get(characteristic.props.provider.name).provide(parameters, characteristic.props.provider.params, this.platform);
// platformCharacteristic.setProps({...propsToSet, ...providerProps});
// } else {
// platformCharacteristic.setProps(propsToSet);
// }
// }
//
// if (platformCharacteristic) {
// if (platformCharacteristic.value !== value) {
// this.platform.getLogger().debug(`[${platformAccessory.context.accessoryId}: ${service.type}.${characteristic.type}]: [${platformCharacteristic.value}] -> [${value}]`);
// platformService.updateCharacteristic(characteristicType, value);
// result = true;
// }
// } else {
// this.platform.getLogger().debug(`[${platformAccessory.context.accessoryId}: ${service.type}.${characteristic.type}]: [${value}]`);
// platformService.updateCharacteristic(characteristicType, value);
// result = true;
// }
// }
// if (characteristic.manage) {
// const characteristicType = this.platform.getCharacteristicType(characteristic.type);
// const platformCharacteristic = platformService.getCharacteristic(characteristicType);
// const manageId = characteristic.manage.id;
// platformCharacteristic.onSet(manageValue => {
// if (characteristic.manage) {
// if (characteristic.manage.provider !== undefined) {
// const params = {newValue: manageValue};
// manageValue = ProviderManager.get(characteristic.manage.provider.name).provide(parameters, {...params, ...characteristic.manage.provider.params}, this.platform);
// }
//
// if (manageValue !== undefined && characteristic.manage.mapper) {
// manageValue = this.transformWithMapper(characteristic.manage.mapper, manageValue);
// }
//
// if (manageValue !== undefined) {
// if (typeof manageValue === 'object') {
// this.platform.getFetcher().setParams(platformAccessory.context.systemUnitId, manageValue);
// } else {
// const manageParameters = {};
// manageParameters[manageId] = manageValue;
// this.platform.getFetcher().setParams(platformAccessory.context.systemUnitId, manageParameters);
// }
// }
// }
// });
// } else {
// const characteristicType = this.platform.getCharacteristicType(characteristic.type);
// const platformCharacteristic = platformService.getCharacteristic(characteristicType);
// platformCharacteristic.onSet(manageValue => {
// this.platform.getLogger().debug(`Set on ${characteristic.type} with value: ${manageValue}, previous value ${platformCharacteristic.value}`);
// });
// }
// });
// });
//
// platformAccessory.context.lastUpdate = new Date();
//
// return result;
// }
//
// private transformWithParser(parser, value) {
// if (parser === 'notEmpty') {
// return value !== null && value !== '';
// }
// if (parser === 'graterThan0') {
// return value !== null && value > 0;
// }
// return value;
// }
//
// private transformWithMapper(mapper:Map<any, any>, value) {
// const filtered = [...mapper.values()].filter(v => {
// return Object.keys(v)[0].toString() === value.toString();
// });
// const defaultValue = [...mapper.values()].filter(v => {
// return Object.keys(v)[0].toString() === 'default';
// });
//
// if (filtered.length > 0) {
// return Object.values(filtered[0])[0];
// } else if (defaultValue.length === 1) {
// return Object.values(defaultValue[0])[0];
// } else {
// return undefined;
// }
// }
//
// private transformWithTranslate(accessoryName, value) {
// const originalValue = value;
// value = this.locale.text(accessoryName + '.' + originalValue, undefined);
// if(value === undefined) {
// value = this.locale.text(originalValue, undefined);
// }
// return value;
// }
//
// private checkConditions(condition: ConfigurationCondition, parameters: Map<number, Parameter>) {
// if (condition.parameterIds && condition.parameterIds.filter(p => parameters.get(p) === undefined).length > 0) {
// return false;
// }
//
// if (condition.provider !== undefined && !ProviderManager.get(condition.provider.name).provide(parameters, condition.provider.params, this.platform)){
// return false;
// }
//
// return true;
// }
//
// private flatten(data: Data): Map<number, Parameter> {
// const result = new Map<number, Parameter>();
//
// for (const systemUnit of data.unitData) {
// // if (systemUnit.systemUnitId !== this.unitId) {
// // continue;
// // }
// //
// // if (systemUnit.categories) {
// // for (const category of systemUnit.categories) {
// // for (const parameter of category.parameters) {
// // if (parameter) {
// // let parameterId = parameter.parameterId;
// // if (parameterId === 0) {
// // if (parameter.key === 'VERSION') {
// // parameterId = 3;
// // } else if (parameter.key === 'SERIAL_NUMBER') {
// // parameterId = 2;
// // } else if (parameter.key === 'PRODUCT') {
// // parameterId = 1;
// // }
// // }
// //
// // result.set(parameterId, {
// // title: parameter.title,
// // value: parameter.value,
// // unit: parameter.unit,
// // displayValue: parameter.displayValue,
// // rawValue: parameter.rawValue,
// // systemUnitId: systemUnit.systemUnitId,
// // });
// // }
// // }
// // }
// // }
// // break; // handle only first for product
// }
//
// if (data.manageData) {
// for (const managedData of data.manageData) {
// for (const parameter of managedData.parameters) {
// if (parameter) {
// result.set(parameter.parameterId, {
// title: parameter.title,
// value: parameter.value,
// unit: parameter.unit,
// displayValue: parameter.displayValue,
// rawValue: parameter.rawValue,
// managed: true,
// });
// }
// }
// }
// }
//
// return result;
// }
// }
Loading
Loading