feat(zigbee): add Zigbee Herdsman plugin for direct Zigbee device integration

apps/admin/src/app.main.ts

@@ -78,6 +78,7 @@ import { DevicesShellyNgPlugin } from './plugins/devices-shelly-ng';
 import { DevicesShellyV1Plugin } from './plugins/devices-shelly-v1';
 import { DevicesThirdPartyPlugin } from './plugins/devices-third-party';
 import { DevicesWledPlugin } from './plugins/devices-wled';
+import { DevicesZigbeeHerdsmanPlugin } from './plugins/devices-zigbee-herdsman';
 import { DevicesZigbee2mqttPlugin } from './plugins/devices-zigbee2mqtt';
 import { LoggerRotatingFilePlugin } from './plugins/logger-rotating-file';
 import { PagesCardsPlugin } from './plugins/pages-cards';
@@ -204,6 +205,7 @@ app.use(DevicesShellyNgPlugin, pluginOptions);
 app.use(DevicesShellyV1Plugin, pluginOptions);
 app.use(SimulatorPlugin, pluginOptions);
 app.use(DevicesWledPlugin, pluginOptions);
+app.use(DevicesZigbeeHerdsmanPlugin, pluginOptions);
 app.use(DevicesZigbee2mqttPlugin, pluginOptions);
 app.use(SpacesHomeControlPlugin, pluginOptions);
 app.use(SpacesSyntheticMasterPlugin, pluginOptions);

apps/admin/src/plugins/devices-zigbee-herdsman/components/components.ts

@@ -0,0 +1,5 @@
+export { default as ZigbeeHerdsmanConfigForm } from './zigbee-herdsman-config-form.vue';
+export { default as ZigbeeHerdsmanDeviceAddForm } from './zigbee-herdsman-device-add-form.vue';
+export { default as ZigbeeHerdsmanDeviceEditForm } from './zigbee-herdsman-device-edit-form.vue';
+
+export * from './types';

apps/admin/src/plugins/devices-zigbee-herdsman/components/types.ts

@@ -0,0 +1,3 @@
+export * from './zigbee-herdsman-config-form.types';
+export * from './zigbee-herdsman-device-add-form.types';
+export * from './zigbee-herdsman-device-edit-form.types';

apps/admin/src/plugins/devices-zigbee-herdsman/components/zigbee-herdsman-config-form.types.ts

@@ -0,0 +1,11 @@
+import type { FormResultType, LayoutType } from '../../../modules/config';
+import type { IConfigPlugin } from '../../../modules/config/store/config-plugins.store.types';
+
+export interface IZigbeeHerdsmanConfigFormProps {
+	config: IConfigPlugin;
+	remoteFormSubmit?: boolean;
+	remoteFormResult?: FormResultType;
+	remoteFormReset?: boolean;
+	remoteFormChanged?: boolean;
+	layout?: LayoutType;
+}

apps/admin/src/plugins/devices-zigbee-herdsman/components/zigbee-herdsman-config-form.vue

@@ -0,0 +1,339 @@
+<template>
+	<el-form
+		ref="formEl"
+		:model="model"
+		:rules="rules"
+		label-position="top"
+		status-icon
+	>
+		<el-alert
+			type="info"
+			:title="t('devicesZigbeeHerdsmanPlugin.headings.aboutPluginStatus')"
+			:description="t('devicesZigbeeHerdsmanPlugin.texts.aboutPluginStatus')"
+			:closable="false"
+		/>
+
+		<el-form-item
+			:label="t('devicesZigbeeHerdsmanPlugin.fields.config.enabled.title')"
+			prop="enabled"
+			label-position="left"
+			class="mt-3"
+		>
+			<el-switch
+				v-model="model.enabled"
+				name="enabled"
+			/>
+		</el-form-item>
+
+		<hr />
+
+		<el-alert
+			type="info"
+			:title="t('devicesZigbeeHerdsmanPlugin.headings.aboutSerial')"
+			:description="t('devicesZigbeeHerdsmanPlugin.texts.aboutSerial')"
+			:closable="false"
+		/>
+
+		<el-form-item
+			:label="t('devicesZigbeeHerdsmanPlugin.fields.config.serial.path.title')"
+			prop="serial.path"
+			class="mt-3"
+		>
+			<el-input
+				v-model="model.serial.path"
+				:placeholder="t('devicesZigbeeHerdsmanPlugin.fields.config.serial.path.placeholder')"
+				name="serialPath"
+			/>
+		</el-form-item>
+
+		<el-row :gutter="20">
+			<el-col
+				:xs="24"
+				:sm="12"
+			>
+				<el-form-item
+					:label="t('devicesZigbeeHerdsmanPlugin.fields.config.serial.baudRate.title')"
+					prop="serial.baudRate"
+				>
+					<el-input-number
+						v-model="model.serial.baudRate"
+						:min="1"
+						name="serialBaudRate"
+						class="w-full!"
+					/>
+				</el-form-item>
+			</el-col>
+			<el-col
+				:xs="24"
+				:sm="12"
+			>
+				<el-form-item
+					:label="t('devicesZigbeeHerdsmanPlugin.fields.config.serial.adapterType.title')"
+					prop="serial.adapterType"
+				>
+					<el-input
+						v-model="model.serial.adapterType"
+						:placeholder="t('devicesZigbeeHerdsmanPlugin.fields.config.serial.adapterType.placeholder')"
+						name="serialAdapterType"
+					/>
+				</el-form-item>
+			</el-col>
+		</el-row>
+
+		<hr />
+
+		<el-alert
+			type="info"
+			:title="t('devicesZigbeeHerdsmanPlugin.headings.aboutNetwork')"
+			:description="t('devicesZigbeeHerdsmanPlugin.texts.aboutNetwork')"
+			:closable="false"
+		/>
+
+		<el-form-item
+			:label="t('devicesZigbeeHerdsmanPlugin.fields.config.network.channel.title')"
+			prop="network.channel"
+			class="mt-3"
+		>
+			<el-input-number
+				v-model="model.network.channel"
+				:min="11"
+				:max="26"
+				name="networkChannel"
+				class="w-full!"
+			/>
+		</el-form-item>
+
+		<hr />
+
+		<el-alert
+			type="info"
+			:title="t('devicesZigbeeHerdsmanPlugin.headings.aboutDiscovery')"
+			:description="t('devicesZigbeeHerdsmanPlugin.texts.aboutDiscovery')"
+			:closable="false"
+		/>
+
+		<el-row
+			:gutter="20"
+			class="mt-3"
+		>
+			<el-col
+				:xs="24"
+				:sm="8"
+			>
+				<el-form-item
+					:label="t('devicesZigbeeHerdsmanPlugin.fields.config.discovery.permitJoinTimeout.title')"
+					prop="discovery.permitJoinTimeout"
+				>
+					<el-input-number
+						v-model="model.discovery.permitJoinTimeout"
+						:min="0"
+						name="discoveryPermitJoinTimeout"
+						class="w-full!"
+					/>
+				</el-form-item>
+			</el-col>
+			<el-col
+				:xs="24"
+				:sm="8"
+			>
+				<el-form-item
+					:label="t('devicesZigbeeHerdsmanPlugin.fields.config.discovery.mainsDeviceTimeout.title')"
+					prop="discovery.mainsDeviceTimeout"
+				>
+					<el-input-number
+						v-model="model.discovery.mainsDeviceTimeout"
+						:min="60"
+						name="discoveryMainsDeviceTimeout"
+						class="w-full!"
+					/>
+				</el-form-item>
+			</el-col>
+			<el-col
+				:xs="24"
+				:sm="8"
+			>
+				<el-form-item
+					:label="t('devicesZigbeeHerdsmanPlugin.fields.config.discovery.batteryDeviceTimeout.title')"
+					prop="discovery.batteryDeviceTimeout"
+				>
+					<el-input-number
+						v-model="model.discovery.batteryDeviceTimeout"
+						:min="60"
+						name="discoveryBatteryDeviceTimeout"
+						class="w-full!"
+					/>
+				</el-form-item>
+			</el-col>
+		</el-row>
+
+		<el-row :gutter="20">
+			<el-col
+				:xs="24"
+				:sm="12"
+			>
+				<el-form-item
+					:label="t('devicesZigbeeHerdsmanPlugin.fields.config.discovery.commandRetries.title')"
+					prop="discovery.commandRetries"
+				>
+					<el-input-number
+						v-model="model.discovery.commandRetries"
+						:min="1"
+						name="discoveryCommandRetries"
+						class="w-full!"
+					/>
+				</el-form-item>
+			</el-col>
+		</el-row>
+
+		<el-form-item
+			:label="t('devicesZigbeeHerdsmanPlugin.fields.config.discovery.syncOnStartup.title')"
+			prop="discovery.syncOnStartup"
+			label-position="left"
+		>
+			<el-switch
+				v-model="model.discovery.syncOnStartup"
+				name="discoverySyncOnStartup"
+			/>
+		</el-form-item>
+
+		<hr />
+
+		<el-alert
+			type="info"
+			:title="t('devicesZigbeeHerdsmanPlugin.headings.aboutDatabase')"
+			:description="t('devicesZigbeeHerdsmanPlugin.texts.aboutDatabase')"
+			:closable="false"
+		/>
+
+		<el-form-item
+			:label="t('devicesZigbeeHerdsmanPlugin.fields.config.databasePath.title')"
+			prop="databasePath"
+			class="mt-3"
+		>
+			<el-input
+				v-model="model.databasePath"
+				:placeholder="t('devicesZigbeeHerdsmanPlugin.fields.config.databasePath.placeholder')"
+				name="databasePath"
+			/>
+		</el-form-item>
+	</el-form>
+</template>
+
+<script setup lang="ts">
+import { reactive, watch } from 'vue';
+import { useI18n } from 'vue-i18n';
+
+import {
+	ElAlert,
+	ElCol,
+	ElForm,
+	ElFormItem,
+	ElInput,
+	ElInputNumber,
+	ElRow,
+	ElSwitch,
+	type FormRules,
+} from 'element-plus';
+
+import { FormResult, type FormResultType, Layout, useConfigPluginEditForm } from '../../../modules/config';
+import type { IZigbeeHerdsmanConfigEditForm } from '../schemas/config.types';
+
+import type { IZigbeeHerdsmanConfigFormProps } from './zigbee-herdsman-config-form.types';
+
+defineOptions({
+	name: 'ZigbeeHerdsmanConfigForm',
+});
+
+const props = withDefaults(defineProps<IZigbeeHerdsmanConfigFormProps>(), {
+	remoteFormSubmit: false,
+	remoteFormResult: FormResult.NONE,
+	remoteFormReset: false,
+	remoteFormChanged: false,
+	layout: Layout.DEFAULT,
+});
+
+const emit = defineEmits<{
+	(e: 'update:remote-form-submit', remoteFormSubmit: boolean): void;
+	(e: 'update:remote-form-result', remoteFormResult: FormResultType): void;
+	(e: 'update:remote-form-reset', remoteFormReset: boolean): void;
+	(e: 'update:remote-form-changed', formChanged: boolean): void;
+}>();
+
+const { t } = useI18n();
+
+const { formEl, model, formChanged, submit, formResult } = useConfigPluginEditForm<IZigbeeHerdsmanConfigEditForm>({
+	config: props.config,
+	messages: {
+		success: t('devicesZigbeeHerdsmanPlugin.messages.config.edited'),
+		error: t('devicesZigbeeHerdsmanPlugin.messages.config.notEdited'),
+	},
+});
+
+const rules = reactive<FormRules<IZigbeeHerdsmanConfigEditForm>>({
+	'serial.path': [
+		{ required: true, message: t('devicesZigbeeHerdsmanPlugin.fields.config.serial.path.validation.required'), trigger: 'blur' },
+	],
+	'serial.baudRate': [
+		{
+			type: 'integer',
+			message: t('devicesZigbeeHerdsmanPlugin.fields.config.serial.baudRate.validation.number'),
+			validator: (_rule, value) => value >= 1,
+			trigger: 'change',
+		},
+	],
+	'serial.adapterType': [
+		{ required: true, message: t('devicesZigbeeHerdsmanPlugin.fields.config.serial.adapterType.validation.required'), trigger: 'blur' },
+	],
+	'network.channel': [
+		{
+			type: 'integer',
+			message: t('devicesZigbeeHerdsmanPlugin.fields.config.network.channel.validation.range'),
+			validator: (_rule, value) => value >= 11 && value <= 26,
+			trigger: 'change',
+		},
+	],
+	'databasePath': [
+		{ required: true, message: t('devicesZigbeeHerdsmanPlugin.fields.config.databasePath.validation.required'), trigger: 'blur' },
+	],
+});
+
+watch(
+	(): FormResultType => formResult.value,
+	async (val: FormResultType): Promise<void> => {
+		emit('update:remote-form-result', val);
+	}
+);
+
+watch(
+	(): boolean => props.remoteFormSubmit,
+	async (val: boolean): Promise<void> => {
+		if (val) {
+			emit('update:remote-form-submit', false);
+
+			submit().catch(() => {
+				// The form is not valid
+			});
+		}
+	}
+);
+
+watch(
+	(): boolean => props.remoteFormReset,
+	(val: boolean): void => {
+		if (val) {
+			emit('update:remote-form-reset', false);
+
+			if (!formEl.value) return;
+
+			formEl.value.resetFields();
+		}
+	}
+);
+
+watch(
+	(): boolean => formChanged.value,
+	(val: boolean): void => {
+		emit('update:remote-form-changed', val);
+	}
+);
+</script>

apps/admin/src/plugins/devices-zigbee-herdsman/components/zigbee-herdsman-device-add-form.types.ts

@@ -0,0 +1,12 @@
+import type { IPluginElement } from '../../../common';
+import type { FormResultType } from '../../../modules/devices';
+import type { IZigbeeHerdsmanDevice } from '../store/devices.store.types';
+
+export interface IZigbeeHerdsmanDeviceAddFormProps {
+	id: IZigbeeHerdsmanDevice['id'];
+	type: IPluginElement['type'];
+	remoteFormSubmit?: boolean;
+	remoteFormResult?: FormResultType;
+	remoteFormReset?: boolean;
+	remoteFormChanged?: boolean;
+}