djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/machine.Pin: Update to use preferred DRIVE_x constants.

Browse Source 
Update documents with new common names for the drive strength constants.
This commit is contained in:
Jonathan Hogg 2022-03-07 09:03:54 +00:00 committed by Damien George
parent 4c7c80d626
commit 3ebc370344
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/library/machine.Pin.rst
View File

@ -87,9 +87,9 @@ Constructors
output pin value if given, otherwise the state of the pin peripheral remains output pin value if given, otherwise the state of the pin peripheral remains
unchanged. unchanged.
- ``drive`` specifies the output power of the pin and can be one of: ``Pin.LOW_POWER``, - ``drive`` specifies the output power of the pin and can be one of: ``Pin.DRIVE_0``,
``Pin.MED_POWER`` or ``Pin.HIGH_POWER``. The actual current driving capabilities ``Pin.DRIVE_1``, etc., increasing in drive strength. The actual current driving
are port dependent. Not all ports implement this argument. capabilities are port dependent. Not all ports implement this argument.
- ``alt`` specifies an alternate function for the pin and the values it can take are - ``alt`` specifies an alternate function for the pin and the values it can take are
port dependent. This argument is valid only for ``Pin.ALT`` and ``Pin.ALT_OPEN_DRAIN`` port dependent. This argument is valid only for ``Pin.ALT`` and ``Pin.ALT_OPEN_DRAIN``
@ -260,11 +260,13 @@ not all constants are available on all ports.
Selects whether there is a pull up/down resistor. Use the value Selects whether there is a pull up/down resistor. Use the value
``None`` for no pull. ``None`` for no pull.
.. data:: Pin.LOW_POWER .. data:: Pin.DRIVE_0
Pin.MED_POWER Pin.DRIVE_1
Pin.HIGH_POWER Pin.DRIVE_2
Selects the pin drive strength. Selects the pin drive strength. A port may define additional drive
constants with increasing number corresponding to increasing drive
strength.
.. data:: Pin.IRQ_FALLING .. data:: Pin.IRQ_FALLING
Pin.IRQ_RISING Pin.IRQ_RISING