summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien George <damien@micropython.org>2021-02-01 13:40:28 +1100
committerDamien George <damien@micropython.org>2021-02-03 00:54:18 +1100
commit0e4458707673bdf04a812ab9cd2ae06712bcdd1a (patch)
tree66242e2dbadc65c8caa5ae1565c6d46a5b377972
parent195e7dfa0681bcfbc67cfaa68f863c51dcac95da (diff)
docs/library/machine.Pin.rst: Make it clear which methods are not core.
Signed-off-by: Damien George <damien@micropython.org>
-rw-r--r--docs/library/machine.Pin.rst58
1 files changed, 37 insertions, 21 deletions
diff --git a/docs/library/machine.Pin.rst b/docs/library/machine.Pin.rst
index 095240fe1..f8e9e1054 100644
--- a/docs/library/machine.Pin.rst
+++ b/docs/library/machine.Pin.rst
@@ -33,8 +33,8 @@ Usage Model::
# read and print the pin value
print(p2.value())
- # reconfigure pin #0 in input mode
- p0.mode(p0.IN)
+ # reconfigure pin #0 in input mode with a pull down resistor
+ p0.init(p0.IN, p0.PULL_DOWN)
# configure an irq callback
p0.irq(lambda p:print(p))
@@ -160,25 +160,6 @@ Methods
Set pin to "0" output level.
-.. method:: Pin.mode([mode])
-
- Get or set the pin mode.
- See the constructor documentation for details of the ``mode`` argument.
-
-.. method:: Pin.pull([pull])
-
- Get or set the pin pull state.
- See the constructor documentation for details of the ``pull`` argument.
-
-.. method:: Pin.drive([drive])
-
- Get or set the pin drive strength.
- See the constructor documentation for details of the ``drive`` argument.
-
- Not all ports implement this method.
-
- Availability: WiPy.
-
.. method:: Pin.irq(handler=None, trigger=(Pin.IRQ_FALLING | Pin.IRQ_RISING), *, priority=1, wake=None, hard=False)
Configure an interrupt handler to be called when the trigger source of the
@@ -220,6 +201,41 @@ Methods
This method returns a callback object.
+The following methods are not part of the core Pin API and only implemented on certain ports.
+
+.. method:: Pin.low()
+
+ Set pin to "0" output level.
+
+ Availability: nrf, rp2, stm32 ports.
+
+.. method:: Pin.high()
+
+ Set pin to "1" output level.
+
+ Availability: nrf, rp2, stm32 ports.
+
+.. method:: Pin.mode([mode])
+
+ Get or set the pin mode.
+ See the constructor documentation for details of the ``mode`` argument.
+
+ Availability: cc3200, stm32 ports.
+
+.. method:: Pin.pull([pull])
+
+ Get or set the pin pull state.
+ See the constructor documentation for details of the ``pull`` argument.
+
+ Availability: cc3200, stm32 ports.
+
+.. method:: Pin.drive([drive])
+
+ Get or set the pin drive strength.
+ See the constructor documentation for details of the ``drive`` argument.
+
+ Availability: cc3200 port.
+
Constants
---------