Skip to content

Commit c5e3271

Browse files
committed
new note tags
1 parent 7a157a5 commit c5e3271

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/ar_ibus.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ The interface methods:
3838
**readRegisterWord** | Read a word of data from a particular register of a device |
3939
**readRegisterRegion** | Read an array of data from a particular register of a device |
4040

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.
4243
4344
### The sfeTkII2C Implementation
4445

@@ -50,7 +51,8 @@ This class sub-classes from the ```sfeTkIBus``` interface adding additional func
5051
**setAddress** | Set the I2C address to use for this I2C object |
5152
**address** | Returns the address used by this I2C object |
5253

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.
5456
5557
### The sfeTkISPI Implementation
5658

@@ -61,7 +63,8 @@ This class sub-classes from the ```sfeTkIBus``` interface adding additional func
6163
**setCS** | Set the CS Pin to use for this SPI object |
6264
**cs** | Returns the CS Pin used by this SPI object |
6365

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.
6568
6669
The class diagram of these base class interfaces/implementation:
6770

@@ -73,7 +76,8 @@ The initial implementation of the toolkit IBus interface is for the Arduino envi
7376

7477
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.
7578

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.
7781
7882
The class diagram for the Arduino implementation is as follows:
7983

0 commit comments

Comments
 (0)