starlink-grpc-tools/dump_dish_status.py

#!/usr/bin/python3
"""Simple example of get_status request using grpc call directly."""

import sys

import grpc

try:
    from spacex.api.device import device_pb2
    from spacex.api.device import device_pb2_grpc
except ModuleNotFoundError:
    print("This script requires the generated gRPC protocol modules. See README file for details.",
          file=sys.stderr)
    sys.exit(1)

# Note that if you remove the 'with' clause here, you need to separately
# call channel.close() when you're done with the gRPC connection.
with grpc.insecure_channel("192.168.100.1:9200") as channel:
    stub = device_pb2_grpc.DeviceStub(channel)
    response = stub.Handle(device_pb2.Request(get_status={}), timeout=10)

# Dump everything
print(response)

# Just the software version
print("Software version:", response.dish_get_status.device_info.software_version)

# Check if connected
print("Not connected" if response.dish_get_status.HasField("outage") else "Connected")
Last of initial set of scripts 2020-12-22 22:16:33 -06:00			`#!/usr/bin/python3`
Switch generated protobuf module imports around The way I had them, it was hiding the fact that there was no explicit import for the spacex.api.device.dish_pb2 module. 2021-02-04 22:02:45 -06:00			`"""Simple example of get_status request using grpc call directly."""`
Clean up the simple example script and add new one This adds an example script for the starlink_grpc module. It's a kinda silly thing, but I threw it together to better understand some of the status data, so I figured I'd upload it, since the other example is for direct grpc usage (or for starlink_json if parseJsonHistory can be considered an example). Rename dishDumpStatus so pylint will stop complaining about the module name. The only script left with my old naming convention now is parseJsonHistory.py. 2021-02-01 22:47:18 -06:00
Emit specific error if protocol modules not found This has now tripped up more than one user (see issues #47 and #53). There is a note in the README about this, but it's easy to miss if you don't read it thoroughly. 2022-08-17 15:59:22 -05:00			`import sys`

Last of initial set of scripts 2020-12-22 22:16:33 -06:00			`import grpc`

Emit specific error if protocol modules not found This has now tripped up more than one user (see issues #47 and #53). There is a note in the README about this, but it's easy to miss if you don't read it thoroughly. 2022-08-17 15:59:22 -05:00			`try:`
			`from spacex.api.device import device_pb2`
			`from spacex.api.device import device_pb2_grpc`
			`except ModuleNotFoundError:`
Address a bunch of pylint and yapf complaints I don't necessarily think all of these make the code better or easier to read, but it's easier to just go along with what the tools want, since they do generally make things better. There should be no functional changes here. 2022-09-14 14:55:50 -05:00			`print("This script requires the generated gRPC protocol modules. See README file for details.",`
Emit specific error if protocol modules not found This has now tripped up more than one user (see issues #47 and #53). There is a note in the README about this, but it's easy to miss if you don't read it thoroughly. 2022-08-17 15:59:22 -05:00			`file=sys.stderr)`
			`sys.exit(1)`
Last of initial set of scripts 2020-12-22 22:16:33 -06:00
Handle errors on the gRPC connection Also, actually do the thing I said I was doing in the prior checkin by writing state as a string instead of integer. And a bit more cleanup. 2020-12-30 12:17:02 -06:00			`# Note that if you remove the 'with' clause here, you need to separately`
			`# call channel.close() when you're done with the gRPC connection.`
Readability improvements (or so PEP 8 style guide claims...) 2021-01-06 12:12:56 -06:00			`with grpc.insecure_channel("192.168.100.1:9200") as channel:`
Revert "Make dish_obstruction_map work in Docker image" This reverts commit 1545b0fcc960bb60f5010dea957b0079fe4c1c4b. 2022-12-01 19:51:24 -06:00			`stub = device_pb2_grpc.DeviceStub(channel)`
			`response = stub.Handle(device_pb2.Request(get_status={}), timeout=10)`
Last of initial set of scripts 2020-12-22 22:16:33 -06:00
More example usage, commented out 2020-12-23 09:25:30 -06:00			`# Dump everything`
Last of initial set of scripts 2020-12-22 22:16:33 -06:00			`print(response)`
More example usage, commented out 2020-12-23 09:25:30 -06:00
Clean up the simple example script and add new one This adds an example script for the starlink_grpc module. It's a kinda silly thing, but I threw it together to better understand some of the status data, so I figured I'd upload it, since the other example is for direct grpc usage (or for starlink_json if parseJsonHistory can be considered an example). Rename dishDumpStatus so pylint will stop complaining about the module name. The only script left with my old naming convention now is parseJsonHistory.py. 2021-02-01 22:47:18 -06:00			`# Just the software version`
			`print("Software version:", response.dish_get_status.device_info.software_version)`
More example usage, commented out 2020-12-23 09:25:30 -06:00
Clean up the simple example script and add new one This adds an example script for the starlink_grpc module. It's a kinda silly thing, but I threw it together to better understand some of the status data, so I figured I'd upload it, since the other example is for direct grpc usage (or for starlink_json if parseJsonHistory can be considered an example). Rename dishDumpStatus so pylint will stop complaining about the module name. The only script left with my old naming convention now is parseJsonHistory.py. 2021-02-01 22:47:18 -06:00			`# Check if connected`
Fix this silly example script This never got updated to the gRPC protocol changes that happened almost a year ago. This should address part 4 of issue #45. 2022-05-25 18:41:07 -05:00			`print("Not connected" if response.dish_get_status.HasField("outage") else "Connected")`