jeff/starlink-grpc-tools
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

A few doc string updates

Browse source 
Reword the is_snr_above_noise_floor description to be more consistent with the rest of the field docs.

Correct the order the status field groups in the docs for the functions that return them to reflect the actual order in which they are returned.
This commit is contained in:
sparky8512 2022-08-28 09:07:24 -07:00
parent 40713e1426
commit feccac23ee
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
starlink_grpc.py
View file

@ -81,7 +81,9 @@ This group holds information about the current state of the user terminal.
terminal is communicating. terminal is communicating.
: **direction_elevation** : Elevation angle, in degrees, of the direction in : **direction_elevation** : Elevation angle, in degrees, of the direction in
which the user terminal's dish antenna is physically pointing. which the user terminal's dish antenna is physically pointing.
: **is_snr_above_noise_floor** : True if SNR is more than 3dB above the noise floor. : **is_snr_above_noise_floor** : Boolean indicating whether or not the dish
considers the signal to noise ratio to be above some minimum threshold for
connectivity, currently 3dB.
Obstruction detail status data Obstruction detail status data
------------------------------ ------------------------------
@ -449,8 +451,8 @@ def status_field_names(context: Optional[ChannelContext] = None):
with reflection service. with reflection service.
Returns: Returns:
A tuple with 3 lists, with status data field names, alert detail field A tuple with 3 lists, with status data field names, obstruction detail
names, and obstruction detail field names, in that order. field names, and alert detail field names, in that order.
Raises: Raises:
GrpcError: No user terminal is currently available to resolve imports GrpcError: No user terminal is currently available to resolve imports
@ -504,8 +506,8 @@ def status_field_types(context: Optional[ChannelContext] = None):
with reflection service. with reflection service.
Returns: Returns:
A tuple with 3 lists, with status data field types, alert detail field A tuple with 3 lists, with status data field types, obstruction detail
types, and obstruction detail field types, in that order. field types, and alert detail field types, in that order.
Raises: Raises:
GrpcError: No user terminal is currently available to resolve imports GrpcError: No user terminal is currently available to resolve imports
@ -595,8 +597,8 @@ def status_data(context: Optional[ChannelContext] = None):
across repeated calls. across repeated calls.
Returns: Returns:
A tuple with 3 dicts, mapping status data field names, alert detail A tuple with 3 dicts, mapping status data field names, obstruction
field names, and obstruction detail field names to their respective detail field names, and alert detail field names to their respective
values, in that order. values, in that order.
Raises: Raises: