Class WiFiNetworkDiagnosticsServer

This is the default server implementation of WiFiNetworkDiagnosticsBehavior.

Hierarchy (view full)

WiFiNetworkDiagnosticsBehavior
- WiFiNetworkDiagnosticsServer

Constructors

constructor

new WiFiNetworkDiagnosticsServer(agent, backing): WiFiNetworkDiagnosticsServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns WiFiNetworkDiagnosticsServer
Inherited from WiFiNetworkDiagnosticsBehavior.constructor
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:119

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

`Readonly`events

events: EventEmitter & Omit<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    bssid$Changing: ClusterEvents.AttributeObservable<Attribute<null | Uint8Array, any>>;
    channelNumber$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    rssi$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    securityType$Changing: ClusterEvents.AttributeObservable<Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>>;
    wiFiVersion$Changing: ClusterEvents.AttributeObservable<Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>>;
} & {
    currentMaxRate$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
} & {
    bssid$Changed: ClusterEvents.AttributeObservable<Attribute<null | Uint8Array, any>>;
    channelNumber$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    rssi$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    securityType$Changed: ClusterEvents.AttributeObservable<Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>>;
    wiFiVersion$Changed: ClusterEvents.AttributeObservable<Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>>;
} & {
    currentMaxRate$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
} & {} & {
    associationFailure?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
        status: FieldType<number>;
    }>, any>>;
    connectionStatus?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
    }>, any>>;
    disconnection?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        reasonCode: FieldType<number>;
    }>, any>>;
}

Access the behavior's events.

Type declaration

Optional ReadonlyassociationFailure?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
status: FieldType<number>;
}>, any>>
The AssociationFailure event shall indicate that a Node has attempted to connect, or reconnect, to a Wi-Fi access point, but is unable to successfully associate or authenticate, after exhausting all internal retries of its supplicant.

See
MatterSpecification.v13.Core § 11.15.8.2
Optional ReadonlyconnectionStatus?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
}>, any>>
The ConnectionStatus Event shall indicate that a Node’s connection status to a Wi-Fi network has changed. Connected, in this context, shall mean that a Node acting as a Wi-Fi station is successfully associated to a Wi-Fi Access Point.

See
MatterSpecification.v13.Core § 11.15.8.3
Optional Readonlydisconnection?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
reasonCode: FieldType<number>;
}>, any>>
The Disconnection Event shall indicate that a Node’s Wi-Fi connection has been disconnected as a result of de-authenticated or dis-association and indicates the reason.

See
MatterSpecification.v13.Core § 11.15.8.1

features

features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
errorCounts: BitFlag;
packetCounts: BitFlag;
}>

Supported features as a flag object.

session

session: SecureSession

`Readonly`state

state: Omit<ClusterState.Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    bssid: null | Uint8Array;
    channelNumber: null | number;
    rssi: null | number;
    securityType: null | WiFiNetworkDiagnostics.SecurityType;
    wiFiVersion: null | WiFiNetworkDiagnostics.WiFiVersion;
} & {
    currentMaxRate?: null | number | bigint;
} & {} & {}

Access the behavior's state.

Type declaration

Readonlybssid: null | Uint8Array
The BSSID attribute shall indicate the BSSID for which the Wi-Fi network the Node is currently connected.

See
MatterSpecification.v13.Core § 11.15.6.1
ReadonlychannelNumber: null | number
The ChannelNumber attribute shall indicate the channel that Wi-Fi communication is currently operating on.

See
MatterSpecification.v13.Core § 11.15.6.4
Readonlyrssi: null | number
The RSSI attribute shall indicate the current RSSI of the Node’s Wi-Fi radio in dBm.

See
MatterSpecification.v13.Core § 11.15.6.5
ReadonlysecurityType: null | WiFiNetworkDiagnostics.SecurityType
The SecurityType attribute shall indicate the current type of Wi-Fi security used.

See
MatterSpecification.v13.Core § 11.15.6.2
ReadonlywiFiVersion: null | WiFiNetworkDiagnostics.WiFiVersion
The WiFiVersion attribute shall indicate the current 802.11 standard version in use by the Node, per the table below.

See
MatterSpecification.v13.Core § 11.15.6.3

Type declaration

Optional ReadonlycurrentMaxRate?: null | number | bigint
The CurrentMaxRate attribute shall indicate the current maximum PHY rate of transfer of data in bits-per-second.

See
MatterSpecification.v13.Core § 11.15.6.12

`Static` `Readonly`cluster

cluster: WiFiNetworkDiagnostics.Cluster

Base cluster state include all attribute values but may be extended by subclasses.

`Static` `Readonly`defaults

defaults: ClusterState.Type<WiFiNetworkDiagnostics.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, WiFiNetworkDiagnosticsInterface>>

`Static` `Optional` `Readonly`dependencies

dependencies?: Iterable<Type, any, any>

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

Events: ClusterEvents.Type<WiFiNetworkDiagnostics.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, WiFiNetworkDiagnosticsInterface>>

`Static` `Readonly`ExtensionInterface

ExtensionInterface: {}

`Static` `Readonly`id

The behavior ID for ClusterBehaviors is the name of the cluster.

`Static` `Readonly`Interface

Interface: WiFiNetworkDiagnosticsInterface

`Static` `Readonly`Internal

Internal: (new () => {})

Type declaration

- new (): {}
- Implementation of internal state. Subclasses may override to extend.
  
  Returns {}

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`Static` `Readonly`State

State: (new () => ClusterState.Type<WiFiNetworkDiagnostics.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, WiFiNetworkDiagnosticsInterface>>)

`Static` `Readonly`supervisor

supervisor: RootSupervisor

`Static`supports

supports: ((other: Type) => boolean)

Type declaration

- (other): boolean
- Does this behavior support functionality of a specific implementation?
  Parameters
  - other: Type
  Returns boolean

Methods

[asyncDispose]

[asyncDispose](): MaybePromise
Release resources. This is the public API for releasing application resources held by behaviors in internal state.

Returns MaybePromise
Inherited from WiFiNetworkDiagnosticsBehavior.[asyncDispose]
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:115

asAdmin

asAdmin(fn): void
Execute logic with elevated privileges.

The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

Elevated logic effectively ignores ACLs so should be used with care.

Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.
Parameters
- fn: (() => void)
  the elevated logic
  - - (): void
    - Returns void
Returns void
Inherited from WiFiNetworkDiagnosticsBehavior.asAdmin
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:77

assertAttributeEnabled

assertAttributeEnabled<This, K>(this, attributeName): void
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns void
Inherited from WiFiNetworkDiagnosticsBehavior.assertAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:112

`Protected`callback

callback<A, R>(reactor, options?): ((...args: A) => undefined | R)
Create a generic callback function that has the same properties as a Reactor.

Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!
Type Parameters
- A extends any[]
- R
Parameters
- reactor: Reactor<A, R>
- Optionaloptions: Reactor.Options
Returns ((...args: A) => undefined | R)
- - (...args): undefined | R
  - Parameters
    - Rest...args: A
    Returns undefined | R
Inherited from WiFiNetworkDiagnosticsBehavior.callback
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:132

initialize

initialize(_options?): MaybePromise
Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.
Parameters
- Optional_options: {}
Returns MaybePromise
Inherited from WiFiNetworkDiagnosticsBehavior.initialize
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:110

`Protected`reactTo

reactTo<O>(observable, reactor, options?): void
Install a Reactor.

Important: The reactor MUST be a real JS function - arrow functions will not work!
Type Parameters
- O extends Observable<any[], any>
Parameters
- observable: O
- reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>
- Optionaloptions: Reactor.Options
Returns void
Inherited from WiFiNetworkDiagnosticsBehavior.reactTo
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:125

requireAttributeEnabled

requireAttributeEnabled<This, K>(this, attributeName): Exclude<This["state"][K], undefined>
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns Exclude<This["state"][K], undefined>
Inherited from WiFiNetworkDiagnosticsBehavior.requireAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:111

toString

toString(): string
Description used in diagnostic messages.

Returns string
Inherited from WiFiNetworkDiagnosticsBehavior.toString
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:119

`Static`alter

alter<This, const AlterationsT>(this, alterations): Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const AlterationsT extends Alterations<This["cluster"]>
Parameters
- this: This
- alterations: AlterationsT
Returns Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from WiFiNetworkDiagnosticsBehavior.alter
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:142

`Static`enable

enable<This, const FlagsT>(this, flags): Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FlagsT extends ElementFlags<This["cluster"]>
Parameters
- this: This
- flags: FlagsT
Returns Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Inherited from WiFiNetworkDiagnosticsBehavior.enable
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:144

`Static`for

for<This, const ClusterT>(this, cluster, schema?): Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const ClusterT extends ClusterType
Parameters
- this: This
- cluster: ClusterT
- Optionalschema: Schema
Returns Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Inherited from WiFiNetworkDiagnosticsBehavior.for
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:140

`Static`set

set<This>(this, defaults): This
Type Parameters
- This extends Type
Parameters
- this: This
- defaults: Partial<RelaxTypes<InstanceType<This["State"]>>>
Returns This
Inherited from WiFiNetworkDiagnosticsBehavior.set
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:143

`Static`with

with<This, const FeaturesT>(this, ...features): Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FeaturesT extends FeatureSelection<This["cluster"]>
Parameters
- this: This
- Rest...features: FeaturesT
Returns Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from WiFiNetworkDiagnosticsBehavior.with
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:141

Class WiFiNetworkDiagnosticsServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WiFiNetworkDiagnosticsServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

Type declaration

Optional ReadonlyassociationFailure?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>; status: FieldType<number>; }>, any>>

See

Optional ReadonlyconnectionStatus?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>; }>, any>>

See

Optional Readonlydisconnection?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ reasonCode: FieldType<number>; }>, any>>

See

features

session

Readonlystate

Type declaration

Readonlybssid: null | Uint8Array

See

ReadonlychannelNumber: null | number

See

Readonlyrssi: null | number

See

ReadonlysecurityType: null | WiFiNetworkDiagnostics.SecurityType

See

ReadonlywiFiVersion: null | WiFiNetworkDiagnostics.WiFiVersion

See

Type declaration

Optional ReadonlycurrentMaxRate?: null | number | bigint

See

Static Readonlycluster

Static Readonlydefaults

Static Optional Readonlydependencies

Static Readonlyearly

Static ReadonlyEvents

Static ReadonlyExtensionInterface

Static Readonlyid

Static ReadonlyInterface

Static ReadonlyInternal

Type declaration

Returns {}

Static Readonlyname

Static Optional Readonlyschema

Static ReadonlyState

Static Readonlysupervisor

Staticsupports

Type declaration

Parameters

Returns boolean

Methods

[asyncDispose]

Returns MaybePromise

asAdmin

Parameters

Returns void

Returns void

assertAttributeEnabled

Type Parameters

Parameters

Returns void

Protectedcallback

Type Parameters

Parameters

Returns ((...args: A) => undefined | R)

Parameters

Returns undefined | R

initialize

Parameters

`Readonly`events

`Optional` `Readonly`associationFailure?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
status: FieldType<number>;
}>, any>>

`Optional` `Readonly`connectionStatus?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
}>, any>>

`Optional` `Readonly`disconnection?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
reasonCode: FieldType<number>;
}>, any>>

`Readonly`state

`Readonly`bssid: null | Uint8Array

`Readonly`channelNumber: null | number

`Readonly`rssi: null | number

`Readonly`securityType: null | WiFiNetworkDiagnostics.SecurityType

`Readonly`wiFiVersion: null | WiFiNetworkDiagnostics.WiFiVersion

`Optional` `Readonly`currentMaxRate?: null | number | bigint

`Static` `Readonly`cluster

`Static` `Readonly`defaults

`Static` `Optional` `Readonly`dependencies

`Static` `Readonly`early

`Static` `Readonly`Events

`Static` `Readonly`ExtensionInterface

`Static` `Readonly`id

`Static` `Readonly`Interface

`Static` `Readonly`Internal

`Static` `Readonly`name

`Static` `Optional` `Readonly`schema

`Static` `Readonly`State

`Static` `Readonly`supervisor

`Static`supports

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with