Introduction

CircuitPython helper library to handle serial user input in an nonblocking way.

Dependencies

This helper library depends on:

• Adafruit CircuitPython
• CircuitPython_ansi_escape_code

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 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 nonblocking_serialinput

Or the following command to update an existing version:

circup update

Usage Example

import nonblocking_serialinput as nb_serialin
my_input = nb_serialin.NonBlockingSerialInput()
while True:
    my_input.update()
    input_string = my_input.input()
    if input_string is not None:
        my_input.print(input_string)

Contributing

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

Documentation

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