Skip to content

Commit 055d478

Browse files
committed
latest state of the docs
1 parent 4bb58ca commit 055d478

File tree

5 files changed

+10
-2
lines changed

5 files changed

+10
-2
lines changed

docs/ar_ibus.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,13 @@ The interface methods:
5757
> [!NOTE]
5858
> This interface only defines the methods to read and write data on the given bus. Any address, or bus specific settings is provided/implemented by the implementation/specialization of this interface.
5959
60+
The Inteface diagram for the ```sfeTkIBus``` is:
61+
62+
![IIBus Interface](images/tk_uml_ibus.png)
63+
6064
### The sfeTkII2C Implementation
6165

62-
This class sub-classes from the ```sfeTkIBus``` interface adding additional functionally focused on supporting an I2C implementation. This interface provides the additional functionality.
66+
This class sub-classes from the ```sfeTkIBus``` interface adding additional functionally focused on supporting an I2C implementation. This class does not implement the IIBus interface, so it's abstract, but the class adds the additional functionality.
6367

6468
| Method| Definition |
6569
|------|-------|
@@ -70,6 +74,10 @@ This class sub-classes from the ```sfeTkIBus``` interface adding additional func
7074
> [!NOTE]
7175
> The ```sfeTkII2C``` class manages the device address for the I2C bus. As such, each I2C device instantiates/uses an instance of the ```sfeTkII2C``` class.
7276
77+
The class diagram for the ```sfeTkII2C``` interface is the following:
78+
79+
![II2C Class Diagram](images/tk_uml_ii2c.png)
80+
7381
### The sfeTkISPI Implementation
7482

7583
This class sub-classes from the ```sfeTkIBus``` interface adding additional functionally focused on supporting an SPI implementation. This interface provides the additional functionality.
@@ -84,7 +92,7 @@ This class sub-classes from the ```sfeTkIBus``` interface adding additional func
8492
8593
The class diagram of these base class interfaces/implementation:
8694

87-
![IBus diagram](images/tk_IBUS.png)
95+
![ISPI Class Diagram](images/tk_uml_ispi.png)
8896

8997
## sfeTkIIBus - Arduino Implementation
9098

docs/images/tk_IBUS.png

-100 KB
Binary file not shown.

docs/images/tk_uml_ibus.png

64 KB
Loading

docs/images/tk_uml_ii2c.png

171 KB
Loading

docs/images/tk_uml_ispi.png

163 KB
Loading

0 commit comments

Comments
 (0)