Skip to content

Commit

Permalink
docs: update typed documentation and API report 🤖 (#6671)
Browse files Browse the repository at this point in the history
Co-authored-by: Al Calzone <d.griesel@gmx.net>
  • Loading branch information
zwave-js-bot and AlCalzone authored Apr 3, 2024
1 parent 827a427 commit 943b10d
Showing 7 changed files with 88 additions and 26 deletions.
4 changes: 4 additions & 0 deletions docs/api/controller.md
Original file line number Diff line number Diff line change
@@ -1509,6 +1509,10 @@ interface ControllerStatistics {
average: number;
current: number;
};
channel3?: {
average: number;
current: number;
};
};
}
```
13 changes: 0 additions & 13 deletions packages/cc/api.md
Original file line number Diff line number Diff line change
@@ -101,7 +101,6 @@ import { Security2CCAPI } from '../cc/Security2CC';
import { SecurityCCAPI } from '../cc/SecurityCC';
import { SecurityClass } from '@zwave-js/core';
import { SecurityManager } from '@zwave-js/core';
import { SecurityManager2 } from '@zwave-js/core';
import { SendCommandOptions } from '@zwave-js/core';
import { SinglecastCC } from '@zwave-js/core';
import { SinglecastCC as SinglecastCC_2 } from '@zwave-js/core/safe';
@@ -15457,10 +15456,6 @@ export class Security2CCMessageEncapsulation extends Security2CC {
// (undocumented)
hasMOSExtension(): boolean;
// (undocumented)
host: ZWaveHost_2 & {
securityManager2: SecurityManager2;
};
// (undocumented)
prepareRetransmission(): void;
// (undocumented)
readonly securityClass?: SecurityClass;
@@ -15543,10 +15538,6 @@ export class Security2CCNetworkKeyVerify extends Security2CC {
// @public (undocumented)
export class Security2CCNonceGet extends Security2CC {
constructor(host: ZWaveHost_2, options: CCCommandOptions);
// (undocumented)
host: ZWaveHost_2 & {
securityManager2: SecurityManager2;
};
get sequenceNumber(): number;
// (undocumented)
serialize(): Buffer;
@@ -15560,10 +15551,6 @@ export class Security2CCNonceGet extends Security2CC {
export class Security2CCNonceReport extends Security2CC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | (CCCommandOptions & Security2CCNonceReportOptions));
// (undocumented)
host: ZWaveHost_2 & {
securityManager2: SecurityManager2;
};
// (undocumented)
readonly MOS: boolean;
// (undocumented)
readonly receiverEI?: Buffer;
53 changes: 46 additions & 7 deletions packages/core/api.md
Original file line number Diff line number Diff line change
@@ -338,6 +338,8 @@ export enum CommandClasses {
// (undocumented)
"Window Covering" = 106,
// (undocumented)
"Z-Wave Long Range" = 4,
// (undocumented)
"Z-Wave Plus Info" = 94,
// (undocumented)
"Z-Wave Protocol" = 1,
@@ -867,6 +869,11 @@ export function encodeFloatWithScale(value: number, scale: number, override?: {
precision?: number;
}): Buffer;

// Warning: (ae-missing-release-tag) "encodeLongRangeNodeBitMask" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function encodeLongRangeNodeBitMask(nodeIDs: readonly number[], startValue: number): Buffer;

// Warning: (ae-missing-release-tag) "encodeMaybeBoolean" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The reference is ambiguous because "UNKNOWN_STATE" has more than one declaration; you need to add a TSDoc member reference selector
//
@@ -886,17 +893,17 @@ export function encodeNodeID(nodeId: number, type?: NodeIDType): Buffer;
// Warning: (ae-missing-release-tag) "encodeNodeInformationFrame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function encodeNodeInformationFrame(info: NodeInformationFrame): Buffer;
export function encodeNodeInformationFrame(info: NodeInformationFrame, isLongRange?: boolean): Buffer;

// Warning: (ae-missing-release-tag) "encodeNodeProtocolInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function encodeNodeProtocolInfo(info: NodeProtocolInfo): Buffer;
export function encodeNodeProtocolInfo(info: NodeProtocolInfo, isLongRange?: boolean): Buffer;

// Warning: (ae-missing-release-tag) "encodeNodeProtocolInfoAndDeviceClass" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function encodeNodeProtocolInfoAndDeviceClass(info: NodeProtocolInfoAndDeviceClass): Buffer;
export function encodeNodeProtocolInfoAndDeviceClass(info: NodeProtocolInfoAndDeviceClass, isLongRange?: boolean): Buffer;

// Warning: (ae-missing-release-tag) "encodeNodeUpdatePayload" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
@@ -1205,6 +1212,11 @@ export function isEncapsulationCC(cc: CommandClasses): boolean;
// @public (undocumented)
export function isExtendedCCId(ccId: CommandClasses): boolean;

// Warning: (ae-missing-release-tag) "isLongRangeNodeId" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function isLongRangeNodeId(nodeId: number): boolean;

// Warning: (ae-missing-release-tag) "isManagementCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
@@ -1447,6 +1459,18 @@ export type LogValueArgs<T> = T & {
internal?: boolean;
};

// Warning: (ae-missing-release-tag) "LongRangeChannel" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum LongRangeChannel {
// (undocumented)
A = 1,
// (undocumented)
B = 2,
// (undocumented)
Unknown = 0
}

// Warning: (ae-missing-release-tag) "managementCCs" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
@@ -1723,6 +1747,16 @@ export const NOT_KNOWN: undefined;
// @public (undocumented)
export type NOT_KNOWN = typeof NOT_KNOWN;

// Warning: (ae-missing-release-tag) "NUM_LR_NODEMASK_SEGMENT_BYTES" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export const NUM_LR_NODEMASK_SEGMENT_BYTES: number;

// Warning: (ae-missing-release-tag) "NUM_LR_NODES_PER_SEGMENT" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export const NUM_LR_NODES_PER_SEGMENT = 128;

// Warning: (ae-missing-release-tag) "NUM_NODEMASK_BYTES" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
@@ -1741,7 +1775,7 @@ export function parseApplicationNodeInformation(nif: Buffer): ApplicationNodeInf
// Warning: (ae-missing-release-tag) "parseBitMask" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function parseBitMask(mask: Buffer, startValue?: number): number[];
export function parseBitMask(mask: Buffer, startValue?: number, numBits?: number): number[];

// Warning: (ae-missing-release-tag) "parseBoolean" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
@@ -1784,6 +1818,11 @@ export function parseFloatWithScale(payload: Buffer, allowEmpty: true): {
bytesRead: number;
};

// Warning: (ae-missing-release-tag) "parseLongRangeNodeBitMask" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function parseLongRangeNodeBitMask(mask: Buffer, startValue: number): number[];

// Warning: (ae-missing-release-tag) "parseMaybeBoolean" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The reference is ambiguous because "UNKNOWN_STATE" has more than one declaration; you need to add a TSDoc member reference selector
//
@@ -1812,17 +1851,17 @@ export function parseNodeID(buffer: Buffer, type?: NodeIDType, offset?: number):
// Warning: (ae-missing-release-tag) "parseNodeInformationFrame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function parseNodeInformationFrame(buffer: Buffer): NodeInformationFrame;
export function parseNodeInformationFrame(buffer: Buffer, isLongRange?: boolean): NodeInformationFrame;

// Warning: (ae-missing-release-tag) "parseNodeProtocolInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function parseNodeProtocolInfo(buffer: Buffer, offset: number): NodeProtocolInfo;
export function parseNodeProtocolInfo(buffer: Buffer, offset: number, isLongRange?: boolean): NodeProtocolInfo;

// Warning: (ae-missing-release-tag) "parseNodeProtocolInfoAndDeviceClass" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function parseNodeProtocolInfoAndDeviceClass(buffer: Buffer): {
export function parseNodeProtocolInfoAndDeviceClass(buffer: Buffer, isLongRange?: boolean): {
info: NodeProtocolInfoAndDeviceClass;
bytesRead: number;
};
1 change: 1 addition & 0 deletions packages/host/api.md
Original file line number Diff line number Diff line change
@@ -118,6 +118,7 @@ export interface ZWaveHost {
ownNodeId: number;
securityManager: SecurityManager | undefined;
securityManager2: SecurityManager2 | undefined;
securityManagerLR: SecurityManager2 | undefined;
// (undocumented)
setSecurityClass(nodeId: number, securityClass: SecurityClass, granted: boolean): void;
}
7 changes: 7 additions & 0 deletions packages/nvmedit/api.md
Original file line number Diff line number Diff line change
@@ -8,6 +8,7 @@

import { CommandClasses } from '@zwave-js/core/safe';
import { FLiRS } from '@zwave-js/core/safe';
import { NodeIDType } from '@zwave-js/core/safe';
import { NodeProtocolInfo } from '@zwave-js/core/safe';
import { RFRegion } from '@zwave-js/core/safe';
import { RouteProtocolDataRate } from '@zwave-js/core/safe';
@@ -209,6 +210,8 @@ export interface NVMJSONController {
// (undocumented)
applicationData?: string | null;
// (undocumented)
applicationName?: string | null;
// (undocumented)
applicationVersion: string;
// (undocumented)
commandClasses: {
@@ -275,6 +278,8 @@ export interface NVMJSONControllerRFConfig {
// (undocumented)
measured0dBm: number;
// (undocumented)
nodeIdType: NodeIDType | null;
// (undocumented)
rfRegion: RFRegion;
// (undocumented)
txPower: number;
@@ -332,6 +337,8 @@ export interface NVMMeta {
// (undocumented)
pageSize: number;
// (undocumented)
sharedFileSystem: boolean;
// (undocumented)
writeSize: PageWriteSize;
}

11 changes: 10 additions & 1 deletion packages/serial/api.md
Original file line number Diff line number Diff line change
@@ -193,6 +193,10 @@ export enum FunctionType {
// (undocumented)
GetControllerVersion = 21,
// (undocumented)
GetLongRangeChannel = 219,
// (undocumented)
GetLongRangeNodes = 218,
// (undocumented)
GetNodeProtocolInfo = 65,
// (undocumented)
GetNVMId = 41,
@@ -241,6 +245,10 @@ export enum FunctionType {
// (undocumented)
SetApplicationNodeInformation = 3,
// (undocumented)
SetLongRangeChannel = 220,
// (undocumented)
SetLongRangeShadowNodeIDs = 221,
// (undocumented)
SetPriorityRoute = 147,
// (undocumented)
SetRFReceiveMode = 16,
@@ -456,7 +464,7 @@ export class Message {
expectsNodeUpdate(): boolean;
expectsResponse(): boolean;
static extractPayload(data: Buffer): Buffer;
static from(host: ZWaveHost, options: MessageDeserializationOptions): Message;
static from(host: ZWaveHost, options: MessageDeserializationOptions, contextStore?: Map<FunctionType, Record<string, unknown>>): Message;
// (undocumented)
functionType: FunctionType;
getCallbackTimeout(): number | undefined;
@@ -521,6 +529,7 @@ export interface MessageCreationOptions extends MessageBaseOptions {
//
// @public (undocumented)
export interface MessageDeserializationOptions {
context?: unknown;
// (undocumented)
data: Buffer;
// (undocumented)
25 changes: 20 additions & 5 deletions packages/zwave-js/api.md
Original file line number Diff line number Diff line change
@@ -108,6 +108,7 @@ import { ProtocolDataRate } from '@zwave-js/core/safe';
import type { ProtocolDataRate as ProtocolDataRate_2 } from '@zwave-js/core';
import { protocolDataRateToString } from '@zwave-js/core';
import { Protocols } from '@zwave-js/core';
import type { Protocols as Protocols_2 } from '@zwave-js/core/safe';
import { ProtocolType } from '@zwave-js/core';
import { ProtocolVersion } from '@zwave-js/core/safe';
import { ProtocolVersion as ProtocolVersion_2 } from '@zwave-js/core';
@@ -244,6 +245,10 @@ export interface ControllerStatistics {
average: number;
current: number;
};
channel3?: {
average: number;
current: number;
};
};
CAN: number;
messagesDroppedRX: number;
@@ -406,6 +411,7 @@ export class Driver extends TypedEventEmitter<DriverEventCallbacks> implements Z
schedulePoll(nodeId: number, valueId: ValueID_2, options: NodeSchedulePollOptions): boolean;
get securityManager(): SecurityManager | undefined;
get securityManager2(): SecurityManager2 | undefined;
get securityManagerLR(): SecurityManager2 | 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: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "SupervisionResult"
@@ -852,10 +858,12 @@ export type PartialZWaveOptions = Expand<DeepPartial<Omit<ZWaveOptions, "inclusi
export interface PlannedProvisioningEntry {
[prop: string]: any;
dsk: string;
protocol?: Protocols_2;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "securityClasses"
requestedSecurityClasses?: readonly SecurityClass[];
securityClasses: SecurityClass[];
status?: ProvisioningEntryStatus;
supportedProtocols?: readonly Protocols_2[];
}

export { Powerlevel }
@@ -1012,9 +1020,9 @@ export { SensorType }
// @public (undocumented)
export enum SerialAPISetupCommand {
// (undocumented)
GetLRMaximumPayloadSize = 17,
GetLongRangeMaximumPayloadSize = 17,
// (undocumented)
GetLRMaximumTxPower = 5,
GetLongRangeMaximumTxPower = 5,
// (undocumented)
GetMaximumPayloadSize = 16,
// (undocumented)
@@ -1026,7 +1034,7 @@ export enum SerialAPISetupCommand {
// (undocumented)
GetSupportedCommands = 1,
// (undocumented)
SetLRMaximumTxPower = 3,
SetLongRangeMaximumTxPower = 3,
// (undocumented)
SetNodeIDType = 128,
// (undocumented)
@@ -1197,6 +1205,7 @@ export class ZWaveController extends TypedEventEmitter<ControllerEventCallbacks>
rssiChannel0: RSSI_2;
rssiChannel1: RSSI_2;
rssiChannel2?: RSSI_2;
rssiChannel3?: RSSI_2;
}>;
getBroadcastNode(): VirtualNode;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "assignCustomReturnRoutes"
@@ -1302,6 +1311,7 @@ export class ZWaveController extends TypedEventEmitter<ControllerEventCallbacks>
// (undocumented)
get supportedSerialAPISetupCommands(): readonly SerialAPISetupCommand[] | undefined;
supportsFeature(feature: ZWaveFeature): MaybeNotKnown<boolean>;
get supportsLongRange(): MaybeNotKnown<boolean>;
// (undocumented)
get supportsTimers(): MaybeNotKnown<boolean>;
toggleRF(enabled: boolean): Promise<boolean>;
@@ -1440,6 +1450,7 @@ export class ZWaveNode extends Endpoint implements SecurityClassOwner, IZWaveNod
get productId(): MaybeNotKnown<number>;
// (undocumented)
get productType(): MaybeNotKnown<number>;
get protocol(): Protocols;
get protocolVersion(): MaybeNotKnown<ProtocolVersion_2>;
protected queryProtocolInfo(): Promise<void>;
get ready(): boolean;
@@ -1727,11 +1738,15 @@ export interface ZWaveOptions extends ZWaveHostOptions {
};
};
securityKeys?: {
S2_Unauthenticated?: Buffer;
S2_Authenticated?: Buffer;
S2_AccessControl?: Buffer;
S2_Authenticated?: Buffer;
S2_Unauthenticated?: Buffer;
S0_Legacy?: Buffer;
};
securityKeysLongRange?: {
S2_AccessControl?: Buffer;
S2_Authenticated?: Buffer;
};
// (undocumented)
storage: {
driver: FileSystem_2;

0 comments on commit 943b10d

Please sign in to comment.