8000 docs (pyboard): four minor changes/corrections by peterhinch · Pull Request #1909 · micropython/micropython · GitHub
[go: up one dir, main page]

Skip to content

docs (pyboard): four minor changes/corrections #1909

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

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
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
14 changes: 11 additions & 3 deletions docs/library/pyb.I2C.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,24 @@ Constructors

.. class:: pyb.I2C(bus, ...)

Construct an I2C object on the given bus. ``bus`` can be 1 or 2.
With no additional parameters, the I2C object is created but not
Construct an I2C object on the given bus. ``bus`` can be 1 or 2, 'X' or
'Y'. With no additional parameters, the I2C object is created but not
initialised (it has the settings from the last initialisation of
the bus, if any). If extra arguments are given, the bus is initialised.
See ``init`` for parameters of initialisation.

The physical pins of the I2C busses are:
The physical pins of the I2C busses on Pyboards V1.0 and V1.1 are:

- ``I2C(1)`` is on the X position: ``(SCL, SDA) = (X9, X10) = (PB6, PB7)``
- ``I2C(2)`` is on the Y position: ``(SCL, SDA) = (Y9, Y10) = (PB10, PB11)``

On the Pyboard Lite:

- ``I2C(1)`` is on the X position: ``(SCL, SDA) = (X9, X10) = (PB6, PB7)``
- ``I2C(3)`` is on the Y position: ``(SCL, SDA) = (Y9, Y10) = (PA8, PB8)``

Calling the constructor with 'X' or 'Y' enables portability between Pyboard
types.

Methods
-------
Expand Down
6 changes: 3 additions & 3 deletions docs/library/pyb.SPI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ Constructors

.. class:: pyb.SPI(bus, ...)

Construct an SPI object on the given bus. ``bus`` can be 1 or 2.
With no additional parameters, the SPI object is created but not
initialised (it has the settings from the last initialisation of
Construct an SPI object on the given bus. ``bus`` can be 1 or 2, or
'X' or 'Y'. With no additional parameters, the SPI object is created but
not initialised (it has the settings from the last initialisation of
the bus, if any). If extra arguments are given, the bus is initialised.
See ``init`` for parameters of initialisation.

Expand Down
2 changes: 1 addition & 1 deletion docs/library/pyb.UART.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Methods

.. method:: uart.any()

Return ``True`` if any characters waiting, else ``False``.
Returns the number of characters waiting (may be 0).

.. method:: uart.writechar(char)

Expand Down
4 changes: 2 additions & 2 deletions docs/pyboard/tutorial/assembler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ This code uses a few new concepts:
Accepting arguments
-------------------

Inline assembler functions can accept up to 3 arguments. If they are
used, they must be named ``r0``, ``r1`` and ``r2`` to reflect the registers
Inline assembler functions can accept up to 4 arguments. If they are
used, they must be named ``r0``, ``r1``, ``r2`` and ``r3`` to reflect the registers
and the calling conventions.

Here is a function that adds its arguments::
Expand Down
0