652 lines
26 KiB
Markdown
652 lines
26 KiB
Markdown
## API Report File for "@zwave-js/config"
|
|
|
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
|
|
```ts
|
|
|
|
import { CommandClasses } from '@zwave-js/core/safe';
|
|
import { CommandClassInfo } from '@zwave-js/core/safe';
|
|
import { JSONObject } from '@zwave-js/shared';
|
|
import { JSONObject as JSONObject_2 } from '@zwave-js/shared/safe';
|
|
import type { LogContext } from '@zwave-js/core/safe';
|
|
import { ReadonlyObjectKeyMap } from '@zwave-js/shared/safe';
|
|
import { ValueID } from '@zwave-js/core/safe';
|
|
import { ZWaveLogContainer } from '@zwave-js/core';
|
|
|
|
// Warning: (ae-missing-release-tag) "AssociationConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type AssociationConfig = Omit<ConditionalAssociationConfig, "condition" | "evaluateCondition">;
|
|
|
|
// 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)
|
|
export class CompatAddCC {
|
|
constructor(filename: string, definition: JSONObject_2);
|
|
// (undocumented)
|
|
readonly endpoints: ReadonlyMap<number, Partial<CommandClassInfo>>;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "CompatConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type CompatConfig = Omit<ConditionalCompatConfig, "condition" | "evaluateCondition">;
|
|
|
|
// Warning: (ae-missing-release-tag) "CompatMapAlarm" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class CompatMapAlarm {
|
|
constructor(filename: string, definition: JSONObject_2, index: number);
|
|
// (undocumented)
|
|
readonly from: CompatMapAlarmFrom;
|
|
// (undocumented)
|
|
readonly to: CompatMapAlarmTo;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "CompatMapAlarmFrom" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface CompatMapAlarmFrom {
|
|
// (undocumented)
|
|
alarmLevel?: number;
|
|
// (undocumented)
|
|
alarmType: number;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "CompatMapAlarmTo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface CompatMapAlarmTo {
|
|
// (undocumented)
|
|
eventParameters?: Record<string, number | "alarmLevel">;
|
|
// (undocumented)
|
|
notificationEvent: number;
|
|
// (undocumented)
|
|
notificationType: number;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "CompatOverrideQueries" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class CompatOverrideQueries {
|
|
constructor(filename: string, definition: JSONObject_2);
|
|
// (undocumented)
|
|
hasOverride(ccId: CommandClasses): boolean;
|
|
// (undocumented)
|
|
matchOverride(cc: CommandClasses, endpointIndex: number, method: string, args: any[]): Pick<CompatOverrideQuery, "result" | "persistValues" | "extendMetadata"> | undefined;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "CompatOverrideQuery" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface CompatOverrideQuery {
|
|
endpoint?: number;
|
|
extendMetadata?: Record<string, any>;
|
|
matchArgs?: any[];
|
|
method: string;
|
|
persistValues?: Record<string, any>;
|
|
result: any;
|
|
}
|
|
|
|
// Warning: (ae-forgotten-export) The symbol "ConditionalItem" needs to be exported by the entry point index.d.ts
|
|
// Warning: (ae-missing-release-tag) "ConditionalAssociationConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class ConditionalAssociationConfig implements ConditionalItem<AssociationConfig> {
|
|
constructor(filename: string, groupId: number, definition: JSONObject_2);
|
|
// (undocumented)
|
|
readonly condition?: string;
|
|
// (undocumented)
|
|
readonly description?: string;
|
|
// (undocumented)
|
|
evaluateCondition(deviceId?: DeviceID): AssociationConfig | undefined;
|
|
// (undocumented)
|
|
readonly groupId: number;
|
|
readonly isLifeline: boolean;
|
|
// (undocumented)
|
|
readonly label: string;
|
|
// (undocumented)
|
|
readonly maxNodes: number;
|
|
readonly multiChannel: boolean | "auto";
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConditionalCompatConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
|
|
constructor(filename: string, definition: JSONObject_2);
|
|
// (undocumented)
|
|
readonly addCCs?: ReadonlyMap<CommandClasses, CompatAddCC>;
|
|
// (undocumented)
|
|
readonly alarmMapping?: readonly CompatMapAlarm[];
|
|
// (undocumented)
|
|
readonly condition?: string | undefined;
|
|
// (undocumented)
|
|
readonly disableAutoRefresh?: boolean;
|
|
// (undocumented)
|
|
readonly disableCallbackFunctionTypeCheck?: number[];
|
|
// (undocumented)
|
|
readonly disableStrictEntryControlDataValidation?: boolean;
|
|
// (undocumented)
|
|
readonly disableStrictMeasurementValidation?: boolean;
|
|
// (undocumented)
|
|
readonly encodeCCsUsingTargetVersion?: boolean;
|
|
// (undocumented)
|
|
evaluateCondition(deviceId?: DeviceID): CompatConfig | undefined;
|
|
// (undocumented)
|
|
readonly forceNotificationIdleReset?: boolean;
|
|
// (undocumented)
|
|
readonly forceSceneControllerGroupCount?: number;
|
|
// (undocumented)
|
|
readonly manualValueRefreshDelayMs?: number;
|
|
// (undocumented)
|
|
readonly mapBasicReport?: BasicReportMapping;
|
|
// (undocumented)
|
|
readonly mapBasicSet?: BasicSetMapping;
|
|
// (undocumented)
|
|
readonly mapRootReportsToEndpoint?: number;
|
|
// (undocumented)
|
|
readonly overrideFloatEncoding?: {
|
|
size?: number;
|
|
precision?: number;
|
|
};
|
|
// (undocumented)
|
|
readonly overrideQueries?: CompatOverrideQueries;
|
|
// (undocumented)
|
|
readonly preserveEndpoints?: "*" | readonly number[];
|
|
// (undocumented)
|
|
readonly preserveRootApplicationCCValueIDs?: boolean;
|
|
// (undocumented)
|
|
readonly queryOnWakeup?: readonly [
|
|
string,
|
|
string,
|
|
...(string | number | boolean | Pick<ValueID, "property" | "propertyKey">)[]
|
|
][];
|
|
// (undocumented)
|
|
readonly removeCCs?: ReadonlyMap<CommandClasses, "*" | readonly number[]>;
|
|
// (undocumented)
|
|
readonly removeEndpoints?: "*" | readonly number[];
|
|
// (undocumented)
|
|
readonly reportTimeout?: number;
|
|
// (undocumented)
|
|
readonly skipConfigurationInfoQuery?: boolean;
|
|
// (undocumented)
|
|
readonly skipConfigurationNameQuery?: boolean;
|
|
// (undocumented)
|
|
readonly treatDestinationEndpointAsSource?: boolean;
|
|
// (undocumented)
|
|
readonly treatMultilevelSwitchSetAsEvent?: boolean;
|
|
// (undocumented)
|
|
readonly treatSetAsReport?: ReadonlySet<string>;
|
|
// (undocumented)
|
|
readonly useUTCInTimeParametersCC?: boolean;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConditionalConfigOption" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class ConditionalConfigOption implements ConditionalItem<ConfigOption> {
|
|
constructor(value: number, label: string, condition?: string | undefined);
|
|
// (undocumented)
|
|
readonly condition?: string | undefined;
|
|
// (undocumented)
|
|
evaluateCondition(deviceId?: DeviceID): ConfigOption | undefined;
|
|
// (undocumented)
|
|
readonly label: string;
|
|
// (undocumented)
|
|
readonly value: number;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConditionalDeviceComment" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class ConditionalDeviceComment implements ConditionalItem<DeviceComment> {
|
|
constructor(level: DeviceComment["level"], text: string, condition?: string | undefined);
|
|
// (undocumented)
|
|
readonly condition?: string | undefined;
|
|
// (undocumented)
|
|
evaluateCondition(deviceId?: DeviceID): DeviceComment | undefined;
|
|
// (undocumented)
|
|
readonly level: DeviceComment["level"];
|
|
// (undocumented)
|
|
readonly text: string;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConditionalDeviceConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public
|
|
export class ConditionalDeviceConfig {
|
|
constructor(filename: string, isEmbedded: boolean, definition: JSONObject);
|
|
// (undocumented)
|
|
readonly associations?: ReadonlyMap<number, ConditionalAssociationConfig>;
|
|
readonly compat?: ConditionalCompatConfig | ConditionalCompatConfig[];
|
|
// (undocumented)
|
|
readonly description: ConditionalPrimitive<string>;
|
|
// (undocumented)
|
|
readonly devices: readonly {
|
|
productType: number;
|
|
productId: number;
|
|
}[];
|
|
// (undocumented)
|
|
readonly endpoints?: ReadonlyMap<number, ConditionalEndpointConfig>;
|
|
// (undocumented)
|
|
evaluate(deviceId?: DeviceID): DeviceConfig;
|
|
// (undocumented)
|
|
readonly filename: string;
|
|
// (undocumented)
|
|
readonly firmwareVersion: FirmwareVersionRange;
|
|
// (undocumented)
|
|
static from(filename: string, isEmbedded: boolean, options: {
|
|
rootDir: string;
|
|
fallbackDirs?: string[];
|
|
relative?: boolean;
|
|
}): Promise<ConditionalDeviceConfig>;
|
|
readonly isEmbedded: boolean;
|
|
// (undocumented)
|
|
readonly label: ConditionalPrimitive<string>;
|
|
// Warning: (ae-forgotten-export) The symbol "ConditionalPrimitive" needs to be exported by the entry point index.d.ts
|
|
//
|
|
// (undocumented)
|
|
readonly manufacturer: ConditionalPrimitive<string>;
|
|
// (undocumented)
|
|
readonly manufacturerId: number;
|
|
readonly metadata?: ConditionalDeviceMetadata;
|
|
// (undocumented)
|
|
readonly paramInformation?: ConditionalParamInfoMap;
|
|
readonly preferred: boolean;
|
|
readonly proprietary?: Record<string, unknown>;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConditionalDeviceMetadata" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class ConditionalDeviceMetadata implements ConditionalItem<DeviceMetadata> {
|
|
constructor(filename: string, definition: JSONObject_2);
|
|
readonly comments?: ConditionalDeviceComment | ConditionalDeviceComment[];
|
|
// (undocumented)
|
|
readonly condition?: string;
|
|
// (undocumented)
|
|
evaluateCondition(deviceId?: DeviceID): DeviceMetadata | undefined;
|
|
readonly exclusion?: ConditionalPrimitive<string>;
|
|
readonly inclusion?: ConditionalPrimitive<string>;
|
|
readonly manual?: ConditionalPrimitive<string>;
|
|
readonly reset?: ConditionalPrimitive<string>;
|
|
readonly wakeup?: ConditionalPrimitive<string>;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConditionalEndpointConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class ConditionalEndpointConfig implements ConditionalItem<EndpointConfig> {
|
|
constructor(parent: ConditionalDeviceConfig, index: number, definition: JSONObject_2);
|
|
// (undocumented)
|
|
readonly associations?: ReadonlyMap<number, ConditionalAssociationConfig>;
|
|
// (undocumented)
|
|
readonly condition?: string;
|
|
// (undocumented)
|
|
evaluateCondition(deviceId?: DeviceID): EndpointConfig | undefined;
|
|
// (undocumented)
|
|
readonly index: number;
|
|
// (undocumented)
|
|
readonly label?: string;
|
|
// (undocumented)
|
|
readonly paramInformation?: ConditionalParamInfoMap;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConditionalParamInfoMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type ConditionalParamInfoMap = ReadonlyObjectKeyMap<{
|
|
parameter: number;
|
|
valueBitMask?: number;
|
|
}, ConditionalParamInformation[]>;
|
|
|
|
// Warning: (ae-missing-release-tag) "ConditionalParamInformation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class ConditionalParamInformation implements ConditionalItem<ParamInformation> {
|
|
constructor(parent: ConditionalDeviceConfig, parameterNumber: number, valueBitMask: number | undefined, definition: JSONObject_2);
|
|
// (undocumented)
|
|
readonly allowManualEntry: boolean;
|
|
// (undocumented)
|
|
readonly condition?: string;
|
|
// (undocumented)
|
|
readonly defaultValue: number;
|
|
// (undocumented)
|
|
readonly description?: string;
|
|
// (undocumented)
|
|
evaluateCondition(deviceId?: DeviceID): ParamInformation | undefined;
|
|
// (undocumented)
|
|
readonly label: string;
|
|
// (undocumented)
|
|
readonly maxValue?: number;
|
|
// (undocumented)
|
|
readonly minValue?: number;
|
|
// (undocumented)
|
|
readonly options: readonly ConditionalConfigOption[];
|
|
// (undocumented)
|
|
readonly parameterNumber: number;
|
|
// (undocumented)
|
|
readonly readOnly?: true;
|
|
// (undocumented)
|
|
readonly unit?: string;
|
|
// (undocumented)
|
|
readonly unsigned?: boolean;
|
|
// (undocumented)
|
|
readonly valueBitMask?: number;
|
|
// (undocumented)
|
|
readonly valueSize: number;
|
|
// (undocumented)
|
|
readonly writeOnly?: true;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "CONFIG_LABEL" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export const CONFIG_LABEL = "CONFIG";
|
|
|
|
// Warning: (ae-missing-release-tag) "CONFIG_LOGLEVEL" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export const CONFIG_LOGLEVEL = "debug";
|
|
|
|
// Warning: (ae-missing-release-tag) "ConfigLogContext" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type ConfigLogContext = LogContext<"config">;
|
|
|
|
// Warning: (ae-missing-release-tag) "ConfigManager" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class ConfigManager {
|
|
constructor(options?: ConfigManagerOptions);
|
|
// (undocumented)
|
|
get configVersion(): string;
|
|
// (undocumented)
|
|
get externalConfigDir(): string | undefined;
|
|
// (undocumented)
|
|
getFulltextIndex(): FulltextDeviceConfigIndex | undefined;
|
|
// (undocumented)
|
|
getIndex(): DeviceConfigIndex | undefined;
|
|
// (undocumented)
|
|
loadAll(): Promise<void>;
|
|
// (undocumented)
|
|
loadDeviceIndex(): Promise<void>;
|
|
// (undocumented)
|
|
loadFulltextDeviceIndex(): Promise<void>;
|
|
// (undocumented)
|
|
loadManufacturers(): Promise<void>;
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
lookupDevice(manufacturerId: number, productType: number, productId: number, firmwareVersion?: string): Promise<DeviceConfig | undefined>;
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
lookupDevicePreserveConditions(manufacturerId: number, productType: number, productId: number, firmwareVersion?: string): Promise<ConditionalDeviceConfig | undefined>;
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
lookupManufacturer(manufacturerId: number): string | undefined;
|
|
// (undocumented)
|
|
get manufacturers(): ManufacturersMap;
|
|
// (undocumented)
|
|
saveManufacturers(): Promise<void>;
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
|
|
setManufacturer(manufacturerId: number, manufacturerName: string): void;
|
|
// (undocumented)
|
|
get useExternalConfig(): boolean;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConfigManagerOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface ConfigManagerOptions {
|
|
// (undocumented)
|
|
deviceConfigExternalDir?: string;
|
|
// (undocumented)
|
|
deviceConfigPriorityDir?: string;
|
|
// (undocumented)
|
|
logContainer?: ZWaveLogContainer;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "ConfigOption" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface ConfigOption {
|
|
// (undocumented)
|
|
label: string;
|
|
// (undocumented)
|
|
value: number;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "DeviceComment" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface DeviceComment {
|
|
// (undocumented)
|
|
level: "info" | "warning" | "error";
|
|
// (undocumented)
|
|
text: string;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "DeviceConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export class DeviceConfig {
|
|
constructor(filename: string, isEmbedded: boolean, manufacturer: string, manufacturerId: number, label: string, description: string, devices: readonly {
|
|
productType: number;
|
|
productId: number;
|
|
}[], firmwareVersion: FirmwareVersionRange, preferred: boolean, endpoints?: ReadonlyMap<number, EndpointConfig>, associations?: ReadonlyMap<number, AssociationConfig>, paramInformation?: ParamInfoMap, proprietary?: Record<string, unknown>, compat?: CompatConfig, metadata?: DeviceMetadata);
|
|
// (undocumented)
|
|
readonly associations?: ReadonlyMap<number, AssociationConfig>;
|
|
readonly compat?: CompatConfig;
|
|
// (undocumented)
|
|
readonly description: string;
|
|
// (undocumented)
|
|
readonly devices: readonly {
|
|
productType: number;
|
|
productId: number;
|
|
}[];
|
|
// (undocumented)
|
|
readonly endpoints?: ReadonlyMap<number, EndpointConfig>;
|
|
// (undocumented)
|
|
readonly filename: string;
|
|
// (undocumented)
|
|
readonly firmwareVersion: FirmwareVersionRange;
|
|
// (undocumented)
|
|
static from(filename: string, isEmbedded: boolean, options: {
|
|
rootDir: string;
|
|
fallbackDirs?: string[];
|
|
relative?: boolean;
|
|
deviceId?: DeviceID;
|
|
}): Promise<DeviceConfig>;
|
|
getAssociationConfigForEndpoint(endpointIndex: number, group: number): AssociationConfig | undefined;
|
|
getHash(): Uint8Array;
|
|
readonly isEmbedded: boolean;
|
|
// (undocumented)
|
|
readonly label: string;
|
|
// (undocumented)
|
|
readonly manufacturer: string;
|
|
// (undocumented)
|
|
readonly manufacturerId: number;
|
|
readonly metadata?: DeviceMetadata;
|
|
// (undocumented)
|
|
readonly paramInformation?: ParamInfoMap;
|
|
readonly preferred: boolean;
|
|
readonly proprietary?: Record<string, unknown>;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "DeviceConfigIndex" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type DeviceConfigIndex = DeviceConfigIndexEntry[];
|
|
|
|
// Warning: (ae-missing-release-tag) "DeviceConfigIndexEntry" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface DeviceConfigIndexEntry {
|
|
// (undocumented)
|
|
filename: string;
|
|
// (undocumented)
|
|
firmwareVersion: FirmwareVersionRange;
|
|
// (undocumented)
|
|
manufacturerId: string;
|
|
// (undocumented)
|
|
preferred?: true;
|
|
// (undocumented)
|
|
productId: string;
|
|
// (undocumented)
|
|
productType: string;
|
|
// (undocumented)
|
|
rootDir?: string;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "DeviceID" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface DeviceID {
|
|
// (undocumented)
|
|
firmwareVersion?: string;
|
|
// (undocumented)
|
|
manufacturerId: number;
|
|
// (undocumented)
|
|
productId: number;
|
|
// (undocumented)
|
|
productType: number;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "DeviceMetadata" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface DeviceMetadata {
|
|
// (undocumented)
|
|
comments?: DeviceComment | DeviceComment[];
|
|
// (undocumented)
|
|
exclusion?: string;
|
|
// (undocumented)
|
|
inclusion?: string;
|
|
// (undocumented)
|
|
manual?: string;
|
|
// (undocumented)
|
|
reset?: string;
|
|
// (undocumented)
|
|
wakeup?: string;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "embeddedDevicesDir" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export const embeddedDevicesDir: string;
|
|
|
|
// Warning: (ae-missing-release-tag) "EndpointConfig" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type EndpointConfig = Omit<ConditionalEndpointConfig, "condition" | "evaluateCondition" | "associations" | "paramInformation"> & {
|
|
associations?: Map<number, AssociationConfig> | undefined;
|
|
paramInformation?: ParamInfoMap;
|
|
};
|
|
|
|
// Warning: (ae-missing-release-tag) "FirmwareVersionRange" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface FirmwareVersionRange {
|
|
// (undocumented)
|
|
max: string;
|
|
// (undocumented)
|
|
min: string;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "FulltextDeviceConfigIndex" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type FulltextDeviceConfigIndex = FulltextDeviceConfigIndexEntry[];
|
|
|
|
// Warning: (ae-missing-release-tag) "FulltextDeviceConfigIndexEntry" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export interface FulltextDeviceConfigIndexEntry {
|
|
// (undocumented)
|
|
description: string;
|
|
// (undocumented)
|
|
filename: string;
|
|
// (undocumented)
|
|
firmwareVersion: FirmwareVersionRange;
|
|
// (undocumented)
|
|
label: string;
|
|
// (undocumented)
|
|
manufacturer: string;
|
|
// (undocumented)
|
|
manufacturerId: string;
|
|
// (undocumented)
|
|
preferred?: true;
|
|
// (undocumented)
|
|
productId: string;
|
|
// (undocumented)
|
|
productType: string;
|
|
// (undocumented)
|
|
rootDir?: string;
|
|
}
|
|
|
|
// Warning: (ae-missing-release-tag) "getDevicesPaths" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export function getDevicesPaths(configDir: string): {
|
|
devicesDir: string;
|
|
indexPath: string;
|
|
};
|
|
|
|
// Warning: (ae-missing-release-tag) "ManufacturersMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type ManufacturersMap = Map<number, string>;
|
|
|
|
// Warning: (ae-missing-release-tag) "PACKAGE_VERSION" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export const PACKAGE_VERSION = "14.0.0";
|
|
|
|
// Warning: (ae-missing-release-tag) "ParamInfoMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type ParamInfoMap = ReadonlyObjectKeyMap<{
|
|
parameter: number;
|
|
valueBitMask?: number;
|
|
}, ParamInformation>;
|
|
|
|
// Warning: (ae-missing-release-tag) "ParamInformation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export type ParamInformation = Omit<ConditionalParamInformation, "condition" | "evaluateCondition" | "options" | "minValue" | "maxValue"> & {
|
|
options: readonly ConfigOption[];
|
|
minValue: NonNullable<ConditionalParamInformation["minValue"]>;
|
|
maxValue: NonNullable<ConditionalParamInformation["maxValue"]>;
|
|
};
|
|
|
|
// Warning: (ae-missing-release-tag) "parseConditionalParamInformationMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public (undocumented)
|
|
export function parseConditionalParamInformationMap(definition: JSONObject_2, parent: ConditionalDeviceConfig, errorPrefix?: string): ConditionalParamInfoMap;
|
|
|
|
// Warning: (ae-missing-release-tag) "saveManufacturersInternal" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
|
//
|
|
// @public
|
|
export function saveManufacturersInternal(manufacturers: ManufacturersMap): Promise<void>;
|
|
|
|
// (No @packageDocumentation comment for this package)
|
|
|
|
```
|