Skip to content

Commit 51019b6

Browse files
authored
Give examples of bus wrappers
It was a frustrating experience trying to figure out how to actually get an `SpiDevice`, and "This crate provides mechanisms to connect an `SpiBus` and a `SpiDevice`", with no further explanation, did not help. So I added some further explanation.
1 parent 5209452 commit 51019b6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

embedded-hal-bus/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ while `SpiDevice` represents a device on that bus. For further details on these
2121
However, device drivers should use the `SpiDevice` traits, _not the `SpiBus` traits_ if at all possible
2222
in order to allow for sharing of the bus they are connected to.
2323

24-
This crate provides mechanisms to connect a `SpiBus` and a `SpiDevice`.
24+
This crate provides mechanisms to connect a `SpiBus` and a `SpiDevice`. See for instance `ExclusiveDevice::new_no_delay`
25+
or `ExclusiveDevice::new`, or similarly for `CriticalSectionDevice`, `AtomicDevice`, `RefCellDevice`, etc., which wrap an
26+
`SpiBus` and provide an `SpiDevice` with differing access semantics.
2527

2628
## I2C
2729

0 commit comments

Comments
 (0)