Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save stonehippo/06f3b4e423d341279df40c8f154c1fdd to your computer and use it in GitHub Desktop.
Save stonehippo/06f3b4e423d341279df40c8f154c1fdd to your computer and use it in GitHub Desktop.
A note to self about using the CircuitPython native USB for serial data with usb_cdc

Using the CircuitPython native USB for serial data

I was trying to get some CP code to talk to Processing over a serial port interface. Of course, the CP REPL is normally available on whatever serial port the board mounts by default. This is a little complicated, because although you can use something like print from the REPL (or code.py) to print a value to the console, sys.stdin and sys.stdout are text-based streams, which may not be what you want. And you'll get REPL noise to boot. Not ideal.

This is where usb_cdc comes in. It's a handy library for managing the USB CDC (serial) on most CircuitPython boards. First, usb_cdc can be used to control how many serial ports CP will provide at startup. You can modify boot.py to make this work:

import usb_cdc

usb_cdc.enable(console=True, data=False)

This is equivalent to the standard setup. When you plug in your CP device, you'll get one serial port, which will have the REPL on it, and is mapped to sys.stdin and sys.stdout, all of which goes through the console object, which is a binary stream. This means you can do stuff like this in your code.py:

import usb_cdc

console = usb_cdc.console
console.write(bytes([1]))

This is great, since it means you can send binary data, which is useful if you don't want to muck with the REPL's textstream. However, you're still using the same serial port. We can do better. If you put this in boot.py, you'll get a second serial port when you plug in your board:\

import usb_cdc

usb_cdc.enable(console=True, data=True)

Now you can connect to the second serial port and avoid the REPL noise. You can do this with the usb_cdc.data binary stream:

import usb_cdc

console = usb_cdc.data
console.write(bytes([1]))

For reference, take a look at the documentation for the usb_cdc library and this handy guide to configuring the USB ports in CircuitPython.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment