Initial GPS changes.

Author: peterhinch

gps/README.md

@@ -64,14 +64,22 @@ the Pyboard is run from a voltage >5V the Pyboard 3V3 pin should be used.
 | Vin | V+ or 3V3  |          |
 | Gnd | Gnd        |          |
 | PPS | X3         |    Y     |
-| Tx  | X2 (U4 rx) |    Y     |
-| Rx  | X1 (U4 tx) |          |
+| Tx  | X2 (U4 rx) |          |
+| Rx  | X1 (U4 tx) |    Y     |
 
 This is based on UART 4 as used in the test programs; any UART may be used. The
 UART Tx-GPS Rx connection is only necessary if using the read/write driver. The
 PPS connection is required only if using the timing driver `as_tGPS.py`. Any
 pin may be used.
 
+On the Pyboard D the 3.3V output is switched. Enable it with the following
+(typically in `main.py`):
+```python
+import time
+machine.Pin.board.EN_3V3.value(1)
+time.sleep(1)
+```
+
 ## 1.2 Basic Usage
 
 If running on a [MicroPython] target the `uasyncio` library must be installed.
@@ -906,4 +914,4 @@ duration over which it is measured.
 [pyboard]:http://docs.micropython.org/en/latest/pyboard/pyboard/quickref.html
 [MTK_command]:https://github.com/inmcm/MTK_commands
 [Ultimate GPS Breakout]:http://www.adafruit.com/product/746
-[micropyGPS]:https://github.com/inmcm/micropyGPS.git
+[micropyGPS]:https://github.com/inmcm/micropyGPS.git

gps/ast_pbrw.py

@@ -20,7 +20,7 @@
 
 # Avoid multiple baudrates. Tests use 9600 or 19200 only.
 BAUDRATE = 19200
-red, green, yellow, blue = pyb.LED(1), pyb.LED(2), pyb.LED(3), pyb.LED(4)
+red, green, yellow = pyb.LED(1), pyb.LED(2), pyb.LED(3)
 ntimeouts = 0
 
 def callback(gps, _, timer):
@@ -89,7 +89,6 @@ async def date(gps):
     while True:
         await asyncio.sleep(4)
         await gps.data_received(date=True)
-        blue.toggle()
         print('***** DATE AND TIME *****')
         print('Data is Valid:', hex(gps._valid))
         print('UTC Time:', gps.utc)

gps/log_kml.py

@@ -1,11 +1,13 @@
 # log_kml.py Log GPS data to a kml file for display on Google Earth
 
-# Copyright (c) Peter Hinch 2018
+# Copyright (c) Peter Hinch 2018-2020
 # MIT License (MIT) - see LICENSE file
 # Test program for asynchronous GPS device driver as_pyGPS
 # KML file format: https://developers.google.com/kml/documentation/kml_tut
 # http://www.toptechboy.com/arduino/lesson-25-display-your-gps-data-as-track-on-google-earth/
 
+# Remove blue LED for Pyboard D
+
 # Logging stops and the file is closed when the user switch is pressed.
 
 import as_GPS
@@ -39,11 +41,11 @@
 </Document></kml>
 '''
 
-red, green, yellow, blue = pyb.LED(1), pyb.LED(2), pyb.LED(3), pyb.LED(4)
+red, green, yellow = pyb.LED(1), pyb.LED(2), pyb.LED(3)
 sw = pyb.Switch()
 
 # Toggle the red LED
-def toggle_led(gps):
+def toggle_led(*_):
     red.toggle()
 
 async def log_kml(fn='/sd/log.kml', interval=10):
@@ -62,7 +64,6 @@ async def log_kml(fn='/sd/log.kml', interval=10):
             f.write(',')
             f.write(str(gps.altitude))
             f.write('\r\n')
-            blue.toggle()
             for _ in range(interval * 10):
                 await asyncio.sleep_ms(100)
                 if sw.value():

v3/demos/gps/README.md

@@ -7,6 +7,8 @@ based on this excellent library [micropyGPS].
 The code in this V3 repo has been ported to uasyncio V3. Some modules can run
 under CPython: doing so will require Python V3.8 or later.
 
+**UNDER REVIEW: API MAY CHANGE**
+
 ## 1.1 Driver characteristics
 
  * Asynchronous: UART messaging is handled as a background task allowing the
@@ -67,14 +69,22 @@ the Pyboard is run from a voltage >5V the Pyboard 3V3 pin should be used.
 | Vin | V+ or 3V3  |          |
 | Gnd | Gnd        |          |
 | PPS | X3         |    Y     |
-| Tx  | X2 (U4 rx) |    Y     |
-| Rx  | X1 (U4 tx) |          |
+| Tx  | X2 (U4 rx) |          |
+| Rx  | X1 (U4 tx) |    Y     |
 
 This is based on UART 4 as used in the test programs; any UART may be used. The
 UART Tx-GPS Rx connection is only necessary if using the read/write driver. The
 PPS connection is required only if using the timing driver `as_tGPS.py`. Any
 pin may be used.
 
+On the Pyboard D the 3.3V output is switched. Enable it with the following
+(typically in `main.py`):
+```python
+import time
+machine.Pin.board.EN_3V3.value(1)
+time.sleep(1)
+```
+
 ## 1.2 Basic Usage
 
 If running on a [MicroPython] target the `uasyncio` library must be installed.
@@ -160,7 +170,7 @@ optionally be installed; this requires `aswitch.py` from the root of this
 repository.  
 For the [timing driver](./README.md#4-using-gps-for-accurate-timing)
 `as_tGPS.py` should also be copied across. The optional test program
-`as_GPS_time.py` requires `asyn.py` from the root of this repository.
+`as_GPS_time.py` requires the `primitives` package.
 
 ### 1.4.2 Python 3.8 or later
 
@@ -436,7 +446,6 @@ LED's:
  * Red: Toggles each time a GPS update occurs.
  * Green: ON if GPS data is being received, OFF if no data received for >10s.
  * Yellow: Toggles each 4s if navigation updates are being received.
- * Blue: Toggles each 4s if time updates are being received.
 
 ### 3.1.1 Usage example
 
@@ -635,13 +644,13 @@ import as_tGPS
 async def test():
     fstr = '{}ms Time: {:02d}:{:02d}:{:02d}:{:06d}'
     red = pyb.LED(1)
-    blue = pyb.LED(4)
+    green = pyb.LED(2)
     uart = pyb.UART(4, 9600, read_buf_len=200)
     sreader = asyncio.StreamReader(uart)
     pps_pin = pyb.Pin('X3', pyb.Pin.IN)
     gps_tim = as_tGPS.GPS_Timer(sreader, pps_pin, local_offset=1,
                              fix_cb=lambda *_: red.toggle(),
-                             pps_cb=lambda *_: blue.toggle())
+                             pps_cb=lambda *_: green.toggle())
     print('Waiting for signal.')
     await gps_tim.ready()  # Wait for GPS to get a signal
     await gps_tim.set_rtc()  # Set RTC from GPS

v3/demos/gps/as_GPS_time.py

@@ -2,17 +2,16 @@
 # Using GPS for precision timing and for calibrating Pyboard RTC
 
 # This is STM-specific: requires pyb module.
-# Requires asyn.py from this repo.
 
-# Copyright (c) 2018 Peter Hinch
+# Copyright (c) 2018-2020 Peter Hinch
 # Released under the MIT License (MIT) - see LICENSE file
 
 import uasyncio as asyncio
 import pyb
 import utime
 import math
-import asyn
 import as_tGPS
+from primitives.message import Message
 
 # Hardware assumptions. Change as required.
 PPS_PIN = pyb.Pin.board.X3
@@ -25,16 +24,16 @@
 print('usec(minutes=1) Measure accuracy of usec timer.')
 print('Press ctrl-d to reboot after each test.')
 
-# Setup for tests. Red LED toggles on fix, blue on PPS interrupt.
+# Setup for tests. Red LED toggles on fix, green on PPS interrupt.
 async def setup():
     red = pyb.LED(1)
-    blue = pyb.LED(4)
+    green = pyb.LED(2)
     uart = pyb.UART(UART_ID, 9600, read_buf_len=200)
     sreader = asyncio.StreamReader(uart)
     pps_pin = pyb.Pin(PPS_PIN, pyb.Pin.IN)
     return as_tGPS.GPS_Timer(sreader, pps_pin, local_offset=1,
                              fix_cb=lambda *_: red.toggle(),
-                             pps_cb=lambda *_: blue.toggle())
+                             pps_cb=lambda *_: green.toggle())
 
 # Test terminator: task sets the passed event after the passed time.
 async def killer(end_event, minutes):
@@ -66,7 +65,7 @@ async def do_drift(minutes):
     gps = await setup()
     print('Waiting for time data.')
     await gps.ready()
-    terminate = asyn.Event()
+    terminate = asyncio.Event()
     asyncio.create_task(killer(terminate, minutes))
     print('Setting RTC.')
     await gps.set_rtc()
@@ -90,7 +89,7 @@ async def do_time(minutes):
     await gps.ready()
     print('Setting RTC.')
     await gps.set_rtc()
-    terminate = asyn.Event()
+    terminate = asyncio.Event()
     asyncio.create_task(killer(terminate, minutes))
     while not terminate.is_set():
         await asyncio.sleep(1)
@@ -115,24 +114,24 @@ def time(minutes=1):
 def us_cb(my_gps, tick, led):
     global us_acquired  # Time of previous PPS edge in ticks_us()
     if us_acquired is not None:
-        # Trigger event. Pass time between PPS measured by utime.ticks_us()
+        # Trigger Message. Pass time between PPS measured by utime.ticks_us()
         tick.set(utime.ticks_diff(my_gps.acquired, us_acquired))
     us_acquired = my_gps.acquired
     led.toggle()
 
 # Setup initialises with above callback
 async def us_setup(tick):
     red = pyb.LED(1)
-    blue = pyb.LED(4)
+    yellow = pyb.LED(3)
     uart = pyb.UART(UART_ID, 9600, read_buf_len=200)
     sreader = asyncio.StreamReader(uart)
     pps_pin = pyb.Pin(PPS_PIN, pyb.Pin.IN)
     return as_tGPS.GPS_Timer(sreader, pps_pin, local_offset=1,
                              fix_cb=lambda *_: red.toggle(),
-                             pps_cb=us_cb, pps_cb_args=(tick, blue))
+                             pps_cb=us_cb, pps_cb_args=(tick, yellow))
 
 async def do_usec(minutes):
-    tick = asyn.Event()
+    tick = Message()
     print('Setting up GPS.')
     gps = await us_setup(tick)
     print('Waiting for time data.')
@@ -142,10 +141,10 @@ async def do_usec(minutes):
     sd = 0
     nsamples = 0
     count = 0
-    terminate = asyn.Event()
+    terminate = asyncio.Event()
     asyncio.create_task(killer(terminate, minutes))
     while not terminate.is_set():
-        await tick
+        await tick.wait()
         usecs = tick.value()
         tick.clear()
         err = 1000000 - usecs

v3/demos/gps/ast_pb.py

@@ -7,7 +7,7 @@
 
 import pyb
 import uasyncio as asyncio
-import aswitch
+from primitives.delay_ms import Delay_ms
 import as_GPS
 
 red = pyb.LED(1)
@@ -84,15 +84,15 @@ async def gps_test():
     uart = pyb.UART(4, 9600, read_buf_len=200)
     # read_buf_len is precautionary: code runs reliably without it.)
     sreader = asyncio.StreamReader(uart)
-    timer = aswitch.Delay_ms(timeout)
+    timer = Delay_ms(timeout)
     sentence_count = 0
     gps = as_GPS.AS_GPS(sreader, local_offset=1, fix_cb=callback, fix_cb_args=(timer,))
     print('awaiting first fix')
     asyncio.create_task(sat_test(gps))
     asyncio.create_task(stats(gps))
     asyncio.create_task(navigation(gps))
     asyncio.create_task(course(gps))
-    asyncio.create_task(date(gps))
+    await date(gps)
 
 
 asyncio.run(gps_test())

v3/demos/gps/ast_pbrw.py

@@ -1,26 +1,25 @@
 # ast_pb.py
 # Basic test/demo of AS_GPS class (asynchronous GPS device driver)
 # Runs on a Pyboard with GPS data on pin X2.
-# Copyright (c) Peter Hinch 2018
+# Copyright (c) Peter Hinch 2018-2020
 # Released under the MIT License (MIT) - see LICENSE file
 # Test asynchronous GPS device driver as_rwGPS
 
 # LED's:
 # Green indicates data is being received.
 # Red toggles on RMC message received.
-# Yellow and blue: coroutines have 4s loop delay.
+# Yellow: coroutine has 4s loop delay.
 # Yellow toggles on position reading.
-# Blue toggles on date valid.
 
 import pyb
 import uasyncio as asyncio
-import aswitch
+from primitives.delay_ms import Delay_ms
 import as_GPS
 import as_rwGPS
 
 # Avoid multiple baudrates. Tests use 9600 or 19200 only.
 BAUDRATE = 19200
-red, green, yellow, blue = pyb.LED(1), pyb.LED(2), pyb.LED(3), pyb.LED(4)
+red, green, yellow = pyb.LED(1), pyb.LED(2), pyb.LED(3)
 ntimeouts = 0
 
 def callback(gps, _, timer):
@@ -58,7 +57,7 @@ async def stats(gps):
         print('Sentences Parsed:', gps.parsed_sentences)
         print('CRC_Fails:', gps.crc_fails)
         print('Antenna status:', gps.antenna)
-        print('Firmware vesrion:', gps.version)
+        print('Firmware version:', gps.version)
         print('Enabled sentences:', gps.enabled)
         print()
 
@@ -89,7 +88,6 @@ async def date(gps):
     while True:
         await asyncio.sleep(4)
         await gps.data_received(date=True)
-        blue.toggle()
         print('***** DATE AND TIME *****')
         print('Data is Valid:', hex(gps._valid))
         print('UTC Time:', gps.utc)
@@ -136,7 +134,7 @@ async def gps_test():
     # read_buf_len is precautionary: code runs reliably without it.
     sreader = asyncio.StreamReader(uart)
     swriter = asyncio.StreamWriter(uart, {})
-    timer = aswitch.Delay_ms(cb_timeout)
+    timer = Delay_ms(cb_timeout)
     sentence_count = 0
     gps = as_rwGPS.GPS(sreader, swriter, local_offset=1, fix_cb=callback,
                        fix_cb_args=(timer,),  msg_cb = message_cb)
@@ -152,7 +150,7 @@ async def gps_test():
     asyncio.create_task(course(gps))
     asyncio.create_task(date(gps))
     await gps.data_received(True, True, True, True)  # all messages
-    asyncio.create_task(change_status(gps, uart))
+    await change_status(gps, uart)
 
 async def shutdown():
     # Normally UART is already at BAUDRATE. But if last session didn't restore
@@ -167,5 +165,7 @@ async def shutdown():
 
 try:
     asyncio.run(gps_test())
+except KeyboardInterrupt:
+    print('Interrupted')
 finally:
     asyncio.run(shutdown())

v3/demos/gps/log_kml.py

@@ -39,11 +39,11 @@
 </Document></kml>
 '''
 
-red, green, yellow, blue = pyb.LED(1), pyb.LED(2), pyb.LED(3), pyb.LED(4)
+red, green, yellow = pyb.LED(1), pyb.LED(2), pyb.LED(3)
 sw = pyb.Switch()
 
 # Toggle the red LED
-def toggle_led(gps):
+def toggle_led(*_):
     red.toggle()
 
 async def log_kml(fn='/sd/log.kml', interval=10):
@@ -62,7 +62,6 @@ async def log_kml(fn='/sd/log.kml', interval=10):
             f.write(',')
             f.write(str(gps.altitude))
             f.write('\r\n')
-            blue.toggle()
             for _ in range(interval * 10):
                 await asyncio.sleep_ms(100)
                 if sw.value():