toMatterAccessory()

Author: mpatfield

src/accessory/abstract/base.ts

@@ -1,3 +1,5 @@
+import { MatterAccessory } from 'homebridge';
+
 import { MQTTAccessory } from './mqtt.js';
 
 import { Battery } from '../addons/battery.js';
@@ -10,26 +12,38 @@ import { strings } from '../../i18n/i18n.js';
 
 import { CharacteristicKey } from '../../model/enums.js';
 import { HomeKitCharacteristicKey } from '../../model/homekit.js';
+import { MATTER_SERIAL_MAX_LEN, MatterType } from '../../model/matter.js';
 import { BaseAccessoryConfig, MQTTAccessoryDependency } from '../../model/types.js';
 
 import getVersion from '../../tools/version.js';
 
 export abstract class BaseAccessory<C extends BaseAccessoryConfig = BaseAccessoryConfig> extends MQTTAccessory<C> {
 
+  private _UUID?: string;
+
+  private readonly manufacturer: string;
+  private readonly model: string;
+  private readonly serialNumber: string;
+  private readonly softwareVersion: string;
+
   constructor(dependency: MQTTAccessoryDependency<C>) {
     super(dependency);
 
+    this.manufacturer = dependency.config.info.manufacturer ?? PLATFORM_NAME;
+    this.model = dependency.config.info.model ?? dependency.config.info.type;
+    this.serialNumber = this.identifier.length <= MATTER_SERIAL_MAX_LEN ? this.identifier : this.identifier.substring(0, MATTER_SERIAL_MAX_LEN - 1) + '…';
+    this.softwareVersion = dependency.config.info.version ?? getVersion();
+
     if (!dependency.isGrouped) {
-    this.homekitAccessory.getService(this.Service.AccessoryInformation)!
-      .setCharacteristic(this.Characteristic.Name, dependency.config.info.name)
-      .setCharacteristic(this.Characteristic.ConfiguredName, dependency.config.info.name)
-      .setCharacteristic(this.Characteristic.Manufacturer, dependency.config.info.manufacturer ?? PLATFORM_NAME)
-      .setCharacteristic(this.Characteristic.Model, dependency.config.info.model ?? dependency.config.info.type)
-      .setCharacteristic(this.Characteristic.SerialNumber, dependency.config.info.serialNumber ?? this.identifier)
-      .setCharacteristic(this.Characteristic.FirmwareRevision, dependency.config.info.version ?? getVersion());
+      this.homekitAccessory.getService(this.Service.AccessoryInformation)!
+        .setCharacteristic(this.Characteristic.Name, dependency.config.info.name)
+        .setCharacteristic(this.Characteristic.ConfiguredName, dependency.config.info.name)
+        .setCharacteristic(this.Characteristic.Manufacturer, this.manufacturer)
+        .setCharacteristic(this.Characteristic.Model, this.model)
+        .setCharacteristic(this.Characteristic.SerialNumber, dependency.config.info.serialNumber ?? this.identifier)
+        .setCharacteristic(this.Characteristic.FirmwareRevision, this.softwareVersion);
     }
 
-
     this.setup(HomeKitCharacteristicKey.StatusActive, true,
       'topicGetStatusActive',
       this.bindOnUpdateBooleanSingle(HomeKitCharacteristicKey.StatusActive, 'valueStatusActive',
@@ -42,4 +56,71 @@ export abstract class BaseAccessory<C extends BaseAccessoryConfig = BaseAccessor
   override isOptionalCharacteristic(key: CharacteristicKey): boolean {
     return super.isOptionalCharacteristic(key) || isOptionalHKCharacteristic(key, this.config.info.type);
   }
+
+  protected getMatterType(): MatterType | undefined {
+    return undefined;
+  };
+
+  private get matter() {
+    const matter = this.dependency.getMatter();
+    if (matter === undefined) {
+      throw new Error(`${this.displayName} unable to get MatterAPI instance`);
+    }
+    return matter;
+  }
+
+  private get deviceType() {
+
+    const type = this.getMatterType();
+    if (type !== undefined) {
+      return this.matter.deviceTypes[type];
+    }
+
+    throw new Error(`${this.getMatterType.name} not implemented for ${this.getHomeKitType()}`);
+  }
+
+  public get UUID(): string {
+    if (!this._UUID) {
+      this._UUID = this.matter.uuid.generate(this.identifier);
+    }
+    return this._UUID;
+  }
+
+  protected get clusters(): MatterAccessory['clusters'] | undefined {
+    return undefined;
+  }
+
+  protected get handlers(): MatterAccessory['handlers'] | undefined {
+    return undefined;
+  }
+
+  protected get parts(): MatterAccessory['parts'] | undefined {
+    return undefined; // Use this for sensors and groups
+  }
+
+  public toMatterAccessory(): MatterAccessory {
+    return {
+      UUID: this.UUID,
+      displayName: this.displayName,
+      deviceType: this.deviceType,
+      serialNumber: this.serialNumber,
+      manufacturer: this.manufacturer,
+      model: this.model,
+      context: {
+        UUID: this.UUID,
+        deviceType: this.deviceType,
+        displayName: this.displayName,
+        serialNumber: this.serialNumber,
+        manufacturer: this.manufacturer,
+        model: this.model,
+        softwareVersion: this.softwareVersion,
+        clusters: this.clusters,
+        handlers: this.handlers,
+        parts: this.parts,
+      },
+      clusters: this.clusters,
+      handlers: this.handlers,
+      parts: this.parts,
+    };
+  }
 }

src/accessory/abstract/mqtt.ts

@@ -20,7 +20,7 @@ export abstract class MQTTAccessory<C extends MQTTAccessoryConfig> extends Commo
   private readonly homekitService: Service;
 
   constructor(
-    private readonly dependency: MQTTAccessoryDependency<C>,
+    protected readonly dependency: MQTTAccessoryDependency<C>,
   ) {
     super(dependency.config.info.name);
 

src/homebridge/platform.ts

@@ -154,6 +154,24 @@ export class HomebridgeEasyMQTT implements DynamicPlatformPlugin {
           continue;
         }
 
+        const dependency: AccessoryDependency = {
+          protocol: accessoryConfig.info.protocol,
+          getHomeKit: () => undefined,
+          getMatter: () => this.api.matter,
+          log: this.log,
+        };
+
+        const accessory = createAccessory(dependency, accessoryConfig);
+
+        if (accessory === undefined) {
+          continue;
+        }
+
+        await this.registerMatterAccessory(accessory.toMatterAccessory());
+
+        matterKeepIdentifiers.add(accessory.UUID);
+        this.mqttAccessories.push(accessory);
+
       } else {
         this.log.warning(strings.startup.unsupportedProtocol, `'${accessoryConfig.info.protocol}'`, printableValues(Protocol));
         continue;

src/model/matter.ts

@@ -0,0 +1,15 @@
+export const MATTER_SERIAL_MAX_LEN = 32;
+
+export enum MatterClusterKey {
+  onOff = 'onOff',
+}
+
+export enum MatterValueKey {
+  onOff = 'onOff',
+}
+
+export enum MatterType {
+  OnOffSwitch = 'OnOffSwitch',
+}
+
+export type MatterValue = boolean | number;