You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ar_ibus.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,8 @@ The interface methods:
38
38
**readRegisterWord** | Read a word of data from a particular register of a device |
39
39
**readRegisterRegion** | Read an array of data from a particular register of a device |
40
40
41
-
> Note: 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.
41
+
> [!NOTE]
42
+
> 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.
42
43
43
44
### The sfeTkII2C Implementation
44
45
@@ -50,7 +51,8 @@ This class sub-classes from the ```sfeTkIBus``` interface adding additional func
50
51
**setAddress** | Set the I2C address to use for this I2C object |
51
52
**address** | Returns the address used by this I2C object |
52
53
53
-
> Note: The ```sfeTkII2C``` class manages the device address for the I2C bus. As such, each I2C device instantiates/uses a instance of the ```sfeTkII2C``` class.
54
+
> [!NOTE]
55
+
> The ```sfeTkII2C``` class manages the device address for the I2C bus. As such, each I2C device instantiates/uses a instance of the ```sfeTkII2C``` class.
54
56
55
57
### The sfeTkISPI Implementation
56
58
@@ -61,7 +63,8 @@ This class sub-classes from the ```sfeTkIBus``` interface adding additional func
61
63
**setCS** | Set the CS Pin to use for this SPI object |
62
64
**cs** | Returns the CS Pin used by this SPI object |
63
65
64
-
> Note: The ```sfeTkISPI``` class manages CS Pin for the SPI bus. As such, each SPI device instantiates/uses a instance of the ```sfeTkISPI``` class.
66
+
> [!NOTE]
67
+
> The ```sfeTkISPI``` class manages CS Pin for the SPI bus. As such, each SPI device instantiates/uses a instance of the ```sfeTkISPI``` class.
65
68
66
69
The class diagram of these base class interfaces/implementation:
67
70
@@ -73,7 +76,8 @@ The initial implementation of the toolkit IBus interface is for the Arduino envi
73
76
74
77
These driver implementations provide the platform specific implementation for the toolkit bus interfaces, supporting the methods defined by the interfaces, as well as contain and manage the platform specific settings and attributes for each bus type.
75
78
76
-
> Note: The intent is that each user of an particular bus - a device in most cases - contains an instance of the specific bus object.
79
+
> [!IMPORTANT]
80
+
> The intent is that each user of an particular bus - a device in most cases - contains an instance of the specific bus object.
77
81
78
82
The class diagram for the Arduino implementation is as follows:
0 commit comments