Rewrite PlejdAPI to async/await, set data in central DeviceRegistry
This commit is contained in:
Victor Hagelbäck
parent
75b9a1a8d7
commit
377c6a75db
1 changed files with 217 additions and 235 deletions
|
|
@ -1,5 +1,6 @@
|
||||||
const axios = require('axios');
|
const axios = require('axios').default;
|
||||||
const EventEmitter = require('events');
|
|
||||||
|
const Configuration = require('./Configuration');
|
||||||
const Logger = require('./Logger');
|
const Logger = require('./Logger');
|
||||||
|
|
||||||
const API_APP_ID = 'zHtVqXt8k4yFyk2QGmgp48D9xZr2G94xWYnF4dak';
|
const API_APP_ID = 'zHtVqXt8k4yFyk2QGmgp48D9xZr2G94xWYnF4dak';
|
||||||
|
|
@ -10,271 +11,147 @@ const API_SITE_DETAILS_URL = 'functions/getSiteById';
|
||||||
|
|
||||||
const logger = Logger.getLogger('plejd-api');
|
const logger = Logger.getLogger('plejd-api');
|
||||||
|
|
||||||
class PlejdApi extends EventEmitter {
|
class PlejdApi {
|
||||||
constructor(siteName, username, password, includeRoomsAsLights) {
|
config;
|
||||||
super();
|
deviceRegistry;
|
||||||
|
sessionToken;
|
||||||
|
siteId;
|
||||||
|
siteDetails;
|
||||||
|
|
||||||
this.includeRoomsAsLights = includeRoomsAsLights;
|
constructor(deviceRegistry) {
|
||||||
this.siteName = siteName;
|
this.config = Configuration.getOptions();
|
||||||
this.username = username;
|
this.deviceRegistry = deviceRegistry;
|
||||||
this.password = password;
|
|
||||||
|
|
||||||
this.sessionToken = '';
|
|
||||||
this.site = null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
login() {
|
async init() {
|
||||||
|
logger.info('init()');
|
||||||
|
await this.login();
|
||||||
|
await this.getSites();
|
||||||
|
await this.getSiteDetails();
|
||||||
|
this.getDevices();
|
||||||
|
}
|
||||||
|
|
||||||
|
async login() {
|
||||||
logger.info('login()');
|
logger.info('login()');
|
||||||
logger.info(`logging into ${this.siteName}`);
|
logger.info(`logging into ${this.config.site}`);
|
||||||
const self = this;
|
|
||||||
|
|
||||||
const instance = axios.create({
|
|
||||||
baseURL: API_BASE_URL,
|
|
||||||
headers: {
|
|
||||||
'X-Parse-Application-Id': API_APP_ID,
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
logger.debug(`sending POST to ${API_BASE_URL}${API_LOGIN_URL}`);
|
logger.debug(`sending POST to ${API_BASE_URL}${API_LOGIN_URL}`);
|
||||||
|
|
||||||
instance
|
try {
|
||||||
.post(API_LOGIN_URL, {
|
const response = await this._getAxiosInstance().post(API_LOGIN_URL, {
|
||||||
username: this.username,
|
username: this.config.username,
|
||||||
password: this.password,
|
password: this.config.password,
|
||||||
})
|
});
|
||||||
.then((response) => {
|
|
||||||
logger.info('got session token response');
|
logger.info('got session token response');
|
||||||
self.sessionToken = response.data.sessionToken;
|
this.sessionToken = response.data.sessionToken;
|
||||||
|
|
||||||
if (!self.sessionToken) {
|
if (!this.sessionToken) {
|
||||||
logger.error('No session token received');
|
logger.error('No session token received');
|
||||||
reject(new Error('no session token received.'));
|
throw new Error('API: No session token received.');
|
||||||
}
|
}
|
||||||
|
} catch (error) {
|
||||||
resolve();
|
|
||||||
})
|
|
||||||
.catch((error) => {
|
|
||||||
if (error.response.status === 400) {
|
if (error.response.status === 400) {
|
||||||
|
logger.error('Server returned status 400. probably invalid credentials, please verify.');
|
||||||
|
} else if (error.response.status === 403) {
|
||||||
logger.error(
|
logger.error(
|
||||||
'Server returned status 400. probably invalid credentials, please verify.',
|
'Server returned status 403, forbidden. Plejd seems to do this sometimes, despite correct credentials. Possibly waiting a long time will fix this.',
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
logger.error('Unable to retrieve session token response: ', error);
|
logger.error('Unable to retrieve session token response: ', error);
|
||||||
}
|
}
|
||||||
|
logger.verbose(`Error details: ${JSON.stringify(error.response, null, 2)}`);
|
||||||
|
|
||||||
reject(new Error(`unable to retrieve session token response: ${error}`));
|
throw new Error(`API: Unable to retrieve session token response: ${error}`);
|
||||||
});
|
}
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
getSites() {
|
async getSites() {
|
||||||
logger.info('Get all Plejd sites for account...');
|
logger.info('Get all Plejd sites for account...');
|
||||||
const self = this;
|
|
||||||
|
|
||||||
const instance = axios.create({
|
|
||||||
baseURL: API_BASE_URL,
|
|
||||||
headers: {
|
|
||||||
'X-Parse-Application-Id': API_APP_ID,
|
|
||||||
'X-Parse-Session-Token': this.sessionToken,
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
logger.debug(`sending POST to ${API_BASE_URL}${API_SITE_LIST_URL}`);
|
logger.debug(`sending POST to ${API_BASE_URL}${API_SITE_LIST_URL}`);
|
||||||
|
|
||||||
instance
|
try {
|
||||||
.post(API_SITE_LIST_URL)
|
const response = await this._getAxiosInstance().post(API_SITE_LIST_URL);
|
||||||
.then((response) => {
|
|
||||||
logger.info('got site list response');
|
const sites = response.data.result;
|
||||||
const site = response.data.result.find((x) => x.site.title === self.siteName);
|
logger.info(
|
||||||
|
`Got site list response with ${sites.length}: ${sites.map((s) => s.site.title).join(', ')}`,
|
||||||
|
);
|
||||||
|
logger.silly('All sites found:');
|
||||||
|
logger.silly(JSON.stringify(sites, null, 2));
|
||||||
|
|
||||||
|
const site = sites.find((x) => x.site.title === this.config.site);
|
||||||
|
|
||||||
if (!site) {
|
if (!site) {
|
||||||
logger.error(`error: failed to find a site named ${self.siteName}`);
|
logger.error(`Failed to find a site named ${this.config.site}`);
|
||||||
reject(new Error(`failed to find a site named ${self.siteName}`));
|
throw new Error(`API: Failed to find a site named ${this.config.site}`);
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
resolve(site);
|
logger.info(`Site found matching configuration name ${this.config.site}`);
|
||||||
})
|
logger.silly(JSON.stringify(site, null, 2));
|
||||||
.catch((error) => {
|
this.siteId = site.site.siteId;
|
||||||
|
} catch (error) {
|
||||||
logger.error('error: unable to retrieve list of sites. error: ', error);
|
logger.error('error: unable to retrieve list of sites. error: ', error);
|
||||||
return reject(new Error(`plejd-api: unable to retrieve list of sites. error: ${error}`));
|
throw new Error(`API: unable to retrieve list of sites. error: ${error}`);
|
||||||
});
|
}
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
getSite(siteId) {
|
async getSiteDetails() {
|
||||||
logger.info('Get site details...');
|
logger.info(`Get site details for ${this.siteId}...`);
|
||||||
const self = this;
|
|
||||||
|
|
||||||
const instance = axios.create({
|
|
||||||
baseURL: API_BASE_URL,
|
|
||||||
headers: {
|
|
||||||
'X-Parse-Application-Id': API_APP_ID,
|
|
||||||
'X-Parse-Session-Token': this.sessionToken,
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
logger.debug(`sending POST to ${API_BASE_URL}${API_SITE_DETAILS_URL}`);
|
logger.debug(`sending POST to ${API_BASE_URL}${API_SITE_DETAILS_URL}`);
|
||||||
|
|
||||||
instance
|
try {
|
||||||
.post(API_SITE_DETAILS_URL, { siteId })
|
const response = await this._getAxiosInstance().post(API_SITE_DETAILS_URL, {
|
||||||
.then((response) => {
|
siteId: this.siteId,
|
||||||
|
});
|
||||||
|
|
||||||
logger.info('got site details response');
|
logger.info('got site details response');
|
||||||
|
|
||||||
if (response.data.result.length === 0) {
|
if (response.data.result.length === 0) {
|
||||||
const msg = `no site with ID ${siteId} was found.`;
|
logger.error(`No site with ID ${this.siteId} was found.`);
|
||||||
logger.error(`error: ${msg}`);
|
throw new Error(`API: No site with ID ${this.siteId} was found.`);
|
||||||
reject(msg);
|
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
self.site = response.data.result[0];
|
this.siteDetails = response.data.result[0];
|
||||||
self.cryptoKey = self.site.plejdMesh.cryptoKey;
|
this.deviceRegistry.setApiSite(this.siteDetails);
|
||||||
|
|
||||||
resolve(self.cryptoKey);
|
logger.info(`Site details for site id ${this.siteId} found`);
|
||||||
})
|
logger.silly(JSON.stringify(this.siteDetails, null, 2));
|
||||||
.catch((error) => {
|
|
||||||
logger.error('error: unable to retrieve the crypto key. error: ', error);
|
this.deviceRegistry.cryptoKey = this.siteDetails.plejdMesh.cryptoKey;
|
||||||
return reject(new Error(`plejd-api: unable to retrieve the crypto key. error: ${error}`));
|
if (!this.deviceRegistry.cryptoKey) {
|
||||||
});
|
throw new Error('API: No crypto key set for site');
|
||||||
});
|
}
|
||||||
|
} catch (error) {
|
||||||
|
logger.error(`Unable to retrieve site details for ${this.siteId}. error: `, error);
|
||||||
|
throw new Error(`API: Unable to retrieve site details. error: ${error}`);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
getDevices() {
|
getDevices() {
|
||||||
const devices = [];
|
logger.info('Getting devices from site details response...');
|
||||||
|
|
||||||
logger.verbose(JSON.stringify(this.site));
|
this._getPlejdDevices();
|
||||||
|
this._getRoomDevices();
|
||||||
const roomDevices = {};
|
this._getSceneDevices();
|
||||||
|
|
||||||
for (let i = 0; i < this.site.devices.length; i++) {
|
|
||||||
const device = this.site.devices[i];
|
|
||||||
const { deviceId } = device;
|
|
||||||
|
|
||||||
const settings = this.site.outputSettings.find((x) => x.deviceParseId === device.objectId);
|
|
||||||
let deviceNum = this.site.deviceAddress[deviceId];
|
|
||||||
|
|
||||||
if (settings) {
|
|
||||||
const outputs = this.site.outputAddress[deviceId];
|
|
||||||
deviceNum = outputs[settings.output];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// check if device is dimmable
|
_getAxiosInstance() {
|
||||||
const plejdDevice = this.site.plejdDevices.find((x) => x.deviceId === deviceId);
|
const headers = {
|
||||||
const deviceType = this._getDeviceType(plejdDevice.hardwareId);
|
'X-Parse-Application-Id': API_APP_ID,
|
||||||
const { name, type } = deviceType;
|
'Content-Type': 'application/json',
|
||||||
let { dimmable } = deviceType;
|
|
||||||
|
|
||||||
if (settings) {
|
|
||||||
dimmable = settings.dimCurve !== 'NonDimmable';
|
|
||||||
}
|
|
||||||
|
|
||||||
const newDevice = {
|
|
||||||
id: deviceNum,
|
|
||||||
name: device.title,
|
|
||||||
type,
|
|
||||||
typeName: name,
|
|
||||||
dimmable,
|
|
||||||
version: plejdDevice.firmware.version,
|
|
||||||
serialNumber: plejdDevice.deviceId,
|
|
||||||
};
|
};
|
||||||
|
|
||||||
if (newDevice.typeName === 'WPH-01') {
|
if (this.sessionToken) {
|
||||||
// WPH-01 is special, it has two buttons which needs to be
|
headers['X-Parse-Session-Token'] = this.sessionToken;
|
||||||
// registered separately.
|
|
||||||
const inputs = this.site.inputAddress[deviceId];
|
|
||||||
const first = inputs[0];
|
|
||||||
const second = inputs[1];
|
|
||||||
|
|
||||||
let switchDevice = {
|
|
||||||
id: first,
|
|
||||||
name: `${device.title} knapp vä`,
|
|
||||||
type,
|
|
||||||
typeName: name,
|
|
||||||
dimmable,
|
|
||||||
version: plejdDevice.firmware.version,
|
|
||||||
serialNumber: plejdDevice.deviceId,
|
|
||||||
};
|
|
||||||
|
|
||||||
if (roomDevices[device.roomId]) {
|
|
||||||
roomDevices[device.roomId].push(switchDevice);
|
|
||||||
} else {
|
|
||||||
roomDevices[device.roomId] = [switchDevice];
|
|
||||||
}
|
|
||||||
devices.push(switchDevice);
|
|
||||||
|
|
||||||
switchDevice = {
|
|
||||||
id: second,
|
|
||||||
name: `${device.title} knapp hö`,
|
|
||||||
type,
|
|
||||||
typeName: name,
|
|
||||||
dimmable,
|
|
||||||
version: plejdDevice.firmware.version,
|
|
||||||
serialNumber: plejdDevice.deviceId,
|
|
||||||
};
|
|
||||||
|
|
||||||
if (roomDevices[device.roomId]) {
|
|
||||||
roomDevices[device.roomId].push(switchDevice);
|
|
||||||
} else {
|
|
||||||
roomDevices[device.roomId] = [switchDevice];
|
|
||||||
}
|
|
||||||
devices.push(switchDevice);
|
|
||||||
} else {
|
|
||||||
if (roomDevices[device.roomId]) {
|
|
||||||
roomDevices[device.roomId].push(newDevice);
|
|
||||||
} else {
|
|
||||||
roomDevices[device.roomId] = [newDevice];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
devices.push(newDevice);
|
return axios.create({
|
||||||
}
|
baseURL: API_BASE_URL,
|
||||||
}
|
headers,
|
||||||
|
});
|
||||||
if (this.includeRoomsAsLights) {
|
|
||||||
logger.debug('includeRoomsAsLights is set to true, adding rooms too.');
|
|
||||||
for (let i = 0; i < this.site.rooms.length; i++) {
|
|
||||||
const room = this.site.rooms[i];
|
|
||||||
const { roomId } = room;
|
|
||||||
const roomAddress = this.site.roomAddress[roomId];
|
|
||||||
|
|
||||||
const newDevice = {
|
|
||||||
id: roomAddress,
|
|
||||||
name: room.title,
|
|
||||||
type: 'light',
|
|
||||||
typeName: 'Room',
|
|
||||||
dimmable: roomDevices[roomId].filter((x) => x.dimmable).length > 0,
|
|
||||||
};
|
|
||||||
|
|
||||||
devices.push(newDevice);
|
|
||||||
}
|
|
||||||
logger.debug('includeRoomsAsLights done.');
|
|
||||||
}
|
|
||||||
|
|
||||||
// add scenes as switches
|
|
||||||
const scenes = this.site.scenes.filter((x) => x.hiddenFromSceneList === false);
|
|
||||||
|
|
||||||
// eslint-disable-next-line no-restricted-syntax
|
|
||||||
for (const scene of scenes) {
|
|
||||||
const sceneNum = this.site.sceneIndex[scene.sceneId];
|
|
||||||
const newScene = {
|
|
||||||
id: sceneNum,
|
|
||||||
name: scene.title,
|
|
||||||
type: 'switch',
|
|
||||||
typeName: 'Scene',
|
|
||||||
dimmable: false,
|
|
||||||
version: '1.0',
|
|
||||||
serialNumber: scene.objectId,
|
|
||||||
};
|
|
||||||
|
|
||||||
devices.push(newScene);
|
|
||||||
}
|
|
||||||
|
|
||||||
return devices;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// eslint-disable-next-line class-methods-use-this
|
// eslint-disable-next-line class-methods-use-this
|
||||||
|
|
@ -324,6 +201,111 @@ class PlejdApi extends EventEmitter {
|
||||||
throw new Error(`Unknown device type with id ${hardwareId}`);
|
throw new Error(`Unknown device type with id ${hardwareId}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
_getPlejdDevices() {
|
||||||
|
this.deviceRegistry.clearPlejdDevices();
|
||||||
|
|
||||||
|
this.siteDetails.devices.forEach((device) => {
|
||||||
|
const { deviceId } = device;
|
||||||
|
|
||||||
|
const settings = this.siteDetails.outputSettings.find(
|
||||||
|
(x) => x.deviceParseId === device.objectId,
|
||||||
|
);
|
||||||
|
|
||||||
|
let deviceNum = this.siteDetails.deviceAddress[deviceId];
|
||||||
|
|
||||||
|
if (settings) {
|
||||||
|
const outputs = this.siteDetails.outputAddress[deviceId];
|
||||||
|
deviceNum = outputs[settings.output];
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if device is dimmable
|
||||||
|
const plejdDevice = this.siteDetails.plejdDevices.find((x) => x.deviceId === deviceId);
|
||||||
|
const deviceType = this._getDeviceType(plejdDevice.hardwareId);
|
||||||
|
const { name, type } = deviceType;
|
||||||
|
let { dimmable } = deviceType;
|
||||||
|
|
||||||
|
if (settings) {
|
||||||
|
dimmable = settings.dimCurve !== 'NonDimmable';
|
||||||
|
}
|
||||||
|
|
||||||
|
const newDevice = {
|
||||||
|
id: deviceNum,
|
||||||
|
name: device.title,
|
||||||
|
type,
|
||||||
|
typeName: name,
|
||||||
|
dimmable,
|
||||||
|
roomId: device.roomId,
|
||||||
|
version: plejdDevice.firmware.version,
|
||||||
|
serialNumber: plejdDevice.deviceId,
|
||||||
|
};
|
||||||
|
|
||||||
|
if (newDevice.typeName === 'WPH-01') {
|
||||||
|
// WPH-01 is special, it has two buttons which needs to be
|
||||||
|
// registered separately.
|
||||||
|
const inputs = this.siteDetails.inputAddress[deviceId];
|
||||||
|
const first = inputs[0];
|
||||||
|
const second = inputs[1];
|
||||||
|
|
||||||
|
this.deviceRegistry.addPlejdDevice({
|
||||||
|
...newDevice,
|
||||||
|
id: first,
|
||||||
|
name: `${device.title} left`,
|
||||||
|
});
|
||||||
|
|
||||||
|
this.deviceRegistry.addPlejdDevice({
|
||||||
|
...newDevice,
|
||||||
|
id: second,
|
||||||
|
name: `${device.title} right`,
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
this.deviceRegistry.addPlejdDevice(newDevice);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
_getRoomDevices() {
|
||||||
|
if (this.config.includeRoomsAsLights) {
|
||||||
|
logger.debug('includeRoomsAsLights is set to true, adding rooms too.');
|
||||||
|
this.siteDetails.rooms.forEach((room) => {
|
||||||
|
const { roomId } = room;
|
||||||
|
const roomAddress = this.siteDetails.roomAddress[roomId];
|
||||||
|
|
||||||
|
const newDevice = {
|
||||||
|
id: roomAddress,
|
||||||
|
name: room.title,
|
||||||
|
type: 'light',
|
||||||
|
typeName: 'Room',
|
||||||
|
dimmable: this.deviceIdsByRoom[roomId].some(
|
||||||
|
(deviceId) => this.plejdDevices[deviceId].dimmable,
|
||||||
|
),
|
||||||
|
};
|
||||||
|
|
||||||
|
this.deviceRegistry.addRoomDevice(newDevice);
|
||||||
|
});
|
||||||
|
logger.debug('includeRoomsAsLights done.');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_getSceneDevices() {
|
||||||
|
// add scenes as switches
|
||||||
|
const scenes = this.siteDetails.scenes.filter((x) => x.hiddenFromSceneList === false);
|
||||||
|
|
||||||
|
scenes.forEach((scene) => {
|
||||||
|
const sceneNum = this.siteDetails.sceneIndex[scene.sceneId];
|
||||||
|
const newScene = {
|
||||||
|
id: sceneNum,
|
||||||
|
name: scene.title,
|
||||||
|
type: 'switch',
|
||||||
|
typeName: 'Scene',
|
||||||
|
dimmable: false,
|
||||||
|
version: '1.0',
|
||||||
|
serialNumber: scene.objectId,
|
||||||
|
};
|
||||||
|
|
||||||
|
this.deviceRegistry.addScene(newScene);
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = PlejdApi;
|
module.exports = PlejdApi;
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue