@@ -58,36 +58,36 @@
Setup
Features
Help/About
diff --git a/src/index.ts b/src/index.ts
index a9b1ab3..c39f0b1 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,14 +1,13 @@
+import type { API } from 'homebridge'
+
/* Copyright(C) 2017-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
*
* index.ts: homebridge-august.
*/
-import { AugustPlatform } from './platform.js';
-import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js';
-
-import type { API } from 'homebridge';
+import { AugustPlatform } from './platform.js'
+import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
// Register our platform with homebridge.
export default (api: API): void => {
-
- api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, AugustPlatform);
-};
+ api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, AugustPlatform)
+}
diff --git a/src/platform.ts b/src/platform.ts
index bb1cc7a..d490e0b 100644
--- a/src/platform.ts
+++ b/src/platform.ts
@@ -1,15 +1,18 @@
-
/* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
*
* platform.ts: homebridge-august.
*/
-import August from 'august-yale';
-import { readFileSync, writeFileSync } from 'fs';
-import { LockMechanism } from './devices/lock.js';
-import { PLUGIN_NAME, PLATFORM_NAME } from './settings.js';
+import type { API, DynamicPlatformPlugin, Logging, PlatformAccessory } from 'homebridge'
+
+import type { AugustPlatformConfig, credentials, device, devicesConfig, options } from './settings.js'
+
+import { readFileSync, writeFileSync } from 'node:fs'
+import { argv } from 'node:process'
+
+import August from 'august-yale'
-import type { AugustPlatformConfig, credentials, device, devicesConfig, options } from './settings.js';
-import type { API, DynamicPlatformPlugin, Logging, PlatformAccessory } from 'homebridge';
+import { LockMechanism } from './devices/lock.js'
+import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
/**
* HomebridgePlatform
@@ -17,22 +20,22 @@ import type { API, DynamicPlatformPlugin, Logging, PlatformAccessory } from 'hom
* parse the user config and discover/register accessories with Homebridge.
*/
export class AugustPlatform implements DynamicPlatformPlugin {
- public accessories: PlatformAccessory[];
- public readonly api: API;
- public readonly log: Logging;
- public config!: AugustPlatformConfig;
-
- platformConfig!: AugustPlatformConfig['options'];
- platformLogging!: options['logging'];
- platformRefreshRate!: options['refreshRate'];
- platformPushRate!: options['pushRate'];
- platformUpdateRate!: options['updateRate'];
- registeringDevice!: boolean;
- debugMode!: boolean;
- version!: string;
+ public accessories: PlatformAccessory[]
+ public readonly api: API
+ public readonly log: Logging
+ public config!: AugustPlatformConfig
+
+ platformConfig!: AugustPlatformConfig
+ platformLogging!: options['logging']
+ platformRefreshRate!: options['refreshRate']
+ platformPushRate!: options['pushRate']
+ platformUpdateRate!: options['updateRate']
+ registeringDevice!: boolean
+ debugMode!: boolean
+ version!: string
// August API
- augustConfig!: August;
+ augustConfig!: August
constructor(
log: Logging,
@@ -40,13 +43,13 @@ export class AugustPlatform implements DynamicPlatformPlugin {
api: API,
) {
// Initialize
- this.accessories = [];
- this.api = api;
- this.log = log;
+ this.accessories = []
+ this.api = api
+ this.log = log
// only load if configured
if (!config) {
- return;
+ return
}
// Plugin options into our config variables.
@@ -55,53 +58,52 @@ export class AugustPlatform implements DynamicPlatformPlugin {
name: config.name,
credentials: config.credentials as credentials,
options: config.options as object,
- };
+ }
// Plugin Configuration
- this.getPlatformLogSettings();
- this.getPlatformRateSettings();
- this.getPlatformConfigSettings();
- this.getVersion();
+ this.getPlatformLogSettings()
+ this.getPlatformRateSettings()
+ this.getPlatformConfigSettings()
+ this.getVersion()
- // Finish initializing the plugin
+ // Finish initializing the platform
this.debugLog(`Finished initializing platform: ${config.name}`);
// verify the config
(async () => {
try {
- this.verifyConfig();
- this.debugLog('Config OK');
+ this.verifyConfig()
+ this.debugLog('Config OK')
} catch (e: any) {
- await this.errorLog(`Verify Config, Error Message: ${e.message}, Submit Bugs Here: https://bit.ly/august-bug-report`);
- await this.debugErrorLog(`Verify Config, Error: ${e}`);
- return;
+ await this.errorLog(`Verify Config, Error Message: ${e.message}, Submit Bugs Here: https://bit.ly/august-bug-report`)
+ await this.debugErrorLog(`Verify Config, Error: ${e}`)
}
- })();
+ })()
// When this event is fired it means Homebridge has restored all cached accessories from disk.
// Dynamic Platform plugins should only register new accessories after this event was fired,
// in order to ensure they weren't added to homebridge already. This event can also be used
// to start discovery of new accessories.
this.api.on('didFinishLaunching', async () => {
- await this.debugLog('Executed didFinishLaunching callback');
+ await this.debugLog('Executed didFinishLaunching callback')
// run the method to discover / register your devices as accessories
if (this.config.credentials?.isValidated === false || this.config.credentials?.isValidated === undefined) {
- await this.debugWarnLog(`Config Credentials: ${JSON.stringify(this.config.credentials)}`);
+ await this.debugWarnLog(`Config Credentials: ${JSON.stringify(this.config.credentials)}`)
try {
- await this.validated();
+ await this.validated()
} catch (e: any) {
- this.errorLog(`Validate: ${e}`);
+ this.errorLog(`Validate: ${e}`)
}
} else {
- await this.debugWarnLog(`Config Credentials: ${JSON.stringify(this.config.credentials)}`);
+ await this.debugWarnLog(`Config Credentials: ${JSON.stringify(this.config.credentials)}`)
try {
- await this.discoverDevices();
+ await this.discoverDevices()
} catch (e: any) {
- await this.errorLog(`Validated, Discover Devices: ${e}`);
+ await this.errorLog(`Validated, Discover Devices: ${e}`)
}
}
- });
+ })
}
/**
@@ -109,10 +111,10 @@ export class AugustPlatform implements DynamicPlatformPlugin {
* It should be used to setup event handlers for characteristics and update respective values.
*/
async configureAccessory(accessory: PlatformAccessory): Promise
{
- await this.debugLog(`Loading accessory from cache: ${accessory.displayName}`);
+ await this.debugLog(`Loading accessory from cache: ${accessory.displayName}`)
// add the restored accessory to the accessories cache so we can track if it has already been registered
- this.accessories.push(accessory);
+ this.accessories.push(accessory)
}
/**
@@ -120,13 +122,13 @@ export class AugustPlatform implements DynamicPlatformPlugin {
*/
async verifyConfig() {
if (!this.config.credentials) {
- throw 'Missing Credentials';
+ throw new Error('Missing Credentials')
} else {
if (!this.config.credentials.augustId) {
- throw 'Missing August ID (E-mail/Phone Number';
+ throw new Error('Missing August ID (E-mail/Phone Number)')
}
if (!this.config.credentials.password) {
- throw 'Missing August Password';
+ throw new Error('Missing August Password')
}
}
}
@@ -137,85 +139,82 @@ export class AugustPlatform implements DynamicPlatformPlugin {
* this process then looks to see if session is already validated and if the validateCode in config;
* if isValidated is false then it will validate iwth the validateCode and save isValidated as true in the config.json file
* will also make the validateCode undefined
- * @param this.config.credentials.installId
- * @param this.config.credentials.isValidated
- * @param this.config.credentials.validateCode
*/
async validated() {
if (!this.config.credentials?.installId) {
- this.config.credentials!.installId = this.api.hap.uuid.generate(`${this.config.credentials?.augustId}`);
+ this.config.credentials!.installId = this.api.hap.uuid.generate(`${this.config.credentials?.augustId}`)
}
- await this.augustCredentials();
+ await this.augustCredentials()
if (!this.config.credentials?.isValidated && this.config.credentials?.validateCode) {
- const validateCode = this.config.credentials?.validateCode;
- const isValidated = await August.validate(this.config.credentials!, validateCode);
+ const validateCode = this.config.credentials?.validateCode
+ const isValidated = await August.validate(this.config.credentials!, validateCode)
// If validated successfully, set flag for future use, and you can now use the API
- this.config.credentials.isValidated = isValidated;
+ this.config.credentials.isValidated = isValidated
// load in the current config
- const { pluginConfig, currentConfig } = await this.pluginConfig();
+ const { pluginConfig, currentConfig } = await this.pluginConfig()
- pluginConfig.credentials.isValidated = this.config.credentials?.isValidated;
+ pluginConfig.credentials.isValidated = this.config.credentials?.isValidated
if (this.config.credentials.isValidated) {
- pluginConfig.credentials.validateCode = undefined;
+ pluginConfig.credentials.validateCode = undefined
}
- await this.debugWarnLog(`isValidated: ${pluginConfig.credentials.isValidated}`);
- await this.debugWarnLog(`validateCode: ${pluginConfig.credentials.validateCode}`);
+ await this.debugWarnLog(`isValidated: ${pluginConfig.credentials.isValidated}`)
+ await this.debugWarnLog(`validateCode: ${pluginConfig.credentials.validateCode}`)
// save the config, ensuring we maintain pretty json
- writeFileSync(this.api.user.configPath(), JSON.stringify(currentConfig, null, 4));
+ writeFileSync(this.api.user.configPath(), JSON.stringify(currentConfig, null, 4))
if (!isValidated) {
- return;
+ this.debugErrorLog('Validate Code is Invalid, Please Check Your Code and Restart Homebridge.')
} else {
try {
- await this.discoverDevices();
- await this.debugWarnLog(`isValidated: ${this.config.credentials?.isValidated}`);
+ await this.discoverDevices()
+ await this.debugWarnLog(`isValidated: ${this.config.credentials?.isValidated}`)
} catch (e: any) {
- await this.errorLog(`Validate, Discover Devices: ${e}`);
+ await this.errorLog(`Validate, Discover Devices: ${e}`)
}
}
} else {
// load in the current config
- const { pluginConfig, currentConfig } = await this.pluginConfig();
+ const { pluginConfig, currentConfig } = await this.pluginConfig()
// set the refresh token
- pluginConfig.credentials.installId = this.config.credentials?.installId;
+ pluginConfig.credentials.installId = this.config.credentials?.installId
- await this.debugWarnLog(`installId: ${pluginConfig.credentials.installId}`);
+ await this.debugWarnLog(`installId: ${pluginConfig.credentials.installId}`)
// save the config, ensuring we maintain pretty json
- writeFileSync(this.api.user.configPath(), JSON.stringify(currentConfig, null, 4));
+ writeFileSync(this.api.user.configPath(), JSON.stringify(currentConfig, null, 4))
// A 6-digit code will be sent to your email or phone (depending on what you used for your augustId).
// Need some way to get this code from the user.
- August.authorize(this.config.credentials!);
- await this.warnLog('Input Your August email verification code into the validateCode config and restart Homebridge.');
+ August.authorize(this.config.credentials!)
+ await this.warnLog('Input Your August email verification code into the validateCode config and restart Homebridge.')
}
}
async augustCredentials() {
if (!this.config.credentials) {
- throw 'Missing Credentials';
+ throw new Error('Missing Credentials')
} else {
- this.augustConfig = new August(this.config.credentials);
- await this.debugLog(`August Credentials: ${JSON.stringify(this.augustConfig)}`);
+ this.augustConfig = new August(this.config.credentials)
+ await this.debugLog(`August Credentials: ${JSON.stringify(this.augustConfig)}`)
}
}
async pluginConfig() {
- const currentConfig = JSON.parse(readFileSync(this.api.user.configPath(), 'utf8'));
+ const currentConfig = JSON.parse(readFileSync(this.api.user.configPath(), 'utf8'))
// check the platforms section is an array before we do array things on it
if (!Array.isArray(currentConfig.platforms)) {
- throw new Error('Cannot find platforms array in config');
+ throw new TypeError('Cannot find platforms array in config')
}
// find this plugins current config
- const pluginConfig = currentConfig.platforms.find((x: { platform: string; }) => x.platform === PLATFORM_NAME);
+ const pluginConfig = currentConfig.platforms.find((x: { platform: string }) => x.platform === PLATFORM_NAME)
if (!pluginConfig) {
- throw new Error(`Cannot find config for ${PLATFORM_NAME} in platforms array`);
+ throw new Error(`Cannot find config for ${PLATFORM_NAME} in platforms array`)
}
// check the .credentials is an object before doing object things with it
if (typeof pluginConfig.credentials !== 'object') {
- throw new Error('pluginConfig.credentials is not an object');
+ throw new TypeError('pluginConfig.credentials is not an object')
}
- return { pluginConfig, currentConfig };
+ return { pluginConfig, currentConfig }
}
/**
@@ -223,28 +222,28 @@ export class AugustPlatform implements DynamicPlatformPlugin {
*/
async discoverDevices() {
// August Locks
- const devices = await August.details(this.config.credentials!, '');
- let deviceLists: any[];
+ const devices = await August.details(this.config.credentials!, '')
+ let deviceLists: any[]
if (devices.length > 1) {
- deviceLists = devices;
- await this.infoLog(`Total August Locks Found: ${deviceLists.length}`);
+ deviceLists = devices
+ await this.infoLog(`Total August Locks Found: ${deviceLists.length}`)
} else {
- deviceLists = [devices];
- await this.infoLog(`Total August Locks Found: ${deviceLists.length}`);
+ deviceLists = [devices]
+ await this.infoLog(`Total August Locks Found: ${deviceLists.length}`)
}
if (!this.config.options?.devices) {
- await this.debugWarnLog(`August Platform Config Not Set: ${JSON.stringify(this.config.options?.devices)}`);
- const devices = deviceLists.map((v: any) => v);
+ await this.debugWarnLog(`August Platform Config Not Set: ${JSON.stringify(this.config.options?.devices)}`)
+ const devices = deviceLists.map((v: any) => v)
for (const device of devices) {
if (device.configDeviceName) {
- device.deviceName = device.configDeviceName;
+ device.deviceName = device.configDeviceName
}
- await this.debugLog(`August Devices: ${JSON.stringify(device)}`);
- await this.Lock(device);
+ await this.debugLog(`August Devices: ${JSON.stringify(device)}`)
+ await this.Lock(device)
}
} else if (this.config.options.devices) {
- await this.debugWarnLog(`August Platform Config Set: ${JSON.stringify(this.config.options?.devices)}`);
- const deviceConfigs = this.config.options?.devices;
+ await this.debugWarnLog(`August Platform Config Set: ${JSON.stringify(this.config.options?.devices)}`)
+ const deviceConfigs = this.config.options?.devices
const mergeBylockId = (a1: { lockId: string }[], a2: any[]) =>
a1.map((itm: { lockId: string }) => ({
@@ -253,163 +252,170 @@ export class AugustPlatform implements DynamicPlatformPlugin {
item.lockId.toUpperCase().replace(/[^A-Z0-9]+/g, '') === itm.lockId.toUpperCase().replace(/[^A-Z0-9]+/g, '') && item,
),
...itm,
- }));
- const devices = mergeBylockId(deviceLists, deviceConfigs);
- await this.debugLog(`August Lock(s): ${JSON.stringify(devices)}`);
+ }))
+ const devices = mergeBylockId(deviceLists, deviceConfigs)
+ await this.debugLog(`August Lock(s): ${JSON.stringify(devices)}`)
for (const device of devices) {
if (device.configDeviceName) {
- device.deviceName = device.configDeviceName;
+ device.deviceName = device.configDeviceName
}
- await this.debugLog(`device: ${JSON.stringify(device)}`);
- await this.Lock(device);
+ await this.debugLog(`device: ${JSON.stringify(device)}`)
+ await this.Lock(device)
}
} else {
- await this.errorLog('August ID & Password Supplied, Issue with Auth.');
+ await this.errorLog('August ID & Password Supplied, Issue with Auth.')
}
}
private async Lock(device: device & devicesConfig) {
- const uuid = this.api.hap.uuid.generate(device.lockId);
+ const uuid = this.api.hap.uuid.generate(device.lockId)
// see if an accessory with the same uuid has already been registered and restored from
// the cached devices we stored in the `configureAccessory` method above
- const existingAccessory = this.accessories.find((accessory) => accessory.UUID === uuid);
+ const existingAccessory = this.accessories.find(accessory => accessory.UUID === uuid)
if (existingAccessory) {
-
// the accessory already exists
if (await this.registerDevice(device)) {
- await this.infoLog(`Restoring existing accessory from cache: ${device.LockName}, Lock ID: ${device.lockId}`);
+ await this.infoLog(`Restoring existing accessory from cache: ${device.LockName}, Lock ID: ${device.lockId}`)
// if you need to update the accessory.context then you should run `api.updatePlatformAccessories`. eg.:
- existingAccessory.context.device = device;
+ existingAccessory.context.device = device
existingAccessory.displayName = device.configLockName
? await this.validateAndCleanDisplayName(device.configLockName, 'configLockName', device.configLockName)
- : await this.validateAndCleanDisplayName(device.LockName, 'LockName', device.LockName);
- existingAccessory.context.currentFirmwareVersion = device.currentFirmwareVersion;
- existingAccessory.context.model = device.skuNumber;
- existingAccessory.context.serialnumber = device.SerialNumber;
- existingAccessory.context.lockId = device.lockId;
- this.api.updatePlatformAccessories([existingAccessory]);
+ : await this.validateAndCleanDisplayName(device.LockName, 'LockName', device.LockName)
+ existingAccessory.context.currentFirmwareVersion = device.currentFirmwareVersion
+ existingAccessory.context.model = device.skuNumber
+ existingAccessory.context.serialnumber = device.SerialNumber
+ existingAccessory.context.lockId = device.lockId
+ this.api.updatePlatformAccessories([existingAccessory])
// create the accessory handler for the restored accessory
// this is imported from `platformAccessory.ts`
- new LockMechanism(this, existingAccessory, device);
- await this.debugLog(`Lock: ${device.LockName} (${device.lockId}) uuid: ${existingAccessory.UUID}`);
+ new LockMechanism(this, existingAccessory, device)
+ await this.debugLog(`Lock: ${device.LockName} (${device.lockId}) uuid: ${existingAccessory.UUID}`)
} else {
- await this.unregisterPlatformAccessories(existingAccessory, device);
+ await this.unregisterPlatformAccessories(existingAccessory, device)
}
} else if (await this.registerDevice(device)) {
// create a new accessory
- const accessory = new this.api.platformAccessory(device.configLockName ?? device.LockName, uuid);
+ const accessory = new this.api.platformAccessory(device.configLockName ?? device.LockName, uuid)
// store a copy of the device object in the `accessory.context`
// the `context` property can be used to store any data about the accessory you may need
- accessory.context.device = device;
+ accessory.context.device = device
accessory.displayName = device.configLockName
? await this.validateAndCleanDisplayName(device.configLockName, 'configLockName', device.configLockName)
- : await this.validateAndCleanDisplayName(device.LockName, 'LockName', device.LockName);
- accessory.context.currentFirmwareVersion = device.currentFirmwareVersion;
- accessory.context.model = device.skuNumber;
- accessory.context.serialnumber = device.SerialNumber;
- accessory.context.lockId = device.lockId;
+ : await this.validateAndCleanDisplayName(device.LockName, 'LockName', device.LockName)
+ accessory.context.currentFirmwareVersion = device.currentFirmwareVersion
+ accessory.context.model = device.skuNumber
+ accessory.context.serialnumber = device.SerialNumber
+ accessory.context.lockId = device.lockId
// the accessory does not yet exist, so we need to create it
if (!device.external) {
- await this.infoLog(`Adding new accessory: ${device.LockName}, Lock ID: ${device.lockId}`);
+ await this.infoLog(`Adding new accessory: ${device.LockName}, Lock ID: ${device.lockId}`)
}
// create the accessory handler for the newly create accessory
// this is imported from `platformAccessory.ts`
- new LockMechanism(this, accessory, device);
- await this.debugLog(`Lock: ${device.LockName} (${device.lockId}) uuid: ${accessory.UUID}`);
+ new LockMechanism(this, accessory, device)
+ await this.debugLog(`Lock: ${device.LockName} (${device.lockId}) uuid: ${accessory.UUID}`)
// link the accessory to your platform
- await this.externalOrPlatform(device, accessory);
- this.accessories.push(accessory);
+ await this.externalOrPlatform(device, accessory)
+ this.accessories.push(accessory)
} else {
- await this.debugErrorLog(`Unable to Register: ${device.LockName}, Lock ID: ${device.lockId} Check Config to see if is being Hidden.`);
+ await this.debugErrorLog(`Unable to Register: ${device.LockName}, Lock ID: ${device.lockId} Check Config to see if is being Hidden.`)
}
}
async registerDevice(device: device & devicesConfig) {
if (!device.hide_device && !device.homeKitEnabled) {
- this.registeringDevice = true;
- await this.debugLog(`Device: ${device.LockName} Enabled`);
+ this.registeringDevice = true
+ await this.debugLog(`Device: ${device.LockName} Enabled`)
} else if (device.homeKitEnabled && device.overrideHomeKitEnabled) {
- this.registeringDevice = true;
+ this.registeringDevice = true
await this.debugWarnLog(`Device: ${device.LockName} HomeKit Enabled: ${device.homeKitEnabled}, `
- + `Override HomeKit Enabled: ${device.overrideHomeKitEnabled}`);
+ + `Override HomeKit Enabled: ${device.overrideHomeKitEnabled}`)
} else if (device.homeKitEnabled && !device.overrideHomeKitEnabled) {
- this.registeringDevice = false;
+ this.registeringDevice = false
await this.debugErrorLog(`Device: ${device.LockName} HomeKit Enabled: `
- + `${device.homeKitEnabled}, device will not be registered. To enable, set overrideHomeKitEnabled to true.`);
+ + `${device.homeKitEnabled}, device will not be registered. To enable, set overrideHomeKitEnabled to true.`)
} else {
- this.registeringDevice = false;
- await this.debugLog(`Device: ${device.LockName} is Hidden.`);
+ this.registeringDevice = false
+ await this.debugLog(`Device: ${device.LockName} is Hidden.`)
}
- return this.registeringDevice;
+ return this.registeringDevice
}
public async externalOrPlatform(device: device & devicesConfig, accessory: PlatformAccessory) {
if (device.external) {
- await this.infoLog(`${accessory.displayName} External Accessory Mode: ${device.external}`);
- await this.externalAccessory(accessory);
+ await this.infoLog(`${accessory.displayName} External Accessory Mode: ${device.external}`)
+ await this.externalAccessory(accessory)
} else {
- await this.debugLog(`${accessory.displayName} External Accessory Mode: ${device.external}`);
- this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory]);
+ await this.debugLog(`${accessory.displayName} External Accessory Mode: ${device.external}`)
+ this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory])
}
}
public async externalAccessory(accessory: PlatformAccessory) {
- this.api.publishExternalAccessories(PLUGIN_NAME, [accessory]);
+ this.api.publishExternalAccessories(PLUGIN_NAME, [accessory])
}
public async unregisterPlatformAccessories(existingAccessory: PlatformAccessory, device: device & devicesConfig) {
// remove platform accessories when no longer present
- this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [existingAccessory]);
- await this.warnLog(`Removing existing accessory from cache: ${device.LockName}`);
- }
-
- async getVersion() {
- const json = JSON.parse(
- readFileSync(
- new URL('../package.json', import.meta.url),
- 'utf-8',
- ),
- );
- await this.debugLog(`Plugin Version: ${json.version}`);
- this.version = json.version;
+ this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [existingAccessory])
+ await this.warnLog(`Removing existing accessory from cache: ${device.LockName}`)
}
async getPlatformConfigSettings() {
if (this.config.options) {
- const platformConfig: AugustPlatformConfig['options'] = {};
- platformConfig.logging = this.config.options.logging ? this.config.options.logging : undefined;
- platformConfig.refreshRate = this.config.options.refreshRate ? this.config.options.refreshRate : undefined;
- platformConfig.updateRate = this.config.options.updateRate ? this.config.options.updateRate : undefined;
- platformConfig.pushRate = this.config.options.pushRate ? this.config.options.pushRate : undefined;
+ const platformConfig: AugustPlatformConfig = {
+ platform: 'August',
+ }
+ platformConfig.logging = this.config.options.logging ? this.config.options.logging : undefined
+ platformConfig.refreshRate = this.config.options.refreshRate ? this.config.options.refreshRate : undefined
+ platformConfig.updateRate = this.config.options.updateRate ? this.config.options.updateRate : undefined
+ platformConfig.pushRate = this.config.options.pushRate ? this.config.options.pushRate : undefined
if (Object.entries(platformConfig).length !== 0) {
- await this.debugLog(`Platform Config: ${JSON.stringify(platformConfig)}`);
+ await this.debugLog(`Platform Config: ${JSON.stringify(platformConfig)}`)
}
- this.platformConfig = platformConfig;
+ this.platformConfig = platformConfig
}
}
async getPlatformRateSettings() {
- this.platformRefreshRate = this.config.options?.refreshRate ? this.config.options.refreshRate : 0;
- const refreshRate = this.config.options?.refreshRate ? 'Using Platform Config refreshRate' : 'refreshRate Disabled by Default';
- await this.debugLog(`${refreshRate}: ${this.platformRefreshRate}`);
- this.platformUpdateRate = this.config.options?.updateRate ? this.config.options.updateRate : 1;
- const updateRate = this.config.options?.updateRate ? 'Using Platform Config updateRate' : 'Using Default updateRate';
- await this.debugLog(`${updateRate}: ${this.platformUpdateRate}`);
- this.platformPushRate = this.config.options?.pushRate ? this.config.options.pushRate : 1;
- const pushRate = this.config.options?.pushRate ? 'Using Platform Config pushRate' : 'Using Default pushRate';
- await this.debugLog(`${pushRate}: ${this.platformPushRate}`);
+ this.platformRefreshRate = this.config.options?.refreshRate ? this.config.options.refreshRate : 0
+ const refreshRate = this.config.options?.refreshRate ? 'Using Platform Config refreshRate' : 'refreshRate Disabled by Default'
+ await this.debugLog(`${refreshRate}: ${this.platformRefreshRate}`)
+ this.platformUpdateRate = this.config.options?.updateRate ? this.config.options.updateRate : 1
+ const updateRate = this.config.options?.updateRate ? 'Using Platform Config updateRate' : 'Using Default updateRate'
+ await this.debugLog(`${updateRate}: ${this.platformUpdateRate}`)
+ this.platformPushRate = this.config.options?.pushRate ? this.config.options.pushRate : 1
+ const pushRate = this.config.options?.pushRate ? 'Using Platform Config pushRate' : 'Using Default pushRate'
+ await this.debugLog(`${pushRate}: ${this.platformPushRate}`)
}
async getPlatformLogSettings() {
- this.debugMode = process.argv.includes('-D') ?? process.argv.includes('--debug');
+ this.debugMode = argv.includes('-D') ?? argv.includes('--debug')
this.platformLogging = (this.config.options?.logging === 'debug' || this.config.options?.logging === 'standard'
- || this.config.options?.logging === 'none') ? this.config.options.logging : this.debugMode ? 'debugMode' : 'standard';
- const logging = this.config.options?.logging ? 'Platform Config' : this.debugMode ? 'debugMode' : 'Default';
- await this.debugLog(`Using ${logging} Logging: ${this.platformLogging}`);
+ || this.config.options?.logging === 'none')
+ ? this.config.options.logging
+ : this.debugMode ? 'debugMode' : 'standard'
+ const logging = this.config.options?.logging ? 'Platform Config' : this.debugMode ? 'debugMode' : 'Default'
+ await this.debugLog(`Using ${logging} Logging: ${this.platformLogging}`)
+ }
+
+ /**
+ * Asynchronously retrieves the version of the plugin from the package.json file.
+ *
+ * This method reads the package.json file located in the parent directory,
+ * parses its content to extract the version, and logs the version using the debug logger.
+ * The extracted version is then assigned to the `version` property of the class.
+ *
+ * @returns {Promise} A promise that resolves when the version has been retrieved and logged.
+ */
+ async getVersion(): Promise {
+ const { version } = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf-8'))
+ this.debugLog(`Plugin Version: ${version}`)
+ this.version = version
}
/**
@@ -418,40 +424,36 @@ export class AugustPlatform implements DynamicPlatformPlugin {
* @param name - The name of the characteristic.
* @param value - The value to be validated and cleaned.
* @returns The cleaned string value.
- */
+ */
async validateAndCleanDisplayName(displayName: string, name: string, value: string): Promise {
if (this.config.options?.allowInvalidCharacters) {
- return value;
+ return value
} else {
- const validPattern = new RegExp(/^[\p{L}\p{N}][\p{L}\p{N} ']*[\p{L}\p{N}]$/u);
- const invalidCharsPattern = /[^\p{L}\p{N} ']/gu;
- const invalidStartEndPattern = /^[^\p{L}\p{N}]+|[^\p{L}\p{N}]+$/gu;
+ const validPattern = /^[\p{L}\p{N}][\p{L}\p{N} ']*[\p{L}\p{N}]$/u
+ const invalidCharsPattern = /[^\p{L}\p{N} ']/gu
+ const invalidStartEndPattern = /^[^\p{L}\p{N}]+|[^\p{L}\p{N}]+$/gu
if (typeof value === 'string' && !validPattern.test(value)) {
- this.warnLog(`WARNING: The accessory '${displayName}' has an invalid '${name}' characteristic ('${value}'). Please use only alphanumeric,`
- + ' space, and apostrophe characters. Ensure it starts and ends with an alphabetic or numeric character, and avoid emojis. This may'
- + ' prevent the accessory from being added in the Home App or cause unresponsiveness.');
+ this.warnLog(`WARNING: The accessory '${displayName}' has an invalid '${name}' characteristic ('${value}'). Please use only alphanumeric, space, and apostrophe characters. Ensure it starts and ends with an alphabetic or numeric character, and avoid emojis. This may prevent the accessory from being added in the Home App or cause unresponsiveness.`)
// Remove invalid characters
if (invalidCharsPattern.test(value)) {
- const before = value;
- this.warnLog(`Removing invalid characters from '${name}' characteristic, if you feel this is incorrect,`
- + ' please enable \'allowInvalidCharacter\' in the config to allow all characters');
- value = value.replace(invalidCharsPattern, '');
- this.warnLog(`${name} Before: '${before}' After: '${value}'`);
+ const before = value
+ this.warnLog(`Removing invalid characters from '${name}' characteristic, if you feel this is incorrect, please enable \'allowInvalidCharacter\' in the config to allow all characters`)
+ value = value.replace(invalidCharsPattern, '')
+ this.warnLog(`${name} Before: '${before}' After: '${value}'`)
}
// Ensure it starts and ends with an alphanumeric character
if (invalidStartEndPattern.test(value)) {
- const before = value;
- this.warnLog(`Removing invalid starting or ending characters from '${name}' characteristic, if you feel this is incorrect,`
- + ' please enable \'allowInvalidCharacter\' in the config to allow all characters');
- value = value.replace(invalidStartEndPattern, '');
- this.warnLog(`${name} Before: '${before}' After: '${value}'`);
+ const before = value
+ this.warnLog(`Removing invalid starting or ending characters from '${name}' characteristic, if you feel this is incorrect, please enable \'allowInvalidCharacter\' in the config to allow all characters`)
+ value = value.replace(invalidStartEndPattern, '')
+ this.warnLog(`${name} Before: '${before}' After: '${value}'`)
}
}
- return value;
+ return value
}
}
@@ -461,67 +463,67 @@ export class AugustPlatform implements DynamicPlatformPlugin {
*/
async infoLog(...log: any[]): Promise {
if (await this.enablingPlatformLogging()) {
- this.log.info(String(...log));
+ this.log.info(String(...log))
}
}
async successLog(...log: any[]): Promise {
if (await this.enablingPlatformLogging()) {
- this.log.success(String(...log));
+ this.log.success(String(...log))
}
}
async debugSuccessLog(...log: any[]): Promise {
if (await this.enablingPlatformLogging()) {
if (await this.loggingIsDebug()) {
- this.log.success('[DEBUG]', String(...log));
+ this.log.success('[DEBUG]', String(...log))
}
}
}
async warnLog(...log: any[]): Promise {
if (await this.enablingPlatformLogging()) {
- this.log.warn(String(...log));
+ this.log.warn(String(...log))
}
}
async debugWarnLog(...log: any[]): Promise {
if (await this.enablingPlatformLogging()) {
if (await this.loggingIsDebug()) {
- this.log.warn('[DEBUG]', String(...log));
+ this.log.warn('[DEBUG]', String(...log))
}
}
}
async errorLog(...log: any[]): Promise {
if (await this.enablingPlatformLogging()) {
- this.log.error(String(...log));
+ this.log.error(String(...log))
}
}
async debugErrorLog(...log: any[]): Promise {
if (await this.enablingPlatformLogging()) {
if (await this.loggingIsDebug()) {
- this.log.error('[DEBUG]', String(...log));
+ this.log.error('[DEBUG]', String(...log))
}
}
}
async debugLog(...log: any[]): Promise {
if (await this.enablingPlatformLogging()) {
- if (this.platformLogging === 'debug') {
- this.log.info('[DEBUG]', String(...log));
- } else if (this.platformLogging === 'debugMode') {
- this.log.debug(String(...log));
+ if (this.platformLogging === 'debugMode') {
+ this.log.debug(String(...log))
+ } else if (this.platformLogging === 'debug') {
+ this.log.info('[DEBUG]', String(...log))
}
}
}
async loggingIsDebug(): Promise {
- return this.platformLogging === 'debugMode' || this.platformLogging === 'debug';
+ return this.platformLogging === 'debugMode' || this.platformLogging === 'debug'
}
async enablingPlatformLogging(): Promise {
- return this.platformLogging === 'debugMode' || this.platformLogging === 'debug' || this.platformLogging === 'standard';
+ return this.platformLogging === 'debugMode' || this.platformLogging === 'debug' || this.platformLogging === 'standard'
}
-}
\ No newline at end of file
+}
diff --git a/src/settings.ts b/src/settings.ts
index f7ec5b9..ed1d047 100644
--- a/src/settings.ts
+++ b/src/settings.ts
@@ -2,100 +2,100 @@
*
* setting.ts: homebridge-august.
*/
-import type { PlatformConfig } from 'homebridge';
+import type { PlatformConfig } from 'homebridge'
/**
* This is the name of the platform that users will use to register the plugin in the Homebridge config.json
*/
-export const PLATFORM_NAME = 'August';
+export const PLATFORM_NAME = 'August'
/**
* This must match the name of your plugin as defined the package.json
*/
-export const PLUGIN_NAME = 'homebridge-august';
+export const PLUGIN_NAME = 'homebridge-august'
-//Config
+// Config
export interface AugustPlatformConfig extends PlatformConfig {
- credentials?: credentials;
- options?: options;
-}
-
-export type credentials = {
- apiKey?: string;
- pnSubKey?: string;
- installId: string;
- augustId: string; // Phone must be formatted +[countrycode][number]
- password: string;
- countryCode: string;
- validateCode?: string;
- isValidated?: boolean;
-};
-
-export type options = {
- devices?: devicesConfig[];
- allowInvalidCharacters?: boolean;
- refreshRate?: number;
- updateRate?: number;
- pushRate?: number;
- logging?: string;
-};
-
-export type device = {
- LockName: string;
- Type: number;
- Created: string;
- Updated: string;
- LockId: string;
- HouseID: string;
- HouseName: string;
- Calibrated: boolean;
- timeZone: string;
- battery: number;
- batteryInfo: BatteryInfo;
- doorStateOpenTimeout: number;
- hostLockInfo: HostLockInfo;
- supportsEntryCodes: boolean;
- remoteOperateSecret: string;
- skuNumber: string;
- macAddress: string;
- SerialNumber: string;
- LockStatus: LockStatus;
- currentFirmwareVersion: string;
+ credentials?: credentials
+ options?: options
+}
+
+export interface credentials {
+ apiKey?: string
+ pnSubKey?: string
+ installId: string
+ augustId: string // Phone must be formatted +[countrycode][number]
+ password: string
+ countryCode: string
+ validateCode?: string
+ isValidated?: boolean
+}
+
+export interface options {
+ devices?: devicesConfig[]
+ allowInvalidCharacters?: boolean
+ refreshRate?: number
+ updateRate?: number
+ pushRate?: number
+ logging?: string
+}
+
+export interface device {
+ LockName: string
+ Type: number
+ Created: string
+ Updated: string
+ LockId: string
+ HouseID: string
+ HouseName: string
+ Calibrated: boolean
+ timeZone: string
+ battery: number
+ batteryInfo: BatteryInfo
+ doorStateOpenTimeout: number
+ hostLockInfo: HostLockInfo
+ supportsEntryCodes: boolean
+ remoteOperateSecret: string
+ skuNumber: string
+ macAddress: string
+ SerialNumber: string
+ LockStatus: LockStatus
+ currentFirmwareVersion: string
homeKitEnabled: boolean
- zWaveEnabled: boolean;
- isGalileo: boolean;
- Bridge: Bridge;
- parametersToSet: Record;
- users: Record;
- pubsubChannel: string;
- ruleHash: any;
- cameras: any[];
- lockId: string;
-};
-
-export type BatteryInfo = {
+ zWaveEnabled: boolean
+ isGalileo: boolean
+ Bridge: Bridge
+ parametersToSet: Record
+ users: Record
+ pubsubChannel: string
+ ruleHash: any
+ cameras: any[]
+ lockId: string
+}
+
+export interface BatteryInfo {
level: number
warningState: string
infoUpdatedDate: string
lastChangeDate: string
lastChangeVoltage: number
-};
+}
-export type HostLockInfo = {
+export interface HostLockInfo {
serialNumber: string
manufacturer: string
productID: number
productTypeID: number
-};
+}
-export type LockStatus = {
+export interface LockStatus {
status: string
dateTime: string
isLockStatusChanged: boolean
valid: boolean
doorState: string
-};
+}
-export type Bridge = {
+export interface Bridge {
_id: string
mfgBridgeID: string
deviceModel: string
@@ -104,97 +104,97 @@ export type Bridge = {
status: Status
locks: Lock[]
hyperBridge: boolean
-};
+}
-export type Status = {
+export interface Status {
current: string
lastOffline: string
updated: string
lastOnline: string
-};
+}
-export type Lock = {
+export interface Lock {
_id: string
LockID: string
macAddress: string
-};
+}
export interface devicesConfig extends device {
- configLockName?: string;
- lockId: string;
- lock?: lock;
+ configLockName?: string
+ lockId: string
+ lock?: lock
overrideHomeKitEnabled: boolean
- hide_device?: boolean;
- external?: boolean;
- logging?: string;
- refreshRate?: number;
- updateRate?: number;
- pushRate?: number;
- firmware?: string;
-}
-
-export type lock = {
- hide_lock?: boolean;
- hide_contactsensor?: boolean;
-};
-
-export type lockDetails = {
- lockName: string;
- battery: number;
- LockStatus: lockStatus;
- currentFirmwareVersion: string;
-};
-
-export type lockStatus = {
- lockId: string;
- status: string;
- doorState: string;
- state: state;
-};
-
-export type state = {
- unlocked: boolean;
- locked: boolean;
- locking: boolean;
- unlocking: boolean;
- open: boolean;
- closed: boolean;
-};
-
-export type lockEvent = {
- remoteEvent?: boolean;
- status: string;
- info?: info;
- callingUserID?: string;
- doorState: string;
- state: stateEvent;
- lockID: string;
- lockId: string;
-};
-
-export type stateEvent = {
- locked: boolean;
- unlocked: boolean;
- locking: boolean;
- unlocking: boolean;
- open?: boolean;
- closed?: boolean;
-};
-
-export type info = {
- action: string;
- startTime: Date;
+ hide_device?: boolean
+ external?: boolean
+ logging?: string
+ refreshRate?: number
+ updateRate?: number
+ pushRate?: number
+ firmware?: string
+}
+
+export interface lock {
+ hide_lock?: boolean
+ hide_contactsensor?: boolean
+}
+
+export interface lockDetails {
+ lockName: string
+ battery: number
+ LockStatus: lockStatus
+ currentFirmwareVersion: string
+}
+
+export interface lockStatus {
+ lockId: string
+ status: string
+ doorState: string
+ state: state
+}
+
+export interface state {
+ unlocked: boolean
+ locked: boolean
+ locking: boolean
+ unlocking: boolean
+ open: boolean
+ closed: boolean
+}
+
+export interface lockEvent {
+ remoteEvent?: boolean
+ status: string
+ info?: info
+ callingUserID?: string
+ doorState: string
+ state: stateEvent
+ lockID: string
+ lockId: string
+}
+
+export interface stateEvent {
+ locked: boolean
+ unlocked: boolean
+ locking: boolean
+ unlocking: boolean
+ open?: boolean
+ closed?: boolean
+}
+
+export interface info {
+ action: string
+ startTime: Date
context: {
- transactionID: string;
- startDate: Date;
- retryCount: number;
- };
- lockType: string;
- serialNumber: string;
- rssi: number;
- wlanRSSI: number;
- wlanSNR: number;
- duration: number;
- lockID: string;
- bridgeID: string;
-};
\ No newline at end of file
+ transactionID: string
+ startDate: Date
+ retryCount: number
+ }
+ lockType: string
+ serialNumber: string
+ rssi: number
+ wlanRSSI: number
+ wlanSNR: number
+ duration: number
+ lockID: string
+ bridgeID: string
+}
diff --git a/tsconfig.json b/tsconfig.json
index b5ad9a3..53abb89 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -1,22 +1,22 @@
{
"compilerOptions": {
"target": "ES2022",
- "module": "ES2022",
"lib": [
"DOM",
"ES2022"
],
- "declaration": true,
- "declarationMap": true,
- "sourceMap": true,
- "outDir": "dist",
"rootDir": "src",
+ "module": "ES2022",
+ "moduleResolution": "node",
"strict": true,
- "esModuleInterop": true,
"noImplicitAny": false,
+ "declaration": true,
+ "declarationMap": true,
+ "outDir": "dist",
+ "sourceMap": true,
"allowSyntheticDefaultImports": true,
- "forceConsistentCasingInFileNames": true,
- "moduleResolution": "node",
+ "esModuleInterop": true,
+ "forceConsistentCasingInFileNames": true
},
"include": [
"src"
@@ -24,4 +24,4 @@
"exclude": [
"**/*.spec.ts"
]
-}
\ No newline at end of file
+}
+
# Homebridge August
@@ -9,9 +9,9 @@
\n\nThe **August** plugin allows you to control August Devices. \n\nTo get started link your August Account.\n\n1. Input your August E-mail/Phone Number into the August Account Info.\n\n2.Restart Homebridge to receive an August Validate Code.\n\n3. Input your Validate Code into the August Account Info.\n\n4. Finally Restart Homebridge.",
- "footerDisplay": "Please raise any issues on our [project page](https://github.com/donavanbecker/homebridge-august/issues).\n\nIf you would like to have other August Devices added to this plugin fill out [Feature Request Form](https://github.com/donavanbecker/homebridge-august/issues/new?assignees=&labels=&template=feature_request.md).",
+ "footerDisplay": "Please raise any issues on our [project page](https://github.com/homebridge-plugins/homebridge-august/issues).\n\nIf you would like to have other August Devices added to this plugin fill out [Feature Request Form](https://github.com/homebridge-plugins/homebridge-august/issues/new?assignees=&labels=&template=feature_request.md).",
"schema": {
"type": "object",
"properties": {
diff --git a/docs/assets/icons.js b/docs/assets/icons.js
index e88e8ca..3dfbd32 100644
--- a/docs/assets/icons.js
+++ b/docs/assets/icons.js
@@ -3,7 +3,7 @@
function addIcons() {
if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons);
const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg"));
- svg.innerHTML = `"