@@ -26,7 +26,7 @@ If the `Responder` (typically an ESP8266) crashes the resultant I2C failure is
26
26
detected by the ` Initiator ` which can issue a hardware reboot to the
27
27
` Responder ` enabling the link to recover. This can occur transparently to the
28
28
application and is covered in detail
29
- [ in section 5.3] ( ./README .md#53-responder-crash-detection ) .
29
+ [ in section 5.3] ( ./I2C .md#53-responder-crash-detection ) .
30
30
31
31
## Changes
32
32
@@ -42,20 +42,20 @@ V0.1 Initial release.
42
42
43
43
# Contents
44
44
45
- 1 . [ Files] ( ./README .md#1-files )
46
- 2 . [ Wiring] ( ./README .md#2-wiring )
47
- 3 . [ Design] ( ./README .md#3-design )
48
- 4 . [ API] ( ./README .md#4-api )
49
- 4.1 [ Channel class] ( ./README .md#41-channel-class )
50
- 4.2 [ Initiator class] ( ./README .md#42-initiator-class )
51
- 4.2.1 [ Configuration] ( ./README .md#421-configuration ) Fine-tuning the interface.
52
- 4.2.2 [ Optional coroutines] ( ./README .md#422-optional-coroutines )
53
- 4.3 [ Responder class] ( ./README .md#43-responder-class )
54
- 5 . [ Limitations] ( ./README .md#5-limitations )
55
- 5.1 [ Blocking] ( ./README .md#51-blocking )
56
- 5.2 [ Buffering and RAM usage] ( ./README .md#52-buffering-and-ram-usage )
57
- 5.3 [ Responder crash detection] ( ./README .md#53-responder-crash-detection )
58
- 6 . [ Hacker notes] ( ./README .md#6-hacker-notes ) For anyone wanting to hack on
45
+ 1 . [ Files] ( ./I2C .md#1-files )
46
+ 2 . [ Wiring] ( ./I2C .md#2-wiring )
47
+ 3 . [ Design] ( ./I2C .md#3-design )
48
+ 4 . [ API] ( ./I2C .md#4-api )
49
+ 4.1 [ Channel class] ( ./I2C .md#41-channel-class )
50
+ 4.2 [ Initiator class] ( ./I2C .md#42-initiator-class )
51
+ 4.2.1 [ Configuration] ( ./I2C .md#421-configuration ) Fine-tuning the interface.
52
+ 4.2.2 [ Optional coroutines] ( ./I2C .md#422-optional-coroutines )
53
+ 4.3 [ Responder class] ( ./I2C .md#43-responder-class )
54
+ 5 . [ Limitations] ( ./I2C .md#5-limitations )
55
+ 5.1 [ Blocking] ( ./I2C .md#51-blocking )
56
+ 5.2 [ Buffering and RAM usage] ( ./I2C .md#52-buffering-and-ram-usage )
57
+ 5.3 [ Responder crash detection] ( ./I2C .md#53-responder-crash-detection )
58
+ 6 . [ Hacker notes] ( ./I2C .md#6-hacker-notes ) For anyone wanting to hack on
59
59
the code.
60
60
61
61
# 1. Files
@@ -107,7 +107,7 @@ machine.Pin.board.EN_3V3.value(1)
107
107
```
108
108
This also enables the I2C pullups on the X side.
109
109
110
- ###### [ Contents] ( ./README .md#contents )
110
+ ###### [ Contents] ( ./I2C .md#contents )
111
111
112
112
# 3. Design
113
113
@@ -142,7 +142,7 @@ starts to run once each end has determined that its counterpart is ready.
142
142
The design assumes exclusive use of the I2C interface. Hard or soft I2C may be
143
143
used.
144
144
145
- ###### [ Contents] ( ./README .md#contents )
145
+ ###### [ Contents] ( ./I2C .md#contents )
146
146
147
147
# 4. API
148
148
@@ -244,7 +244,7 @@ finally:
244
244
chan.close() # for subsequent runs
245
245
```
246
246
247
- ###### [ Contents] ( ./README .md#contents )
247
+ ###### [ Contents] ( ./I2C .md#contents )
248
248
249
249
## 4.1 Channel class
250
250
@@ -267,7 +267,7 @@ Coroutine:
267
267
4 . ` reset=None ` Optional tuple defining a reset pin (see below).
268
268
5 . ` verbose=True ` If ` True ` causes debug messages to be output.
269
269
6 . ` cr_go=False ` Optional coroutine to run at startup. See
270
- [ 4.2.2] ( ./README .md#422-optional-coroutines ) .
270
+ [ 4.2.2] ( ./I2C .md#422-optional-coroutines ) .
271
271
7 . ` go_args=() ` Optional tuple of args for above coro.
272
272
8 . ` cr_fail=False ` Optional coro to run on ESP8266 fail or reboot.
273
273
9 . ` f_args=() ` Optional tuple of args for above.
@@ -290,12 +290,12 @@ If the `Initiator` has no `reset` tuple and the `Responder` times out, an
290
290
2 . ` rxbufsize=200 ` Size of receive buffer. This should exceed the maximum
291
291
message length.
292
292
293
- See [ Section 4.2.1] ( ./README .md#421-configuration ) .
293
+ See [ Section 4.2.1] ( ./I2C .md#421-configuration ) .
294
294
295
295
##### Instance variables:
296
296
297
297
The ` Initiator ` maintains instance variables which may be used to measure its
298
- peformance. See [ Section 4.2.1] ( ./README .md#421-configuration ) .
298
+ peformance. See [ Section 4.2.1] ( ./I2C .md#421-configuration ) .
299
299
300
300
##### Coroutine:
301
301
1 . ` reboot ` If a ` reset ` tuple was provided, reboot the ` Responder ` .
@@ -353,7 +353,7 @@ from as_drivers.i2c.asi2c_i import Initiator
353
353
chan = Initiator(i2c, syn, ack, rst, verbose, self ._go, (), self ._fail)
354
354
```
355
355
356
- ###### [ Contents] ( ./README .md#contents )
356
+ ###### [ Contents] ( ./I2C .md#contents )
357
357
358
358
## 4.3 Responder class
359
359
@@ -372,7 +372,7 @@ chan = Initiator(i2c, syn, ack, rst, verbose, self._go, (), self._fail)
372
372
2 . ` rxbufsize=200 ` Size of receive buffer. This should exceed the maximum
373
373
message length. Consider reducing this in ESP8266 applications to save RAM.
374
374
375
- ###### [ Contents] ( ./README .md#contents )
375
+ ###### [ Contents] ( ./I2C .md#contents )
376
376
377
377
# 5. Limitations
378
378
@@ -428,7 +428,7 @@ This also has implications when testing. If a `Responder` application is
428
428
interrupted with ` ctrl-c ` the ISR will continue to run. To test crash detection
429
429
issue a soft or hard reset to the ` Responder ` .
430
430
431
- ###### [ Contents] ( ./README .md#contents )
431
+ ###### [ Contents] ( ./I2C .md#contents )
432
432
433
433
# 6. Hacker notes
434
434
0 commit comments