Skip to content

Latest commit

 

History

History

README.md

Python CryptoAuthLib Examples

This directory contains a number of examples for using the python cryptoauthlib module

Prerequesites

Install the python requirements via the command:

    pip install -r requirements.txt

Running the examples

The examples are intended to be simple and straightforward to illustrate the basic concepts. To get help on any example you can consult the associated document (e.g. info.py has an accompanying info.md document) or from the command line:

    info.py -h
usage: info.py [-h] [-i {i2c,hid}]

## Info Example

This example extracts identifying information and configuration from a device.

* Device type identification and mask revision
* Serial number
* Configuration zone data
* Lock status

### Prerequisite software before running the example:
- cryptoauthlib python module, can be install through pip with
    "pip install cryptoauthlib" command

### Supported devices:
- [ATSHA204A](http://www.microchip.com/ATSHA204A)
- [ATECC508A](http://www.microchip.com/ATECC508A)
- [ATECC608A](http://www.microchip.com/ATECC608A)

optional arguments:
  -h, --help            show this help message and exit
  -i {i2c,hid}, --iface {i2c,hid}
                        Interface type (default: hid)

list of Examples

What does the Python CryptoAuthLib package do?

CryptoAuthLib module gives access to most functions available as part of standard cryptoauthlib (which is written in 'C'). These python functions for the most part are very similar to 'C' functions. The module in short acts as a wrapper over the 'C' cryptoauth library functions.

Microchip cryptoauthlib product page: Link

Supported hardware