Reworked characteristic and service definition generation

jest.config.js

@@ -4,6 +4,8 @@ module.exports = {
   coverageReporters: ["lcov"],
   collectCoverageFrom: [
     "src/**",
-    "!src/accessories/**"
+    "!src/accessories/**",
+    "!src/lib/definitions/generate-definitions.ts",
+    "!src/lib/definitions/generator-configuration.ts"
   ],
 };

package.json

@@ -64,6 +64,7 @@
     "@types/debug": "^4.1.5",
     "@types/jest": "^26.0.14",
     "@types/node": "^10.17.20",
+    "commander": "^6.1.0",
     "jest": "^26.5.2",
     "rimraf": "^3.0.2",
     "semver": "^7.3.2",

src/accessories/AirConditioner_accessory.ts

@@ -51,7 +51,6 @@ ACTest.on(AccessoryEventTypes.IDENTIFY, (paired: boolean, callback: VoidCallback
 });
 
 // Add the actual Fan Service and listen for change events from iOS.
-// We can see the complete list of Services and Characteristics in `lib/gen/HomeKit.ts`
 
 const FanService = ACTest.addService(Service.Fan, "Blower"); // services exposed to the user should have "names" like "Fake Light" for us
 FanService.getCharacteristic(Characteristic.On)!

src/accessories/Fan_accessory.ts

@@ -56,7 +56,6 @@ fan.on(AccessoryEventTypes.IDENTIFY, (paired: boolean, callback: VoidCallback) =
 });
 
 // Add the actual Fan Service and listen for change events from iOS.
-// We can see the complete list of Services and Characteristics in `lib/gen/HomeKit.ts`
 fan
   .addService(Service.Fan, "Fan") // services exposed to the user should have "names" like "Fake Light" for us
   .getCharacteristic(Characteristic.On)!

src/accessories/Light_accessory.ts

@@ -104,7 +104,6 @@ lightAccessory.on(AccessoryEventTypes.IDENTIFY, (paired: boolean, callback: Void
 });
 
 // Add the actual Lightbulb Service and listen for change events from iOS.
-// We can see the complete list of Services and Characteristics in `lib/gen/HomeKit.ts`
 lightAccessory
   .addService(Service.Lightbulb, LightController.name) // services exposed to the user should have "names" like "Light" for this case
   .getCharacteristic(Characteristic.On)!

src/accessories/Lock_accessory.ts

@@ -56,7 +56,6 @@ lock.on(AccessoryEventTypes.IDENTIFY, (paired, callback) => {
 const service = new Service.LockMechanism("Fake Lock");
 
 // Add the actual Door Lock Service and listen for change events from iOS.
-// We can see the complete list of Services and Characteristics in `lib/gen/HomeKit.ts`
 service.getCharacteristic(Characteristic.LockTargetState)
   .on(CharacteristicEventTypes.SET, (value, callback) => {
 

src/accessories/Outlet_accessory.ts

@@ -67,7 +67,6 @@ outlet.on(AccessoryEventTypes.IDENTIFY, function(paired: boolean, callback: Void
 });
 
 // Add the actual outlet Service and listen for change events from iOS.
-// We can see the complete list of Services and Characteristics in `lib/gen/HomeKit.ts`
 outlet
   .addService(Service.Outlet, "Fake Outlet") // services exposed to the user should have "names" like "Fake Light" for us
   .getCharacteristic(Characteristic.On)!

src/accessories/SmartSpeaker_accessory.ts

@@ -3,11 +3,12 @@ import {
   Categories,
   Characteristic,
   CharacteristicEventTypes,
-  CharacteristicGetCallback, CharacteristicSetCallback, CharacteristicValue,
+  CharacteristicGetCallback,
+  CharacteristicSetCallback,
+  CharacteristicValue,
   Service,
   uuid
 } from "..";
-import {CurrentMediaState, TargetMediaState} from "../lib/gen/HomeKit-TV";
 
 const speakerUUID = uuid.generate('hap-nodejs:accessories:smart-speaker');
 const speaker = exports.accessory = new Accessory('SmartSpeaker', speakerUUID);
@@ -20,8 +21,8 @@ speaker.category = Categories.SPEAKER;
 
 const service = new Service.SmartSpeaker('Smart Speaker', '');
 
-let currentMediaState: number = CurrentMediaState.PAUSE;
-let targetMediaState: number = TargetMediaState.PAUSE;
+let currentMediaState: number = Characteristic.CurrentMediaState.PAUSE;
+let targetMediaState: number = Characteristic.TargetMediaState.PAUSE;
 
 // ConfigureName is used to listen for Name changes inside the Home App.
 // A device manufacturer would probably need to adjust the name of the device in the AirPlay 2 protocol (or something)

src/accessories/Sprinkler_accessory.ts

@@ -45,7 +45,6 @@ sprinkler.pincode = "123-44-567";
 sprinkler.category = Categories.SPRINKLER;
 
 // Add the actual Valve Service and listen for change events from iOS.
-// We can see the complete list of Services and Characteristics in `lib/gen/HomeKit.ts`
 const sprinklerService = sprinkler.addService(Service.Valve, "💦 Sprinkler");
 
 

src/accessories/TV_accessory.ts

@@ -29,7 +29,6 @@ tv.pincode = "031-45-154";
 tv.category = Categories.TELEVISION;
 
 // Add the actual TV Service and listen for change events from iOS.
-// We can see the complete list of Services and Characteristics in `lib/gen/HomeKit.ts`
 const televisionService = tv.addService(Service.Television, "Television", "Television");
 
 televisionService

src/accessories/TemperatureSensor_accessory.ts

@@ -31,7 +31,6 @@ sensor.pincode = "031-45-154";
 sensor.category = Categories.SENSOR;
 
 // Add the actual TemperatureSensor Service.
-// We can see the complete list of Services and Characteristics in `lib/gen/HomeKit.ts`
 sensor
   .addService(Service.TemperatureSensor)!
   .getCharacteristic(Characteristic.CurrentTemperature)!

src/index.ts

@@ -1,5 +1,5 @@
 import "source-map-support/register"; // registering node-source-map-support for typescript stack traces
-import './lib/gen';
+import './lib/definitions'; // must be loaded before Characteristic and Service class
 import * as accessoryLoader from './lib/AccessoryLoader';
 import * as uuidFunctions from './lib/util/uuid';
 import * as legacyTypes from './accessories/types';
@@ -17,7 +17,6 @@ export * from './lib/AccessoryLoader';
 export * from './lib/camera';
 export * from './lib/tv/AccessControlManagement';
 export * from './lib/HAPServer';
-export * from './lib/gen';
 export * from './lib/datastream';
 export * from './lib/controller';
 

src/lib/Accessory.spec.ts

@@ -1,4 +1,3 @@
-import './gen';
 import {
   Accessory,
   Categories,

src/lib/Accessory.ts

@@ -42,16 +42,6 @@ import {
   ControllerType,
   isSerializableController,
 } from "./controller";
-import * as HomeKitTypes from "./gen";
-import {
-  CameraEventRecordingManagement,
-  CameraOperatingMode,
-  CameraRTPStreamManagement,
-  ContactSensorState,
-  MotionDetected,
-  ProgrammableSwitchEvent,
-} from "./gen/HomeKit";
-import { ButtonEvent } from "./gen/HomeKit-Remote";
 import {
   AccessoriesCallback,
   AddPairingCallback,
@@ -659,8 +649,8 @@ export class Accessory extends EventEmitter {
 
     // we try here to be as good as possibly of keeping current behaviour
     cameraSource.services.forEach(service => {
-      if (service.UUID === CameraRTPStreamManagement.UUID || service.UUID === CameraOperatingMode.UUID
-          || service.UUID === CameraEventRecordingManagement.UUID) {
+      if (service.UUID === Service.CameraRTPStreamManagement.UUID || service.UUID === Service.CameraOperatingMode.UUID
+          || service.UUID === Service.CameraRecordingManagement.UUID) {
         return; // ignore those services, as they get replaced by the RTPStreamManagement
       }
 
@@ -1414,7 +1404,7 @@ export class Accessory extends EventEmitter {
         data.perms = characteristic.props.perms;
       }
       if (request.includeType) {
-        data.type = toShortForm(this.UUID, HomeKitTypes.BASE_UUID);
+        data.type = toShortForm(this.UUID);
       }
       if (request.includeEvent) {
         data.ev = connection.hasEventNotifications(id.aid, id.iid);
@@ -1730,8 +1720,8 @@ export class Accessory extends EventEmitter {
       }
 
       const uuid = change.characteristic.UUID;
-      const immediateDelivery = uuid === ButtonEvent.UUID || uuid === ProgrammableSwitchEvent.UUID
-        || uuid === MotionDetected.UUID || uuid === ContactSensorState.UUID;
+      const immediateDelivery = uuid === Characteristic.ButtonEvent.UUID || uuid === Characteristic.ProgrammableSwitchEvent.UUID
+        || uuid === Characteristic.MotionDetected.UUID || uuid === Characteristic.ContactSensorState.UUID;
 
       this._server.sendEventNotifications(accessory.aid, change.characteristic.iid, change.newValue, change.originator, immediateDelivery);
     }

src/lib/Characteristic.spec.ts

@@ -10,7 +10,6 @@ import {
   Units,
   uuid
 } from '..';
-import './gen';
 
 function createCharacteristic(type: Formats, customUUID?: string): Characteristic {
   return new Characteristic('Test', customUUID || uuid.generate('Foo'), { format: type, perms: [Perms.PAIRED_READ, Perms.PAIRED_WRITE] });