package SpaceX.API.Device

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Handle (Request, Response)

  service.proto:10

• rpc Stream (stream ToDevice, stream FromDevice)

  service.proto:11

  message ToDevice

  device.proto:14

  • oneof message

    • Request request = 1

  message FromDevice

  device.proto:20

  • oneof message

    • Response response = 1

    • Event event = 2

Used in: Request

• optional SignedData challenge = 1

• optional string dish_id = 1

• optional string wifi_id = 2

• optional bytes nonce = 3

Used in: PublicKey

• READ = 0

• WRITE = 1

• DEBUG = 2

• ADMIN = 3

• SETUP = 4

• SET_SKU = 5

• REFRESH = 6

• READ_PRIVATE = 7

Used in: DishAuthenticateResponse, WifiAuthenticateResponse

• optional bytes signature = 1

• optional bytes certificate_chain = 2

Used in: DishGetContextResponse, DishGetStatusResponse, GetDeviceInfoResponse, WifiGetStatusResponse

• optional string id = 1

• optional string hardware_version = 2

• optional string software_version = 3

• optional string country_code = 4

• optional int32 utc_offset_s = 5

Used in: DishGetContextResponse, DishGetStatusResponse, WifiGetStatusResponse

• optional uint64 uptime_s = 1

Used in: DishGetStatusResponse

• optional bool motors_stuck = 1

• optional bool thermal_throttle = 3

• optional bool thermal_shutdown = 2

• optional bool mast_not_near_vertical = 5

• optional bool unexpected_location = 4

• optional bool slow_ethernet_speeds = 6

Used in: Response

• optional ChallengeResponse dish = 2

Used in: Request

• optional double theta = 1

• optional double phi = 2

• optional uint32 rx_chan = 3

• optional uint32 tx_chan = 4

• optional uint32 modulation = 5

• optional double desired_tilt_angle = 7

• optional bool chan_override = 8

• optional bool theta_enabled = 9

• optional bool phi_enabled = 10

• optional bool idle = 11

• optional bool fast_switching = 12

• optional bool sky_search = 13

• optional bool force_pll_unlock = 14

• optional bool force_eirp_failure = 15

• optional bool snow_active_override = 16

• optional bool manual_tilting = 18

• optional bool tilt_to_stowed = 19

• optional bool reboot = 20

Used in: Response

• optional bool is_test_device = 1

• optional string uuid = 2

• optional uint64 timestamp = 3

• optional string state = 4

• optional string sky_search_state = 5

• optional float snr = 6

• optional float seconds_until_schedule = 7

• optional double snr_uptime = 8

• optional double cplane_uptime = 9

• optional double percent_scheduled = 10

• optional uint32 cplane_updates = 11

• optional double downlink_throughput = 12

• optional double uplink_throughput = 13

• optional bool connected = 14

• optional int32 sys_uptime = 15

• optional double gps_latitude = 16

• optional double gps_longitude = 17

• optional double gps_pdop = 18

• optional uint32 rf_mode = 19

• optional double phi = 20

• optional double theta = 21

• optional uint32 rx_channel = 22

• optional uint32 tx_channel = 23

• optional float t_dbf_max = 24

• optional double t_center = 25

• optional double baseline_heating = 26

• optional double additional_heating = 27

• optional double total_heating = 28

• optional double target_total_heating = 29

• optional bool auto_power_snow_melt_enabled = 30

• optional double voltage = 32

• optional uint32 rx_beam_state = 33

• optional uint32 tx_beam_state = 34

• optional uint32 half_duplex_state = 35

• optional bool manual_tilt_enabled = 36

• optional double tilt_angle = 37

• optional uint32 pll_tx_lock_detected = 38

• optional bool eirp_exceeded_threshold = 39

• optional float eirp_scale_override = 40

• optional bool idle_override_enabled = 41

• optional bool theta_override_enabled = 42

• optional double theta_override_value = 43

• optional bool phi_override_enabled = 44

• optional double phi_override_value = 45

• optional uint32 rx_chan_override_value = 46

• optional uint32 tx_chan_override_value = 47

• optional bool sky_search_override_enabled = 48

• optional bool fast_switching_enabled = 49

• optional uint32 modulation_override_value = 50

• optional bool force_eirp_failure = 51

• optional bool force_pll_unlock = 52

• optional uint32 ut_ine_success = 53

• optional bool rf_ready = 54

Used in: Request

(message has no fields)

Used in: Response

• optional DeviceInfo device_info = 1

• optional DeviceState device_state = 7

• optional float obstruction_fraction = 2

• optional float obstruction_valid_s = 3

• optional uint32 cell_id = 4

• optional uint32 pop_rack_id = 5

• optional uint32 initial_satellite_id = 8

• optional uint32 initial_gateway_id = 9

• optional bool on_backup_beam = 10

• optional float seconds_to_slot_end = 6

Used in: Response

• optional uint64 current = 1

• repeated float pop_ping_drop_rate = 1001

• repeated float pop_ping_latency_ms = 1002

• repeated float downlink_throughput_bps = 1003

• repeated float uplink_throughput_bps = 1004

• repeated float snr = 1005

• repeated bool scheduled = 1006

• repeated bool obstructed = 1007

Used in: Request

(message has no fields)

Used in: Response

• optional uint32 num_rows = 1

• optional uint32 num_cols = 2

• repeated float snr = 3

Used in: Response

• optional DeviceInfo device_info = 1

• optional DeviceState device_state = 2

• optional DishState state = 1006

• optional DishAlerts alerts = 1005

• optional float snr = 1001

• optional float seconds_to_first_nonempty_slot = 1002

• optional float pop_ping_drop_rate = 1003

• optional float downlink_throughput_bps = 1007

• optional float uplink_throughput_bps = 1008

• optional float pop_ping_latency_ms = 1009

• optional DishObstructionStats obstruction_stats = 1004

• optional bool stow_requested = 1010

• optional DishOutage outage = 1014

Used in: DishGetStatusResponse

• optional bool currently_obstructed = 5

• optional float fraction_obstructed = 1

• optional float last_24h_obstructed_s = 1006

• optional float valid_s = 4

• repeated float wedge_fraction_obstructed = 2

• repeated float wedge_abs_fraction_obstructed = 3

Used in: DishGetStatusResponse

• DishOutage.Cause cause = 1

• int64 start_timestamp_ns = 2

• uint64 duration_ns = 3

• bool did_switch = 4

Used in: DishOutage

• UNKNOWN = 0

• BOOTING = 1

• STOWED = 2

• THERMAL_SHUTDOWN = 3

• NO_SCHEDULE = 4

• NO_SATS = 5

• OBSTRUCTED = 6

• NO_DOWNLINK = 7

• NO_PINGS = 8

Used in: DishGetStatusResponse, TransceiverGetStatusResponse

• UNKNOWN = 0

• CONNECTED = 1

• SEARCHING = 2

• BOOTING = 3

Used in: Request

• optional bool unstow = 1

Used in: Response

(message has no fields)

Used in: GetLocationResponse

• optional double x = 1

• optional double y = 2

• optional double z = 3

Used in: Request

• optional string name = 1

• optional uint32 duration_h = 2

Used in: Response

(message has no fields)

Used in: NetworkInterface

• optional bool link_detected = 1

• optional uint32 speed_mbps = 2

• optional bool autonegotiation_on = 3

• optional EthernetNetworkInterface.Duplex duplex = 4

Used in: EthernetNetworkInterface

• UNKNOWN = 0

• HALF = 1

• FULL = 2

Used in: FromDevice

• oneof event

  • WifiNewClientConnectedEvent wifi_new_client_connected = 3001

  • WifiAccountBondingEvent wifi_account_bonding = 3002

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

Used in: Request

(message has no fields)

Used in: Response

• optional DeviceInfo device_info = 1

Used in: Request

(message has no fields)

Used in: Response

• optional string heap_dump = 1

Used in: Request

(message has no fields)

Used in: Request

(message has no fields)

Used in: Response

• optional LLAPosition lla = 1

• optional ECEFPosition ecef = 2

Used in: Request

(message has no fields)

Used in: Response

• optional string syslog = 1

• optional string offline_log = 2

Used in: Request

(message has no fields)

Used in: Response

• repeated NetworkInterface network_interfaces = 1006

Used in: Request

(message has no fields)

Used in: Response

• optional uint64 id = 1

• optional uint64 epoch_id = 2

Used in: Request

(message has no fields)

Used in: Response

• repeated GetPingResponse.ResultsEntry results = 1

Used in: GetPingResponse

• optional string key = 1

• optional PingResult value = 2

Used in: Request

(message has no fields)

Used in: GetLocationResponse

• optional double lat = 1

• optional double lon = 2

• optional double alt = 3

Used in: GetNetworkInterfacesResponse

• optional string name = 1

• optional NetworkInterface.RxStats rx_stats = 2

• optional NetworkInterface.TxStats tx_stats = 3

• oneof interface

  • EthernetNetworkInterface ethernet = 1000

  • WifiNetworkInterface wifi = 1001

Used in: NetworkInterface

• optional uint64 bytes = 1

• optional uint64 packets = 2

• optional uint64 frame_errors = 3

Used in: NetworkInterface

• optional uint64 bytes = 1

• optional uint64 packets = 2

Used in: Request

• optional string address = 3

Used in: Response

• optional PingResult result = 1

Used in: WifiGetPingMetricsResponse

• optional float latency_mean_ms = 1

• optional float latency_stddev_ms = 2

• optional float latency_mean_ms_5m = 3

• optional float latency_mean_ms_1h = 4

• optional float latency_mean_ms_1d = 5

• optional float drop_rate = 6

• optional float drop_rate_5m = 7

• optional float drop_rate_1h = 8

• optional float drop_rate_1d = 9

• optional float seconds_since_last_success = 10

• optional float seconds_since_last_1s_outage = 11

• optional float seconds_since_last_2s_outage = 15

• optional float seconds_since_last_5s_outage = 12

• optional float seconds_since_last_15s_outage = 18

• optional float seconds_since_last_60s_outage = 19

• optional float seconds_since_last_300s_outage = 20

• optional float happy_hours_1s_1d = 13

• optional float happy_hours_2s_1d = 16

• optional float happy_hours_5s_1d = 14

Used in: GetPingResponse.ResultsEntry, PingHostResponse

• optional PingTarget target = 3

• optional float dropRate = 1

• optional float latencyMs = 2

Used in: PingResult

• optional string service = 1

• optional string location = 2

• optional string address = 3

Used in: SetTrustedKeysRequest

• optional string key = 1

• repeated Capability capabilities = 2

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

Used as request type in: Device.Handle

Used as field type in: ToDevice

• optional uint64 id = 1

• optional uint64 epoch_id = 14

• optional string target_id = 13

• oneof request

  • SignedData signed_request = 15

  • GetNextIdRequest get_next_id = 1006

  • AuthenticateRequest authenticate = 1005

  • EnableFlowRequest enable_flow = 1018

  • FactoryResetRequest factory_reset = 1011

  • GetDeviceInfoRequest get_device_info = 1008

  • GetHistoryRequest get_history = 1007

  • GetLogRequest get_log = 1012

  • GetNetworkInterfacesRequest get_network_interfaces = 1015

  • GetPingRequest get_ping = 1009

  • PingHostRequest ping_host = 1016

  • GetStatusRequest get_status = 1004

  • RebootRequest reboot = 1001

  • SetSkuRequest set_sku = 1013

  • SetTrustedKeysRequest set_trusted_keys = 1010

  • SpeedTestRequest speed_test = 1003

  • UpdateRequest update = 1014

  • GetLocationRequest get_location = 1017

  • GetHeapDumpRequest get_heap_dump = 1019

  • RestartControlRequest restart_control = 1020

  • FuseRequest fuse = 1021

  • DishStowRequest dish_stow = 2002

  • DishGetContextRequest dish_get_context = 2003

  • DishGetObstructionMapRequest dish_get_obstruction_map = 2008

  • DishEmcRequest dish_emc = 2007

  • TransceiverIFLoopbackTestRequest transceiver_if_loopback_test = 4001

  • TransceiverGetStatusRequest transceiver_get_status = 4003

  • TransceiverGetTelemetryRequest transceiver_get_telemetry = 4004

  • WifiGetClientsRequest wifi_get_clients = 3002

  • WifiGetDiagnosticsRequest wifi_get_diagnostics = 3008

  • WifiGetPingMetricsRequest wifi_get_ping_metrics = 3007

  • WifiSetConfigRequest wifi_set_config = 3001

  • WifiGetConfigRequest wifi_get_config = 3009

  • WifiSetupRequest wifi_setup = 3003

Used as response type in: Device.Handle

Used as field type in: FromDevice

• optional uint64 id = 1

• optional Status.Status status = 2

• optional uint64 api_version = 3

• oneof response

  • GetNextIdResponse get_next_id = 1006

  • EnableFlowResponse enable_flow = 1018

  • FactoryResetResponse factory_reset = 1011

  • GetDeviceInfoResponse get_device_info = 1004

  • GetLogResponse get_log = 1012

  • GetNetworkInterfacesResponse get_network_interfaces = 1015

  • GetPingResponse get_ping = 1009

  • PingHostResponse ping_host = 1016

  • RebootResponse reboot = 1001

  • SpeedTestResponse speed_test = 1003

  • SetSkuResponse set_sku = 1013

  • SetTrustedKeysResponse set_trusted_keys = 1010

  • UpdateResponse update = 1014

  • GetLocationResponse get_location = 1017

  • GetHeapDumpResponse get_heap_dump = 1019

  • RestartControlResponse restart_control = 1020

  • FuseResponse fuse = 1021

  • DishAuthenticateResponse dish_authenticate = 2005

  • DishGetContextResponse dish_get_context = 2003

  • DishGetHistoryResponse dish_get_history = 2006

  • DishGetStatusResponse dish_get_status = 2004

  • DishGetObstructionMapResponse dish_get_obstruction_map = 2008

  • DishStowResponse dish_stow = 2002

  • DishEmcResponse dish_emc = 2007

  • TransceiverIFLoopbackTestResponse transceiver_if_loopback_test = 4001

  • TransceiverGetStatusResponse transceiver_get_status = 4003

  • TransceiverGetTelemetryResponse transceiver_get_telemetry = 4004

  • WifiAuthenticateResponse wifi_authenticate = 3005

  • WifiGetClientsResponse wifi_get_clients = 3002

  • WifiGetDiagnosticsResponse wifi_get_diagnostics = 3008

  • WifiGetHistoryResponse wifi_get_history = 3006

  • WifiGetPingMetricsResponse wifi_get_ping_metrics = 3007

  • WifiGetStatusResponse wifi_get_status = 3004

  • WifiSetConfigResponse wifi_set_config = 3001

  • WifiGetConfigResponse wifi_get_config = 3009

  • WifiSetupResponse wifi_setup = 3003

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

Used in: Request

• optional string sku = 1

• optional string country_code = 2

• optional bool apply_country_code = 4

Used in: Response

(message has no fields)

Used in: Request

• repeated PublicKey keys = 1

Used in: Response

(message has no fields)

Used in: AuthenticateRequest, Request, WifiAuthenticateRequest

• optional bytes data = 1

• optional bytes signature = 2

Used in: Request

(message has no fields)

Used in: Response

• optional float download_bps = 1

• optional float upload_bps = 2

• optional float latency_s = 3

• optional float download_mbps = 4

• optional float upload_mbps = 5

• optional float latency_ms = 6

• optional float download_mbps_1_tcp_conn = 7

• optional float upload_mbps_1_tcp_conn = 8

• optional float download_mbps_4_tcp_conn = 9

• optional float upload_mbps_4_tcp_conn = 10

• optional float download_mbps_16_tcp_conn = 11

• optional float upload_mbps_16_tcp_conn = 12

• optional float download_mbps_64_tcp_conn = 13

• optional float upload_mbps_64_tcp_conn = 14

Used in: TransceiverGetStatusResponse

• optional bool over_temp_modem_asic_fault = 1

• optional bool over_temp_pcba_fault = 2

• optional bool dc_voltage_fault = 3

Used in: Request

(message has no fields)

Used in: Response

• optional TransceiverModulatorState mod_state = 1

• optional TransceiverModulatorState demod_state = 2

• optional TransceiverTxRxState tx_state = 3

• optional TransceiverTxRxState rx_state = 4

• optional DishState state = 1006

• optional TransceiverFaults faults = 1007

• optional TransceiverTransmitBlankingState transmit_blanking_state = 1008

• optional float modem_asic_temp = 1009

• optional float tx_if_temp = 1010

Used in: Request

(message has no fields)

Used in: Response

• optional uint32 antenna_pointing_mode = 1001

• optional float antenna_pitch = 1002

• optional float antenna_roll = 1003

• optional float antenna_rx_theta = 1004

• optional float antenna_true_heading = 1005

• optional uint32 rx_channel = 1006

• optional uint32 current_cell_id = 1007

• optional float seconds_until_slot_end = 1008

• optional float wb_rssi_peak_mag_db = 1009

• optional float pop_ping_drop_rate = 1010

• optional float snr_db = 1011

• optional float l1_snr_avg_db = 1012

• optional float l1_snr_min_db = 1013

• optional float l1_snr_max_db = 1014

• optional uint32 lmac_satellite_id = 1015

• optional uint32 target_satellite_id = 1016

• optional uint32 grant_mcs = 1017

• optional float grant_symbols_avg = 1018

• optional uint32 ded_grant = 1019

• optional uint32 mobility_proactive_slot_change = 1020

• optional uint32 mobility_reactive_slot_change = 1021

• optional uint32 rfp_total_syn_failed = 1022

• optional uint32 num_out_of_seq = 1023

• optional uint32 num_ulmap_drop = 1024

• optional float current_seconds_of_schedule = 1025

• optional uint32 send_label_switch_to_ground_failed_calls = 1026

• optional double ema_velocity_x = 1027

• optional double ema_velocity_y = 1028

• optional double ema_velocity_z = 1029

• optional float ce_rssi_db = 1030

Used in: Request

• optional bool enable_if_loopback = 1

Used in: Response

• optional float ber_loopback_test = 1

• optional float snr_loopback_test = 2

• optional float rssi_loopback_test = 3

• optional bool pll_lock = 4

Used in: TransceiverGetStatusResponse

• MODSTATE_UNKNOWN = 0

• MODSTATE_ENABLED = 1

• MODSTATE_DISABLED = 2

Used in: TransceiverGetStatusResponse

• TB_UNKNOWN = 0

• TB_ENABLED = 1

• TB_DISABLED = 2

Used in: TransceiverGetStatusResponse

• TXRX_UNKNOWN = 0

• TXRX_ENABLED = 1

• TXRX_DISABLED = 2

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

Used in: Event

• optional string dish_id = 1

• optional SignedData challenge = 1

Used in: Response

• optional ChallengeResponse wifi = 1

• optional ChallengeResponse dish = 2

Used in: WifiGetClientsResponse, WifiGetStatusResponse, WifiNewClientConnectedEvent

• optional string name = 1

• optional string mac_address = 2

• optional string ip_address = 3

• optional float signal_strength = 4

• optional WifiClient.RxStats rx_stats = 5

• optional WifiClient.TxStats tx_stats = 6

• optional uint32 associated_time_s = 7

• optional string mode_str = 8

• optional WifiClient.Interface iface = 9

• optional float snr = 10

• optional int32 psmode = 11

Used in: WifiClient

• UNKNOWN = 0

• ETH = 1

• RF_2GHZ = 2

• RF_5GHZ = 3

Used in: WifiClient

• optional uint64 bytes = 1

• optional uint64 count_errors = 2

• optional int32 nss = 3

Used in: WifiClient

• optional uint64 bytes = 1

• optional uint64 success_bytes = 2

• optional int32 nss = 3

Used in: WifiGetConfigResponse, WifiSetConfigRequest, WifiSetConfigResponse

• optional string network_name = 1

• optional bool apply_network_name = 1001

• optional string network_password = 2

• optional bool apply_network_password = 1002

• optional string country_code = 3

• optional bool wifi_disabled = 4

• optional bool apply_wifi_disabled = 1003

• optional string lan_ipv4 = 5

• optional string lan_ipv4_subnet_mask = 6

• optional bool setup_complete = 7

• optional bool apply_setup_complete = 1010

• optional uint32 factory_reset_ticker = 8

• optional uint32 version = 9

• optional WifiConfig.Security wifi_security = 10

• optional bool apply_wifi_security = 1004

• optional string network_name_5ghz = 11

• optional bool apply_network_name_5ghz = 1005

• optional string mac_wan = 12

• optional bool apply_mac_wan = 1006

• optional string mac_lan = 13

• optional bool apply_mac_lan = 1007

• optional string mac_lan_2ghz = 14

• optional bool apply_mac_lan_2ghz = 1008

• optional string mac_lan_5ghz = 15

• optional bool apply_mac_lan_5ghz = 1009

• optional string device_id = 16

Used in: WifiConfig

• UNKNOWN = 0

• WPA2 = 1

• WPA3 = 2

• WPA2WPA3 = 3

Used in: Request

(message has no fields)

Used in: Response

• repeated WifiClient clients = 1

Used in: Request

(message has no fields)

Used in: Response

• optional WifiConfig wifi_config = 1

Used in: Request

(message has no fields)

Used in: Response

• optional WifiScanResults network_scan = 1

• repeated WifiNetwork wifi_networks = 2

Used in: Response

• optional uint64 current = 1

• repeated float ping_drop_rate = 1001

• repeated float ping_latency_ms = 1002

Used in: Request

(message has no fields)

Used in: Response

• optional PingMetrics internet = 1

Used in: Response

• optional DeviceInfo device_info = 3

• optional DeviceState device_state = 4

• optional bool captive_portal_enabled = 1

• repeated WifiClient clients = 2

• optional string serial_number = 1001

• optional string sku = 1002

• optional string ipv4_wan_address = 1003

• optional float ping_drop_rate = 1004

• optional float ping_latency_ms = 1005

Used in: WifiGetDiagnosticsResponse

• optional WifiNetwork.Band band = 1

• optional string ssid = 2

• optional uint32 channel = 3

• optional string encryption_type_str = 4

Used in: WifiNetwork

• WIFI_UNKNOWN = 0

• WIFI_2_4GHZ = 1

• WIFI_5GHZ = 2

Used in: NetworkInterface

• optional WifiNetworkInterface.ThermalStatus thermal_status = 1

Used in: WifiNetworkInterface

• optional uint32 level = 1

• optional uint32 temp = 2

Used in: Event

• optional WifiClient client = 1

Used in: WifiGetDiagnosticsResponse

• repeated WifiScanResults.Network networks = 1

Used in: WifiScanResults

• optional Network.Source source = 1

• optional string ssid = 2

• optional string bssid = 3

• optional string frequency_ghz = 4

• optional int32 channel = 5

• optional int32 signal_level_dbm = 6

• optional int32 noise_level_dbm = 7

• optional bool has_encryption_key = 8

• optional string phy_mode_str = 9

Used in: Network

• UNKNOWN = 0

• SCAN_2_4GHZ = 1

• SCAN_5GHZ = 2

Used in: Request

• optional WifiConfig wifi_config = 1

Used in: Response

• optional WifiConfig updated_wifi_config = 1

Used in: Request

• optional bool skip = 1

• optional string network_name = 2

• optional string network_password = 3

Used in: Response

(message has no fields)