Skip to content
Driver for Microchip ATECCx08 cryptographic co-processors with secure hardware-based key storage
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_atecc remove debugging init kwarg Sep 17, 2019
docs pass sphinx Sep 17, 2019
examples
.gitignore initial move of files over Sep 17, 2019
.pylintrc initial move of files over Sep 17, 2019
.readthedocs.yml initial move of files over Sep 17, 2019
.travis.yml
CODE_OF_CONDUCT.md
LICENSE
README.rst fix build config for folder setup Sep 17, 2019
requirements.txt
setup.py

README.rst

Introduction

Documentation Status Discord Build Status

Driver for Microchip's ATECCx08 cryptographic co-processors with secure hardware-based key storage.

Note: This library was developed and tested with an ATECC608A, but should work for ATECC508 modules as well.

Dependencies

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

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

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

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

sudo pip3 install adafruit-circuitpython-atecc

To install in a virtual environment in your current project:

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

Usage Example

Examples of using this module are in examples folder.

Contributing

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

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

License

This library was written by Arduino SA. We've converted it to work with Adafruit CircuitPython and made changes for it to work with CircuitPython devices and single-board linux computers running CircuitPython libraries. We've added examples to demonstrate using the nonce, random, monotonic counter and SHA256 security functions within the library.

This open source code is licensed under the LGPL License (see LICENSE for details).

You can’t perform that action at this time.