@gibme/starlink
    Preparing search index...

    Interface DeviceClient<CallOptionsExt>

    interface DeviceClient<CallOptionsExt = {}> {
        handle(
            request: {
                authenticate?: {
                    challenge?: {
                        data?: Uint8Array<ArrayBufferLike>;
                        signature?: Uint8Array<ArrayBufferLike>;
                    };
                };
                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;
                };
                dishGetContext?: {};
                dishGetObstructionMap?: {};
                dishStow?: { unstow?: boolean };
                enableFlow?: { durationH?: number; name?: string };
                epochId?: number;
                factoryReset?: {};
                fuse?: {};
                getDeviceInfo?: {};
                getDiagnostics?: {};
                getHeapDump?: {};
                getHistory?: {};
                getLocation?: {};
                getLog?: {};
                getNetworkInterfaces?: {};
                getNextId?: {};
                getPing?: {};
                getStatus?: {};
                id?: number;
                pingHost?: { address?: string };
                reboot?: {};
                restartControl?: {};
                setSku?: {
                    applyCountryCode?: boolean;
                    countryCode?: string;
                    sku?: string;
                };
                setTrustedKeys?: {
                    keys?: { capabilities?: Capability[]; key?: string }[];
                };
                signedRequest?: {
                    data?: Uint8Array<ArrayBufferLike>;
                    signature?: Uint8Array<ArrayBufferLike>;
                };
                speedTest?: {};
                targetId?: string;
                transceiverGetStatus?: {};
                transceiverGetTelemetry?: {};
                transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
                update?: {};
                wifiGetClients?: {};
                wifiGetConfig?: {};
                wifiGetDiagnostics?: {};
                wifiGetPingMetrics?: {};
                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;
                    };
                };
                wifiSetup?: {
                    networkName?: string;
                    networkPassword?: string;
                    skip?: boolean;
                };
            },
            options?: CallOptions & CallOptionsExt,
        ): Promise<Response>;
        stream(
            request: AsyncIterable<
                {
                    request?: {
                        authenticate?: {
                            challenge?: {
                                data?: Uint8Array<ArrayBufferLike>;
                                signature?: Uint8Array<ArrayBufferLike>;
                            };
                        };
                        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;
                        };
                        dishGetContext?: {};
                        dishGetObstructionMap?: {};
                        dishStow?: { unstow?: boolean };
                        enableFlow?: { durationH?: number; name?: string };
                        epochId?: number;
                        factoryReset?: {};
                        fuse?: {};
                        getDeviceInfo?: {};
                        getDiagnostics?: {};
                        getHeapDump?: {};
                        getHistory?: {};
                        getLocation?: {};
                        getLog?: {};
                        getNetworkInterfaces?: {};
                        getNextId?: {};
                        getPing?: {};
                        getStatus?: {};
                        id?: number;
                        pingHost?: { address?: string };
                        reboot?: {};
                        restartControl?: {};
                        setSku?: {
                            applyCountryCode?: boolean;
                            countryCode?: string;
                            sku?: string;
                        };
                        setTrustedKeys?: { keys?: { capabilities?: (...)[]; key?: string }[] };
                        signedRequest?: {
                            data?: Uint8Array<ArrayBufferLike>;
                            signature?: Uint8Array<ArrayBufferLike>;
                        };
                        speedTest?: {};
                        targetId?: string;
                        transceiverGetStatus?: {};
                        transceiverGetTelemetry?: {};
                        transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
                        update?: {};
                        wifiGetClients?: {};
                        wifiGetConfig?: {};
                        wifiGetDiagnostics?: {};
                        wifiGetPingMetrics?: {};
                        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;
                            };
                        };
                        wifiSetup?: {
                            networkName?: string;
                            networkPassword?: string;
                            skip?: boolean;
                        };
                    };
                },
            >,
            options?: CallOptions & CallOptionsExt,
        ): AsyncIterable<FromDevice>;
    }

    Type Parameters

    • CallOptionsExt = {}
    Index

    Methods

    Methods

    • Parameters

      • request: {
            authenticate?: {
                challenge?: {
                    data?: Uint8Array<ArrayBufferLike>;
                    signature?: Uint8Array<ArrayBufferLike>;
                };
            };
            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;
            };
            dishGetContext?: {};
            dishGetObstructionMap?: {};
            dishStow?: { unstow?: boolean };
            enableFlow?: { durationH?: number; name?: string };
            epochId?: number;
            factoryReset?: {};
            fuse?: {};
            getDeviceInfo?: {};
            getDiagnostics?: {};
            getHeapDump?: {};
            getHistory?: {};
            getLocation?: {};
            getLog?: {};
            getNetworkInterfaces?: {};
            getNextId?: {};
            getPing?: {};
            getStatus?: {};
            id?: number;
            pingHost?: { address?: string };
            reboot?: {};
            restartControl?: {};
            setSku?: { applyCountryCode?: boolean; countryCode?: string; sku?: string };
            setTrustedKeys?: { keys?: { capabilities?: Capability[]; key?: string }[] };
            signedRequest?: {
                data?: Uint8Array<ArrayBufferLike>;
                signature?: Uint8Array<ArrayBufferLike>;
            };
            speedTest?: {};
            targetId?: string;
            transceiverGetStatus?: {};
            transceiverGetTelemetry?: {};
            transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
            update?: {};
            wifiGetClients?: {};
            wifiGetConfig?: {};
            wifiGetDiagnostics?: {};
            wifiGetPingMetrics?: {};
            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;
                };
            };
            wifiSetup?: {
                networkName?: string;
                networkPassword?: string;
                skip?: boolean;
            };
        }
      • Optionaloptions: CallOptions & CallOptionsExt

      Returns Promise<Response>

    • Parameters

      • request: AsyncIterable<
            {
                request?: {
                    authenticate?: {
                        challenge?: {
                            data?: Uint8Array<ArrayBufferLike>;
                            signature?: Uint8Array<ArrayBufferLike>;
                        };
                    };
                    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;
                    };
                    dishGetContext?: {};
                    dishGetObstructionMap?: {};
                    dishStow?: { unstow?: boolean };
                    enableFlow?: { durationH?: number; name?: string };
                    epochId?: number;
                    factoryReset?: {};
                    fuse?: {};
                    getDeviceInfo?: {};
                    getDiagnostics?: {};
                    getHeapDump?: {};
                    getHistory?: {};
                    getLocation?: {};
                    getLog?: {};
                    getNetworkInterfaces?: {};
                    getNextId?: {};
                    getPing?: {};
                    getStatus?: {};
                    id?: number;
                    pingHost?: { address?: string };
                    reboot?: {};
                    restartControl?: {};
                    setSku?: {
                        applyCountryCode?: boolean;
                        countryCode?: string;
                        sku?: string;
                    };
                    setTrustedKeys?: { keys?: { capabilities?: (...)[]; key?: string }[] };
                    signedRequest?: {
                        data?: Uint8Array<ArrayBufferLike>;
                        signature?: Uint8Array<ArrayBufferLike>;
                    };
                    speedTest?: {};
                    targetId?: string;
                    transceiverGetStatus?: {};
                    transceiverGetTelemetry?: {};
                    transceiverIfLoopbackTest?: { enableIfLoopback?: boolean };
                    update?: {};
                    wifiGetClients?: {};
                    wifiGetConfig?: {};
                    wifiGetDiagnostics?: {};
                    wifiGetPingMetrics?: {};
                    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;
                        };
                    };
                    wifiSetup?: {
                        networkName?: string;
                        networkPassword?: string;
                        skip?: boolean;
                    };
                };
            },
        >
      • Optionaloptions: CallOptions & CallOptionsExt

      Returns AsyncIterable<FromDevice>