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

Материал из Онлайн справочника
Перейти к навигацииПерейти к поиску
Нет описания правки
Нет описания правки
Строка 5: Строка 5:
=Модуль network – настройки сети<ref>[http://docs.micropython.org/en/latest/library/network.html docs.micropython.org - network — network configuration]</ref>=
=Модуль network – настройки сети<ref>[http://docs.micropython.org/en/latest/library/network.html docs.micropython.org - network — network configuration]</ref>=


В этом модуле реализованы сетевые драйверы и настройки маршрутизации. Чтобы использовать этот модуль, у вас должна быть установлена версия/билд MicroPython с возможностями работы с сетью. Сетевые драйверы для различного сетевого оборудования, входящие в этот модуль, используются для настройки аппаратного сетевого интерфейса (или интерфейсов). После того, как настроенные сетевые интерфейсы предоставят доступ к сетевым службам, вы сможете воспользоваться ими с помощью модуля usocket.  
В этом модуле реализованы сетевые драйверы и настройки маршрутизации. Чтобы использовать этот модуль, у вас должна быть установлена версия/билд [[MicroPython]] с возможностями работы с сетью. Сетевые драйверы для различного сетевого оборудования, входящие в этот модуль, используются для настройки аппаратного сетевого интерфейса (или интерфейсов). После того, как настроенные сетевые интерфейсы предоставят доступ к сетевым службам, вы сможете воспользоваться ими с помощью модуля usocket.  


Например:
Например:
Строка 35: Строка 35:


В этом разделе описывается (скрытый) абстрактный базовый класс для всех классов сетевого интерфейса, реализованных в MicroPython для разных платформ. Это значит, что в MicroPython нет класса AbstractNIC, но при этом описанные ниже методы реализованы во всех NIC-классах (от англ. «network interface», то есть «сетевой интерфейс»).
В этом разделе описывается (скрытый) абстрактный базовый класс для всех классов сетевого интерфейса, реализованных в MicroPython для разных платформ. Это значит, что в MicroPython нет класса AbstractNIC, но при этом описанные ниже методы реализованы во всех NIC-классах (от англ. «network interface», то есть «сетевой интерфейс»).
* [[MicroPython:Библиотеки/network/network.AbstractNIC()|network.AbstractNIC()]]
* [[MicroPython:Библиотеки/network/AbstractNIC.active()|AbstractNIC.active()]]
* [[MicroPython:Библиотеки/network/AbstractNIC.connect()|AbstractNIC.connect()]]
* [[MicroPython:Библиотеки/network/AbstractNIC.disconnect()|AbstractNIC.disconnect()]]
* [[MicroPython:Библиотеки/network/AbstractNIC.isconnected()|AbstractNIC.isconnected()]]
* [[MicroPython:Библиотеки/network/AbstractNIC.scan()|AbstractNIC.scan()]]
* [[MicroPython:Библиотеки/network/AbstractNIC.status()|AbstractNIC.status()]]
* [[MicroPython:Библиотеки/network/AbstractNIC.ifconfig()|AbstractNIC.ifconfig()]]
* [[MicroPython:Библиотеки/network/AbstractNIC.config()|AbstractNIC.config()]]
* [[MicroPython:Библиотеки/network/
* [[MicroPython:Библиотеки/network/
* [[MicroPython:Библиотеки/network/
* [[MicroPython:Библиотеки/network/
* Класс network.AbstractNIC(id=None, ...) – инстанцинирует объект сетевого интерфейса. Аргументы зависят от используемого сетевого интерфейса. Если интерфейсов одного и того же типа больше одного, первым аргументом должен быть id.
* Класс network.AbstractNIC(id=None, ...) – инстанцинирует объект сетевого интерфейса. Аргументы зависят от используемого сетевого интерфейса. Если интерфейсов одного и того же типа больше одного, первым аргументом должен быть id.
* AbstractNIC.active([is_active]) – если в аргументе is_active задано булево значение, этот метод активирует или деактивирует сетевой интерфейс. Если аргумента is_active задано не будет, он возвращает текущее состояние сетевого интерфейса. Большинству других методов требуется активное состояние интерфейса (их поведение в ситуации, когда они будут вызваны при неактивном интерфейсе, не задано).  
* AbstractNIC.active([is_active]) – если в аргументе is_active задано булево значение, этот метод активирует или деактивирует сетевой интерфейс. Если аргумента is_active задано не будет, он возвращает текущее состояние сетевого интерфейса. Большинству других методов требуется активное состояние интерфейса (их поведение в ситуации, когда они будут вызваны при неактивном интерфейсе, не задано).  
Строка 59: Строка 75:
print(ap.config('essid'))
print(ap.config('essid'))
print(ap.config('channel'))
print(ap.config('channel'))
Специфические реализации класса  
 
== Специфические реализации класса ==
 
В классах ниже в разных вариациях реализован интерфейс AbstractNIC – каждая из этих вариаций позволяет управлять разными типами сетевых интерфейсов:
В классах ниже в разных вариациях реализован интерфейс AbstractNIC – каждая из этих вариаций позволяет управлять разными типами сетевых интерфейсов:
* Класс WLAN – управление встроенными WiFi-интерфейсами
 
* Класс WLANWiPy – управление WiFi-интерфейсом с особенностями WiPy
* [[MicroPython:Библиотеки/network/Класс WLAN|Класс WLAN – управление встроенными WiFi-интерфейсами]]
* Класс CC3K – управление WiFi-модулями CC3000
* [[MicroPython:Библиотеки/network/Класс WLANWiPy|Класс WLANWiPy – управление WiFi-интерфейсом с особенностями WiPy]]
* Класс WIZNET5K – управление Ethernet-модулями WIZnet5x00
* [[MicroPython:Библиотеки/network/Класс CC3K|Класс CC3K – управление WiFi-модулями CC3000]]
Сетевые функции
* [[MicroPython:Библиотеки/network/Класс WIZNET5K|Класс WIZNET5K – управление Ethernet-модулями WIZnet5x00]]
 
== Сетевые функции ==
 
Здесь описаны дополнительные функции модуля network:
Здесь описаны дополнительные функции модуля network:
* [[MicroPython:Библиотеки/network/network.phy_mode()|network.phy_mode()]]
* network.phy_mode([mode]) – задает или считывает PHY-режим.
* network.phy_mode([mode]) – задает или считывает PHY-режим.
Если аргумент mode задан, эта функция устанавливает PHY-режим. Если аргумента mode не задано, функция возвращает текущий PHY-режим. Режимы, которые можно задать (в виде констант):
Если аргумент mode задан, эта функция устанавливает PHY-режим. Если аргумента mode не задано, функция возвращает текущий PHY-режим. Режимы, которые можно задать (в виде констант):
Строка 72: Строка 96:
** MODE_11G – IEEE 802.11g.
** MODE_11G – IEEE 802.11g.
** MODE_11N – IEEE 802.11n.
** MODE_11N – IEEE 802.11n.
Доступность: ESP8266.
Доступность: ESP8266.



Версия от 19:53, 20 сентября 2020

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


Модуль network – настройки сети[1]

В этом модуле реализованы сетевые драйверы и настройки маршрутизации. Чтобы использовать этот модуль, у вас должна быть установлена версия/билд MicroPython с возможностями работы с сетью. Сетевые драйверы для различного сетевого оборудования, входящие в этот модуль, используются для настройки аппаратного сетевого интерфейса (или интерфейсов). После того, как настроенные сетевые интерфейсы предоставят доступ к сетевым службам, вы сможете воспользоваться ими с помощью модуля usocket.

Например:

# Подключение и печать IP-настроек сетевого интерфейса.
# Примеры специфических драйверов смотрите ниже.
import network
import utime
nic = network.Driver(...)
if not nic.isconnected():
    nic.connect()
    print("Ждем соединения...")
    while not nic.isconnected():
        utime.sleep(1)
print(nic.ifconfig())

# Теперь используем «usocket» как обычно:
import usocket as socket
addr = socket.getaddrinfo('micropython.org', 80)[0][-1]
s = socket.socket()
s.connect(addr)
s.send(b'GET / HTTP/1.1\r\nHost: micropython.org\r\n\r\n')
data = s.recv(1000)
s.close()

Общий интерфейс сетевого адаптера

В этом разделе описывается (скрытый) абстрактный базовый класс для всех классов сетевого интерфейса, реализованных в MicroPython для разных платформ. Это значит, что в MicroPython нет класса AbstractNIC, но при этом описанные ниже методы реализованы во всех NIC-классах (от англ. «network interface», то есть «сетевой интерфейс»).


  • Класс network.AbstractNIC(id=None, ...) – инстанцинирует объект сетевого интерфейса. Аргументы зависят от используемого сетевого интерфейса. Если интерфейсов одного и того же типа больше одного, первым аргументом должен быть id.
  • AbstractNIC.active([is_active]) – если в аргументе is_active задано булево значение, этот метод активирует или деактивирует сетевой интерфейс. Если аргумента is_active задано не будет, он возвращает текущее состояние сетевого интерфейса. Большинству других методов требуется активное состояние интерфейса (их поведение в ситуации, когда они будут вызваны при неактивном интерфейсе, не задано).
  • AbstractNIC.connect([service_id, key=None, *, ...]) – подключает интерфейс к сети. Это опциональный метод, доступный только на интерфейсах, которые не всегда находятся в подключенном состоянии. Если никаких параметров задано не будет, метод подключается к сервису, заданному по умолчанию, или к единственному доступному сервису. Если задать только один аргумент, то он будет главным идентификатором сервиса, к которому надо подключиться. Вместе с ним можно также задать аргумент key (пароль) для доступа к сервису. В этом методе можно задать и другие именованные аргументы – это зависит от типа коммуникации и/или используемого устройства. Эти аргументы могут быть использованы:
    • …чтобы задать альтернативный идентификатор сервиса.
    • …чтобы задать дополнительные параметры соединения.

У разных типов соединений разный перечень стандартных/рекомендованных аргументов, например:

    • Для WiFi - это: bssid – это название BSSID, к которой надо подключиться (MAC-адрес).
  • AbstractNIC.disconnect() – отключает устройство от сети.
  • AbstractNIC.isconnected() – возвращает True, если подключение к сети установлено, и False, если нет.
  • AbstractNIC.scan(*, ...) – сканирует доступные соединения и сетевые сервисы. Возвращает список кортежей с параметрами найденных сервисов. У разных типов соединений – разные варианты стандартных/рекомендованных форматов кортежей. Например:
    • Для WiFi – это: (ssid, bssid, channel, RSSI, authmode, hidden). В кортеже могут быть заданы и другие параметры – это зависит от используемого устройства.

Кроме того, в этой функции можно задать дополнительные именованные аргументы, чтобы отфильтровать результаты сканирования (например, чтобы найти конкретный сервис, конкретный канал, сервисы конкретного типа и т.д.), задать время сканирования и т.д. Где это возможно, названия аргументов должны совпадать с названиями аргументов в connect().

  • AbstractNIC.status([param]) – запрашивает информацию о динамическом статусе интерфейса. Если вызвать эту функцию без аргумента, возвращаемое значение будет обозначать состояние связи. Если вам нужно узнать значение конкретного параметра, задайте этот параметр в аргументе param (он должен быть строкой).

Возвращаемые значения зависят от типа/технологии сети. Вот некоторые из поддерживаемых параметров:

    • WiFi в режиме станции: rssi – чтобы узнать RSSI сигнала точки доступа.
    • WiFi в режиме точки доступа: stations – чтобы узнать список всех станций, подключенных к точке доступа. Этот список будет состоять из кортежей в виде (MAC, RSSI).
  • AbstractNIC.ifconfig([(ip, subnet, gateway, dns)]) – считывает/задает параметры IP-уровня: IP-адрес, маску подсети, сетевой шлюз и DNS-сервер. Если вызвать эту функцию без аргументов, она вернет 4-элементный кортеж с вышеперечисленными параметрами. Чтобы задать эти параметры, передайте методу 4-элементный кортеж с ними. Например:

nic.ifconfig(('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8'))

  • AbstractNIC.config('param') и AbstractNIC.config(param=value, ...) – задает или считывает общие параметры сетевого интерфейса. Эти методы позволяют работать не только со стандартными IP-настройками (как в методе ifconfig()), но и с дополнительными параметрами. Сюда входят параметры, специфичные для используемой сети и платформы. Чтобы задать параметры, нужно воспользоваться синтаксисом именованных аргументов. Кроме того, за раз можно задать несколько параметров. Чтобы прочесть параметр, его строковое название нужно взять в кавычки, и за раз можно прочесть только один параметр.
  1. Задаем название для точки WiFi-доступа (ESSID) и WiFi-канал:

ap.config(essid='My AP', channel=11)

  1. Считываем параметры по одному:

print(ap.config('essid')) print(ap.config('channel'))

Специфические реализации класса

В классах ниже в разных вариациях реализован интерфейс AbstractNIC – каждая из этих вариаций позволяет управлять разными типами сетевых интерфейсов:

Сетевые функции

Здесь описаны дополнительные функции модуля network:

  • network.phy_mode([mode]) – задает или считывает PHY-режим.

Если аргумент mode задан, эта функция устанавливает PHY-режим. Если аргумента mode не задано, функция возвращает текущий PHY-режим. Режимы, которые можно задать (в виде констант):

    • MODE_11B – IEEE 802.11b.
    • MODE_11G – IEEE 802.11g.
    • MODE_11N – IEEE 802.11n.

Доступность: ESP8266.


<syntaxhighlight lang="python" enclose="div">

См.также

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