docs: update typed documentation and API report

zwave-js · May 8, 2024 · a7b5d37 · a7b5d37
1 parent e7c5470
commit a7b5d37
Show file tree

Hide file tree

Showing 7 changed files with 1,013 additions and 180 deletions.
diff --git a/docs/api/driver.md b/docs/api/driver.md
@@ -944,6 +944,9 @@ interface ZWaveOptions extends ZWaveHostOptions {
 			/** A hardware-specific calibration value. */
 			measured0dBm: number;
 		};
+
+		/** The desired max. powerlevel setting for Z-Wave Long Range in dBm. */
+		maxLongRangePowerlevel?: number;
 	};
 
 	apiKeys?: {

diff --git a/packages/cc/api.md b/packages/cc/api.md
@@ -7926,9 +7926,9 @@ export enum HumidityControlSetpointType {
     // (undocumented)
     "De-humidifier" = 2,
     // (undocumented)
-    "N/A" = 0,
+    "N/A" = 0,// CC v1
     // (undocumented)
-    "Auto" = 3,
+    "Auto" = 3,// CC v1
     // (undocumented)
     "Humidifier" = 1
 }
@@ -10195,21 +10195,21 @@ export function isTransportServiceEncapsulation(command: CommandClass): command
 // @public (undocumented)
 export enum KEXFailType {
     // (undocumented)
-    BootstrappingCanceled = 6,
+    BootstrappingCanceled = 6,// KEX_KEY
     // (undocumented)
-    Decrypt = 5,
+    Decrypt = 5,// KEX_SCHEME
     // (undocumented)
-    DifferentKey = 10,
+    DifferentKey = 10,// KEX_CURVES
     // (undocumented)
     KeyNotGranted = 8,
     // (undocumented)
-    NoKeyMatch = 1,
+    NoKeyMatch = 1,// CANCEL
     // (undocumented)
-    NoSupportedCurve = 3,
+    NoSupportedCurve = 3,// AUTH
     // (undocumented)
-    NoSupportedScheme = 2,
+    NoSupportedScheme = 2,// GET
     // (undocumented)
-    NoVerify = 9,
+    NoVerify = 9,// VERIFY
     // (undocumented)
     WrongSecurityLevel = 7
 }
@@ -15453,6 +15453,7 @@ export class Security2CCMessageEncapsulation extends Security2CC {
     extensions: Security2Extension[];
     // (undocumented)
     getMulticastGroupId(): number | undefined;
+    getSenderEI(): Buffer | undefined;
     // (undocumented)
     hasMOSExtension(): boolean;
     // (undocumented)
@@ -17676,25 +17677,25 @@ export enum ThermostatSetpointType {
     // (undocumented)
     "Auto Changeover" = 10,
     // (undocumented)
-    "Away Cooling" = 14,
+    "Away Cooling" = 14,// CC v1
     // (undocumented)
-    "Away Heating" = 13,
+    "Away Heating" = 13,// CC v1
     // (undocumented)
-    "Dry Air" = 8,
+    "Dry Air" = 8,// CC v1
     // (undocumented)
-    "Energy Save Cooling" = 12,
+    "Energy Save Cooling" = 12,// CC v1
     // (undocumented)
-    "Energy Save Heating" = 11,
+    "Energy Save Heating" = 11,// CC v1
     // (undocumented)
-    "Full Power" = 15,
+    "Full Power" = 15,// CC v1
     // (undocumented)
-    "Moist Air" = 9,
+    "Moist Air" = 9,// CC v2
     // (undocumented)
-    "N/A" = 0,
+    "N/A" = 0,// CC v2
     // (undocumented)
-    "Cooling" = 2,
+    "Cooling" = 2,// CC v2
     // (undocumented)
-    "Furnace" = 7,
+    "Furnace" = 7,// CC v3
     // (undocumented)
     "Heating" = 1
 }
@@ -20525,7 +20526,7 @@ export enum ZWavePlusCommand {
 // @public (undocumented)
 export enum ZWavePlusNodeType {
     // (undocumented)
-    IPGateway = 2,
+    IPGateway = 2,// ZWave+ Node
     // (undocumented)
     Node = 0
 }

diff --git a/packages/config/api.md b/packages/config/api.md
@@ -36,6 +36,18 @@ export interface BasicDeviceClass {
 // @public (undocumented)
 export type BasicDeviceClassMap = ReadonlyMap<number, string>;
 
+// Warning: (ae-forgotten-export) The symbol "basicReportMappings" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "BasicReportMapping" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export type BasicReportMapping = typeof basicReportMappings[number];
+
+// Warning: (ae-forgotten-export) The symbol "basicSetMappings" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "BasicSetMapping" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export type BasicSetMapping = typeof basicSetMappings[number];
+
 // Warning: (ae-missing-release-tag) "CompatAddCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -142,16 +154,12 @@ export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
     // (undocumented)
     readonly disableAutoRefresh?: boolean;
     // (undocumented)
-    readonly disableBasicMapping?: boolean;
-    // (undocumented)
     readonly disableCallbackFunctionTypeCheck?: number[];
     // (undocumented)
     readonly disableStrictEntryControlDataValidation?: boolean;
     // (undocumented)
     readonly disableStrictMeasurementValidation?: boolean;
     // (undocumented)
-    readonly enableBasicSetMapping?: boolean;
-    // (undocumented)
     evaluateCondition(deviceId?: DeviceID): CompatConfig | undefined;
     // (undocumented)
     readonly forceNotificationIdleReset?: boolean;
@@ -160,6 +168,10 @@ export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
     // (undocumented)
     readonly manualValueRefreshDelayMs?: number;
     // (undocumented)
+    readonly mapBasicReport?: BasicReportMapping;
+    // (undocumented)
+    readonly mapBasicSet?: BasicSetMapping;
+    // (undocumented)
     readonly mapRootReportsToEndpoint?: number;
     // (undocumented)
     readonly overrideFloatEncoding?: {
@@ -189,8 +201,6 @@ export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
     // (undocumented)
     readonly skipConfigurationNameQuery?: boolean;
     // (undocumented)
-    readonly treatBasicSetAsEvent?: boolean;
-    // (undocumented)
     readonly treatDestinationEndpointAsSource?: boolean;
     // (undocumented)
     readonly treatMultilevelSwitchSetAsEvent?: boolean;
@@ -663,8 +673,6 @@ export interface FulltextDeviceConfigIndexEntry {
 export class GenericDeviceClass {
     constructor(key: number, definition: JSONObject);
     // (undocumented)
-    readonly controlledCCs: readonly CommandClasses[];
-    // (undocumented)
     readonly key: number;
     // (undocumented)
     readonly label: string;
@@ -674,8 +682,6 @@ export class GenericDeviceClass {
     readonly requiresSecurity?: boolean;
     // (undocumented)
     readonly specific: ReadonlyMap<number, SpecificDeviceClass>;
-    // (undocumented)
-    readonly supportedCCs: readonly CommandClasses[];
 }
 
 // Warning: (ae-missing-release-tag) "GenericDeviceClassMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -847,6 +853,8 @@ export class NotificationParameterWithDuration {
 export class NotificationParameterWithEnum {
     constructor(definition: JSONObject);
     // (undocumented)
+    readonly default?: number;
+    // (undocumented)
     readonly values: ReadonlyMap<number, string>;
 }
 
@@ -971,8 +979,6 @@ export type SensorTypeMap = ReadonlyMap<number, SensorType>;
 export class SpecificDeviceClass {
     constructor(key: number, definition: JSONObject, generic: GenericDeviceClass);
     // (undocumented)
-    readonly controlledCCs: readonly CommandClasses[];
-    // (undocumented)
     readonly key: number;
     // (undocumented)
     readonly label: string;
@@ -981,8 +987,6 @@ export class SpecificDeviceClass {
     // (undocumented)
     readonly requiresSecurity?: boolean;
     // (undocumented)
-    readonly supportedCCs: readonly CommandClasses[];
-    // (undocumented)
     readonly zwavePlusDeviceType?: string;
 }