Skip to content

Commit 36c01ea

Browse files
Merge pull request #33 from FoamyGuy/fix_docs
fixing docs API section and resolve sphinx errors to get docs rendering
2 parents 7697a02 + e1a6a65 commit 36c01ea

File tree

3 files changed

+28
-9
lines changed

3 files changed

+28
-9
lines changed

adafruit_atecc/adafruit_atecc.py

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,14 @@
3636
* Adafruit CircuitPython firmware for the supported boards:
3737
https://github.com/adafruit/circuitpython/releases
3838
39-
* Adafruit Bus Device library:
39+
* Adafruit Bus Device library:
4040
https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
4141
42-
* Adafruit binascii library:
42+
* Adafruit binascii library:
4343
https://github.com/adafruit/Adafruit_CircuitPython_binascii
4444
4545
"""
46+
4647
import time
4748
from struct import pack
4849

@@ -106,6 +107,7 @@ def _convert_i2c_addr_to_atecc_addr(i2c_addr=0x60):
106107
OP_WRITE: const(26),
107108
}
108109

110+
# pylint: disable=line-too-long
109111
"""
110112
Configuration Zone Bytes
111113
@@ -122,13 +124,21 @@ def _convert_i2c_addr_to_atecc_addr(i2c_addr=0x60):
122124
123125
I2C Config
124126
125-
HEX DEC BIN Description
126-
Byte 14: C0 192 1100 0000
127-
^xxx xxxx Bit 0 (MSB): 0:Single Wire, 1:I2C; Bit 1-7: Set by Microchip
128-
Byte 16: C0 192 1100 0000 Default 7 bit I2C Address: 0xC0>>1: 0x60 ATECC608A-MAHDA
129-
Byte 16: 6A 106 0110 1010 Default 7 bit I2C Address: 0x6A>>1: 0x35 ATECC608A-TNGTLS
130-
Byte 16: 20 32 0010 0000 Default 7 bit I2C Address: 0x20>>1: 0x10 ATECC608A-UNKNOWN
127+
+------+-------+---------+-------------+---------------------------------------------------------------+
128+
| HEX | DEC | BIN | Description |
129+
+======+=======+=========+=============+===============================================================+
130+
| Byte 14: C0 | 192 | 1100 0000 | |
131+
| | | ^xxx xxxx | Bit 0 (MSB): 0:Single Wire, 1:I2C; Bit 1-7: Set by Microchip |
132+
+--------------+---------+-------------+---------------------------------------------------------------+
133+
| Byte 16: C0 | 192 | 1100 0000 | Default 7 bit I2C Address: 0xC0>>1: 0x60 ATECC608A-MAHDA |
134+
+--------------+---------+-------------+---------------------------------------------------------------+
135+
| Byte 16: 6A | 106 | 0110 1010 | Default 7 bit I2C Address: 0x6A>>1: 0x35 ATECC608A-TNGTLS |
136+
+--------------+---------+-------------+---------------------------------------------------------------+
137+
| Byte 16: 20 | 32 | 0010 0000 | Default 7 bit I2C Address: 0x20>>1: 0x10 ATECC608A-UNKNOWN |
138+
+--------------+---------+-------------+---------------------------------------------------------------+
139+
131140
"""
141+
132142
CFG_TLS = bytes(
133143
bytearray(
134144
unhexlify(

adafruit_atecc/adafruit_atecc_asn1.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
2121

2222
"""
23-
`atecc_asn1`
23+
`adafruit_atecc_asn1`
2424
================================================================================
2525
2626
ASN.1 Utilities for the Adafruit_ATECC Module.

docs/api.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,12 @@ API
77
88
.. automodule:: adafruit_atecc
99
:members:
10+
11+
.. automodule:: adafruit_atecc.adafruit_atecc
12+
:members:
13+
14+
.. automodule:: adafruit_atecc.adafruit_atecc_asn1
15+
:members:
16+
17+
.. automodule:: adafruit_atecc.adafruit_atecc_cert_util
18+
:members:

0 commit comments

Comments
 (0)