@@ -156,12 +156,16 @@ time.sleep(1)
156
156
## 2.2 Library installation
157
157
158
158
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 ) .
162
166
163
167
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.
165
169
Code samples will need adaptation for the serial port.
166
170
167
171
## 2.3 Dependency
@@ -1055,33 +1059,38 @@ applications will not need the read/write or timing files.
1055
1059
1056
1060
* ` as_GPS.py ` The library. Supports the ` AS_GPS ` class for read-only access to
1057
1061
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.
1061
1068
* ` log_kml.py ` A simple demo which logs a route travelled to a .kml file which
1062
1069
may be displayed on Google Earth.
1063
1070
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
-
1067
1071
## 10.2 Files for read/write operation
1068
1072
1069
1073
* ` as_rwGPS.py ` Supports the ` GPS ` class. This subclass of ` AS_GPS ` enables
1070
1074
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 `
1073
1078
1074
1079
## 10.3 Files for timing applications
1075
1080
1076
- Note that these require the ` threadsafe ` directory to be copied to the target.
1077
-
1078
1081
* ` 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).
1081
1089
1082
1090
## 10.4 Special test programs
1083
1091
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:
1085
1094
1086
1095
* ` astests.py ` Test with synthetic data. Run on PC under CPython 3.8+ or MicroPython.
1087
1096
* ` astests_pyb.py ` Test with synthetic data on UART. GPS hardware replaced by
0 commit comments