@matter-server/dashboard 0.3.2 → 0.3.3

package/src/pages/network/network-types.ts

@@ -0,0 +1,161 @@
+/**
+ * @license
+ * Copyright 2025-2026 Open Home Foundation
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Network type detected from NetworkCommissioning cluster feature map.
+ */
+export type NetworkType = "thread" | "wifi" | "ethernet" | "unknown";
+
+/**
+ * Thread routing role from ThreadNetworkDiagnostics cluster.
+ * Attribute 0/53/1 (RoutingRole)
+ */
+export enum ThreadRoutingRole {
+    Unspecified = 0,
+    Unassigned = 1,
+    SleepyEndDevice = 2,
+    EndDevice = 3,
+    REED = 4, // Router-Eligible End Device
+    Router = 5,
+    Leader = 6,
+}
+
+/**
+ * Thread neighbor table entry from ThreadNetworkDiagnostics cluster.
+ * Attribute 0/53/7 (NeighborTable)
+ */
+export interface ThreadNeighbor {
+    /** Extended address of the neighbor (64-bit) */
+    extAddress: bigint;
+    /** Age of the entry in seconds */
+    age: number;
+    /** RLOC16 (Router Locator) */
+    rloc16: number;
+    /** Link frame counter */
+    linkFrameCounter: number;
+    /** MLE frame counter */
+    mleFrameCounter: number;
+    /** Link Quality Indicator (0-255, higher is better) */
+    lqi: number;
+    /** Average RSSI in dBm (nullable) */
+    avgRssi: number | null;
+    /** Last RSSI in dBm (nullable) */
+    lastRssi: number | null;
+    /** Frame error rate (0-255) */
+    frameErrorRate: number;
+    /** Message error rate (0-255) */
+    messageErrorRate: number;
+    /** Whether RX is on when idle */
+    rxOnWhenIdle: boolean;
+    /** Whether this is a full Thread device */
+    fullThreadDevice: boolean;
+    /** Whether this is a full network data device */
+    fullNetworkData: boolean;
+    /** Whether the link is established */
+    isChild: boolean;
+}
+
+/**
+ * Thread route table entry from ThreadNetworkDiagnostics cluster.
+ * Attribute 0/53/8 (RouteTable)
+ */
+export interface ThreadRoute {
+    /** Extended address of the destination */
+    extAddress: bigint;
+    /** RLOC16 of the destination */
+    rloc16: number;
+    /** Router ID */
+    routerId: number;
+    /** Next hop RLOC16 */
+    nextHop: number;
+    /** Path cost */
+    pathCost: number;
+    /** LQI in */
+    lqiIn: number;
+    /** LQI out */
+    lqiOut: number;
+    /** Age of the route */
+    age: number;
+    /** Whether this is allocated */
+    allocated: boolean;
+    /** Whether link is established */
+    linkEstablished: boolean;
+}
+
+/**
+ * Categorized devices by network type.
+ * Node IDs are stored as strings to avoid BigInt precision loss.
+ */
+export interface CategorizedDevices {
+    thread: string[];
+    wifi: string[];
+    ethernet: string[];
+    unknown: string[];
+}
+
+/**
+ * Thread mesh connection between two nodes.
+ */
+export interface ThreadConnection {
+    fromNodeId: number | string;
+    toNodeId: number | string;
+    signalColor: string;
+    lqi: number;
+    rssi: number | null;
+}
+
+/**
+ * Unknown Thread device seen in neighbor tables but not commissioned.
+ */
+export interface UnknownThreadDevice {
+    /** Unique ID for the unknown device (prefixed with 'unknown_') */
+    id: string;
+    /** Extended address as hex string */
+    extAddressHex: string;
+    /** Extended address as BigInt */
+    extAddress: bigint;
+    /** Node IDs that see this device as a neighbor (as strings to avoid BigInt precision loss) */
+    seenBy: string[];
+    /** Whether this device appears to be a router */
+    isRouter: boolean;
+    /** Best signal strength seen */
+    bestRssi: number | null;
+}
+
+/**
+ * Network graph node data for vis.js.
+ */
+export interface NetworkGraphNode {
+    id: number | string;
+    label: string;
+    image: string;
+    shape: "image";
+    networkType: NetworkType;
+    threadRole?: ThreadRoutingRole;
+    /** Whether the node is offline */
+    offline?: boolean;
+    /** Whether this is an unknown/external device */
+    isUnknown?: boolean;
+    /** Physics group: "connected" or "disconnected" */
+    group?: "connected" | "disconnected";
+}
+
+/**
+ * Network graph edge data for vis.js.
+ */
+export interface NetworkGraphEdge {
+    id: number | string;
+    from: number | string;
+    to: number | string;
+    color: {
+        color: string;
+        highlight: string;
+    };
+    width: number;
+    title?: string;
+    /** Whether to show as dashed line */
+    dashes?: boolean;
+}