-
+ {
+ items.map((item) => (
+
- {item} + )) + } +
| {renderTableProperty(property)} | ++ { + (typeof value === 'object' && value !== null) ? ( + renderTable(value) + ) : ( + renderTableValue(property, value) + ) + } + | +
|---|
+
+ );
+ }
+
+ // If parsing has failed.
+ if (status === 'failed') {
+ return (
+ The information shown below is for your eyes only. Fingerprints are considered your secondary password. Leaking this will compromise the MFA security to your ADT Pulse account.
+ { + renderTable(_.get(parsedObject, ['fingerprint'])) + } +Failed to parse your fingerprint. Please re-run the setup wizard.
+ ); + } + + return ( +Parsing your fingerprint, please wait...
+ ); +} diff --git a/src/config-ui/vite/src/pages/settings-classic.tsx b/src/config-ui/vite/src/pages/settings-classic.tsx new file mode 100644 index 0000000..12a80f0 --- /dev/null +++ b/src/config-ui/vite/src/pages/settings-classic.tsx @@ -0,0 +1,53 @@ +import React, { useEffect, useState } from 'react'; + +import type { SettingsClassicProps } from '@/types/config-ui.d.ts'; + +/** + * Settings classic. + * + * @constructor + * + * @since 1.0.0 + */ +export default function SettingsClassic(props: SettingsClassicProps) { + const { homebridge, setView } = props; + + const [ready, setReady] = useState(false); + + useEffect(() => { + (async () => { + if (homebridge === undefined) { + return; + } + + homebridge.showSpinner(); + + // Making sure the UI does not randomly flash. + await new Promise((resolve) => { + setTimeout(resolve, 1000); + }); + + // In case the previous view was modern settings. + homebridge.showSchemaForm(); + + // Once the schema form shows, set the view to "ready". + setReady(true); + + homebridge.hideSpinner(); + })(); + }, []); + + if (ready) { + return ( + + ); + } + + return null; +} diff --git a/src/config-ui/vite/src/pages/settings-fingerprint.tsx b/src/config-ui/vite/src/pages/settings-fingerprint.tsx new file mode 100644 index 0000000..f26f5f7 --- /dev/null +++ b/src/config-ui/vite/src/pages/settings-fingerprint.tsx @@ -0,0 +1,26 @@ +import React from 'react'; + +import FingerprintTable from '@/config-ui/vite/src/components/fingerprint-table.js'; +import type { SettingsFingerprintProps } from '@/types/config-ui.d.ts'; + +/** + * Settings fingerprint. + * + * @constructor + * + * @since 1.0.0 + */ +export default function SettingsFingerprint(props: SettingsFingerprintProps) { + const { fingerprint } = props; + + if (fingerprint !== '' || import.meta.env.DEV) { + return ( + <> +This section allows you to explore the contents of the randomly generated browser fingerprint used with your account. If you would like to refresh your fingerprint, re-run the setup wizard located in the "System" tab.
+
+ ((
+ <>
+
+
+
+ {(fieldState.error) ? fieldState.error.message : 'Enter a unique name for this plugin. The name will mainly be used for identification purposes, such as in Homebridge logs.'}
+
+
+ ))}
+ />
+
+
+
+
+
+ ((
+ <>
+
+
+
+ {(fieldState.error) ? fieldState.error.message : 'Choose the operational mode for this plugin. Debug mode is enabled only when Homebridge debug mode is on; there is no separate setting for this.'}
+
+
+ ))}
+ />
+
+
+
+ ((
+ <>
+
+
+
+ {(fieldState.error) ? fieldState.error.message : 'Choose the synchronization speed for this plugin. Designed to enhance the performance of devices with older hardware. Results in slower device updates.'}
+
+
+ ))}
+ />
+
+
+
+ );
+}
diff --git a/src/config-ui/vite/src/pages/settings-login.tsx b/src/config-ui/vite/src/pages/settings-login.tsx
new file mode 100644
index 0000000..14bddc6
--- /dev/null
+++ b/src/config-ui/vite/src/pages/settings-login.tsx
@@ -0,0 +1,124 @@
+import React from 'react';
+import { Controller } from 'react-hook-form';
+
+import type { SettingsLoginProps } from '@/types/config-ui.d.ts';
+
+/**
+ * Settings login.
+ *
+ * @constructor
+ *
+ * @since 1.0.0
+ */
+export default function SettingsLogin(props: SettingsLoginProps) {
+ const { control, getValues } = props;
+
+ return (
+ <>
+ Advanced Options
+ {
+ optionsCheckboxes.map((optionsCheckbox) => (
+
+ (
+
+ )}
+ />
+
+ ))
+ }
+
+ Customize the features of this plugin. Please note these advanced options will disable expected functionality. Only enable them if necessary.
+
+
+ ((
+ <>
+
+
+
+ {(fieldState.error) ? fieldState.error.message : 'Select the portal region based on where you are subscribed in.'}
+
+
+ ))}
+ />
+
+
+
+ );
+}
diff --git a/src/config-ui/vite/src/pages/settings-plugin.tsx b/src/config-ui/vite/src/pages/settings-plugin.tsx
new file mode 100644
index 0000000..8da7b69
--- /dev/null
+++ b/src/config-ui/vite/src/pages/settings-plugin.tsx
@@ -0,0 +1,162 @@
+import _ from 'lodash';
+import React, { useEffect, useState } from 'react';
+
+import type { SettingsPluginProps } from '@/types/config-ui.d.ts';
+
+/**
+ * Settings plugin.
+ *
+ * @constructor
+ *
+ * @since 1.0.0
+ */
+export default function SettingsPlugin(props: SettingsPluginProps) {
+ const { homebridge, setView } = props;
+
+ const [information, setInformation] = useState({
+ name: 'homebridge-adt-pulse',
+ version: '1.0.0',
+ verified: false,
+ instanceName: 'Unknown',
+ instanceId: 'Unknown',
+ homebridgeVersion: 'Unknown',
+ nodeVersion: 'Unknown',
+ platform: 'Unknown',
+ runningOn: 'Unknown',
+ });
+
+ useEffect(() => {
+ (async () => {
+ if (homebridge === undefined) {
+ return;
+ }
+
+ const runningNames = {
+ runningInDocker: 'Docker',
+ runningInFreeBSD: 'FreeBSD',
+ runningInLinux: 'Linux',
+ runningInPackageMode: 'Package Mode',
+ runningInSynologyPackage: 'Synology Package',
+ runningOnRaspberryPi: 'Raspberry Pi',
+ };
+ const running = Object.entries(homebridge.serverEnv.env)
+ .filter(([key, value]) => key.startsWith('running') && value === true)
+ .map(([key]) => _.get(runningNames, [key], '') as string);
+
+ setInformation({
+ name: _.get(homebridge, ['plugin', 'name'], ''),
+ version: _.get(homebridge, ['plugin', 'installedVersion'], ''),
+ verified: _.get(homebridge, ['plugin', 'verifiedPlugin'], false),
+ instanceName: _.get(homebridge, ['serverEnv', 'env', 'homebridgeInstanceName'], ''),
+ instanceId: _.get(homebridge, ['serverEnv', 'env', 'instanceId'], ''),
+ homebridgeVersion: _.get(homebridge, ['serverEnv', 'env', 'homebridgeVersion'], ''),
+ nodeVersion: _.get(homebridge, ['serverEnv', 'env', 'nodeVersion'], ''),
+ platform: _.get(homebridge, ['serverEnv', 'env', 'platform'], ''),
+ runningOn: (running.length > 0) ? running.join(', ') : 'Unknown',
+ });
+ })();
+ }, [homebridge]);
+
+ return (
+ <>
+
+
+
+ ((
+ <>
+
+
+
+ {(fieldState.error) ? fieldState.error.message : 'Provide the username you use to login to the portal.'}
+
+
+ ))}
+ />
+
+
+
+ ((
+ <>
+
+
+
+ {(fieldState.error) ? fieldState.error.message : 'Provide the password you use to login to the portal.'}
+
+
+ ))}
+ />
+ + + You are currently + {' '} + { + _.sample([ + 'running', + 'enjoying', + 'utilizing', + 'rocking', + 'dominating', + ]) + } + +
+
+
+ + {information.name} + {' '} + + v + {information.version} + +
+ verified +-
+
- + GitHub + +
- + Sponsor + +
- + Report an Issue + +
System Information
+| Instance Name: | ++ {information.instanceName} + | +
|---|---|
| Instance ID: | ++ {information.instanceId} + | +
| Homebridge Version: | ++ {information.homebridgeVersion} + | +
| Node.js Version | ++ {information.nodeVersion} + | +
| Platform | ++ {information.platform} + | +
| Running on: | ++ {information.runningOn} + | +
This section allows you to define your ADT connected sensors here. Sensors include connected devices like "Door/Window Sensor" or "Motion Sensor". If you would like to update your sensors, re-run the setup wizard.
++ A maximum of 147 sensors can be added (3 slots are reserved for the gateway, security panel, and alarm ringing switch). + {' '} + Z-Wave connected accessories are not supported. +
+
+ {
+ sensors.map((sensor, index) => (
+
+ {
+ (sensors.length <= 147) ? (
+
+
+ ))
+ }
+
+
+
+
+
+
+
+
+ (
+ <>
+
+
+
+ {
+ (fieldState.error) ? fieldState.error.message : (
+ <>
+ Optional.
+ {' '}
+ Provide a display name for this sensor to differentiate it from the names assigned by ADT technicians during installation.
+
+ )
+ }
+
+
+ )}
+ />
+
+
+
+
+
+ (
+ <>
+
+
+
+ {
+ (fieldState.error) ? fieldState.error.message : (
+ <>
+ Specify the
+ {' '}
+ exact name
+ {' '}
+ associated with the sensor you want to add. Double-check the names to ensure they don't include extra characters.
+
+ )
+ }
+
+
+ )}
+ />
+
+
+
+ (
+ <>
+
+
+
+ {
+ (fieldState.error) ? fieldState.error.message : (
+ <>
+ Specify the
+ {' '}
+ exact zone
+ {' '}
+ associated with the sensor you want to add. Double-check the zone to ensure the correct sensor is added.
+
+ )
+ }
+
+
+ )}
+ />
+
+ (
+ <>
+
+
+
+
+ {
+ (fieldState.error) ? fieldState.error.message : (
+ <>
+ Select the
+ {' '}
+ type
+ {' '}
+ associated with the sensor you want to add. Ensure your selection matches the sensor type, as selecting the wrong type may lead to incorrect status detection.
+
+ )
+ }
+
+
+ )}
+ />
+
+
+
+ ) : null
+ }
+
+ );
+}
diff --git a/src/config-ui/vite/src/pages/settings.tsx b/src/config-ui/vite/src/pages/settings.tsx
index bff07b0..83c900c 100644
--- a/src/config-ui/vite/src/pages/settings.tsx
+++ b/src/config-ui/vite/src/pages/settings.tsx
@@ -1,8 +1,14 @@
import { zodResolver } from '@hookform/resolvers/zod';
-import React, { useEffect } from 'react';
-import { Controller, useForm } from 'react-hook-form';
+import _ from 'lodash';
+import React, { useEffect, useState } from 'react';
+import { useForm } from 'react-hook-form';
import { z } from 'zod';
+import SettingsFingerprint from '@/config-ui/vite/src/pages/settings-fingerprint.js';
+import SettingsGeneral from '@/config-ui/vite/src/pages/settings-general.js';
+import SettingsLogin from '@/config-ui/vite/src/pages/settings-login.js';
+import SettingsPlugin from '@/config-ui/vite/src/pages/settings-plugin.js';
+import SettingsSensors from '@/config-ui/vite/src/pages/settings-sensors.js';
import { platformConfig } from '@/lib/schema.js';
import type { SettingsProps } from '@/types/config-ui.d.ts';
@@ -18,13 +24,14 @@ export default function Settings(props: SettingsProps) {
const {
control,
- formState,
- // handleSubmit,
+ getValues,
reset,
+ setValue,
watch,
} = useForm-
-
- - General - -
- - Login - -
- - Fingerprint - -
- - Sensors - -
- - System - -
-
-
- ((
- <>
-
-
- {(fieldState.error) ? fieldState.error.message : 'Enter a unique name for this plugin. The name will mainly be used for identification purposes, such as in Homebridge logs.'}
-
-
- ))}
- />
+ useEffect(() => {
+ (async () => {
+ if (homebridge === undefined) {
+ return;
+ }
+
+ await homebridge.updatePluginConfig([formChanges]);
+ })();
+ }, [formChanges]);
+
+ if (ready) {
+ return (
+ <>
+ -
+
- + General + +
- + Login + +
- + Fingerprint + +
- + Sensors + +
- + Plugin + +
+
+
-
-
-
- );
+
+ );
+ }
+
+ return null;
}
diff --git a/src/config-ui/vite/src/pages/setup-complete.tsx b/src/config-ui/vite/src/pages/setup-complete.tsx
index 264c053..4eaff10 100644
--- a/src/config-ui/vite/src/pages/setup-complete.tsx
+++ b/src/config-ui/vite/src/pages/setup-complete.tsx
@@ -30,7 +30,7 @@ export default function SetupComplete(props: SetupCompleteProps) {
homebridge.showSpinner();
const configs = await homebridge.getPluginConfig();
- const config = configs[0];
+ const config = configs[0] ?? {};
const generateConfigResponse = await homebridge.request('/generate-config', {
oldConfig: config,
updateSensors,
@@ -46,7 +46,7 @@ export default function SetupComplete(props: SetupCompleteProps) {
return (
-
-
- ((
- <>
-
-
-
- {(fieldState.error) ? fieldState.error.message : 'Choose the operational mode for this plugin. Debug mode is enabled only when Homebridge debug mode is on; there is no separate setting for this.'}
-
-
- ))}
- />
-
-
+
- ((
- <>
-
-
-
- {(fieldState.error) ? fieldState.error.message : 'Choose the synchronization speed for this plugin. Designed to enhance the performance of devices with older hardware. Results in slower device updates.'}
-
-
- ))}
- />
-
+
-
- ((
- <>
-
- Advanced Options
-
-
-
-
-
-
-
- {(fieldState.error) ? fieldState.error.message : 'Customize the features of this plugin. Please note these advanced options will disable expected functionality. Only enable them if necessary.'}
-
-
- ))}
- />
+
+
+
+
+
+
- login
-
-
- fingerprint
-
-
- sensors
-
-
- system
-
-
-
- 
+
Setup Complete
Restart Homebridge to apply your configuration changes.
diff --git a/src/config-ui/vite/src/pages/setup-sensors.tsx b/src/config-ui/vite/src/pages/setup-sensors.tsx index 2c1d240..aec494b 100644 --- a/src/config-ui/vite/src/pages/setup-sensors.tsx +++ b/src/config-ui/vite/src/pages/setup-sensors.tsx @@ -44,7 +44,7 @@ export default function SetupSensors(props: SetupSensorsProps) { } const configs = await homebridge.getPluginConfig(); - const config = configs[0]; + const config = configs[0] ?? {}; // For user experience purposes. if (_.get(config, ['sensors'], []).length > 0) { diff --git a/src/config-ui/vite/src/pages/setup-welcome.tsx b/src/config-ui/vite/src/pages/setup-welcome.tsx index a915fb5..e996352 100644 --- a/src/config-ui/vite/src/pages/setup-welcome.tsx +++ b/src/config-ui/vite/src/pages/setup-welcome.tsx @@ -16,7 +16,7 @@ export default function SetupWelcome(props: SetupWelcomeProps) { return (
- 
+
>;
+/**
+ * Fingerprint table.
+ *
+ * @since 1.0.0
+ */
+export type FingerprintTablePropsFingerprint = string;
+
+export type FingerprintTableProps = {
+ fingerprint: FingerprintTablePropsFingerprint;
+};
+
+export type FingerprintTableParsedObject = object;
+
+export type FingerprintTableStatus = 'failed' | 'loading' | 'success';
+
+/**
+ * Fingerprint table - Render table property.
+ *
+ * @since 1.0.0
+ */
+export type FingerprintTableRenderTablePropertyProperty = string;
+
+export type FingerprintTableRenderTablePropertyReturns = string;
+
+/**
+ * Fingerprint table - Render table value.
+ *
+ * @since 1.0.0
+ */
+export type FingerprintTableRenderTableValueProperty = string;
+
+export type FingerprintTableRenderTableValueValue = unknown;
+
+export type FingerprintTableRenderTableValueReturns = ReactNode;
+
+/**
+ * Fingerprint table - Render table.
+ *
+ * @since 1.0.0
+ */
+export type FingerprintTableRenderTableData = object;
+
+export type FingerprintTableRenderTableReturns = ReactNode;
+
/**
* Router.
*
@@ -184,6 +231,121 @@ export type SettingsProps = {
setView: SettingsPropsSetView;
};
+/**
+ * Settings classic.
+ *
+ * @since 1.0.0
+ */
+export type SettingsClassicPropsHomebridge = IHomebridgePluginUi | undefined;
+
+export type SettingsClassicPropsSetView = React.Dispatch>;
+
+export type SettingsClassicProps = {
+ homebridge: SettingsClassicPropsHomebridge;
+ setView: SettingsClassicPropsSetView;
+};
+
+/**
+ * Settings fingerprint.
+ *
+ * @since 1.0.0
+ */
+export type SettingsFingerprintPropsFingerprint = string;
+
+export type SettingsFingerprintProps = {
+ fingerprint: SettingsFingerprintPropsFingerprint;
+};
+
+/**
+ * Settings general.
+ *
+ * @since 1.0.0
+ */
+export type SettingsGeneralPropsControl = Control>;
+
+export type SettingsGeneralPropsGetValues = UseFormGetValues>;
+
+export type SettingsGeneralPropsSetValue = UseFormSetValue>;
+
+export type SettingsGeneralProps = {
+ control: SettingsGeneralPropsControl;
+ getValues: SettingsGeneralPropsGetValues;
+ setValue: SettingsGeneralPropsSetValue;
+};
+
+export type SettingsGeneralOptionsCheckboxId = string;
+
+export type SettingsGeneralOptionsCheckboxLabel = string;
+
+export type SettingsGeneralOptionsCheckboxValue = PluginSettingOptions;
+
+export type SettingsGeneralOptionsCheckbox = {
+ id: SettingsGeneralOptionsCheckboxId;
+ label: SettingsGeneralOptionsCheckboxLabel;
+ value: SettingsGeneralOptionsCheckboxValue;
+};
+
+export type SettingsGeneralOptionsCheckboxes = SettingsGeneralOptionsCheckbox[];
+
+/**
+ * Settings general - Handle options change.
+ *
+ * @since 1.0.0
+ */
+export type SettingsGeneralHandleOptionsChangeChecked = boolean;
+
+export type SettingsGeneralHandleOptionsChangeValue = PluginSettingOptions;
+
+export type SettingsGeneralHandleOptionsChangeReturns = void;
+
+/**
+ * Settings login.
+ *
+ * @since 1.0.0
+ */
+export type SettingsLoginPropsControl = Control>;
+
+export type SettingsLoginPropsGetValues = UseFormGetValues>;
+
+export type SettingsLoginProps = {
+ control: SettingsLoginPropsControl;
+ getValues: SettingsLoginPropsGetValues;
+};
+
+/**
+ * Settings plugin.
+ *
+ * @since 1.0.0
+ */
+export type SettingsPluginHomebridge = IHomebridgePluginUi | undefined;
+
+export type SettingsPluginPropsSetView = React.Dispatch>;
+
+export type SettingsPluginProps = {
+ homebridge: SettingsPluginHomebridge;
+ setView: SettingsPluginPropsSetView;
+};
+
+/**
+ * Settings sensors.
+ *
+ * @since 1.0.0
+ */
+export type SettingsSensorsPropsControl = Control>;
+
+export type SettingsSensorsProps = {
+ control: SettingsSensorsPropsControl;
+};
+
+/**
+ * Settings sensors - Get sensor header.
+ *
+ * @since 1.0.0
+ */
+export type SettingsSensorsGetSensorHeaderIndex = number;
+
+export type SettingsSensorsGetSensorHeaderReturns = string;
+
/**
* Setup.
*
@@ -359,4 +521,4 @@ export type SetupWelcomeProps = {
*
* @since 1.0.0
*/
-export type Styles = React.CSSProperties;
+export type Styles = Record;
diff --git a/src/types/constant.d.ts b/src/types/constant.d.ts
index fd2577c..219d273 100644
--- a/src/types/constant.d.ts
+++ b/src/types/constant.d.ts
@@ -63,6 +63,15 @@ export type PluginLogLevel =
| 'success'
| 'warn';
+/**
+ * Plugin setting options.
+ *
+ * @since 1.0.0
+ */
+export type PluginSettingOptions =
+ 'disableAlarmRingingSwitch'
+ | 'ignoreSensorProblemStatus';
+
/**
* Portal device gateway status.
*
diff --git a/src/types/shared.d.ts b/src/types/shared.d.ts
index c8afcb2..1d1549d 100644
--- a/src/types/shared.d.ts
+++ b/src/types/shared.d.ts
@@ -156,7 +156,7 @@ export type Credentials = {
*
* @since 1.0.0
*/
-export type CurrentView = 'setup' | 'settings' | undefined;
+export type CurrentView = 'settings' | 'settings-classic' | 'setup' | undefined;
/**
* Debug parser.
@@ -577,14 +577,14 @@ export type PortalVersionContent = {
*/
export type SensorConfigAdtName = string;
-export type SensorConfigAdtType = PluginDeviceSensorType;
-
export type SensorConfigAdtZone = number;
+export type SensorConfigAdtType = PluginDeviceSensorType;
+
export type SensorConfig = {
adtName: SensorConfigAdtName;
- adtType: SensorConfigAdtType;
adtZone: SensorConfigAdtZone;
+ adtType: SensorConfigAdtType;
};
/**
diff --git a/tsconfig.json b/tsconfig.json
index 68c4c79..c03efbc 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -41,6 +41,7 @@
"luxon",
"react",
"react-dom",
+ "semver",
"tough-cookie"
]
},
Welcome to
ADT Pulse
Homebridge plugin for ADT Pulse Security System
diff --git a/src/config-ui/vite/src/router.tsx b/src/config-ui/vite/src/router.tsx index e0659e3..7abc8e4 100644 --- a/src/config-ui/vite/src/router.tsx +++ b/src/config-ui/vite/src/router.tsx @@ -2,6 +2,7 @@ import React, { useEffect, useState } from 'react'; import ScreenToggle from '@/config-ui/vite/src/components/screen-toggle.js'; import Settings from '@/config-ui/vite/src/pages/settings.js'; +import SettingsClassic from '@/config-ui/vite/src/pages/settings-classic.js'; import Setup from '@/config-ui/vite/src/pages/setup.js'; import type { RouterProps, RouterView } from '@/types/config-ui.d.ts'; @@ -29,8 +30,7 @@ export default function Router(props: RouterProps) { if (configs.length === 0) { setView('setup'); } else { - // setView('settings'); - homebridge.showSchemaForm(); // TODO Will be replaced in a future version. + setView('settings'); } })(); }, [homebridge]); @@ -40,6 +40,9 @@ export default function Router(props: RouterProps) { {(view === 'settings') ? (