docs/library: Remove unnecessary "pyb." prefix on class names.
Otherwise these classes are refered to with a double prefix, like pyb.pyb.ADC. Signed-off-by: Damien George <damien@micropython.org>
This commit is contained in:
parent
89e1e67748
commit
9175482f29
|
@ -23,7 +23,7 @@ Usage::
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.ADC(pin)
|
.. class:: ADC(pin)
|
||||||
|
|
||||||
Create an ADC object associated with the given pin.
|
Create an ADC object associated with the given pin.
|
||||||
This allows you to then read analog values on that pin.
|
This allows you to then read analog values on that pin.
|
||||||
|
|
|
@ -16,7 +16,7 @@ Raw values are between -32 and 31.
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.Accel()
|
.. class:: Accel()
|
||||||
|
|
||||||
Create and return an accelerometer object.
|
Create and return an accelerometer object.
|
||||||
|
|
||||||
|
|
|
@ -31,7 +31,7 @@ for both classic and FD CAN controllers, unless otherwise stated.
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.CAN(bus, ...)
|
.. class:: CAN(bus, ...)
|
||||||
|
|
||||||
Construct a CAN object on the given bus. *bus* can be 1-2, or ``'YA'`` or ``'YB'``.
|
Construct a CAN object on the given bus. *bus* can be 1-2, or ``'YA'`` or ``'YB'``.
|
||||||
With no additional parameters, the CAN object is created but not
|
With no additional parameters, the CAN object is created but not
|
||||||
|
|
|
@ -49,7 +49,7 @@ To output a continuous sine-wave at 12-bit resolution::
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.DAC(port, bits=8, *, buffering=None)
|
.. class:: DAC(port, bits=8, *, buffering=None)
|
||||||
|
|
||||||
Construct a new DAC object.
|
Construct a new DAC object.
|
||||||
|
|
||||||
|
|
|
@ -51,7 +51,7 @@ usrsw.h for an example of using this.
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.ExtInt(pin, mode, pull, callback)
|
.. class:: ExtInt(pin, mode, pull, callback)
|
||||||
|
|
||||||
Create an ExtInt object:
|
Create an ExtInt object:
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ application.
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.Flash()
|
.. class:: Flash()
|
||||||
|
|
||||||
Create and return a block device that represents the flash device presented
|
Create and return a block device that represents the flash device presented
|
||||||
to the USB mass storage interface.
|
to the USB mass storage interface.
|
||||||
|
@ -25,7 +25,7 @@ Constructors
|
||||||
|
|
||||||
This constructor is deprecated and will be removed in a future version of MicroPython.
|
This constructor is deprecated and will be removed in a future version of MicroPython.
|
||||||
|
|
||||||
.. class:: pyb.Flash(*, start=-1, len=-1)
|
.. class:: Flash(*, start=-1, len=-1)
|
||||||
:noindex:
|
:noindex:
|
||||||
|
|
||||||
Create and return a block device that accesses the flash at the specified offset. The length defaults to the remaining size of the device.
|
Create and return a block device that accesses the flash at the specified offset. The length defaults to the remaining size of the device.
|
||||||
|
|
|
@ -56,7 +56,7 @@ Master also has other methods::
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.I2C(bus, ...)
|
.. class:: I2C(bus, ...)
|
||||||
|
|
||||||
Construct an I2C object on the given bus. ``bus`` can be 1 or 2, 'X' or
|
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
|
'Y'. With no additional parameters, the I2C object is created but not
|
||||||
|
|
|
@ -41,7 +41,7 @@ For example, to make a bouncing dot, try::
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.LCD(skin_position)
|
.. class:: LCD(skin_position)
|
||||||
|
|
||||||
Construct an LCD object in the given skin position. ``skin_position`` can be 'X' or 'Y', and
|
Construct an LCD object in the given skin position. ``skin_position`` can be 'X' or 'Y', and
|
||||||
should match the position where the LCD pyskin is plugged in.
|
should match the position where the LCD pyskin is plugged in.
|
||||||
|
|
|
@ -10,7 +10,7 @@ The LED object controls an individual LED (Light Emitting Diode).
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.LED(id)
|
.. class:: LED(id)
|
||||||
|
|
||||||
Create an LED object associated with the given LED:
|
Create an LED object associated with the given LED:
|
||||||
|
|
||||||
|
|
|
@ -74,7 +74,7 @@ gpio pins.
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.Pin(id, ...)
|
.. class:: Pin(id, ...)
|
||||||
|
|
||||||
Create a new Pin object associated with the id. If additional arguments are given,
|
Create a new Pin object associated with the id. If additional arguments are given,
|
||||||
they are used to initialise the pin. See :meth:`pin.init`.
|
they are used to initialise the pin. See :meth:`pin.init`.
|
||||||
|
|
|
@ -17,7 +17,7 @@ Example usage::
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.RTC()
|
.. class:: RTC()
|
||||||
|
|
||||||
Create an RTC object.
|
Create an RTC object.
|
||||||
|
|
||||||
|
|
|
@ -28,7 +28,7 @@ Additional methods for SPI::
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.SPI(bus, ...)
|
.. class:: SPI(bus, ...)
|
||||||
|
|
||||||
Construct an SPI object on the given bus. ``bus`` can be 1 or 2, or
|
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
|
'X' or 'Y'. With no additional parameters, the SPI object is created but
|
||||||
|
|
|
@ -30,7 +30,7 @@ Example usage::
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.Servo(id)
|
.. class:: Servo(id)
|
||||||
|
|
||||||
Create a servo object. ``id`` is 1-4, and corresponds to pins X1 through X4.
|
Create a servo object. ``id`` is 1-4, and corresponds to pins X1 through X4.
|
||||||
|
|
||||||
|
|
|
@ -23,7 +23,7 @@ Example::
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.Switch()
|
.. class:: Switch()
|
||||||
|
|
||||||
Create and return a switch object.
|
Create and return a switch object.
|
||||||
|
|
||||||
|
|
|
@ -53,7 +53,7 @@ limitation.
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.Timer(id, ...)
|
.. class:: Timer(id, ...)
|
||||||
|
|
||||||
Construct a new timer object of the given id. If additional
|
Construct a new timer object of the given id. If additional
|
||||||
arguments are given, then the timer is initialised by ``init(...)``.
|
arguments are given, then the timer is initialised by ``init(...)``.
|
||||||
|
|
|
@ -46,7 +46,7 @@ Earlier versions use ``uart.send`` and ``uart.recv``.
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.UART(bus, ...)
|
.. class:: UART(bus, ...)
|
||||||
|
|
||||||
Construct a UART object on the given bus.
|
Construct a UART object on the given bus.
|
||||||
For Pyboard ``bus`` can be 1-4, 6, 'XA', 'XB', 'YA', or 'YB'.
|
For Pyboard ``bus`` can be 1-4, 6, 'XA', 'XB', 'YA', or 'YB'.
|
||||||
|
|
|
@ -13,7 +13,7 @@ Before you can use this class, you need to use :meth:`pyb.usb_mode()` to set the
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.USB_HID()
|
.. class:: USB_HID()
|
||||||
|
|
||||||
Create a new USB_HID object.
|
Create a new USB_HID object.
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ the connected host.
|
||||||
Constructors
|
Constructors
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. class:: pyb.USB_VCP(id=0)
|
.. class:: USB_VCP(id=0)
|
||||||
|
|
||||||
Create a new USB_VCP object. The *id* argument specifies which USB VCP port to
|
Create a new USB_VCP object. The *id* argument specifies which USB VCP port to
|
||||||
use.
|
use.
|
||||||
|
|
Loading…
Reference in New Issue