Class WiFiRouter

Hierarchy (View Summary)

GRPCApi
- WiFiRouter

Constructors

constructor

new WiFiRouter(__namedParameters?: Options): WiFiRouter
Parameters
- __namedParameters: Options = {}
Returns WiFiRouter
Overrides GRPCApi.constructor

Properties

`Protected`client

client: DeviceClient

`Readonly`host

host: string

`Readonly`port

port: number

`Optional` `Readonly`timeout

timeout?: number

Methods

close

close(): void
Closes the underlying gRPC channel and releases resources

Returns void
Inherited from GRPCApi.close

fetch_backhaul_stats

fetch_backhaul_stats(): Promise<WifiBackhaulStatsResponse>
Fetches WAN backhaul statistics

Returns Promise<WifiBackhaulStatsResponse>

fetch_client_history

fetch_client_history(
mac_address: string,
client_id?: number,
): Promise<WifiGetClientHistoryResponse>
Fetches per-client history for the requested MAC address
Parameters
- mac_address: string
- client_id: number = 0
Returns Promise<WifiGetClientHistoryResponse>

fetch_clients

fetch_clients(): Promise<WifiGetClientsResponse>
Fetches the list of currently associated WiFi clients

Returns Promise<WifiGetClientsResponse>

fetch_config

fetch_config(): Promise<WifiGetConfigResponse>
Fetches the current WiFi router configuration

Returns Promise<WifiGetConfigResponse>

fetch_diagnostics

fetch_diagnostics(): Promise<StarlinkGRPC.WifiRouter.Diagnostics>
Fetches diagnostics information from a local WiFi Router

Returns Promise<StarlinkGRPC.WifiRouter.Diagnostics>

fetch_firewall

fetch_firewall(): Promise<WifiGetFirewallResponse>
Fetches the active firewall snapshot (iptables / iptables6 / ipset)

Returns Promise<WifiGetFirewallResponse>

fetch_guest_info

fetch_guest_info(): Promise<WifiGuestInfoResponse>
Fetches information about the configured guest network

Returns Promise<WifiGuestInfoResponse>

fetch_history

fetch_history(): Promise<WifiGetHistoryResponse>
Fetches the rolling history of WiFi throughput / link state

Returns Promise<WifiGetHistoryResponse>

`Protected`fetch_or_throw

fetch_or_throw<K extends keyof Response>(
    request: {
        authenticate?: {
            challenge?: {
                data?: Uint8Array<ArrayBufferLike>;
                signature?: Uint8Array<ArrayBufferLike>;
            };
        };
        dishActivateRssiScan?: { scanQuery?: { channel?: number } };
        dishClearObstructionMap?: {};
        dishEmc?: {
            chanOverride?: boolean;
            desiredTiltAngle?: number;
            fastSwitching?: boolean;
            forceEirpFailure?: boolean;
            forcePllUnlock?: boolean;
            idle?: boolean;
            manualTilting?: boolean;
            modulation?: number;
            phi?: number;
            phiEnabled?: boolean;
            reboot?: boolean;
            rxChan?: number;
            skySearch?: boolean;
            snowActiveOverride?: boolean;
            theta?: number;
            thetaEnabled?: boolean;
            tiltToStowed?: boolean;
            txChan?: number;
        };
        dishFactoryReset?: { appReset?: boolean };
        dishGetConfig?: {};
        dishGetContext?: {};
        dishGetEmc?: {};
        dishGetObstructionMap?: {};
        dishGetRssiScanResult?: {};
        dishInhibitGps?: { inhibitGps?: boolean };
        dishInhibitRf?: { inhibitRf?: boolean };
        dishPowerSave?: {
            enablePowerSave?: boolean;
            powerSaveDurationMinutes?: number;
            powerSaveStartMinutes?: number;
        };
        dishSetConfig?: {
            dishConfig?: {
                applyAssetClass?: boolean;
                applyLevelDishMode?: boolean;
                applyLocationRequestMode?: boolean;
                applyPowerSaveDurationMinutes?: boolean;
                applyPowerSaveMode?: boolean;
                applyPowerSaveStartMinutes?: boolean;
                applySnowMeltMode?: boolean;
                applySwupdateRebootHour?: boolean;
                applySwupdateThreeDayDeferralEnabled?: boolean;
                assetClass?: number;
                levelDishMode?: DishConfig_LevelDishMode;
                locationRequestMode?: DishConfig_LocationRequestMode;
                powerSaveDurationMinutes?: number;
                powerSaveMode?: boolean;
                powerSaveStartMinutes?: number;
                snowMeltMode?: DishConfig_SnowMeltMode;
                swupdateRebootHour?: number;
                swupdateThreeDayDeferralEnabled?: boolean;
            };
        };
        dishStow?: { unstow?: boolean };
        enableFlow?: { durationH?: number; name?: string };
        epochId?: number;
        factoryReset?: {};
        fuse?: {};
        getConnections?: {};
        getDeviceInfo?: {};
        getDiagnostics?: {};
        getGnssMeasurement?: {};
        getHeapDump?: {};
        getHistory?: {};
        getLocation?: { source?: PositionSource };
        getLog?: {};
        getNetworkInterfaces?: {};
        getNextId?: {};
        getPing?: {};
        getRadioStats?: {};
        getSpeedtestStatus?: {};
        getStatus?: { routerRole?: RouterRole };
        id?: number;
        pingHost?: { address?: string; size?: number };
        reboot?: {};
        reportClientSpeedtest?: {
            appBuild?: number;
            appVersion?: string;
            clientPlatform?: {
                majorVersion?: number;
                minorVersion?: number;
                platform?: ClientPlatform_Platform;
            };
            clientRssi?: number;
            clientSpeedtest?: {
                downloadBytesProcessed?: number;
                downloadMbps?: number;
                downloadStartTime?: number;
                durationS?: number;
                latencyMs?: number;
                startTime?: number;
                tcpStreams?: number;
                uploadBytesProcessed?: number;
                uploadMbps?: number;
                uploadStartTime?: number;
            };
            id?: number;
            wifiSpeedtest?: {
                downloadBytesProcessed?: number;
                downloadMbps?: number;
                downloadStartTime?: number;
                durationS?: number;
                latencyMs?: number;
                startTime?: number;
                tcpStreams?: number;
                uploadBytesProcessed?: number;
                uploadMbps?: number;
                uploadStartTime?: number;
            };
        };
        resetButton?: { pressed?: boolean };
        restartControl?: {};
        runIperfServer?: { durationS?: number };
        setSku?: {
            applyCountryCode?: boolean;
            countryCode?: string;
            sku?: string;
        };
        setTrustedKeys?: {
            keys?: { capabilities?: Capability[]; key?: string }[];
        };
        signedRequest?: {
            data?: Uint8Array<ArrayBufferLike>;
            signature?: Uint8Array<ArrayBufferLike>;
        };
        speedTest?: {};
        startSpeedtest?: { durationS?: number; sendTelemetry?: boolean };
        targetId?: string;
        tcpConnectivityTest?: { port?: number; target?: string };
        time?: {};
        transceiverGetStatus?: {};
        transceiverGetTelemetry?: {};
        transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
        udpConnectivityTest?: {
            port?: number;
            probeData?: UdpConnectivityTestRequest_UDPProbeDataType;
            target?: string;
        };
        update?: {};
        wifiBackhaulStats?: {};
        wifiGetClientHistory?: { clientId?: number; macAddress?: string };
        wifiGetClients?: {};
        wifiGetConfig?: {};
        wifiGetDiagnostics?: {};
        wifiGetFirewall?: {};
        wifiGetPingMetrics?: {};
        wifiGuestInfo?: {};
        wifiRunSelfTest?: {};
        wifiSelfTest?: {};
        wifiSetClientGivenName?: {
            clientConfig?: {
                clientId?: number;
                givenName?: string;
                groupId?: string;
                macAddress?: string;
                weeklyBlockSchedules?: {
                    blockRanges?: { endMinutes?: ...; startMinutes?: ... }[];
                    groupId?: string;
                }[];
            };
            clientName?: { givenName?: string; macAddress?: string };
        };
        wifiSetConfig?: {
            wifiConfig?: {
                applyMacLan?: boolean;
                applyMacLan2ghz?: boolean;
                applyMacLan5ghz?: boolean;
                applyMacWan?: boolean;
                applyNetworkName?: boolean;
                applyNetworkName5ghz?: boolean;
                applyNetworkPassword?: boolean;
                applySetupComplete?: boolean;
                applyWifiDisabled?: boolean;
                applyWifiSecurity?: boolean;
                countryCode?: string;
                deviceId?: string;
                factoryResetTicker?: number;
                lanIpv4?: string;
                lanIpv4SubnetMask?: string;
                macLan?: string;
                macLan2ghz?: string;
                macLan5ghz?: string;
                macWan?: string;
                networkName?: string;
                networkName5ghz?: string;
                networkPassword?: string;
                setupComplete?: boolean;
                version?: number;
                wifiDisabled?: boolean;
                wifiSecurity?: WifiConfig_Security;
            };
        };
        wifiSetMeshConfig?: {
            deviceId?: string;
            meshConfig?: {
                applyAuth?: boolean;
                applyDisplayName?: boolean;
                auth?: MeshAuth;
                displayName?: string;
                hardwareVersion?: string;
                incarnation?: number;
                lastConnected?: number;
                supports5ghzHigh?: boolean;
            };
        };
        wifiSetup?: {
            networkName?: string;
            networkPassword?: string;
            skip?: boolean;
        };
    },
    field: K,
    noun: string,
): Promise<NonNullable<Response[K]>>
Sends request and returns response[field], throwing if the named response variant is absent. noun is interpolated into the error message
Type Parameters
- K extends keyof Response
Parameters
- request: {
      authenticate?: {
          challenge?: {
              data?: Uint8Array<ArrayBufferLike>;
              signature?: Uint8Array<ArrayBufferLike>;
          };
      };
      dishActivateRssiScan?: { scanQuery?: { channel?: number } };
      dishClearObstructionMap?: {};
      dishEmc?: {
          chanOverride?: boolean;
          desiredTiltAngle?: number;
          fastSwitching?: boolean;
          forceEirpFailure?: boolean;
          forcePllUnlock?: boolean;
          idle?: boolean;
          manualTilting?: boolean;
          modulation?: number;
          phi?: number;
          phiEnabled?: boolean;
          reboot?: boolean;
          rxChan?: number;
          skySearch?: boolean;
          snowActiveOverride?: boolean;
          theta?: number;
          thetaEnabled?: boolean;
          tiltToStowed?: boolean;
          txChan?: number;
      };
      dishFactoryReset?: { appReset?: boolean };
      dishGetConfig?: {};
      dishGetContext?: {};
      dishGetEmc?: {};
      dishGetObstructionMap?: {};
      dishGetRssiScanResult?: {};
      dishInhibitGps?: { inhibitGps?: boolean };
      dishInhibitRf?: { inhibitRf?: boolean };
      dishPowerSave?: {
          enablePowerSave?: boolean;
          powerSaveDurationMinutes?: number;
          powerSaveStartMinutes?: number;
      };
      dishSetConfig?: {
          dishConfig?: {
              applyAssetClass?: boolean;
              applyLevelDishMode?: boolean;
              applyLocationRequestMode?: boolean;
              applyPowerSaveDurationMinutes?: boolean;
              applyPowerSaveMode?: boolean;
              applyPowerSaveStartMinutes?: boolean;
              applySnowMeltMode?: boolean;
              applySwupdateRebootHour?: boolean;
              applySwupdateThreeDayDeferralEnabled?: boolean;
              assetClass?: number;
              levelDishMode?: DishConfig_LevelDishMode;
              locationRequestMode?: DishConfig_LocationRequestMode;
              powerSaveDurationMinutes?: number;
              powerSaveMode?: boolean;
              powerSaveStartMinutes?: number;
              snowMeltMode?: DishConfig_SnowMeltMode;
              swupdateRebootHour?: number;
              swupdateThreeDayDeferralEnabled?: boolean;
          };
      };
      dishStow?: { unstow?: boolean };
      enableFlow?: { durationH?: number; name?: string };
      epochId?: number;
      factoryReset?: {};
      fuse?: {};
      getConnections?: {};
      getDeviceInfo?: {};
      getDiagnostics?: {};
      getGnssMeasurement?: {};
      getHeapDump?: {};
      getHistory?: {};
      getLocation?: { source?: PositionSource };
      getLog?: {};
      getNetworkInterfaces?: {};
      getNextId?: {};
      getPing?: {};
      getRadioStats?: {};
      getSpeedtestStatus?: {};
      getStatus?: { routerRole?: RouterRole };
      id?: number;
      pingHost?: { address?: string; size?: number };
      reboot?: {};
      reportClientSpeedtest?: {
          appBuild?: number;
          appVersion?: string;
          clientPlatform?: {
              majorVersion?: number;
              minorVersion?: number;
              platform?: ClientPlatform_Platform;
          };
          clientRssi?: number;
          clientSpeedtest?: {
              downloadBytesProcessed?: number;
              downloadMbps?: number;
              downloadStartTime?: number;
              durationS?: number;
              latencyMs?: number;
              startTime?: number;
              tcpStreams?: number;
              uploadBytesProcessed?: number;
              uploadMbps?: number;
              uploadStartTime?: number;
          };
          id?: number;
          wifiSpeedtest?: {
              downloadBytesProcessed?: number;
              downloadMbps?: number;
              downloadStartTime?: number;
              durationS?: number;
              latencyMs?: number;
              startTime?: number;
              tcpStreams?: number;
              uploadBytesProcessed?: number;
              uploadMbps?: number;
              uploadStartTime?: number;
          };
      };
      resetButton?: { pressed?: boolean };
      restartControl?: {};
      runIperfServer?: { durationS?: number };
      setSku?: { applyCountryCode?: boolean; countryCode?: string; sku?: string };
      setTrustedKeys?: { keys?: { capabilities?: Capability[]; key?: string }[] };
      signedRequest?: {
          data?: Uint8Array<ArrayBufferLike>;
          signature?: Uint8Array<ArrayBufferLike>;
      };
      speedTest?: {};
      startSpeedtest?: { durationS?: number; sendTelemetry?: boolean };
      targetId?: string;
      tcpConnectivityTest?: { port?: number; target?: string };
      time?: {};
      transceiverGetStatus?: {};
      transceiverGetTelemetry?: {};
      transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
      udpConnectivityTest?: {
          port?: number;
          probeData?: UdpConnectivityTestRequest_UDPProbeDataType;
          target?: string;
      };
      update?: {};
      wifiBackhaulStats?: {};
      wifiGetClientHistory?: { clientId?: number; macAddress?: string };
      wifiGetClients?: {};
      wifiGetConfig?: {};
      wifiGetDiagnostics?: {};
      wifiGetFirewall?: {};
      wifiGetPingMetrics?: {};
      wifiGuestInfo?: {};
      wifiRunSelfTest?: {};
      wifiSelfTest?: {};
      wifiSetClientGivenName?: {
          clientConfig?: {
              clientId?: number;
              givenName?: string;
              groupId?: string;
              macAddress?: string;
              weeklyBlockSchedules?: {
                  blockRanges?: { endMinutes?: ...; startMinutes?: ... }[];
                  groupId?: string;
              }[];
          };
          clientName?: { givenName?: string; macAddress?: string };
      };
      wifiSetConfig?: {
          wifiConfig?: {
              applyMacLan?: boolean;
              applyMacLan2ghz?: boolean;
              applyMacLan5ghz?: boolean;
              applyMacWan?: boolean;
              applyNetworkName?: boolean;
              applyNetworkName5ghz?: boolean;
              applyNetworkPassword?: boolean;
              applySetupComplete?: boolean;
              applyWifiDisabled?: boolean;
              applyWifiSecurity?: boolean;
              countryCode?: string;
              deviceId?: string;
              factoryResetTicker?: number;
              lanIpv4?: string;
              lanIpv4SubnetMask?: string;
              macLan?: string;
              macLan2ghz?: string;
              macLan5ghz?: string;
              macWan?: string;
              networkName?: string;
              networkName5ghz?: string;
              networkPassword?: string;
              setupComplete?: boolean;
              version?: number;
              wifiDisabled?: boolean;
              wifiSecurity?: WifiConfig_Security;
          };
      };
      wifiSetMeshConfig?: {
          deviceId?: string;
          meshConfig?: {
              applyAuth?: boolean;
              applyDisplayName?: boolean;
              auth?: MeshAuth;
              displayName?: string;
              hardwareVersion?: string;
              incarnation?: number;
              lastConnected?: number;
              supports5ghzHigh?: boolean;
          };
      };
      wifiSetup?: {
          networkName?: string;
          networkPassword?: string;
          skip?: boolean;
      };
  }
- field: K
- noun: string
Returns Promise<NonNullable<Response[K]>>
Inherited from GRPCApi.fetch_or_throw

fetch_ping_metrics

fetch_ping_metrics(): Promise<WifiGetPingMetricsResponse>
Fetches per-host ping metrics tracked by the router

Returns Promise<WifiGetPingMetricsResponse>

fetch_self_test

fetch_self_test(): Promise<WifiSelfTestResponse>
Fetches the most recent self-test result

Returns Promise<WifiSelfTestResponse>

fetch_status

fetch_status(role?: RouterRole): Promise<WifiGetStatusResponse>
Fetches router status (device info, WAN addresses, hops from controller, alerts)
Parameters
- Optionalrole: RouterRole
  optional router role for the status request; the router picks its own default when omitted
Returns Promise<WifiGetStatusResponse>

`Protected`handle

handle(
    request: {
        authenticate?: {
            challenge?: {
                data?: Uint8Array<ArrayBufferLike>;
                signature?: Uint8Array<ArrayBufferLike>;
            };
        };
        dishActivateRssiScan?: { scanQuery?: { channel?: number } };
        dishClearObstructionMap?: {};
        dishEmc?: {
            chanOverride?: boolean;
            desiredTiltAngle?: number;
            fastSwitching?: boolean;
            forceEirpFailure?: boolean;
            forcePllUnlock?: boolean;
            idle?: boolean;
            manualTilting?: boolean;
            modulation?: number;
            phi?: number;
            phiEnabled?: boolean;
            reboot?: boolean;
            rxChan?: number;
            skySearch?: boolean;
            snowActiveOverride?: boolean;
            theta?: number;
            thetaEnabled?: boolean;
            tiltToStowed?: boolean;
            txChan?: number;
        };
        dishFactoryReset?: { appReset?: boolean };
        dishGetConfig?: {};
        dishGetContext?: {};
        dishGetEmc?: {};
        dishGetObstructionMap?: {};
        dishGetRssiScanResult?: {};
        dishInhibitGps?: { inhibitGps?: boolean };
        dishInhibitRf?: { inhibitRf?: boolean };
        dishPowerSave?: {
            enablePowerSave?: boolean;
            powerSaveDurationMinutes?: number;
            powerSaveStartMinutes?: number;
        };
        dishSetConfig?: {
            dishConfig?: {
                applyAssetClass?: boolean;
                applyLevelDishMode?: boolean;
                applyLocationRequestMode?: boolean;
                applyPowerSaveDurationMinutes?: boolean;
                applyPowerSaveMode?: boolean;
                applyPowerSaveStartMinutes?: boolean;
                applySnowMeltMode?: boolean;
                applySwupdateRebootHour?: boolean;
                applySwupdateThreeDayDeferralEnabled?: boolean;
                assetClass?: number;
                levelDishMode?: DishConfig_LevelDishMode;
                locationRequestMode?: DishConfig_LocationRequestMode;
                powerSaveDurationMinutes?: number;
                powerSaveMode?: boolean;
                powerSaveStartMinutes?: number;
                snowMeltMode?: DishConfig_SnowMeltMode;
                swupdateRebootHour?: number;
                swupdateThreeDayDeferralEnabled?: boolean;
            };
        };
        dishStow?: { unstow?: boolean };
        enableFlow?: { durationH?: number; name?: string };
        epochId?: number;
        factoryReset?: {};
        fuse?: {};
        getConnections?: {};
        getDeviceInfo?: {};
        getDiagnostics?: {};
        getGnssMeasurement?: {};
        getHeapDump?: {};
        getHistory?: {};
        getLocation?: { source?: PositionSource };
        getLog?: {};
        getNetworkInterfaces?: {};
        getNextId?: {};
        getPing?: {};
        getRadioStats?: {};
        getSpeedtestStatus?: {};
        getStatus?: { routerRole?: RouterRole };
        id?: number;
        pingHost?: { address?: string; size?: number };
        reboot?: {};
        reportClientSpeedtest?: {
            appBuild?: number;
            appVersion?: string;
            clientPlatform?: {
                majorVersion?: number;
                minorVersion?: number;
                platform?: ClientPlatform_Platform;
            };
            clientRssi?: number;
            clientSpeedtest?: {
                downloadBytesProcessed?: number;
                downloadMbps?: number;
                downloadStartTime?: number;
                durationS?: number;
                latencyMs?: number;
                startTime?: number;
                tcpStreams?: number;
                uploadBytesProcessed?: number;
                uploadMbps?: number;
                uploadStartTime?: number;
            };
            id?: number;
            wifiSpeedtest?: {
                downloadBytesProcessed?: number;
                downloadMbps?: number;
                downloadStartTime?: number;
                durationS?: number;
                latencyMs?: number;
                startTime?: number;
                tcpStreams?: number;
                uploadBytesProcessed?: number;
                uploadMbps?: number;
                uploadStartTime?: number;
            };
        };
        resetButton?: { pressed?: boolean };
        restartControl?: {};
        runIperfServer?: { durationS?: number };
        setSku?: {
            applyCountryCode?: boolean;
            countryCode?: string;
            sku?: string;
        };
        setTrustedKeys?: {
            keys?: { capabilities?: Capability[]; key?: string }[];
        };
        signedRequest?: {
            data?: Uint8Array<ArrayBufferLike>;
            signature?: Uint8Array<ArrayBufferLike>;
        };
        speedTest?: {};
        startSpeedtest?: { durationS?: number; sendTelemetry?: boolean };
        targetId?: string;
        tcpConnectivityTest?: { port?: number; target?: string };
        time?: {};
        transceiverGetStatus?: {};
        transceiverGetTelemetry?: {};
        transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
        udpConnectivityTest?: {
            port?: number;
            probeData?: UdpConnectivityTestRequest_UDPProbeDataType;
            target?: string;
        };
        update?: {};
        wifiBackhaulStats?: {};
        wifiGetClientHistory?: { clientId?: number; macAddress?: string };
        wifiGetClients?: {};
        wifiGetConfig?: {};
        wifiGetDiagnostics?: {};
        wifiGetFirewall?: {};
        wifiGetPingMetrics?: {};
        wifiGuestInfo?: {};
        wifiRunSelfTest?: {};
        wifiSelfTest?: {};
        wifiSetClientGivenName?: {
            clientConfig?: {
                clientId?: number;
                givenName?: string;
                groupId?: string;
                macAddress?: string;
                weeklyBlockSchedules?: {
                    blockRanges?: { endMinutes?: ...; startMinutes?: ... }[];
                    groupId?: string;
                }[];
            };
            clientName?: { givenName?: string; macAddress?: string };
        };
        wifiSetConfig?: {
            wifiConfig?: {
                applyMacLan?: boolean;
                applyMacLan2ghz?: boolean;
                applyMacLan5ghz?: boolean;
                applyMacWan?: boolean;
                applyNetworkName?: boolean;
                applyNetworkName5ghz?: boolean;
                applyNetworkPassword?: boolean;
                applySetupComplete?: boolean;
                applyWifiDisabled?: boolean;
                applyWifiSecurity?: boolean;
                countryCode?: string;
                deviceId?: string;
                factoryResetTicker?: number;
                lanIpv4?: string;
                lanIpv4SubnetMask?: string;
                macLan?: string;
                macLan2ghz?: string;
                macLan5ghz?: string;
                macWan?: string;
                networkName?: string;
                networkName5ghz?: string;
                networkPassword?: string;
                setupComplete?: boolean;
                version?: number;
                wifiDisabled?: boolean;
                wifiSecurity?: WifiConfig_Security;
            };
        };
        wifiSetMeshConfig?: {
            deviceId?: string;
            meshConfig?: {
                applyAuth?: boolean;
                applyDisplayName?: boolean;
                auth?: MeshAuth;
                displayName?: string;
                hardwareVersion?: string;
                incarnation?: number;
                lastConnected?: number;
                supports5ghzHigh?: boolean;
            };
        };
        wifiSetup?: {
            networkName?: string;
            networkPassword?: string;
            skip?: boolean;
        };
    },
    timeout?: number | undefined,
): Promise<Response>
Protected
Performs a handle request against the GRPC server
Parameters
- request: {
      authenticate?: {
          challenge?: {
              data?: Uint8Array<ArrayBufferLike>;
              signature?: Uint8Array<ArrayBufferLike>;
          };
      };
      dishActivateRssiScan?: { scanQuery?: { channel?: number } };
      dishClearObstructionMap?: {};
      dishEmc?: {
          chanOverride?: boolean;
          desiredTiltAngle?: number;
          fastSwitching?: boolean;
          forceEirpFailure?: boolean;
          forcePllUnlock?: boolean;
          idle?: boolean;
          manualTilting?: boolean;
          modulation?: number;
          phi?: number;
          phiEnabled?: boolean;
          reboot?: boolean;
          rxChan?: number;
          skySearch?: boolean;
          snowActiveOverride?: boolean;
          theta?: number;
          thetaEnabled?: boolean;
          tiltToStowed?: boolean;
          txChan?: number;
      };
      dishFactoryReset?: { appReset?: boolean };
      dishGetConfig?: {};
      dishGetContext?: {};
      dishGetEmc?: {};
      dishGetObstructionMap?: {};
      dishGetRssiScanResult?: {};
      dishInhibitGps?: { inhibitGps?: boolean };
      dishInhibitRf?: { inhibitRf?: boolean };
      dishPowerSave?: {
          enablePowerSave?: boolean;
          powerSaveDurationMinutes?: number;
          powerSaveStartMinutes?: number;
      };
      dishSetConfig?: {
          dishConfig?: {
              applyAssetClass?: boolean;
              applyLevelDishMode?: boolean;
              applyLocationRequestMode?: boolean;
              applyPowerSaveDurationMinutes?: boolean;
              applyPowerSaveMode?: boolean;
              applyPowerSaveStartMinutes?: boolean;
              applySnowMeltMode?: boolean;
              applySwupdateRebootHour?: boolean;
              applySwupdateThreeDayDeferralEnabled?: boolean;
              assetClass?: number;
              levelDishMode?: DishConfig_LevelDishMode;
              locationRequestMode?: DishConfig_LocationRequestMode;
              powerSaveDurationMinutes?: number;
              powerSaveMode?: boolean;
              powerSaveStartMinutes?: number;
              snowMeltMode?: DishConfig_SnowMeltMode;
              swupdateRebootHour?: number;
              swupdateThreeDayDeferralEnabled?: boolean;
          };
      };
      dishStow?: { unstow?: boolean };
      enableFlow?: { durationH?: number; name?: string };
      epochId?: number;
      factoryReset?: {};
      fuse?: {};
      getConnections?: {};
      getDeviceInfo?: {};
      getDiagnostics?: {};
      getGnssMeasurement?: {};
      getHeapDump?: {};
      getHistory?: {};
      getLocation?: { source?: PositionSource };
      getLog?: {};
      getNetworkInterfaces?: {};
      getNextId?: {};
      getPing?: {};
      getRadioStats?: {};
      getSpeedtestStatus?: {};
      getStatus?: { routerRole?: RouterRole };
      id?: number;
      pingHost?: { address?: string; size?: number };
      reboot?: {};
      reportClientSpeedtest?: {
          appBuild?: number;
          appVersion?: string;
          clientPlatform?: {
              majorVersion?: number;
              minorVersion?: number;
              platform?: ClientPlatform_Platform;
          };
          clientRssi?: number;
          clientSpeedtest?: {
              downloadBytesProcessed?: number;
              downloadMbps?: number;
              downloadStartTime?: number;
              durationS?: number;
              latencyMs?: number;
              startTime?: number;
              tcpStreams?: number;
              uploadBytesProcessed?: number;
              uploadMbps?: number;
              uploadStartTime?: number;
          };
          id?: number;
          wifiSpeedtest?: {
              downloadBytesProcessed?: number;
              downloadMbps?: number;
              downloadStartTime?: number;
              durationS?: number;
              latencyMs?: number;
              startTime?: number;
              tcpStreams?: number;
              uploadBytesProcessed?: number;
              uploadMbps?: number;
              uploadStartTime?: number;
          };
      };
      resetButton?: { pressed?: boolean };
      restartControl?: {};
      runIperfServer?: { durationS?: number };
      setSku?: { applyCountryCode?: boolean; countryCode?: string; sku?: string };
      setTrustedKeys?: { keys?: { capabilities?: Capability[]; key?: string }[] };
      signedRequest?: {
          data?: Uint8Array<ArrayBufferLike>;
          signature?: Uint8Array<ArrayBufferLike>;
      };
      speedTest?: {};
      startSpeedtest?: { durationS?: number; sendTelemetry?: boolean };
      targetId?: string;
      tcpConnectivityTest?: { port?: number; target?: string };
      time?: {};
      transceiverGetStatus?: {};
      transceiverGetTelemetry?: {};
      transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
      udpConnectivityTest?: {
          port?: number;
          probeData?: UdpConnectivityTestRequest_UDPProbeDataType;
          target?: string;
      };
      update?: {};
      wifiBackhaulStats?: {};
      wifiGetClientHistory?: { clientId?: number; macAddress?: string };
      wifiGetClients?: {};
      wifiGetConfig?: {};
      wifiGetDiagnostics?: {};
      wifiGetFirewall?: {};
      wifiGetPingMetrics?: {};
      wifiGuestInfo?: {};
      wifiRunSelfTest?: {};
      wifiSelfTest?: {};
      wifiSetClientGivenName?: {
          clientConfig?: {
              clientId?: number;
              givenName?: string;
              groupId?: string;
              macAddress?: string;
              weeklyBlockSchedules?: {
                  blockRanges?: { endMinutes?: ...; startMinutes?: ... }[];
                  groupId?: string;
              }[];
          };
          clientName?: { givenName?: string; macAddress?: string };
      };
      wifiSetConfig?: {
          wifiConfig?: {
              applyMacLan?: boolean;
              applyMacLan2ghz?: boolean;
              applyMacLan5ghz?: boolean;
              applyMacWan?: boolean;
              applyNetworkName?: boolean;
              applyNetworkName5ghz?: boolean;
              applyNetworkPassword?: boolean;
              applySetupComplete?: boolean;
              applyWifiDisabled?: boolean;
              applyWifiSecurity?: boolean;
              countryCode?: string;
              deviceId?: string;
              factoryResetTicker?: number;
              lanIpv4?: string;
              lanIpv4SubnetMask?: string;
              macLan?: string;
              macLan2ghz?: string;
              macLan5ghz?: string;
              macWan?: string;
              networkName?: string;
              networkName5ghz?: string;
              networkPassword?: string;
              setupComplete?: boolean;
              version?: number;
              wifiDisabled?: boolean;
              wifiSecurity?: WifiConfig_Security;
          };
      };
      wifiSetMeshConfig?: {
          deviceId?: string;
          meshConfig?: {
              applyAuth?: boolean;
              applyDisplayName?: boolean;
              auth?: MeshAuth;
              displayName?: string;
              hardwareVersion?: string;
              incarnation?: number;
              lastConnected?: number;
              supports5ghzHigh?: boolean;
          };
      };
      wifiSetup?: {
          networkName?: string;
          networkPassword?: string;
          skip?: boolean;
      };
  }
- timeout: number | undefined = ...
Returns Promise<Response>
Inherited from GRPCApi.handle

run_self_test

run_self_test(): Promise<boolean>
Triggers a fresh self-test pass on the router

Returns Promise<boolean>

set_client_given_name

set_client_given_name(
client_name: ClientName,
client_config?: ClientConfig,
): Promise<boolean>
Pushes a given-name entry for a client
Parameters
- client_name: ClientName
- Optionalclient_config: ClientConfig
Returns Promise<boolean>

set_config

set_config(config: WifiConfig): Promise<boolean>
Pushes a new WiFi router configuration
Parameters
- config: WifiConfig
Returns Promise<boolean>

set_mesh_config

set_mesh_config(mesh_config: MeshConfig, device_id?: string): Promise<boolean>
Pushes a new mesh configuration to the named device
Parameters
- mesh_config: MeshConfig
- Optionaldevice_id: string
Returns Promise<boolean>

setup

setup(network_name: string, network_password: string): Promise<boolean>
Runs initial network setup on the router
Parameters
- network_name: string
- network_password: string
Returns Promise<boolean>

`Protected`try_handle

try_handle(
    request: {
        authenticate?: {
            challenge?: {
                data?: Uint8Array<ArrayBufferLike>;
                signature?: Uint8Array<ArrayBufferLike>;
            };
        };
        dishActivateRssiScan?: { scanQuery?: { channel?: number } };
        dishClearObstructionMap?: {};
        dishEmc?: {
            chanOverride?: boolean;
            desiredTiltAngle?: number;
            fastSwitching?: boolean;
            forceEirpFailure?: boolean;
            forcePllUnlock?: boolean;
            idle?: boolean;
            manualTilting?: boolean;
            modulation?: number;
            phi?: number;
            phiEnabled?: boolean;
            reboot?: boolean;
            rxChan?: number;
            skySearch?: boolean;
            snowActiveOverride?: boolean;
            theta?: number;
            thetaEnabled?: boolean;
            tiltToStowed?: boolean;
            txChan?: number;
        };
        dishFactoryReset?: { appReset?: boolean };
        dishGetConfig?: {};
        dishGetContext?: {};
        dishGetEmc?: {};
        dishGetObstructionMap?: {};
        dishGetRssiScanResult?: {};
        dishInhibitGps?: { inhibitGps?: boolean };
        dishInhibitRf?: { inhibitRf?: boolean };
        dishPowerSave?: {
            enablePowerSave?: boolean;
            powerSaveDurationMinutes?: number;
            powerSaveStartMinutes?: number;
        };
        dishSetConfig?: {
            dishConfig?: {
                applyAssetClass?: boolean;
                applyLevelDishMode?: boolean;
                applyLocationRequestMode?: boolean;
                applyPowerSaveDurationMinutes?: boolean;
                applyPowerSaveMode?: boolean;
                applyPowerSaveStartMinutes?: boolean;
                applySnowMeltMode?: boolean;
                applySwupdateRebootHour?: boolean;
                applySwupdateThreeDayDeferralEnabled?: boolean;
                assetClass?: number;
                levelDishMode?: DishConfig_LevelDishMode;
                locationRequestMode?: DishConfig_LocationRequestMode;
                powerSaveDurationMinutes?: number;
                powerSaveMode?: boolean;
                powerSaveStartMinutes?: number;
                snowMeltMode?: DishConfig_SnowMeltMode;
                swupdateRebootHour?: number;
                swupdateThreeDayDeferralEnabled?: boolean;
            };
        };
        dishStow?: { unstow?: boolean };
        enableFlow?: { durationH?: number; name?: string };
        epochId?: number;
        factoryReset?: {};
        fuse?: {};
        getConnections?: {};
        getDeviceInfo?: {};
        getDiagnostics?: {};
        getGnssMeasurement?: {};
        getHeapDump?: {};
        getHistory?: {};
        getLocation?: { source?: PositionSource };
        getLog?: {};
        getNetworkInterfaces?: {};
        getNextId?: {};
        getPing?: {};
        getRadioStats?: {};
        getSpeedtestStatus?: {};
        getStatus?: { routerRole?: RouterRole };
        id?: number;
        pingHost?: { address?: string; size?: number };
        reboot?: {};
        reportClientSpeedtest?: {
            appBuild?: number;
            appVersion?: string;
            clientPlatform?: {
                majorVersion?: number;
                minorVersion?: number;
                platform?: ClientPlatform_Platform;
            };
            clientRssi?: number;
            clientSpeedtest?: {
                downloadBytesProcessed?: number;
                downloadMbps?: number;
                downloadStartTime?: number;
                durationS?: number;
                latencyMs?: number;
                startTime?: number;
                tcpStreams?: number;
                uploadBytesProcessed?: number;
                uploadMbps?: number;
                uploadStartTime?: number;
            };
            id?: number;
            wifiSpeedtest?: {
                downloadBytesProcessed?: number;
                downloadMbps?: number;
                downloadStartTime?: number;
                durationS?: number;
                latencyMs?: number;
                startTime?: number;
                tcpStreams?: number;
                uploadBytesProcessed?: number;
                uploadMbps?: number;
                uploadStartTime?: number;
            };
        };
        resetButton?: { pressed?: boolean };
        restartControl?: {};
        runIperfServer?: { durationS?: number };
        setSku?: {
            applyCountryCode?: boolean;
            countryCode?: string;
            sku?: string;
        };
        setTrustedKeys?: {
            keys?: { capabilities?: Capability[]; key?: string }[];
        };
        signedRequest?: {
            data?: Uint8Array<ArrayBufferLike>;
            signature?: Uint8Array<ArrayBufferLike>;
        };
        speedTest?: {};
        startSpeedtest?: { durationS?: number; sendTelemetry?: boolean };
        targetId?: string;
        tcpConnectivityTest?: { port?: number; target?: string };
        time?: {};
        transceiverGetStatus?: {};
        transceiverGetTelemetry?: {};
        transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
        udpConnectivityTest?: {
            port?: number;
            probeData?: UdpConnectivityTestRequest_UDPProbeDataType;
            target?: string;
        };
        update?: {};
        wifiBackhaulStats?: {};
        wifiGetClientHistory?: { clientId?: number; macAddress?: string };
        wifiGetClients?: {};
        wifiGetConfig?: {};
        wifiGetDiagnostics?: {};
        wifiGetFirewall?: {};
        wifiGetPingMetrics?: {};
        wifiGuestInfo?: {};
        wifiRunSelfTest?: {};
        wifiSelfTest?: {};
        wifiSetClientGivenName?: {
            clientConfig?: {
                clientId?: number;
                givenName?: string;
                groupId?: string;
                macAddress?: string;
                weeklyBlockSchedules?: {
                    blockRanges?: { endMinutes?: ...; startMinutes?: ... }[];
                    groupId?: string;
                }[];
            };
            clientName?: { givenName?: string; macAddress?: string };
        };
        wifiSetConfig?: {
            wifiConfig?: {
                applyMacLan?: boolean;
                applyMacLan2ghz?: boolean;
                applyMacLan5ghz?: boolean;
                applyMacWan?: boolean;
                applyNetworkName?: boolean;
                applyNetworkName5ghz?: boolean;
                applyNetworkPassword?: boolean;
                applySetupComplete?: boolean;
                applyWifiDisabled?: boolean;
                applyWifiSecurity?: boolean;
                countryCode?: string;
                deviceId?: string;
                factoryResetTicker?: number;
                lanIpv4?: string;
                lanIpv4SubnetMask?: string;
                macLan?: string;
                macLan2ghz?: string;
                macLan5ghz?: string;
                macWan?: string;
                networkName?: string;
                networkName5ghz?: string;
                networkPassword?: string;
                setupComplete?: boolean;
                version?: number;
                wifiDisabled?: boolean;
                wifiSecurity?: WifiConfig_Security;
            };
        };
        wifiSetMeshConfig?: {
            deviceId?: string;
            meshConfig?: {
                applyAuth?: boolean;
                applyDisplayName?: boolean;
                auth?: MeshAuth;
                displayName?: string;
                hardwareVersion?: string;
                incarnation?: number;
                lastConnected?: number;
                supports5ghzHigh?: boolean;
            };
        };
        wifiSetup?: {
            networkName?: string;
            networkPassword?: string;
            skip?: boolean;
        };
    },
): Promise<boolean>
Sends request and returns true on success, false on any thrown error
Parameters
- request: {
      authenticate?: {
          challenge?: {
              data?: Uint8Array<ArrayBufferLike>;
              signature?: Uint8Array<ArrayBufferLike>;
          };
      };
      dishActivateRssiScan?: { scanQuery?: { channel?: number } };
      dishClearObstructionMap?: {};
      dishEmc?: {
          chanOverride?: boolean;
          desiredTiltAngle?: number;
          fastSwitching?: boolean;
          forceEirpFailure?: boolean;
          forcePllUnlock?: boolean;
          idle?: boolean;
          manualTilting?: boolean;
          modulation?: number;
          phi?: number;
          phiEnabled?: boolean;
          reboot?: boolean;
          rxChan?: number;
          skySearch?: boolean;
          snowActiveOverride?: boolean;
          theta?: number;
          thetaEnabled?: boolean;
          tiltToStowed?: boolean;
          txChan?: number;
      };
      dishFactoryReset?: { appReset?: boolean };
      dishGetConfig?: {};
      dishGetContext?: {};
      dishGetEmc?: {};
      dishGetObstructionMap?: {};
      dishGetRssiScanResult?: {};
      dishInhibitGps?: { inhibitGps?: boolean };
      dishInhibitRf?: { inhibitRf?: boolean };
      dishPowerSave?: {
          enablePowerSave?: boolean;
          powerSaveDurationMinutes?: number;
          powerSaveStartMinutes?: number;
      };
      dishSetConfig?: {
          dishConfig?: {
              applyAssetClass?: boolean;
              applyLevelDishMode?: boolean;
              applyLocationRequestMode?: boolean;
              applyPowerSaveDurationMinutes?: boolean;
              applyPowerSaveMode?: boolean;
              applyPowerSaveStartMinutes?: boolean;
              applySnowMeltMode?: boolean;
              applySwupdateRebootHour?: boolean;
              applySwupdateThreeDayDeferralEnabled?: boolean;
              assetClass?: number;
              levelDishMode?: DishConfig_LevelDishMode;
              locationRequestMode?: DishConfig_LocationRequestMode;
              powerSaveDurationMinutes?: number;
              powerSaveMode?: boolean;
              powerSaveStartMinutes?: number;
              snowMeltMode?: DishConfig_SnowMeltMode;
              swupdateRebootHour?: number;
              swupdateThreeDayDeferralEnabled?: boolean;
          };
      };
      dishStow?: { unstow?: boolean };
      enableFlow?: { durationH?: number; name?: string };
      epochId?: number;
      factoryReset?: {};
      fuse?: {};
      getConnections?: {};
      getDeviceInfo?: {};
      getDiagnostics?: {};
      getGnssMeasurement?: {};
      getHeapDump?: {};
      getHistory?: {};
      getLocation?: { source?: PositionSource };
      getLog?: {};
      getNetworkInterfaces?: {};
      getNextId?: {};
      getPing?: {};
      getRadioStats?: {};
      getSpeedtestStatus?: {};
      getStatus?: { routerRole?: RouterRole };
      id?: number;
      pingHost?: { address?: string; size?: number };
      reboot?: {};
      reportClientSpeedtest?: {
          appBuild?: number;
          appVersion?: string;
          clientPlatform?: {
              majorVersion?: number;
              minorVersion?: number;
              platform?: ClientPlatform_Platform;
          };
          clientRssi?: number;
          clientSpeedtest?: {
              downloadBytesProcessed?: number;
              downloadMbps?: number;
              downloadStartTime?: number;
              durationS?: number;
              latencyMs?: number;
              startTime?: number;
              tcpStreams?: number;
              uploadBytesProcessed?: number;
              uploadMbps?: number;
              uploadStartTime?: number;
          };
          id?: number;
          wifiSpeedtest?: {
              downloadBytesProcessed?: number;
              downloadMbps?: number;
              downloadStartTime?: number;
              durationS?: number;
              latencyMs?: number;
              startTime?: number;
              tcpStreams?: number;
              uploadBytesProcessed?: number;
              uploadMbps?: number;
              uploadStartTime?: number;
          };
      };
      resetButton?: { pressed?: boolean };
      restartControl?: {};
      runIperfServer?: { durationS?: number };
      setSku?: { applyCountryCode?: boolean; countryCode?: string; sku?: string };
      setTrustedKeys?: { keys?: { capabilities?: Capability[]; key?: string }[] };
      signedRequest?: {
          data?: Uint8Array<ArrayBufferLike>;
          signature?: Uint8Array<ArrayBufferLike>;
      };
      speedTest?: {};
      startSpeedtest?: { durationS?: number; sendTelemetry?: boolean };
      targetId?: string;
      tcpConnectivityTest?: { port?: number; target?: string };
      time?: {};
      transceiverGetStatus?: {};
      transceiverGetTelemetry?: {};
      transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
      udpConnectivityTest?: {
          port?: number;
          probeData?: UdpConnectivityTestRequest_UDPProbeDataType;
          target?: string;
      };
      update?: {};
      wifiBackhaulStats?: {};
      wifiGetClientHistory?: { clientId?: number; macAddress?: string };
      wifiGetClients?: {};
      wifiGetConfig?: {};
      wifiGetDiagnostics?: {};
      wifiGetFirewall?: {};
      wifiGetPingMetrics?: {};
      wifiGuestInfo?: {};
      wifiRunSelfTest?: {};
      wifiSelfTest?: {};
      wifiSetClientGivenName?: {
          clientConfig?: {
              clientId?: number;
              givenName?: string;
              groupId?: string;
              macAddress?: string;
              weeklyBlockSchedules?: {
                  blockRanges?: { endMinutes?: ...; startMinutes?: ... }[];
                  groupId?: string;
              }[];
          };
          clientName?: { givenName?: string; macAddress?: string };
      };
      wifiSetConfig?: {
          wifiConfig?: {
              applyMacLan?: boolean;
              applyMacLan2ghz?: boolean;
              applyMacLan5ghz?: boolean;
              applyMacWan?: boolean;
              applyNetworkName?: boolean;
              applyNetworkName5ghz?: boolean;
              applyNetworkPassword?: boolean;
              applySetupComplete?: boolean;
              applyWifiDisabled?: boolean;
              applyWifiSecurity?: boolean;
              countryCode?: string;
              deviceId?: string;
              factoryResetTicker?: number;
              lanIpv4?: string;
              lanIpv4SubnetMask?: string;
              macLan?: string;
              macLan2ghz?: string;
              macLan5ghz?: string;
              macWan?: string;
              networkName?: string;
              networkName5ghz?: string;
              networkPassword?: string;
              setupComplete?: boolean;
              version?: number;
              wifiDisabled?: boolean;
              wifiSecurity?: WifiConfig_Security;
          };
      };
      wifiSetMeshConfig?: {
          deviceId?: string;
          meshConfig?: {
              applyAuth?: boolean;
              applyDisplayName?: boolean;
              auth?: MeshAuth;
              displayName?: string;
              hardwareVersion?: string;
              incarnation?: number;
              lastConnected?: number;
              supports5ghzHigh?: boolean;
          };
      };
      wifiSetup?: {
          networkName?: string;
          networkPassword?: string;
          skip?: boolean;
      };
  }
Returns Promise<boolean>
Inherited from GRPCApi.try_handle

Class WiFiRouter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WiFiRouter

Properties

Protectedclient

Readonlyhost

Readonlyport

Optional Readonlytimeout

Methods

close

Returns void

fetch_backhaul_stats

Returns Promise<WifiBackhaulStatsResponse>

fetch_client_history

Parameters

Returns Promise<WifiGetClientHistoryResponse>

fetch_clients

Returns Promise<WifiGetClientsResponse>

fetch_config

Returns Promise<WifiGetConfigResponse>

fetch_diagnostics

Returns Promise<StarlinkGRPC.WifiRouter.Diagnostics>

fetch_firewall

Returns Promise<WifiGetFirewallResponse>

fetch_guest_info

Returns Promise<WifiGuestInfoResponse>

fetch_history

Returns Promise<WifiGetHistoryResponse>

Protectedfetch_or_throw

Type Parameters

Parameters

Returns Promise<NonNullable<Response[K]>>

fetch_ping_metrics

Returns Promise<WifiGetPingMetricsResponse>

fetch_self_test

Returns Promise<WifiSelfTestResponse>

fetch_status

Parameters

Returns Promise<WifiGetStatusResponse>

Protectedhandle

Parameters

Returns Promise<Response>

run_self_test

Returns Promise<boolean>

set_client_given_name

Parameters

Returns Promise<boolean>

set_config

Parameters

Returns Promise<boolean>

set_mesh_config

Parameters

Returns Promise<boolean>

setup

Parameters

Returns Promise<boolean>

Protectedtry_handle

Parameters

Returns Promise<boolean>

Settings

On This Page

`Protected`client

`Readonly`host

`Readonly`port

`Optional` `Readonly`timeout

`Protected`fetch_or_throw

`Protected`handle

`Protected`try_handle