Skip to content

Commit de6e6dd

Browse files
committed
Add bus_names/0 to porting guide; fix ref
1 parent bfe771a commit de6e6dd

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

PORTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ The remain modifications should mostly be mechanical:
4141
collector will free unreferenced I2C references.
4242
7. If you manually implemented I2C bus retry logic, consider specifying the
4343
`:retries` option to have `Circuits.I2C` retry for you.
44+
8. Change calls to `ElixirALE.I2C.device_names/0` to `Circuits.I2C.bus_names/0`.
4445

4546
If you find that you have to make any other changes, please let us know via an
4647
issue or PR so that other users can benefit.

lib/i2c.ex

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ defmodule Circuits.I2C do
3434
I2C bus names depend on the platform. Names are of the form "i2c-n" where the
3535
"n" is the bus number. The correct bus number can be found in the
3636
documentation for the device or on a schematic. Another option is to call
37-
`Circuits.I2C.bus_names/1` to list them for you.
37+
`Circuits.I2C.bus_names/0` to list them for you.
3838
3939
I2c buses may be opened more than once. There is no need to share an I2C bus
4040
reference between modules.

0 commit comments

Comments
 (0)