Pin - Control I/O Pins

This class provides methods of reading and writing GPIO. A pin object is used to control I/O pins (also known as GPIO - general-purpose input/output). The pin class has methods to set the mode of the pin (IN, OUT, etc) and methods to get and set the digital logic level.

Example:

from machine import Pin

# Creates a GPIO object
gpio1 = Pin(Pin.GPIO1, Pin.OUT, Pin.PULL_DISABLE, 1)

# Gets the pin level
gpio1.read()

# Sets the pin level
gpio1.write(0)
gpio1.write(1)

# Sets input and output modes
gpio1.set_dir(Pin.IN)
gpio1.set_dir(Pin.OUT)

# Gets input and output modes
gpio1.get_dir()

Constructor #

machine.Pin #

class machine.Pin(GPIOn, direction, pullMode, level)

Parameter:

• GPIOn - Integer type. GPIO number. Click here to view the mapping relationship between GPIO pin numbers and physical pins.
• direction - Integer type. I/O mode. IN - Input mode. OUT - Output mode.
• pullMode - Integer type. Pull selection mode. Descriptions are as follows:
  PULL_DISABLE - Floating mode
  PULL_PU - Pull-up mode
  PULL_PD - Pull-down mode
• level - Integer type. Pin level. 0 - Set pin to low level. 1 - Set pin to high level.

Example:

>>> # Creates a GPIO object
>>> from machine import Pin
>>> gpio1 = Pin(Pin.GPIO1, Pin.OUT, Pin.PULL_DISABLE, 0)

Mapping Relationship Between GPIO Pin Numbers and Physical Pins:

Description of GPIO corresponding pin numbers: GPIO pin numbers provided in the document correspond to external pin numbers of the module. For example, for EC600M-CN module, GPIO1 corresponds to pin10, which is an external pin number of the module. See the provided hardware documents for external pin numbers of the module.

Methods #

Pin.read #

Pin.read()

This method reads the pin level.

Return Value:

Pin level. 0 - low level. 1 - high level.

Pin.write #

Pin.write(value)

This method sets the pin level.

Note: You need to ensure that the pin is in the output mode before you set the pin level.

Parameter:

• value - Integer type. Pin level. 0 - low level. 1 - high level.

Return Value:

0 - Successful execution

-1 - Failed execution

Example:

>>> from machine import Pin
>>> gpio1 = Pin(Pin.GPIO1, Pin.OUT, Pin.PULL_DISABLE, 0)
>>> gpio1.write(1)
0
>>> gpio1.read()
1

Pin.set_dir #

Pin.set_dir(value)

This method sets I/O mode of the pin.

Parameter:

• value - Integer type. I/O mode of the pin. 0 - Input mode. 1 - Output mode.

Return Value:

0 - Successful execution

-1 - Failed execution

Pin.get_dir #

Pin.get_dir()

This method gets I/O mode of the pin.

Return Value:

I/O mode of pins.

0 - Input mode.

1 - Output mode.

Example:

>>> from machine import Pin
>>> gpio1 = Pin(Pin.GPIO1, Pin.OUT, Pin.PULL_DISABLE, 0)
>>> gpio1.get_dir()
1
>>> gpio1.set_dir(Pin.IN)
0
>>> gpio1.get_dir()
0

Constants #

1. Constructor
   1. machine.Pin
2. Methods
   1. Pin.read
   2. Pin.write
   3. Pin.set_dir
   4. Pin.get_dir
3. Constants