Documentation Status Discord Build Status Code Style: Black

The binascii module contains a number of methods to convert between binary and various ASCII-encoded binary representations.


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-binascii

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-binascii

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-binascii

Usage Example

Hex <-> Binary Conversions

from adafruit_binascii import hexlify, unhexlify
# Binary data.
data = b"CircuitPython is Awesome!"

# Get the hexadecimal representation of the binary data
hex_data = hexlify(data)
print("Hex Data: ", hex_data)

# Get the binary data represented by hex_data
bin_data = unhexlify(hex_data)
print("Binary Data: ", bin_data)


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

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


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

Table of Contents


Indices and tables