homebridge-noip
Version:
The No-IP plugin allows you to update your No-IP hostname(s) for your homebridge instance.
156 lines • 7.23 kB
JavaScript
/* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
*
* contactsensor.ts: homebridge-noip.
*/
import { Buffer } from 'node:buffer';
import { interval, throwError } from 'rxjs';
import { skipWhile, timeout } from 'rxjs/operators';
import { request } from 'undici';
import { deviceBase } from './device.js';
/**
* Platform Accessory
* An instance of this class is created for each accessory your platform registers
* Each accessory may expose multiple services of different service types.
*/
export class ContactSensor extends deviceBase {
platform;
// Service
contactSensor;
// Others
interval;
ip;
// Updates
SensorUpdateInProgress;
constructor(platform, accessory, device) {
super(platform, accessory, device);
this.platform = platform;
// Contact Sensor Service
this.debugLog('Configure Contact Sensor Service');
this.contactSensor = {
service: this.accessory.getService(this.hap.Service.ContactSensor) ?? this.accessory.addService(this.hap.Service.ContactSensor),
ContactSensorState: this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED,
};
// Add Contact Sensor Service's Characteristics
this.contactSensor.service
.setCharacteristic(this.hap.Characteristic.Name, device.hostname.split('.')[0]);
// this is subject we use to track when we need to POST changes to the NoIP API
this.SensorUpdateInProgress = false;
// Retrieve initial values and updateHomekit
this.refreshStatus();
this.updateHomeKitCharacteristics();
// Start an update interval
interval(this.deviceRefreshRate * 1000)
.pipe(skipWhile(() => this.SensorUpdateInProgress))
.subscribe(async () => {
await this.refreshStatus();
});
}
/**
* Parse the device status from the noip api
*/
async parseStatus(response) {
if (response.includes('nochg')) {
this.contactSensor.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED;
}
else {
this.contactSensor.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
}
await this.debugLog(`ContactSensorState: ${this.contactSensor.ContactSensorState}`);
}
/**
* Asks the NoIP API for the latest device information
*/
async refreshStatus() {
try {
const { body, statusCode } = await request('https://dynupdate.no-ip.com/nic/update', {
method: 'GET',
query: {
hostname: this.device.hostname,
myip: this.platform.publicIPv4,
},
headers: {
'Authorization': `Basic ${Buffer.from(`${this.device.username}:${this.device.password}`).toString('base64')}`,
'User-Agent': `Homebridge-NoIP/v${this.device.firmware}`,
},
});
const response = await body.text();
await this.debugWarnLog(`statusCode: ${JSON.stringify(statusCode)}`);
await this.debugLog(`respsonse: ${JSON.stringify(response)}`);
// this.response = await this.platform.axios.get('https://dynupdate.no-ip.com/nic/update', this.options);
const data = response.trim();
const f = data.match(/good|nochg/g);
if (f) {
await this.debugLog(`Contact Sensor: ${this.accessory.displayName}, ${f[0]}`);
this.status(f, data);
}
else {
await this.errorLog(`error: ${data}`);
}
await this.parseStatus(response);
await this.updateHomeKitCharacteristics();
}
catch (e) {
await this.errorLog(`failed to update status, Error Message: ${JSON.stringify(e.message)}`);
await this.debugLog(`Contact Sensor: ${this.accessory.displayName}, Error: ${JSON.stringify(e)}`);
await this.apiError(e);
}
}
async status(f, data) {
switch (f[0]) {
case 'nochg':
await this.debugLog(`Contact Sensor: ${this.accessory.displayName}'s IP Address has not updated, IP Address: ${data.split(' ')[1]}`);
break;
case 'good':
await this.warnLog(`Contact Sensor: ${this.accessory.displayName}'s IP Address has been updated, IP Address: ${data.split(' ')[1]}`);
break;
case 'nohost':
await this.errorLog('Hostname supplied does not exist under specified account, '
+ 'client exit and require user to enter new login credentials before performing an additional request.');
await this.timeout();
break;
case 'badauth':
await this.errorLog('Invalid username password combination.');
await this.timeout();
break;
case 'badagent':
await this.errorLog('Client disabled. Client should exit and not perform any more updates without user intervention. ');
await this.timeout();
break;
case '!donator':
await this.errorLog('An update request was sent, ' + 'including a feature that is not available to that particular user such as offline options.');
await this.timeout();
break;
case 'abuse':
await this.errorLog('Username is blocked due to abuse. '
+ 'Either for not following our update specifications or disabled due to violation of the No-IP terms of service. '
+ 'Our terms of service can be viewed [here](https://www.noip.com/legal/tos). Client should stop sending updates.');
await this.timeout();
break;
case '911':
await this.errorLog('A fatal error on our side such as a database outage. Retry the update no sooner than 30 minutes. ');
await this.timeout();
break;
default:
await this.debugLog(data);
}
}
async timeout() {
this.interval.pipe(timeout({ each: 1000, with: () => throwError(() => new Error('nohost')) })).subscribe({ error: this.errorLog });
}
/**
* Updates the status for each of the HomeKit Characteristics
*/
async updateHomeKitCharacteristics() {
if (this.contactSensor.ContactSensorState === undefined) {
await this.debugLog(`ContactSensorState: ${this.contactSensor.ContactSensorState}`);
}
else {
this.contactSensor.service.updateCharacteristic(this.hap.Characteristic.ContactSensorState, this.contactSensor.ContactSensorState);
await this.debugLog(`updateCharacteristic ContactSensorState: ${this.contactSensor.ContactSensorState}`);
}
}
async apiError(e) {
this.contactSensor.service.updateCharacteristic(this.hap.Characteristic.ContactSensorState, e);
}
}
//# sourceMappingURL=contactsensor.js.map