Skip to content

Commit a6342ef

Browse files
committed
GPS.md: Clarify platform options.
1 parent bc90dbc commit a6342ef

File tree

2 files changed

+26
-19
lines changed

2 files changed

+26
-19
lines changed

v3/as_drivers/as_GPS/as_tGPS.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
# as_tGPS.py Using GPS for precision timing and for calibrating Pyboard RTC
2-
# This is STM-specific: requires pyb module.
3-
# Hence not as RAM-critical as as_GPS
42

53
# Copyright (c) 2018-2020 Peter Hinch
64
# Released under the MIT License (MIT) - see LICENSE file

v3/docs/GPS.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -156,12 +156,16 @@ time.sleep(1)
156156
## 2.2 Library installation
157157

158158
The library is implemented as a Python package. To install copy the following
159-
directories and their contents to the target hardware:
160-
1. `as_drivers/as_GPS`
161-
2. `threadsafe` Required for timing applications only.
159+
directory and its contents to the target hardware:
160+
* `as_drivers/as_GPS`
161+
162+
The following directory is required for certain Pyboard-specific test scripts:
163+
* `threadsafe`
164+
165+
See [section 10.3](./GPS.md#103-files-for-timing-applications).
162166

163167
On platforms with an underlying OS such as the Raspberry Pi ensure that the
164-
directories are on the Python path and that the Python version is 3.8 or later.
168+
directory is on the Python path and that the Python version is 3.8 or later.
165169
Code samples will need adaptation for the serial port.
166170

167171
## 2.3 Dependency
@@ -1055,33 +1059,38 @@ applications will not need the read/write or timing files.
10551059

10561060
* `as_GPS.py` The library. Supports the `AS_GPS` class for read-only access to
10571061
GPS hardware.
1058-
* `as_GPS_utils.py` Additional formatted string methods for `AS_GPS`.
1059-
* `ast_pb.py` Test/demo program: assumes a MicroPython hardware device with
1060-
GPS connected to UART 4.
1062+
* `as_GPS_utils.py` Additional formatted string methods for `AS_GPS`. On
1063+
RAM-constrained devices this may be omitted in which case the `date_string`
1064+
and `compass_direction` methods will be unavailable.
1065+
1066+
Demos. Written for Pyboard but readily portable.
1067+
* `ast_pb.py` Test/demo program: assumes a Pyboard with GPS connected to UART 4.
10611068
* `log_kml.py` A simple demo which logs a route travelled to a .kml file which
10621069
may be displayed on Google Earth.
10631070

1064-
On RAM-constrained devices `as_GPS_utils.py` may be omitted in which case the
1065-
`date_string` and `compass_direction` methods will be unavailable.
1066-
10671071
## 10.2 Files for read/write operation
10681072

10691073
* `as_rwGPS.py` Supports the `GPS` class. This subclass of `AS_GPS` enables
10701074
writing PMTK packets.
1071-
* `as_rwGPS.py` Required if using the read/write variant.
1072-
* `ast_pbrw.py` Test/demo script.
1075+
1076+
Demo. Written for Pyboard but readily portable.
1077+
* `ast_pbrw.py`
10731078

10741079
## 10.3 Files for timing applications
10751080

1076-
Note that these require the `threadsafe` directory to be copied to the target.
1077-
10781081
* `as_tGPS.py` The library. Provides `GPS_Timer` and `GPS_RWTimer` classes.
1079-
* `as_GPS_time.py` Test scripts for read only driver.
1080-
* `as_rwGPS_time.py` Test scripts for read/write driver.
1082+
Cross platform.
1083+
1084+
Note that the following are Pyboard specific and require the `threadsafe`
1085+
directory to be copied to the target.
1086+
1087+
* `as_GPS_time.py` Test scripts for read only driver (Pyboard).
1088+
* `as_rwGPS_time.py` Test scripts for read/write driver (Pyboard).
10811089

10821090
## 10.4 Special test programs
10831091

1084-
These tests allow NMEA parsing to be verified in the absence of GPS hardware:
1092+
These tests allow NMEA parsing to be verified in the absence of GPS hardware.
1093+
For those modifying or extending the sentence parsing:
10851094

10861095
* `astests.py` Test with synthetic data. Run on PC under CPython 3.8+ or MicroPython.
10871096
* `astests_pyb.py` Test with synthetic data on UART. GPS hardware replaced by

0 commit comments

Comments
 (0)