MicroPython:Библиотеки/pyb/Класс Pin: различия между версиями

Материал из Онлайн справочника
Перейти к навигацииПерейти к поиску
Нет описания правки
Нет описания правки
 
(не показано 12 промежуточных версий 1 участника)
Строка 11: Строка 11:
Все контакты платы предварительно определены в pyb.Pin.board.Name:
Все контакты платы предварительно определены в pyb.Pin.board.Name:


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
x1_pin = pyb.Pin.board.X1
x1_pin = pyb.Pin.board.X1


Строка 17: Строка 17:
</syntaxhighlight>
</syntaxhighlight>


Контакты CPU, соответствующие контактам платы, заданы в pyb.Pin.cpu.Name. Название CPU-контакта состоит из буквы порта, после которой идет номер контакта. На PYBv1.0 pyb.Pin.board.X1 и pyb.Pin.cpu.A0 – это один и тот же контакт.
Контакты [[CPU]], соответствующие контактам платы, заданы в ''pyb.Pin.cpu.Name''. Название CPU-контакта состоит из буквы порта, после которой идет номер контакта. На ''PYBv1.0 pyb.Pin.board.X1'' и ''pyb.Pin.cpu.A0'' – это один и тот же контакт.


Также можно использовать строки:
Также можно использовать строки:


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
g = pyb.Pin('X1', pyb.Pin.OUT_PP)
g = pyb.Pin('X1', pyb.Pin.OUT_PP)
</syntaxhighlight>
</syntaxhighlight>
Строка 27: Строка 27:
Кроме того, пользователи могут задавать собственные названия контактов...
Кроме того, пользователи могут задавать собственные названия контактов...


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
MyMapperDict = { 'LeftMotorDir' : pyb.Pin.cpu.C12 }
MyMapperDict = { 'LeftMotorDir' : pyb.Pin.cpu.C12 }
pyb.Pin.dict(MyMapperDict)
pyb.Pin.dict(MyMapperDict)
Строка 35: Строка 35:
...и запрашивать привязочные данные:
...и запрашивать привязочные данные:


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
pin = pyb.Pin("LeftMotorDir")
pin = pyb.Pin("LeftMotorDir")
</syntaxhighlight>
</syntaxhighlight>
Строка 41: Строка 41:
Также пользователь может создать собственную привязочную функцию:
Также пользователь может создать собственную привязочную функцию:


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
def MyMapper(pin_name):
def MyMapper(pin_name):
   if pin_name == "LeftMotorDir":
   if pin_name == "LeftMotorDir":
Строка 49: Строка 49:
</syntaxhighlight>
</syntaxhighlight>


Таким образом, если вызвать pyb.Pin("LeftMotorDir", pyb.Pin.OUT_PP), то контакт "LeftMotorDir" будет напрямую передан привязочной функции.
Таким образом, если вызвать ''pyb.Pin("LeftMotorDir", pyb.Pin.OUT_PP)'', то контакт ''"LeftMotorDir"'' будет напрямую передан привязочной функции.


Итак, привязка номера обычного контакта к какому-то интересному названию осуществляется в следующем порядке:
Итак, привязка номера обычного контакта к какому-то интересному названию осуществляется в следующем порядке:
# Напрямую указываем объект Pin.
# Напрямую указываем объект ''Pin''.
# Создаем пользовательскую привязочную функцию.
# Создаем пользовательскую привязочную функцию.
# Выполняем пользовательскую привязку (нужно, чтобы объект можно было использовать в качестве ключа словаря).
# Выполняем пользовательскую привязку (нужно, чтобы объект можно было использовать в качестве ключа словаря).
Строка 60: Строка 60:
Некоторую отладочную информацию о том, как объект привязан к контакту, можно узнать с помощью метода pyb.Pin.debug(True).
Некоторую отладочную информацию о том, как объект привязан к контакту, можно узнать с помощью метода pyb.Pin.debug(True).


Если у контакта включен режим Pin.PULL_UP или Pin.PULL_DOWN, его резистор на 40 кОм будет притянут, соответственно, либо к 3.3 вольтам, либо к «земле» (за исключением контакта Y5, который оснащен резисторами на 11 кОм).
Если у контакта включен режим [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.PULL_UP|Pin.PULL_UP]] или [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.PULL_DOWN|Pin.PULL_DOWN]], его [[резистор]] на [[40 кОм]] будет притянут, соответственно, либо к ''3.3 вольтам'', либо к ''«земле»'' (за исключением контакта ''Y5'', который оснащен [[резистор]]ами на [[11 кОм]]).
Теперь, когда на GPIO-контакте будет замечен задний фронт, это будет запускать функцию обратного вызова. Внимание: механические кнопки страдают так называемым «дребезгом» – их нажатие или отпускание может привести к нескольким ложным срабатываниям. Более подробно о дребезге, а также о том, как с ним справиться, читайте [http://www.eng.utah.edu/~cs5780/debouncing.pdf тут].


Все объекты Pin привязываются к GPIO-контактам через привязывающую функцию.
Теперь, когда на GPIO-контакте будет замечен задний фронт, это будет запускать функцию обратного вызова. Внимание: механические кнопки страдают так называемым ''«дребезгом»'' – их нажатие или отпускание может привести к нескольким ложным срабатываниям. Более подробно о дребезге, а также о том, как с ним справиться, читайте [http://www.eng.utah.edu/~cs5780/debouncing.pdf тут].
 
Все объекты ''Pin'' привязываются к GPIO-контактам через привязывающую функцию.


== Конструкторы ==
== Конструкторы ==


* Класс pyb.Pin(id, ...) – создает новый объект Pin, привязанный к идентификатору id. Если задать здесь дополнительные аргументы, они будут использованы для инициализации объекта Pin. Читайте о них в описании метода init().
* [[MicroPython:Библиотеки/pyb/Класс Pin/pyb.Pin()|pyb.Pin(id, ...)]]


== Методы класса ==
== Методы класса ==


* Pin.debug([state]) – задает или считывает то, включен ли режим отладки или нет (чтобы включить отладку, задайте True, а чтобы выключить – False).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.debug()|Pin.debug([state])]]
* Pin.dict([dict]) – задает или считывает словарь для привязки контактов.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.dict()|Pin.dict([dict])]]
* Pin.mapper([fun]) – задает или считывает привязочную функцию.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.mapper()|Pin.mapper([fun])]]


== Методы ==
== Методы ==


* Pin.init(mode, pull=Pin.PULL_NONE, af=- 1) – инициализирует контакт:
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.init()|Pin.init(mode, pull=Pin.PULL_NONE, af=- 1)]]
o В аргументе mode может быть следующее:
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.value()|Pin.value([value])]]
Pin.IN – делает контакт входящим.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.__str__()|Pin.__str__()]]
Pin.OUT_PP – делает контакт выходящим (обычный активный выход).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.af()|Pin.af()]]
Pin.OUT_OD – делает контакт выходящим (выход с открытым стоком).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.af_list()|Pin.af_list()]]
Pin.AF_PP – контакт будет выполнять альтернативную функцию (обычный активный выход).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.gpio()|Pin.gpio()]]
Pin.AF_OD – контакт будет выполнять альтернативную функцию (выход с открытым стоком).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.mode()|Pin.mode()]]
 Pin.ANALOG – делает контакт аналоговым.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.name()|Pin.name()]]
o В аргументе pull может быть следующее:
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.names()|Pin.names()]]
Pin.PULL_NONE – без подтягивающих/стягивающих резисторов.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.pin()|Pin.pin()]]
 Pin.PULL_UP – включает подтягивающий резистор.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.port()|Pin.port()]]
 Pin.PULL_DOWN – включает стягивающий резистор.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.pull()|Pin.pull()]]
Если задан режим Pin.AF_PP или Pin.AF_OD, то в аргументе af можно задать индекс или название одной из альтернативных функций, связанных с этим контактом.
Возвращает None.
* Pin.value([value]) – задает или считывает цифровой логический уровень контакта. Если не задать аргумент value, тот метод вернет «0» или «1» в зависимости от того, какой логический уровень в данный момент имеется на контакте. Если аргумент value будет задан, это задаст логический уровень на контакте. В value можно задать любое значение, которое можно преобразовать в булево значение. И если оно будет преобразовано в True, контакт получит высокий логический уровень, а если в False, то низкий.
* Pin.__str__() – возвращает строку, описывающую объект Pin.
* Pin.af() – возвращает альтернативную функцию контакта, заданную в данный момент. Возвращаемое целое число будет соответствовать одной из констант для аргумента af в методе init().
* Pin.af_list() – возвращает массив альтернативных функций, доступных на этом контакте.
* Pin.gpio() – возвращает базовый адрес GPIO-блока, связанного с контактом.
* Pin.mode() – возвращает режим, в котором в данный момент работает контакт. Возвращаемое целое число будет соответствовать одной из констант для аргумента mode в методе init().
* Pin.name() – считывает название контакта.
* Pin.names() – возвращает процессорное и платовое названия контакта.
* Pin.pin() – считывает номер контакта.  
* Pin.port() – считывает порт контакта.  
* Pin.pull() – возвращает резисторный режим, который в данный момент задан на контакте. Возвращаемое целое число будет соответствовать одной из констант для аргумента pull в методе init().


== Константы ==
== Константы ==


* Pin.AF_OD – инициализирует контакт в режиме альтернативной функции (выход с активным стоком).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.AF_OD|Pin.AF_OD]]
* Pin.AF_PP – инициализирует контакт в режиме альтернативной функции (обычный активный выход).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.AF_PP|Pin.AF_PP]]
* Pin.ANALOG – инициализирует контакт в аналоговым режиме.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.ANALOG|Pin.ANALOG]]
* Pin.IN – инициализирует контакт во входящем режиме.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.IN|Pin.IN]]
* Pin.OUT_OD – инициализирует контакт в выходящем режиме (выход с открытым стоком).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.OUT_OD|Pin.OUT_OD]]
* Pin.OUT_PP – инициализирует контакт в выходящем режиме (обычный активный выход).
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.OUT_PP|Pin.OUT_PP]]
* Pin.PULL_DOWN – включает на контакте стягивающий резистор.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.PULL_DOWN|Pin.PULL_DOWN]]
* Pin.PULL_NONE – на контакте не будет включено ни подтягивающего, ни стягивающего резистора.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.PULL_NONE|Pin.PULL_NONE]]
* Pin.PULL_UP – включает на контакте подтягивающий резистор.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Pin.PULL_UP|Pin.PULL_UP]]


== Класс PinAF – альтернативные функции контакта ==
== Класс PinAF – альтернативные функции контакта ==


В классе Pin реализована программная презентация физического контакта микропроцессора. Один контакт может выполнять несколько функций (GPIO, I2C SDA и т.д.) – их презентация реализуется с помощью класса PinAF.
В классе ''Pin'' реализована программная презентация физического контакта [[микропроцессор]]а. Один контакт может выполнять несколько функций ([[GPIO]], [[I2C]] [[SDA]] и т.д.) – их презентация реализуется с помощью класса PinAF.


Пример использования:
Пример использования:


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
x3 = pyb.Pin.board.X3
x3 = pyb.Pin.board.X3
x3_af = x3.af_list()
x3_af = x3.af_list()
</syntaxhighlight>
</syntaxhighlight>


В x3_af теперь будет содержаться массив объектов PinAF, доступных на контакте X3.  
В ''x3_af'' теперь будет содержаться массив объектов ''PinAF'', доступных на контакте X3.  


На PyBoard в x3_af будет содержаться:
На [[PyBoard]] в ''x3_af'' будет содержаться:


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
[Pin.AF1_TIM2, Pin.AF2_TIM5, Pin.AF3_TIM9, Pin.AF7_USART2]
[Pin.AF1_TIM2, Pin.AF2_TIM5, Pin.AF3_TIM9, Pin.AF7_USART2]
</syntaxhighlight>
</syntaxhighlight>
Строка 136: Строка 124:
Обычно каждый контакт самостоятельно настраивает свои альтернативные функции, но иногда одна и та же функция доступна на разных контактах, что вынуждает прибегнуть к использованию дополнительного кода.
Обычно каждый контакт самостоятельно настраивает свои альтернативные функции, но иногда одна и та же функция доступна на разных контактах, что вынуждает прибегнуть к использованию дополнительного кода.


Чтобы настроить X3 на использование TIM2_CH3, можно выполнить следующее:
Чтобы настроить ''X3'' на использование ''TIM2_CH3'', можно выполнить следующее:


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
pin = pyb.Pin(pyb.Pin.board.X3, mode=pyb.Pin.AF_PP, af=pyb.Pin.AF1_TIM2)
pin = pyb.Pin(pyb.Pin.board.X3, mode=pyb.Pin.AF_PP, af=pyb.Pin.AF1_TIM2)
</syntaxhighlight>
</syntaxhighlight>
Строка 144: Строка 132:
...или...
...или...


<syntaxhighlight lang="python" enclose="div">
<syntaxhighlight lang="python">
pin = pyb.Pin(pyb.Pin.board.X3, mode=pyb.Pin.AF_PP, af=1)
pin = pyb.Pin(pyb.Pin.board.X3, mode=pyb.Pin.AF_PP, af=1)
</syntaxhighlight>
</syntaxhighlight>
Строка 150: Строка 138:
===Методы===
===Методы===


* pinaf.__str__() – возвращает строку, описывающую альтернативную функцию.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Класс PinAF/pinaf.__str__()|pinaf.__str__()]]
* pinaf.index() – возвращает индекс альтернативной функции.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Класс PinAF/pinaf.index()|pinaf.index()]]
* pinaf.name() – возвращает название альтернативной функции.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Класс PinAF/pinaf.name()|pinaf.name()]]
* pinaf.reg() – возвращает базовый регистр, связанный с периферийным устройством, которое использует эту альтернативную функцию. К примеру, если альтернативная функция – это TIM2_CH3, то эта функция вернет stm.TIM2.
* [[MicroPython:Библиотеки/pyb/Класс Pin/Класс PinAF/pinaf.reg()|pinaf.reg()]]
 
 
 
<syntaxhighlight lang="python" enclose="div">


=См.также=
=См.также=

Текущая версия от 18:16, 14 мая 2023

Перевод: Максим Кузьмин
Проверка/Оформление/Редактирование: Мякишев Е.А.


Класс Pin – управление I/O-контактами[1]

Класс Pin – это базовый класс для управления I/O-контактами. В нем есть методы, чтобы задать режим работы контакта (входной, выходной и т.д.), а также методы, позволяющие задать и прочесть цифровой логический уровень контакта. Об управлении аналоговыми контактами читайте в статье о классе ADC.

Модель использования

Все контакты платы предварительно определены в pyb.Pin.board.Name:

x1_pin = pyb.Pin.board.X1

g = pyb.Pin(pyb.Pin.board.X1, pyb.Pin.IN)

Контакты CPU, соответствующие контактам платы, заданы в pyb.Pin.cpu.Name. Название CPU-контакта состоит из буквы порта, после которой идет номер контакта. На PYBv1.0 pyb.Pin.board.X1 и pyb.Pin.cpu.A0 – это один и тот же контакт.

Также можно использовать строки:

g = pyb.Pin('X1', pyb.Pin.OUT_PP)

Кроме того, пользователи могут задавать собственные названия контактов...

MyMapperDict = { 'LeftMotorDir' : pyb.Pin.cpu.C12 }
pyb.Pin.dict(MyMapperDict)
g = pyb.Pin("LeftMotorDir", pyb.Pin.OUT_OD)

...и запрашивать привязочные данные:

pin = pyb.Pin("LeftMotorDir")

Также пользователь может создать собственную привязочную функцию:

def MyMapper(pin_name):
   if pin_name == "LeftMotorDir":
       return pyb.Pin.cpu.A0

pyb.Pin.mapper(MyMapper)

Таким образом, если вызвать pyb.Pin("LeftMotorDir", pyb.Pin.OUT_PP), то контакт "LeftMotorDir" будет напрямую передан привязочной функции.

Итак, привязка номера обычного контакта к какому-то интересному названию осуществляется в следующем порядке:

  1. Напрямую указываем объект Pin.
  2. Создаем пользовательскую привязочную функцию.
  3. Выполняем пользовательскую привязку (нужно, чтобы объект можно было использовать в качестве ключа словаря).
  4. Задаем строку, соответствующую номеру платы.
  5. Задаем строку, соответствующую контакту/порту CPU.

Некоторую отладочную информацию о том, как объект привязан к контакту, можно узнать с помощью метода pyb.Pin.debug(True).

Если у контакта включен режим Pin.PULL_UP или Pin.PULL_DOWN, его резистор на 40 кОм будет притянут, соответственно, либо к 3.3 вольтам, либо к «земле» (за исключением контакта Y5, который оснащен резисторами на 11 кОм).

Теперь, когда на GPIO-контакте будет замечен задний фронт, это будет запускать функцию обратного вызова. Внимание: механические кнопки страдают так называемым «дребезгом» – их нажатие или отпускание может привести к нескольким ложным срабатываниям. Более подробно о дребезге, а также о том, как с ним справиться, читайте тут.

Все объекты Pin привязываются к GPIO-контактам через привязывающую функцию.

Конструкторы

Методы класса

Методы

Константы

Класс PinAF – альтернативные функции контакта

В классе Pin реализована программная презентация физического контакта микропроцессора. Один контакт может выполнять несколько функций (GPIO, I2C SDA и т.д.) – их презентация реализуется с помощью класса PinAF.

Пример использования:

x3 = pyb.Pin.board.X3
x3_af = x3.af_list()

В x3_af теперь будет содержаться массив объектов PinAF, доступных на контакте X3.

На PyBoard в x3_af будет содержаться:

[Pin.AF1_TIM2, Pin.AF2_TIM5, Pin.AF3_TIM9, Pin.AF7_USART2]

Обычно каждый контакт самостоятельно настраивает свои альтернативные функции, но иногда одна и та же функция доступна на разных контактах, что вынуждает прибегнуть к использованию дополнительного кода.

Чтобы настроить X3 на использование TIM2_CH3, можно выполнить следующее:

pin = pyb.Pin(pyb.Pin.board.X3, mode=pyb.Pin.AF_PP, af=pyb.Pin.AF1_TIM2)

...или...

pin = pyb.Pin(pyb.Pin.board.X3, mode=pyb.Pin.AF_PP, af=1)

Методы

См.также

Внешние ссылки