Skip to content

Commit 3f290df

Browse files
committed
remove indentation from comments to pass build docs check
1 parent bf3e31d commit 3f290df

File tree

1 file changed

+28
-23
lines changed

1 file changed

+28
-23
lines changed

adafruit_rockblock.py

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ def rssi(self):
222222
"""Return Received Signal Strength Indicator (RSSI)
223223
values returned are 0 to 5, where 0 is no signal (0 bars) and 5 is strong signal (5 bars).
224224
Important note: signal strength may not be fully accurate, so
225-
waiting for high signal strength prior to sending a message isn't always recommended.
225+
waiting for high signal strength prior to sending a message isn't always recommended.
226226
For details see https://docs.rockblock.rock7.com/docs/checking-the-signal-strength
227227
"""
228228
resp = self._uart_xfer("+CSQ")
@@ -275,14 +275,16 @@ def ring_indication(self):
275275
The response contains separate indications for telephony and SBD ring indications.
276276
The response is in the form:
277277
[<tel_ri>,<sbd_ri>]
278-
where <tel_ri> indicates the telephony ring indication status:
279-
0 No telephony ring alert received.
280-
1 Incoming voice call.
281-
2 Incoming data call.
282-
3 Incoming fax call.
283-
and <sbd_ri> indicates the SBD ring indication status:
284-
0 No SBD ring alert received.
285-
1 SBD ring alert received.
278+
279+
<tel_ri> indicates the telephony ring indication status:
280+
0 No telephony ring alert received.
281+
1 Incoming voice call.
282+
2 Incoming data call.
283+
3 Incoming fax call.
284+
285+
<sbd_ri> indicates the SBD ring indication status:
286+
0 No SBD ring alert received.
287+
1 SBD ring alert received.
286288
"""
287289
resp = self._uart_xfer("+CRIS")
288290
if resp[-1].strip().decode() == "OK":
@@ -296,22 +298,25 @@ def geolocation(self):
296298
and the current time based on the Iridium network timestamp.
297299
The response is in the form:
298300
[<x>,<y>,<z>,<timestamp>]
301+
299302
<x>,<y>,<z> is a geolocation grid code from an earth centered Cartesian coordinate system,
300-
using dimensions, x, y, and z, to specify location. The coordinate system is aligned
301-
such that the z-axis is aligned with the north and south poles, leaving the x-axis
302-
and y-axis to lie in the plane containing the equator. The axes are aligned such that
303-
at 0 degrees latitude and 0 degrees longitude, both y and z are zero and
304-
x is positive (x = +6376, representing the nominal earth radius in kilometres).
305-
Each dimension of the geolocation grid code is displayed in decimal form using
306-
units of kilometres. Each dimension of the geolocation grid code has a minimum value
307-
of –6376, a maximum value of +6376, and a resolution of 4.
303+
using dimensions, x, y, and z, to specify location. The coordinate system is aligned
304+
such that the z-axis is aligned with the north and south poles, leaving the x-axis
305+
and y-axis to lie in the plane containing the equator. The axes are aligned such that
306+
at 0 degrees latitude and 0 degrees longitude, both y and z are zero and
307+
x is positive (x = +6376, representing the nominal earth radius in kilometres).
308+
Each dimension of the geolocation grid code is displayed in decimal form using
309+
units of kilometres. Each dimension of the geolocation grid code has a minimum value
310+
of –6376, a maximum value of +6376, and a resolution of 4.
308311
This geolocation coordinate system is known as ECEF (acronym earth-centered, earth-fixed),
309-
also known as ECR (initialism for earth-centered rotational)
312+
also known as ECR (initialism for earth-centered rotational)
310313
314+
<timestamp> is a time_struct
311315
The timestamp is assigned by the modem when the geolocation grid code received from
312-
the network is stored to the modem's internal memory.
316+
the network is stored to the modem's internal memory.
313317
The timestamp used by the modem is Iridium system time, which is a running count of
314-
90 millisecond intervals, since Sunday May 11, 2014, at 14:23:55 UTC.
318+
90 millisecond intervals, since Sunday May 11, 2014, at 14:23:55 UTC.
319+
The timestamp returned by the modem is a 32-bit integer displayed in hexadecimal form.
315320
We convert the modem's timestamp and return it as a time_struct.
316321
"""
317322
resp = self._uart_xfer("-MSGEO")
@@ -353,9 +358,9 @@ def timestamp(self):
353358
"""
354359
Return the current date and time as given by the Iridium network
355360
The timestamp is assigned by the modem when the geolocation grid code received from
356-
the network is stored to the modem's internal memory.
361+
the network is stored to the modem's internal memory.
357362
The timestamp used by the modem is Iridium system time, which is a running count of
358-
90 millisecond intervals, since Sunday May 11, 2014, at 14:23:55 UTC.
363+
90 millisecond intervals, since Sunday May 11, 2014, at 14:23:55 UTC.
359364
We convert the modem's timestamp and return it as a time_struct.
360365
"""
361366
resp = self._uart_xfer("-MSSTM")
@@ -371,7 +376,7 @@ def timestamp(self):
371376

372377
# milliseconds to seconds\
373378
# hack to divide by 1000 and avoid using limited floating point math which throws the
374-
# calculations off quite a bit, this should be accurate to 1 second or so
379+
# calculations off quite a bit, this should be accurate to 1 second or so
375380
ms_str = str(ms_since_epoch)
376381
substring = ms_str[0 : len(ms_str) - 3]
377382
secs_since_epoch = int(substring)

0 commit comments

Comments
 (0)