Introduction

Cooperative multitasking and asynchronous I/O

The code in this library is largely based on the MicroPython uasyncio implementation.

Dependencies

This driver depends on:

• Adafruit CircuitPython

• Ticks

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

This library is meant to be a subset of the ` asyncio module in CPython <https://docs.python.org/3/library/asyncio.html>`_, and will not be made available on PyPI. Use the CPython version instead.

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install asyncio

Or the following command to update an existing version:

circup update

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Table of Contents

Examples

• Simple test
• Displayio Button Example

API Reference

• Core
• CancelledError
• InvalidStateError
• Loop
  • Loop.call_exception_handler()
  • Loop.close()
  • Loop.create_task()
  • Loop.default_exception_handler()
  • Loop.get_exception_handler()
  • Loop.run_forever()
  • Loop.run_until_complete()
  • Loop.set_exception_handler()
  • Loop.stop()
• TimeoutError
• create_task()
• current_task()
• get_event_loop()
• new_event_loop()
• run()
• run_until_complete()
• sleep()
• sleep_ms()
• Events
• Event
  • Event.clear()
  • Event.is_set()
  • Event.set()
  • Event.wait()
• Functions
• gather()
• wait_for()
• wait_for_ms()
• Locks
• Lock
  • Lock.acquire()
  • Lock.locked()
  • Lock.release()
• Streams
• Server
  • Server.close()
  • Server.wait_closed()
• Stream
  • Stream.aclose()
  • Stream.drain()
  • Stream.get_extra_info()
  • Stream.read()
  • Stream.readexactly()
  • Stream.readinto()
  • Stream.readline()
  • Stream.wait_closed()
  • Stream.write()
• StreamReader
• StreamWriter
• open_connection()
• start_server()
• Tasks
• Task
  • Task.cancel()
  • Task.done()

Other Links

• Download from GitHub
• Download Library Bundle
• CircuitPython Reference Documentation
• CircuitPython Support Forum
• Discord Chat
• Adafruit Learning System
• Adafruit Blog
• Adafruit Store

Indices and tables

• Index

• Module Index

• Search Page