Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ports/psoc6: Fix i2c Documentation. #93

Merged
merged 1 commit into from
Sep 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/psoc6/quickref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,12 +186,12 @@ The constructor
^^^^^^^^^^^^^^^
An instance of the :mod:`machine.I2C` class can be created by invoking the constructor with all the
necessary parameters to fully configure the ``I2C``. By invoking the constructor, I2C peripheral is
initialized and configured to work in master mode.
initialized and configured to work in master mode. The maximum supported frequency is 1 MHz.

::

from machine import I2C
i2c = I2C(0,scl='P6_0',sda='P6_1',freq=4000000)
i2c = I2C(0,scl='P6_0',sda='P6_1',freq=400000)

Here, ``id=0`` should be passed mandatorily which selects the ``master`` mode operation.

Expand All @@ -203,7 +203,7 @@ Here, ``id=0`` should be passed mandatorily which selects the ``master`` mode op
::

from machine import I2C
i2c = I2C(0,scl='P9_0',sda='P9_1',freq=4000000) #I2C is initialised & configured with given scl,sda pins & frequency
i2c = I2C(0,scl='P9_0',sda='P9_1',freq=400000) #I2C is initialised & configured with given scl,sda pins & frequency

Methods
^^^^^^^
Expand Down
Loading