1  Introduction
 2  ============
 3  
 4  .. image:: https://readthedocs.org/projects/adafruit-circuitpython-atecc/badge/?version=latest
 5      :target: https://circuitpython.readthedocs.io/projects/atecc/en/latest/
 6      :alt: Documentation Status
 7  
 8  .. image:: https://img.shields.io/discord/327254708534116352.svg
 9      :target: https://adafru.it/discord
10      :alt: Discord
11  
12  .. image:: https://github.com/adafruit/Adafruit_CircuitPython_ATECC/workflows/Build%20CI/badge.svg
13      :target: https://github.com/adafruit/Adafruit_CircuitPython_ATECC/actions
14      :alt: Build Status
15  
16  
17  Driver for `Microchip's ATECCx08 cryptographic co-processors with secure hardware-based key storage <https://www.adafruit.com/product/4314>`_.
18  
19  Note: This library was developed and tested with an ATECC608A, but should work for ATECC508 modules as well.
20  
21  
22  Dependencies
23  =============
24  This driver depends on:
25  
26  * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
27  * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
28  
29  Please ensure all dependencies are available on the CircuitPython filesystem.
30  This is easily achieved by downloading
31  `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
32  
33  Installing from PyPI
34  =====================
35  .. note:: This library is not available on PyPI yet. Install documentation is included
36     as a standard element. Stay tuned for PyPI availability!
37  
38  On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
39  PyPI <https://pypi.org/project/adafruit-circuitpython-atecc/>`_. To install for current user:
40  
41  .. code-block:: shell
42  
43      pip3 install adafruit-circuitpython-atecc
44  
45  To install system-wide (this may be required in some cases):
46  
47  .. code-block:: shell
48  
49      sudo pip3 install adafruit-circuitpython-atecc
50  
51  To install in a virtual environment in your current project:
52  
53  .. code-block:: shell
54  
55      mkdir project-name && cd project-name
56      python3 -m venv .env
57      source .env/bin/activate
58      pip3 install adafruit-circuitpython-atecc
59  
60  Usage Example
61  =============
62  
63  Examples of using this module are in examples folder.
64  
65  Contributing
66  ============
67  
68  Contributions are welcome! Please read our `Code of Conduct
69  <https://github.com/adafruit/Adafruit_CircuitPython_ATECC/blob/master/CODE_OF_CONDUCT.md>`_
70  before contributing to help this project stay welcoming.
71  
72  Documentation
73  =============
74  
75  For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
76  
77  License
78  ========
79  
80  This library was written by Arduino SA. We've converted it to work with Adafruit CircuitPython and made
81  changes for it to work with CircuitPython devices and single-board linux computers running CircuitPython libraries. We've
82  added examples to demonstrate using the nonce, random, monotonic counter and SHA256 security functions within the library.
83  
84  This open source code is licensed under the LGPL License (see LICENSE for details).