Interface Cluster

The Wi-Fi Network Diagnostics Cluster provides a means to acquire standardized diagnostics metrics that may be used by a Node to assist a user or Administrator in diagnosing potential problems. The Wi-Fi Network Diagnostics Cluster attempts to centralize all metrics that are relevant to a potential Wi-Fi radio running on a Node.

WiFiNetworkDiagnosticsCluster supports optional features that you can enable with the WiFiNetworkDiagnosticsCluster.with() factory method.

See

MatterSpecification.v13.Core § 11.15

interface Cluster {
    attributes: Merge<{
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    }, GlobalAttributes<{
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    }>>;
    base: undefined;
    commands: {};
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: Branded<54, "ClusterId">;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            bssid: Attribute<null | Uint8Array, any>;
            channelNumber: Attribute<null | number, any>;
            currentMaxRate: OptionalAttribute<null | number | bigint, any>;
            rssi: Attribute<null | number, any>;
            securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
            wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
        };
        events: {
            associationFailure: OptionalEvent<TypeFromFields<{
                associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
                status: FieldType<number>;
            }>, any>;
            connectionStatus: OptionalEvent<TypeFromFields<{
                connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
            }>, any>;
            disconnection: OptionalEvent<TypeFromFields<{
                reasonCode: FieldType<number>;
            }>, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    beaconLostCount: Attribute<null | number, any>;
                    overrunCount: Attribute<null | number | bigint, any>;
                };
                commands: {
                    resetCounts: Command<void, void, any>;
                };
            };
            flags: {
                errorCounts: true;
            };
        }, {
            component: {
                attributes: {
                    beaconRxCount: Attribute<null | number, any>;
                    packetMulticastRxCount: Attribute<null | number, any>;
                    packetMulticastTxCount: Attribute<null | number, any>;
                    packetUnicastRxCount: Attribute<null | number, any>;
                    packetUnicastTxCount: Attribute<null | number, any>;
                };
            };
            flags: {
                packetCounts: true;
            };
        }];
        features: {
            errorCounts: BitFlag;
            packetCounts: BitFlag;
        };
        id: 54;
        name: "WiFiNetworkDiagnostics";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            bssid: Attribute<null | Uint8Array, any>;
            channelNumber: Attribute<null | number, any>;
            currentMaxRate: OptionalAttribute<null | number | bigint, any>;
            rssi: Attribute<null | number, any>;
            securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
            wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
        };
        events: {
            associationFailure: OptionalEvent<TypeFromFields<{
                associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
                status: FieldType<number>;
            }>, any>;
            connectionStatus: OptionalEvent<TypeFromFields<{
                connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
            }>, any>;
            disconnection: OptionalEvent<TypeFromFields<{
                reasonCode: FieldType<number>;
            }>, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    beaconLostCount: Attribute<null | number, any>;
                    overrunCount: Attribute<null | number | bigint, any>;
                };
                commands: {
                    resetCounts: Command<void, void, any>;
                };
            };
            flags: {
                errorCounts: true;
            };
        }, {
            component: {
                attributes: {
                    beaconRxCount: Attribute<null | number, any>;
                    packetMulticastRxCount: Attribute<null | number, any>;
                    packetMulticastTxCount: Attribute<null | number, any>;
                    packetUnicastRxCount: Attribute<null | number, any>;
                    packetUnicastTxCount: Attribute<null | number, any>;
                };
            };
            flags: {
                packetCounts: true;
            };
        }];
        features: {
            errorCounts: BitFlag;
            packetCounts: BitFlag;
        };
        id: 54;
        name: "WiFiNetworkDiagnostics";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            bssid: Attribute<null | Uint8Array, any>;
            channelNumber: Attribute<null | number, any>;
            currentMaxRate: OptionalAttribute<null | number | bigint, any>;
            rssi: Attribute<null | number, any>;
            securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
            wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
        };
        events: {
            associationFailure: OptionalEvent<TypeFromFields<{
                associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
                status: FieldType<number>;
            }>, any>;
            connectionStatus: OptionalEvent<TypeFromFields<{
                connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
            }>, any>;
            disconnection: OptionalEvent<TypeFromFields<{
                reasonCode: FieldType<number>;
            }>, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    beaconLostCount: Attribute<null | number, any>;
                    overrunCount: Attribute<null | number | bigint, any>;
                };
                commands: {
                    resetCounts: Command<void, void, any>;
                };
            };
            flags: {
                errorCounts: true;
            };
        }, {
            component: {
                attributes: {
                    beaconRxCount: Attribute<null | number, any>;
                    packetMulticastRxCount: Attribute<null | number, any>;
                    packetMulticastTxCount: Attribute<null | number, any>;
                    packetUnicastRxCount: Attribute<null | number, any>;
                    packetUnicastTxCount: Attribute<null | number, any>;
                };
            };
            flags: {
                packetCounts: true;
            };
        }];
        features: {
            errorCounts: BitFlag;
            packetCounts: BitFlag;
        };
        id: 54;
        name: "WiFiNetworkDiagnostics";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            bssid: Attribute<null | Uint8Array, any>;
            channelNumber: Attribute<null | number, any>;
            currentMaxRate: OptionalAttribute<null | number | bigint, any>;
            rssi: Attribute<null | number, any>;
            securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
            wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
        };
        events: {
            associationFailure: OptionalEvent<TypeFromFields<{
                associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
                status: FieldType<number>;
            }>, any>;
            connectionStatus: OptionalEvent<TypeFromFields<{
                connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
            }>, any>;
            disconnection: OptionalEvent<TypeFromFields<{
                reasonCode: FieldType<number>;
            }>, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    beaconLostCount: Attribute<null | number, any>;
                    overrunCount: Attribute<null | number | bigint, any>;
                };
                commands: {
                    resetCounts: Command<void, void, any>;
                };
            };
            flags: {
                errorCounts: true;
            };
        }, {
            component: {
                attributes: {
                    beaconRxCount: Attribute<null | number, any>;
                    packetMulticastRxCount: Attribute<null | number, any>;
                    packetMulticastTxCount: Attribute<null | number, any>;
                    packetUnicastRxCount: Attribute<null | number, any>;
                    packetUnicastTxCount: Attribute<null | number, any>;
                };
            };
            flags: {
                packetCounts: true;
            };
        }];
        features: {
            errorCounts: BitFlag;
            packetCounts: BitFlag;
        };
        id: 54;
        name: "WiFiNetworkDiagnostics";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Identity<typeof WiFiNetworkDiagnostics.ClusterInstance>
- Cluster

Index

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    bssid: Attribute<null | Uint8Array, any>;
    channelNumber: Attribute<null | number, any>;
    currentMaxRate: OptionalAttribute<null | number | bigint, any>;
    rssi: Attribute<null | number, any>;
    securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
    wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
}, GlobalAttributes<{
    errorCounts: BitFlag;
    packetCounts: BitFlag;
}>>

Type declaration

Readonlybssid: Attribute<null | Uint8Array, any>
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: Attribute<null | number, any>
The ChannelNumber attribute shall indicate the channel that Wi-Fi communication is currently operating on.

See
MatterSpecification.v13.Core § 11.15.6.4
ReadonlycurrentMaxRate: OptionalAttribute<null | number | bigint, any>
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
Readonlyrssi: Attribute<null | number, any>
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: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>
The SecurityType attribute shall indicate the current type of Wi-Fi security used.

See
MatterSpecification.v13.Core § 11.15.6.2
ReadonlywiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>
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

base

base: undefined

commands

commands: {}

events

events: {
    associationFailure: OptionalEvent<TypeFromFields<{
        associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
        status: FieldType<number>;
    }>, any>;
    connectionStatus: OptionalEvent<TypeFromFields<{
        connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
    }>, any>;
    disconnection: OptionalEvent<TypeFromFields<{
        reasonCode: FieldType<number>;
    }>, any>;
}

Type declaration

ReadonlyassociationFailure: 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
ReadonlyconnectionStatus: 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
Readonlydisconnection: 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

extensions

extensions: readonly [{
    component: {
        attributes: {
            beaconLostCount: Attribute<null | number, any>;
            overrunCount: Attribute<null | number | bigint, any>;
        };
        commands: {
            resetCounts: Command<void, void, any>;
        };
    };
    flags: {
        errorCounts: true;
    };
}, {
    component: {
        attributes: {
            beaconRxCount: Attribute<null | number, any>;
            packetMulticastRxCount: Attribute<null | number, any>;
            packetMulticastTxCount: Attribute<null | number, any>;
            packetUnicastRxCount: Attribute<null | number, any>;
            packetUnicastTxCount: Attribute<null | number, any>;
        };
    };
    flags: {
        packetCounts: true;
    };
}]

features

features: {
errorCounts: BitFlag;
packetCounts: BitFlag;
}

Type declaration

ReadonlyerrorCounts: BitFlag
ErrorCounts

Node makes available the counts for the number of errors that have occurred during the reception and transmission of packets on the Wi-Fi interface.
ReadonlypacketCounts: BitFlag
PacketCounts

Node makes available the counts for the number of received and transmitted packets on the Wi-Fi interface.

id

id: Branded<54, "ClusterId">

name

revision

supportedFeatures

supportedFeatures: {}

unknown

Methods

alter

alter<const AlterationsT>(alterations): WithAlterations<Of<{
    attributes: {
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    };
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: 54;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
}>, AlterationsT>
Modify elements using ElementModifier.alter.
Type Parameters
- const AlterationsT extends Alterations<Of<{
      attributes: {
          bssid: Attribute<null | Uint8Array, any>;
          channelNumber: Attribute<null | number, any>;
          currentMaxRate: OptionalAttribute<null | number | bigint, any>;
          rssi: Attribute<null | number, any>;
          securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
          wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
      };
      events: {
          associationFailure: OptionalEvent<TypeFromFields<{
              associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
              status: FieldType<number>;
          }>, any>;
          connectionStatus: OptionalEvent<TypeFromFields<{
              connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
          }>, any>;
          disconnection: OptionalEvent<TypeFromFields<{
              reasonCode: FieldType<number>;
          }>, any>;
      };
      extensions: readonly [{
          component: {
              attributes: {
                  beaconLostCount: Attribute<null | number, any>;
                  overrunCount: Attribute<null | number | bigint, any>;
              };
              commands: {
                  resetCounts: Command<void, void, any>;
              };
          };
          flags: {
              errorCounts: true;
          };
      }, {
          component: {
              attributes: {
                  beaconRxCount: Attribute<null | number, any>;
                  packetMulticastRxCount: Attribute<null | number, any>;
                  packetMulticastTxCount: Attribute<null | number, any>;
                  packetUnicastRxCount: Attribute<null | number, any>;
                  packetUnicastTxCount: Attribute<null | number, any>;
              };
          };
          flags: {
              packetCounts: true;
          };
      }];
      features: {
          errorCounts: BitFlag;
          packetCounts: BitFlag;
      };
      id: 54;
      name: "WiFiNetworkDiagnostics";
      revision: 1;
  }>>
Parameters
- alterations: AlterationsT
Returns WithAlterations<Of<{
    attributes: {
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    };
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: 54;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
}>, AlterationsT>
Inherited from Identity.alter
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:37

enable

enable<const FlagsT>(flags): WithFlags<Of<{
    attributes: {
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    };
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: 54;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
}>, FlagsT>
Modify elements using ElementModifier.enable.
Type Parameters
- const FlagsT extends ElementFlags<Of<{
      attributes: {
          bssid: Attribute<null | Uint8Array, any>;
          channelNumber: Attribute<null | number, any>;
          currentMaxRate: OptionalAttribute<null | number | bigint, any>;
          rssi: Attribute<null | number, any>;
          securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
          wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
      };
      events: {
          associationFailure: OptionalEvent<TypeFromFields<{
              associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
              status: FieldType<number>;
          }>, any>;
          connectionStatus: OptionalEvent<TypeFromFields<{
              connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
          }>, any>;
          disconnection: OptionalEvent<TypeFromFields<{
              reasonCode: FieldType<number>;
          }>, any>;
      };
      extensions: readonly [{
          component: {
              attributes: {
                  beaconLostCount: Attribute<null | number, any>;
                  overrunCount: Attribute<null | number | bigint, any>;
              };
              commands: {
                  resetCounts: Command<void, void, any>;
              };
          };
          flags: {
              errorCounts: true;
          };
      }, {
          component: {
              attributes: {
                  beaconRxCount: Attribute<null | number, any>;
                  packetMulticastRxCount: Attribute<null | number, any>;
                  packetMulticastTxCount: Attribute<null | number, any>;
                  packetUnicastRxCount: Attribute<null | number, any>;
                  packetUnicastTxCount: Attribute<null | number, any>;
              };
          };
          flags: {
              packetCounts: true;
          };
      }];
      features: {
          errorCounts: BitFlag;
          packetCounts: BitFlag;
      };
      id: 54;
      name: "WiFiNetworkDiagnostics";
      revision: 1;
  }>>
Parameters
- flags: FlagsT
Returns WithFlags<Of<{
    attributes: {
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    };
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: 54;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
}>, FlagsT>
Inherited from Identity.enable
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:45

set

set<const ValuesT>(values): WithValues<Of<{
    attributes: {
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    };
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: 54;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
}>, ValuesT>
Modify elements using ElementModifier.set.
Type Parameters
- const ValuesT extends {
      bssid: null | {};
      channelNumber: null | number;
      currentMaxRate?: null | number | bigint;
      rssi: null | number;
      securityType: null | number;
      wiFiVersion: null | number;
  }
Parameters
- values: ValuesT
Returns WithValues<Of<{
    attributes: {
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    };
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: 54;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
}>, ValuesT>
Inherited from Identity.set
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:41

with

with<const SelectionT>(...selection): Of<Of<{
    attributes: {
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    };
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: 54;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
}>, SelectionT>
Select features using ClusterComposer.compose.
Type Parameters
- const SelectionT extends FeatureSelection<Of<{
      attributes: {
          bssid: Attribute<null | Uint8Array, any>;
          channelNumber: Attribute<null | number, any>;
          currentMaxRate: OptionalAttribute<null | number | bigint, any>;
          rssi: Attribute<null | number, any>;
          securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
          wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
      };
      events: {
          associationFailure: OptionalEvent<TypeFromFields<{
              associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
              status: FieldType<number>;
          }>, any>;
          connectionStatus: OptionalEvent<TypeFromFields<{
              connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
          }>, any>;
          disconnection: OptionalEvent<TypeFromFields<{
              reasonCode: FieldType<number>;
          }>, any>;
      };
      extensions: readonly [{
          component: {
              attributes: {
                  beaconLostCount: Attribute<null | number, any>;
                  overrunCount: Attribute<null | number | bigint, any>;
              };
              commands: {
                  resetCounts: Command<void, void, any>;
              };
          };
          flags: {
              errorCounts: true;
          };
      }, {
          component: {
              attributes: {
                  beaconRxCount: Attribute<null | number, any>;
                  packetMulticastRxCount: Attribute<null | number, any>;
                  packetMulticastTxCount: Attribute<null | number, any>;
                  packetUnicastRxCount: Attribute<null | number, any>;
                  packetUnicastTxCount: Attribute<null | number, any>;
              };
          };
          flags: {
              packetCounts: true;
          };
      }];
      features: {
          errorCounts: BitFlag;
          packetCounts: BitFlag;
      };
      id: 54;
      name: "WiFiNetworkDiagnostics";
      revision: 1;
  }>>
Parameters
- Rest...selection: SelectionT
Returns Of<Of<{
    attributes: {
        bssid: Attribute<null | Uint8Array, any>;
        channelNumber: Attribute<null | number, any>;
        currentMaxRate: OptionalAttribute<null | number | bigint, any>;
        rssi: Attribute<null | number, any>;
        securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>;
        wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>;
    };
    events: {
        associationFailure: OptionalEvent<TypeFromFields<{
            associationFailureCause: FieldType<WiFiNetworkDiagnostics.AssociationFailureCause>;
            status: FieldType<number>;
        }>, any>;
        connectionStatus: OptionalEvent<TypeFromFields<{
            connectionStatus: FieldType<WiFiNetworkDiagnostics.ConnectionStatus>;
        }>, any>;
        disconnection: OptionalEvent<TypeFromFields<{
            reasonCode: FieldType<number>;
        }>, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                beaconLostCount: Attribute<null | number, any>;
                overrunCount: Attribute<null | number | bigint, any>;
            };
            commands: {
                resetCounts: Command<void, void, any>;
            };
        };
        flags: {
            errorCounts: true;
        };
    }, {
        component: {
            attributes: {
                beaconRxCount: Attribute<null | number, any>;
                packetMulticastRxCount: Attribute<null | number, any>;
                packetMulticastTxCount: Attribute<null | number, any>;
                packetUnicastRxCount: Attribute<null | number, any>;
                packetUnicastTxCount: Attribute<null | number, any>;
            };
        };
        flags: {
            packetCounts: true;
        };
    }];
    features: {
        errorCounts: BitFlag;
        packetCounts: BitFlag;
    };
    id: 54;
    name: "WiFiNetworkDiagnostics";
    revision: 1;
}>, SelectionT>
Inherited from Identity.with
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:33

Interface Cluster

See

Hierarchy (view full)

Index

Properties

Methods

Properties

attributes

Type declaration

Readonlybssid: Attribute<null | Uint8Array, any>

See

ReadonlychannelNumber: Attribute<null | number, any>

See

ReadonlycurrentMaxRate: OptionalAttribute<null | number | bigint, any>

See

Readonlyrssi: Attribute<null | number, any>

See

ReadonlysecurityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>

See

ReadonlywiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>

See

base

commands

events

Type declaration

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

See

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

See

Readonlydisconnection: OptionalEvent<TypeFromFields<{ reasonCode: FieldType<number>; }>, any>

See

extensions

features

Type declaration

ReadonlyerrorCounts: BitFlag

ReadonlypacketCounts: BitFlag

id

name

revision

supportedFeatures

unknown

Methods

alter

Type Parameters

Parameters

enable

Type Parameters

Parameters

set

Type Parameters

Parameters

with

Type Parameters

Parameters

Settings

On This Page

`Readonly`bssid: Attribute<null | Uint8Array, any>

`Readonly`channelNumber: Attribute<null | number, any>

`Readonly`currentMaxRate: OptionalAttribute<null | number | bigint, any>

`Readonly`rssi: Attribute<null | number, any>

`Readonly`securityType: Attribute<null | WiFiNetworkDiagnostics.SecurityType, any>

`Readonly`wiFiVersion: Attribute<null | WiFiNetworkDiagnostics.WiFiVersion, any>

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

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

`Readonly`disconnection: OptionalEvent<TypeFromFields<{
reasonCode: FieldType<number>;
}>, any>

`Readonly`errorCounts: BitFlag

`Readonly`packetCounts: BitFlag