Class Dishy

Hierarchy

default
- Dishy

Index

Constructors

constructor

new Dishy(host?: string, port?: number, timeout?: number): Dishy
Parameters
- host: string = '192.168.100.1'
- port: number = 9200
- Optionaltimeout: number
Returns Dishy
Overrides GRPCApi.constructor

Properties

`Protected`client

client: DeviceClient

`Readonly`host

host: string

`Readonly`port

port: number

`Optional` `Readonly`timeout

timeout?: number

Methods

fetch_diagnostics

fetch_diagnostics(): Promise<StarlinkGRPC.Dishy.Diagnostics>
Fetches diagnostic information from a dishy

Returns Promise<StarlinkGRPC.Dishy.Diagnostics>

fetch_history

fetch_history(): Promise<DishGetHistoryResponse>
Fetches history information from a dishy

Returns Promise<DishGetHistoryResponse>

fetch_location

fetch_location(): Promise<GetLocationResponse>
Fetches location information from a dishy

Note: Location information must be enabled in the dishy settings

Returns Promise<GetLocationResponse>

fetch_obstruction_map

fetch_obstruction_map(): Promise<DishGetObstructionMapResponse>
Fetches obstruction map information from a dishy

Returns Promise<DishGetObstructionMapResponse>

fetch_status

fetch_status(): Promise<DishGetStatusResponse>
Fetches status information from a dishy

Returns Promise<DishGetStatusResponse>

`Protected`handle

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;
        };
    },
    timeout?: undefined | number,
): Promise<Response>
Protected
Performs a handle request against the GRPC server
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;
      };
  }
- timeout: undefined | number = ...
Returns Promise<Response>
Inherited from GRPCApi.handle

reboot

reboot(): Promise<boolean>
Issues a reboot request to a dishy

Returns Promise<boolean>

stow

stow(): Promise<boolean>
Issues a stow request to a dishy

Note: The dishy must support stow/unstow operations

Returns Promise<boolean>

unstow

unstow(): Promise<boolean>
Issues an unstow request to a dishy

Note: The dishy must support stow/unstow operations

Returns Promise<boolean>

Class Dishy

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Dishy

Properties

`Protected`client

`Readonly`host

`Readonly`port

`Optional` `Readonly`timeout

Methods

fetch_diagnostics

Returns Promise<StarlinkGRPC.Dishy.Diagnostics>

fetch_history

Returns Promise<DishGetHistoryResponse>

fetch_location

Returns Promise<GetLocationResponse>

fetch_obstruction_map

Returns Promise<DishGetObstructionMapResponse>

fetch_status

Returns Promise<DishGetStatusResponse>

`Protected`handle

Parameters

Returns Promise<Response>

reboot

Returns Promise<boolean>

stow

Returns Promise<boolean>

unstow

Returns Promise<boolean>

Settings

On This Page

Class Dishy

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Dishy

Properties

Protectedclient

Readonlyhost

Readonlyport

Optional Readonlytimeout

Methods

fetch_diagnostics

Returns Promise<StarlinkGRPC.Dishy.Diagnostics>

fetch_history

Returns Promise<DishGetHistoryResponse>

fetch_location

Returns Promise<GetLocationResponse>

fetch_obstruction_map

Returns Promise<DishGetObstructionMapResponse>

fetch_status

Returns Promise<DishGetStatusResponse>

Protectedhandle

Parameters

Returns Promise<Response>

reboot

Returns Promise<boolean>

stow

Returns Promise<boolean>

unstow

Returns Promise<boolean>

Settings

On This Page

`Protected`client

`Readonly`host

`Readonly`port

`Optional` `Readonly`timeout

`Protected`handle