Merge remote-tracking branch 'upstream/feature/usbd_python' into feature/usbd_python

Author: turmoni

.github/workflows/build_packages.yml

@@ -2,6 +2,9 @@ name: Build all packages
 
 on: [push, pull_request]
 
+env:
+  PACKAGE_INDEX_PATH: /tmp/micropython-lib-deploy
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -14,3 +17,11 @@ jobs:
       run: source tools/ci.sh && ci_build_packages_check_manifest
     - name: Compile package index
       run: source tools/ci.sh && ci_build_packages_compile_index
+    - name: Publish packages for branch
+      if: vars.MICROPY_PUBLISH_MIP_INDEX && github.event_name == 'push' && ! github.event.deleted
+      run: source tools/ci.sh && ci_push_package_index
+    - name: Upload packages as artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: packages-${{ github.sha }}
+        path: ${{ env.PACKAGE_INDEX_PATH }}

.github/workflows/cleanup_published_packages.yml

@@ -0,0 +1,12 @@
+name: Cleanup published packages
+
+on: delete
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    if: vars.MICROPY_PUBLISH_MIP_INDEX
+    steps:
+    - uses: actions/checkout@v2
+    - name: Clean up published files
+      run: source tools/ci.sh && ci_cleanup_package_index ${{ github.event.ref }}

CONTRIBUTING.md

@@ -69,3 +69,49 @@ There are some specific conventions and guidelines for micropython-lib:
 
 * When porting an existing third-party package, please ensure that the source
   license is compatible.
+
+* To make it easier for others to install packages directly from your PR before
+  it is merged, consider opting-in to automatic package publishing (see
+  [Publishing packages from forks](#publishing-packages-from-forks)). If you do
+  this, consider quoting the [commands to install
+  packages](README.md#installing-packages-from-forks) in your Pull Request
+  description.
+
+### Publishing packages from forks
+
+You can easily publish the packages from your micropython-lib
+[fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)
+by opting in to a system based on [GitHub
+Actions](https://docs.github.com/en/actions) and [GitHub
+Pages](https://docs.github.com/en/pages):
+
+1. Open your fork's repository in the GitHub web interface.
+2. Navigate to "Settings" -> "Secrets and variables" -> "Actions" -> "Variables".
+3. Click "New repository variable"
+4. Create a variable named `MICROPY_PUBLISH_MIP_INDEX` with value `true` (or any
+   "truthy" value).
+5. The settings for GitHub Actions and GitHub Pages features should not need to
+   be changed from the repository defaults, unless you've explicitly disabled
+   them.
+
+The next time you push commits to a branch in your fork, GitHub Actions will run
+an additional step in the "Build All Packages" workflow named "Publish Packages
+for branch".
+
+Anyone can then install these packages as described under [Installing packages
+from forks](README.md#installing-packages-from-forks). The exact commands are also
+quoted in the GitHub Actions log for the "Publish Packages for branch" step.
+
+#### Opting Back Out
+
+To opt-out again, delete the `MICROPY_PUBLISH_MIP_INDEX` variable and
+(optionally) delete the `gh-pages` branch from your fork.
+
+*Note*: While enabled, all micropython-lib packages will be published each time
+a change is pushed to any branch in your fork. A commit is added to the
+`gh-pages` branch each time. In a busy repository, the `gh-pages` branch may
+become quite large. The actual `.git` directory size on disk should still be
+quite small, as most of the content will be duplicated. If you're worried that
+the `gh-pages` branch has become too large then you can always delete this
+branch from GitHub. GitHub Actions will create a new `gh-pages` branch the next
+time you push a change.

README.md

@@ -84,6 +84,37 @@ Note that unlike the other three approaches based on `mip` or `manifest.py`,
 you will need to manually resolve dependencies. You can inspect the relevant
 `manifest.py` file to view the list of dependencies for a given package.
 
+## Installing packages from forks
+
+It is possible to use the `mpremote mip install` or `mip.install()` methods to
+install packages built from a
+[fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)
+of micropython-lib, if the fork's owner has opted in.
+
+This can be useful to install packages from a pending Pull Request, for example.
+
+First, the owner of the fork must opt-in as described under
+[Publishing packages from forks](CONTRIBUTING.md#publishing-packages-from-forks).
+
+After this has happened, each time someone pushes to a branch in that fork then
+GitHub Actions will automatically publish the packages to a GitHub Pages site.
+
+To install these packages, use commands such as:
+
+```bash
+$ mpremote connect /dev/ttyUSB0 mip install --index https://USERNAME.github.io/micropython-lib/mip/BRANCH_NAME PACKAGE_NAME
+```
+
+Or from a networked device:
+
+```py
+import mip
+mip.install(PACKAGE_NAME, index="https://USERNAME.github.io/micropython-lib/mip/BRANCH_NAME")
+```
+
+(Where `USERNAME`, `BRANCH_NAME` and `PACKAGE_NAME` are replaced with the owner
+of the fork, the branch the packages were built from, and the package name.)
+
 ## Contributing
 
 We use [GitHub Discussions](https://github.com/micropython/micropython/discussions)

micropython/aioespnow/README.md

@@ -0,0 +1,91 @@
+# `aioespnow`
+
+A supplementary module which extends the micropython `espnow` module to provide
+`asyncio` support.
+
+- Asyncio support is available on all ESP32 targets as well as those ESP8266
+boards which include the `uasyncio` module (ie. ESP8266 devices with at least
+2MB flash storage).
+
+## API reference
+
+- class `AIOESPNow()`: inherits all the methods of the `ESPNow` class and
+  extends the interface with the following async methods:
+
+  - `async AIOESPNow.arecv()`
+
+      Asyncio support for ESPNow.recv(). Note that this method does not take a
+      timeout value as argument.
+
+  - `async AIOESPNow.airecv()`
+
+      Asyncio support for ESPNow.irecv(). Use this method to reduce memory
+      fragmentation, as it will reuse common storage for each new message
+      received, whereas the `arecv()` method will allocate new memory for every
+      message received.
+
+  - `async AIOESPNow.asend(mac, msg, sync=True)`
+  - `async AIOESPNow.asend(msg)`
+
+      Asyncio support for ESPNow.send().
+
+  - `__aiter__()/async __anext__()`
+
+      AIOESPNow also supports reading incoming messages by asynchronous
+      iteration using `async for`, eg:
+
+    ```python
+      e = AIOESPNow()
+      e.active(True)
+      async def recv_till_halt(e):
+          async for mac, msg in e:
+              print(mac, msg)
+              if msg == b'halt':
+                  break
+      asyncio.run(recv_till_halt(e))
+    ```
+
+## Example Usage
+
+A small async server example::
+
+```python
+    import network
+    import aioespnow
+    import uasyncio as asyncio
+
+    # A WLAN interface must be active to send()/recv()
+    network.WLAN(network.STA_IF).active(True)
+
+    e = aioespnow.AIOESPNow()  # Returns AIOESPNow enhanced with async support
+    e.active(True)
+    peer = b'\xbb\xbb\xbb\xbb\xbb\xbb'
+    e.add_peer(peer)
+
+    # Send a periodic ping to a peer
+    async def heartbeat(e, peer, period=30):
+        while True:
+            if not await e.asend(peer, b'ping'):
+                print("Heartbeat: peer not responding:", peer)
+            else:
+                print("Heartbeat: ping", peer)
+            await asyncio.sleep(period)
+
+    # Echo any received messages back to the sender
+    async def echo_server(e):
+        async for mac, msg in e:
+            print("Echo:", msg)
+            try:
+                await e.asend(mac, msg)
+            except OSError as err:
+                if len(err.args) > 1 and err.args[1] == 'ESP_ERR_ESPNOW_NOT_FOUND':
+                    e.add_peer(mac)
+                    await e.asend(mac, msg)
+
+    async def main(e, peer, timeout, period):
+        asyncio.create_task(heartbeat(e, peer, period))
+        asyncio.create_task(echo_server(e))
+        await asyncio.sleep(timeout)
+
+    asyncio.run(main(e, peer, 120, 10))
+```

micropython/aioespnow/aioespnow.py

@@ -0,0 +1,31 @@
+# aioespnow module for MicroPython on ESP32 and ESP8266
+# MIT license; Copyright (c) 2022 Glenn Moloney @glenn20
+
+import uasyncio as asyncio
+import espnow
+
+
+# Modelled on the uasyncio.Stream class (extmod/stream/stream.py)
+# NOTE: Relies on internal implementation of uasyncio.core (_io_queue)
+class AIOESPNow(espnow.ESPNow):
+    # Read one ESPNow message
+    async def arecv(self):
+        yield asyncio.core._io_queue.queue_read(self)
+        return self.recv(0)  # type: ignore
+
+    async def airecv(self):
+        yield asyncio.core._io_queue.queue_read(self)
+        return self.irecv(0)  # type: ignore
+
+    async def asend(self, mac, msg=None, sync=None):
+        if msg is None:
+            msg, mac = mac, None  # If msg is None: swap mac and msg
+        yield asyncio.core._io_queue.queue_write(self)
+        return self.send(mac, msg, sync)  # type: ignore
+
+    # "async for" support
+    def __aiter__(self):
+        return self
+
+    async def __anext__(self):
+        return await self.airecv()

micropython/aioespnow/manifest.py

@@ -0,0 +1,6 @@
+metadata(
+    description="Extends the micropython espnow module with methods to support asyncio.",
+    version="0.1",
+)
+
+module("aioespnow.py")

micropython/bluetooth/aioble-client/manifest.py

@@ -1,4 +1,4 @@
-metadata(version="0.2.0")
+metadata(version="0.3.0")
 
 require("aioble-core")
 

micropython/bluetooth/aioble-server/manifest.py

@@ -1,4 +1,4 @@
-metadata(version="0.2.0")
+metadata(version="0.3.0")
 
 require("aioble-core")
 

micropython/bluetooth/aioble/aioble/client.py

@@ -439,7 +439,7 @@ class ClientDescriptor(BaseClientCharacteristic):
     def __init__(self, characteristic, dsc_handle, uuid):
         self.characteristic = characteristic
 
-        super().__init__(dsc_handle, _FLAG_READ | _FLAG_WRITE_NO_RESPONSE, uuid)
+        super().__init__(dsc_handle, _FLAG_READ | _FLAG_WRITE, uuid)
 
     def __str__(self):
         return "Descriptor: {} {} {}".format(self._value_handle, self.properties, self.uuid)

micropython/bluetooth/aioble/aioble/server.py

@@ -38,9 +38,6 @@
 
 _FLAG_WRITE_CAPTURE = const(0x10000)
 
-_FLAG_DESC_READ = const(1)
-_FLAG_DESC_WRITE = const(2)
-
 
 _WRITE_CAPTURE_QUEUE_LIMIT = const(10)
 
@@ -307,14 +304,13 @@ class Descriptor(BaseCharacteristic):
     def __init__(self, characteristic, uuid, read=False, write=False, initial=None):
         characteristic.descriptors.append(self)
 
-        # Workaround for https://github.com/micropython/micropython/issues/6864
         flags = 0
         if read:
-            flags |= _FLAG_DESC_READ
+            flags |= _FLAG_READ
         if write:
+            flags |= _FLAG_WRITE
             self._write_event = asyncio.ThreadSafeFlag()
             self._write_data = None
-            flags |= _FLAG_DESC_WRITE
 
         self.uuid = uuid
         self.flags = flags

micropython/bluetooth/aioble/manifest.py

@@ -3,7 +3,7 @@
 # code. This allows (for development purposes) all the files to live in the
 # one directory.
 
-metadata(version="0.2.1")
+metadata(version="0.3.1")
 
 # Default installation gives you everything. Install the individual
 # components (or a combination of them) if you want a more minimal install.

micropython/drivers/bus/onewire/manifest.py

@@ -1 +1,3 @@
+metadata(description="Onewire driver.", version="0.1.0")
+
 module("onewire.py", opt=3)

micropython/drivers/codec/wm8960/manifest.py

@@ -1 +1,3 @@
+metadata(description="WM8960 codec.", version="0.1.0")
+
 module("wm8960.py", opt=3)

micropython/drivers/display/lcd160cr/manifest.py

@@ -1,3 +1,5 @@
+metadata(description="LCD160CR driver.", version="0.1.0")
+
 options.defaults(test=False)
 
 module("lcd160cr.py", opt=3)

micropython/drivers/display/ssd1306/manifest.py

@@ -1 +1,3 @@
+metadata(description="SSD1306 OLED driver.", version="0.1.0")
+
 module("ssd1306.py", opt=3)

micropython/drivers/led/neopixel/manifest.py

@@ -1 +1,3 @@
+metadata(description="WS2812/NeoPixel driver.", version="0.1.0")
+
 module("neopixel.py", opt=3)

micropython/drivers/radio/nrf24l01/manifest.py

@@ -1 +1,3 @@
+metadata(description="nrf24l01 2.4GHz radio driver.", version="0.1.0")
+
 module("nrf24l01.py", opt=3)

micropython/drivers/sensor/dht/manifest.py

@@ -1 +1,3 @@
+metadata(description="DHT11 & DHT22 temperature/humidity sensor driver.", version="0.1.0")
+
 module("dht.py", opt=3)

micropython/drivers/sensor/ds18x20/manifest.py

@@ -1,2 +1,4 @@
+metadata(description="DS18x20 temperature sensor driver.", version="0.1.0")
+
 require("onewire")
 module("ds18x20.py", opt=3)

micropython/drivers/sensor/hts221/manifest.py

@@ -1 +1,3 @@
+metadata(description="HTS221 temperature/humidity sensor driver.", version="0.1.0")
+
 module("hts221.py", opt=3)

micropython/drivers/sensor/lps22h/manifest.py

@@ -1 +1,3 @@
+metadata(description="LPS22H temperature/pressure sensor driver.", version="0.1.0")
+
 module("lps22h.py", opt=3)

micropython/drivers/storage/sdcard/manifest.py

@@ -1 +1,3 @@
+metadata(description="SDCard block device driver.", version="0.1.0")
+
 module("sdcard.py", opt=3)

micropython/net/ntptime/manifest.py

@@ -1 +1,3 @@
+metadata(description="NTP client.", version="0.1.0")
+
 module("ntptime.py", opt=3)

micropython/net/webrepl/manifest.py

@@ -1,2 +1,4 @@
+metadata(description="WebREPL server.", version="0.1.0")
+
 module("webrepl.py", opt=3)
 module("webrepl_setup.py", opt=3)

micropython/senml/examples/base.py

@@ -25,7 +25,7 @@
 
 
 from senml import *
-import utime as time
+import time
 
 
 pack = SenmlPack("device_name")

micropython/senml/examples/basic.py

@@ -25,7 +25,7 @@
 
 
 from senml import *
-import utime as time
+import time
 
 
 pack = SenmlPack("device")

micropython/senml/examples/basic2.py

@@ -25,7 +25,7 @@
 
 
 from senml import *
-import utime as time
+import time
 
 
 pack = SenmlPack("device_name")