2019-12-04 11:17:06 +01:00
|
|
|
const axios = require('axios');
|
|
|
|
|
const EventEmitter = require('events');
|
|
|
|
|
|
|
|
|
|
API_APP_ID = 'zHtVqXt8k4yFyk2QGmgp48D9xZr2G94xWYnF4dak';
|
|
|
|
|
API_BASE_URL = 'https://cloud.plejd.com/parse/';
|
|
|
|
|
API_LOGIN_URL = 'login';
|
2020-03-13 11:58:15 +01:00
|
|
|
API_SITE_LIST_URL = 'functions/getSiteList';
|
|
|
|
|
API_SITE_DETAILS_URL = 'functions/getSiteById';
|
2019-12-04 11:17:06 +01:00
|
|
|
|
2021-01-18 17:21:37 +01:00
|
|
|
const logInfo = true; // Normal operations
|
|
|
|
|
const logDebug = false; // Chatty
|
|
|
|
|
const logVerbose = false; // Very chatty
|
2019-12-04 11:17:06 +01:00
|
|
|
|
2021-01-16 09:14:33 +01:00
|
|
|
const consoleLogger = (level) => (...msg) =>
|
|
|
|
|
console.log(new Date().toISOString().replace("T", " ").substring(0, 19) + "Z", level, "plejd-api", ...msg);
|
|
|
|
|
|
|
|
|
|
const getLogger = (level, shouldLog) => (shouldLog ? consoleLogger(level) : () => {});
|
|
|
|
|
|
|
|
|
|
const errLogger = getLogger("ERR", true);
|
|
|
|
|
const infLogger = getLogger("INF", logInfo);
|
|
|
|
|
const dbgLogger = getLogger("DBG", logDebug);
|
2021-01-18 17:21:37 +01:00
|
|
|
const vrbLogger = getLogger("vrb", logVerbose);
|
2019-12-04 11:17:06 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
class PlejdApi extends EventEmitter {
|
2019-12-13 17:59:48 +01:00
|
|
|
constructor(siteName, username, password, includeRoomsAsLights) {
|
2019-12-04 11:17:06 +01:00
|
|
|
super();
|
|
|
|
|
|
2019-12-13 17:59:48 +01:00
|
|
|
this.includeRoomsAsLights = includeRoomsAsLights;
|
2019-12-04 11:17:06 +01:00
|
|
|
this.siteName = siteName;
|
|
|
|
|
this.username = username;
|
|
|
|
|
this.password = password;
|
|
|
|
|
|
|
|
|
|
this.sessionToken = '';
|
|
|
|
|
this.site = null;
|
|
|
|
|
}
|
|
|
|
|
|
2019-12-22 18:20:20 +00:00
|
|
|
updateSettings(settings) {
|
2021-01-16 09:14:33 +01:00
|
|
|
logVerbose("Got new settings: ", settings);
|
2019-12-22 18:20:20 +00:00
|
|
|
}
|
|
|
|
|
|
2019-12-04 11:17:06 +01:00
|
|
|
login() {
|
2021-01-16 09:14:33 +01:00
|
|
|
infLogger('login()');
|
|
|
|
|
infLogger('logging into ' + this.siteName);
|
2019-12-04 11:17:06 +01:00
|
|
|
const self = this;
|
|
|
|
|
|
|
|
|
|
const instance = axios.create({
|
|
|
|
|
baseURL: API_BASE_URL,
|
|
|
|
|
headers: {
|
|
|
|
|
'X-Parse-Application-Id': API_APP_ID,
|
|
|
|
|
'Content-Type': 'application/json'
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
2020-03-13 11:58:15 +01:00
|
|
|
return new Promise((resolve, reject) => {
|
2021-01-18 17:21:37 +01:00
|
|
|
dbgLogger('sending POST to ' + API_BASE_URL + API_LOGIN_URL);
|
2020-03-13 11:58:15 +01:00
|
|
|
|
|
|
|
|
instance.post(
|
|
|
|
|
API_LOGIN_URL,
|
|
|
|
|
{
|
|
|
|
|
'username': this.username,
|
|
|
|
|
'password': this.password
|
|
|
|
|
})
|
|
|
|
|
.then((response) => {
|
2021-01-16 09:14:33 +01:00
|
|
|
infLogger('got session token response');
|
2020-03-13 11:58:15 +01:00
|
|
|
self.sessionToken = response.data.sessionToken;
|
|
|
|
|
|
|
|
|
|
if (!self.sessionToken) {
|
2021-01-16 09:14:33 +01:00
|
|
|
infError('No session token received');
|
2020-03-13 11:58:15 +01:00
|
|
|
reject('no session token received.');
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
resolve();
|
|
|
|
|
})
|
|
|
|
|
.catch((error) => {
|
|
|
|
|
if (error.response.status === 400) {
|
2021-01-16 09:14:33 +01:00
|
|
|
errLogger('Server returned status 400. probably invalid credentials, please verify.');
|
2020-03-13 11:58:15 +01:00
|
|
|
}
|
|
|
|
|
else {
|
2021-01-16 09:14:33 +01:00
|
|
|
errLogger('Unable to retrieve session token response: ' + error);
|
2020-03-13 11:58:15 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
reject('unable to retrieve session token response: ' + error);
|
|
|
|
|
});
|
|
|
|
|
});
|
2019-12-04 11:17:06 +01:00
|
|
|
}
|
|
|
|
|
|
2020-03-13 11:58:15 +01:00
|
|
|
getSites() {
|
2021-01-16 09:14:33 +01:00
|
|
|
infLogger('getSites()');
|
2019-12-04 11:17:06 +01:00
|
|
|
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'
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
2020-03-13 11:58:15 +01:00
|
|
|
return new Promise((resolve, reject) => {
|
2021-01-18 17:21:37 +01:00
|
|
|
dbgLogger('sending POST to ' + API_BASE_URL + API_SITE_LIST_URL);
|
2020-03-13 11:58:15 +01:00
|
|
|
|
|
|
|
|
instance.post(API_SITE_LIST_URL)
|
|
|
|
|
.then((response) => {
|
2021-01-16 09:14:33 +01:00
|
|
|
infLogger('got site list response');
|
2020-03-13 11:58:15 +01:00
|
|
|
const site = response.data.result.find(x => x.site.title == self.siteName);
|
|
|
|
|
|
|
|
|
|
if (!site) {
|
2021-01-16 09:14:33 +01:00
|
|
|
errLogger('error: failed to find a site named ' + self.siteName);
|
2020-03-13 11:58:15 +01:00
|
|
|
reject('failed to find a site named ' + self.siteName);
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
resolve(site);
|
|
|
|
|
})
|
|
|
|
|
.catch((error) => {
|
2021-01-16 09:14:33 +01:00
|
|
|
errLogger('error: unable to retrieve list of sites. error: ' + error);
|
2020-03-13 11:58:15 +01:00
|
|
|
return reject('plejd-api: unable to retrieve list of sites. error: ' + error);
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
}
|
2019-12-14 14:10:10 +01:00
|
|
|
|
2020-03-13 11:58:15 +01:00
|
|
|
getSite(siteId) {
|
2021-01-16 09:14:33 +01:00
|
|
|
infLogger('getSite(...)');
|
2020-03-13 11:58:15 +01:00
|
|
|
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'
|
|
|
|
|
}
|
|
|
|
|
});
|
2019-12-04 11:17:06 +01:00
|
|
|
|
2020-03-13 11:58:15 +01:00
|
|
|
return new Promise((resolve, reject) => {
|
2021-01-18 17:21:37 +01:00
|
|
|
dbgLogger('sending POST to ' + API_BASE_URL + API_SITE_DETAILS_URL);
|
2020-03-13 11:58:15 +01:00
|
|
|
|
|
|
|
|
instance.post(API_SITE_DETAILS_URL, { siteId: siteId })
|
|
|
|
|
.then((response) => {
|
2021-01-16 09:14:33 +01:00
|
|
|
infLogger('got site details response');
|
2020-03-13 11:58:15 +01:00
|
|
|
if (response.data.result.length === 0) {
|
|
|
|
|
const msg = 'no site with ID ' + siteId + ' was found.';
|
2021-01-16 09:14:33 +01:00
|
|
|
errLogger('error: ' + msg);
|
2020-03-13 11:58:15 +01:00
|
|
|
reject(msg);
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
self.site = response.data.result[0];
|
|
|
|
|
self.cryptoKey = self.site.plejdMesh.cryptoKey;
|
|
|
|
|
|
|
|
|
|
resolve(self.cryptoKey);
|
|
|
|
|
})
|
|
|
|
|
.catch((error) => {
|
2021-01-16 09:14:33 +01:00
|
|
|
errLogger('error: unable to retrieve the crypto key. error: ' + error);
|
2020-03-13 11:58:15 +01:00
|
|
|
return reject('plejd-api: unable to retrieve the crypto key. error: ' + error);
|
|
|
|
|
});
|
|
|
|
|
});
|
2019-12-04 11:17:06 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
getDevices() {
|
|
|
|
|
let devices = [];
|
|
|
|
|
|
2021-01-18 17:21:37 +01:00
|
|
|
vrbLogger(JSON.stringify(this.site));
|
2019-12-10 19:15:38 +01:00
|
|
|
|
2019-12-13 17:59:48 +01:00
|
|
|
const roomDevices = {};
|
|
|
|
|
|
2019-12-04 11:17:06 +01:00
|
|
|
for (let i = 0; i < this.site.devices.length; i++) {
|
2019-12-10 22:01:12 +01:00
|
|
|
const device = this.site.devices[i];
|
|
|
|
|
const deviceId = device.deviceId;
|
2019-12-04 11:17:06 +01:00
|
|
|
|
2019-12-10 22:01:12 +01:00
|
|
|
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];
|
|
|
|
|
}
|
|
|
|
|
|
2019-12-13 14:13:00 +01:00
|
|
|
// check if device is dimmable
|
|
|
|
|
const plejdDevice = this.site.plejdDevices.find(x => x.deviceId == deviceId);
|
|
|
|
|
let { name, type, dimmable } = this._getDeviceType(plejdDevice.hardwareId);
|
2019-12-10 22:01:12 +01:00
|
|
|
|
|
|
|
|
if (settings) {
|
|
|
|
|
dimmable = settings.dimCurve != 'NonDimmable';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const newDevice = {
|
|
|
|
|
id: deviceNum,
|
2019-12-04 11:17:06 +01:00
|
|
|
name: device.title,
|
2019-12-13 14:13:00 +01:00
|
|
|
type: type,
|
|
|
|
|
typeName: name,
|
2020-01-21 14:24:02 +00:00
|
|
|
dimmable: dimmable,
|
|
|
|
|
version: plejdDevice.firmware.version,
|
|
|
|
|
serialNumber: plejdDevice.deviceId
|
2019-12-10 22:01:12 +01:00
|
|
|
};
|
|
|
|
|
|
2020-02-20 13:02:47 +01:00
|
|
|
if (newDevice.typeName === 'WPH-01') {
|
|
|
|
|
// WPH-01 is special, it has two buttons which needs to be
|
|
|
|
|
// registered separately.
|
|
|
|
|
const inputs = this.site.inputAddress[deviceId];
|
|
|
|
|
const first = inputs[0];
|
|
|
|
|
const second = inputs[1];
|
|
|
|
|
|
2020-02-20 13:04:25 +01:00
|
|
|
let switchDevice = {
|
|
|
|
|
id: first,
|
|
|
|
|
name: device.title + ' knapp vä',
|
|
|
|
|
type: type,
|
|
|
|
|
typeName: name,
|
|
|
|
|
dimmable: dimmable,
|
|
|
|
|
version: plejdDevice.firmware.version,
|
|
|
|
|
serialNumber: plejdDevice.deviceId
|
|
|
|
|
};
|
2020-02-20 13:02:47 +01:00
|
|
|
|
|
|
|
|
if (roomDevices[device.roomId]) {
|
2020-02-20 13:04:25 +01:00
|
|
|
roomDevices[device.roomId].push(switchDevice);
|
2020-02-20 13:02:47 +01:00
|
|
|
}
|
|
|
|
|
else {
|
2020-02-20 13:04:25 +01:00
|
|
|
roomDevices[device.roomId] = [switchDevice];
|
2020-02-20 13:02:47 +01:00
|
|
|
}
|
2020-02-20 13:04:25 +01:00
|
|
|
devices.push(switchDevice);
|
|
|
|
|
|
|
|
|
|
switchDevice = {
|
|
|
|
|
id: second,
|
|
|
|
|
name: device.title + ' knapp hö',
|
|
|
|
|
type: type,
|
|
|
|
|
typeName: name,
|
|
|
|
|
dimmable: dimmable,
|
|
|
|
|
version: plejdDevice.firmware.version,
|
|
|
|
|
serialNumber: plejdDevice.deviceId
|
|
|
|
|
};
|
2020-02-20 13:02:47 +01:00
|
|
|
|
|
|
|
|
if (roomDevices[device.roomId]) {
|
2020-02-20 13:04:25 +01:00
|
|
|
roomDevices[device.roomId].push(switchDevice);
|
2020-02-20 13:02:47 +01:00
|
|
|
}
|
|
|
|
|
else {
|
2020-02-20 13:04:25 +01:00
|
|
|
roomDevices[device.roomId] = [switchDevice];
|
2020-02-20 13:02:47 +01:00
|
|
|
}
|
2020-02-20 13:04:25 +01:00
|
|
|
devices.push(switchDevice);
|
2019-12-13 17:59:48 +01:00
|
|
|
}
|
|
|
|
|
else {
|
2020-02-20 13:02:47 +01:00
|
|
|
if (roomDevices[device.roomId]) {
|
|
|
|
|
roomDevices[device.roomId].push(newDevice);
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
roomDevices[device.roomId] = [newDevice];
|
|
|
|
|
}
|
2019-12-13 17:59:48 +01:00
|
|
|
|
2020-02-20 13:04:25 +01:00
|
|
|
devices.push(newDevice);
|
|
|
|
|
}
|
2019-12-04 11:17:06 +01:00
|
|
|
}
|
|
|
|
|
|
2019-12-13 17:59:48 +01:00
|
|
|
if (this.includeRoomsAsLights) {
|
2021-01-18 17:21:37 +01:00
|
|
|
dbgLogger('includeRoomsAsLights is set to true, adding rooms too.');
|
2019-12-13 17:59:48 +01:00
|
|
|
for (let i = 0; i < this.site.rooms.length; i++) {
|
|
|
|
|
const room = this.site.rooms[i];
|
|
|
|
|
const roomId = room.roomId;
|
|
|
|
|
const roomAddress = this.site.roomAddress[roomId];
|
|
|
|
|
|
|
|
|
|
const newDevice = {
|
|
|
|
|
id: roomAddress,
|
|
|
|
|
name: room.title,
|
|
|
|
|
type: 'light',
|
|
|
|
|
typeName: 'Room',
|
2021-01-16 09:14:33 +01:00
|
|
|
dimmable: roomDevices[roomId].filter(x => x.dimmable).length > 0
|
2019-12-13 17:59:48 +01:00
|
|
|
};
|
2020-01-17 15:00:54 +00:00
|
|
|
|
2019-12-13 17:59:48 +01:00
|
|
|
devices.push(newDevice);
|
|
|
|
|
}
|
2021-01-18 17:21:37 +01:00
|
|
|
dbgLogger('includeRoomsAsLights done.');
|
2019-12-13 17:59:48 +01:00
|
|
|
}
|
|
|
|
|
|
2020-02-29 15:54:08 +00:00
|
|
|
// add scenes as switches
|
|
|
|
|
const scenes = this.site.scenes.filter(x => x.hiddenFromSceneList == false);
|
|
|
|
|
|
|
|
|
|
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);
|
|
|
|
|
}
|
|
|
|
|
|
2019-12-04 11:17:06 +01:00
|
|
|
return devices;
|
|
|
|
|
}
|
2019-12-13 14:13:00 +01:00
|
|
|
|
|
|
|
|
_getDeviceType(hardwareId) {
|
|
|
|
|
switch (parseInt(hardwareId)) {
|
|
|
|
|
case 1:
|
|
|
|
|
case 11:
|
|
|
|
|
return { name: "DIM-01", type: 'light', dimmable: true };
|
|
|
|
|
case 2:
|
|
|
|
|
return { name: "DIM-02", type: 'light', dimmable: true };
|
|
|
|
|
case 3:
|
|
|
|
|
return { name: "CTR-01", type: 'light', dimmable: false };
|
|
|
|
|
case 4:
|
|
|
|
|
return { name: "GWY-01", type: 'sensor', dimmable: false };
|
|
|
|
|
case 5:
|
|
|
|
|
return { name: "LED-10", type: 'light', dimmable: true };
|
|
|
|
|
case 6:
|
|
|
|
|
return { name: "WPH-01", type: 'switch', dimmable: false };
|
|
|
|
|
case 7:
|
|
|
|
|
return { name: "REL-01", type: 'switch', dimmable: false };
|
|
|
|
|
case 8:
|
|
|
|
|
case 9:
|
|
|
|
|
// Unknown
|
|
|
|
|
return { name: "-unknown-", type: 'light', dimmable: false };
|
|
|
|
|
case 10:
|
2020-01-17 15:00:54 +00:00
|
|
|
return { name: "-unknown-", type: 'light', dimmable: false };
|
2019-12-13 14:13:00 +01:00
|
|
|
case 12:
|
|
|
|
|
// Unknown
|
|
|
|
|
return { name: "-unknown-", type: 'light', dimmable: false };
|
|
|
|
|
case 13:
|
|
|
|
|
return { name: "Generic", type: 'light', dimmable: false };
|
|
|
|
|
case 14:
|
|
|
|
|
case 15:
|
|
|
|
|
case 16:
|
|
|
|
|
// Unknown
|
|
|
|
|
return { name: "-unknown-", type: 'light', dimmable: false };
|
|
|
|
|
case 17:
|
|
|
|
|
return { name: "REL-01", type: 'switch', dimmable: false };
|
|
|
|
|
case 18:
|
|
|
|
|
return { name: "REL-02", type: 'switch', dimmable: false };
|
|
|
|
|
case 19:
|
|
|
|
|
// Unknown
|
|
|
|
|
return { name: "-unknown-", type: 'light', dimmable: false };
|
|
|
|
|
case 20:
|
|
|
|
|
return { name: "SPR-01", type: 'switch', dimmable: false };
|
|
|
|
|
}
|
|
|
|
|
}
|
2019-12-04 11:17:06 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
module.exports = { PlejdApi };
|