ODNFC-LAN на MicroPython — руководство

ODNFC-LAN и ODNFC-LAN-C — NFC/RFID считыватели-контроллеры с сетевым интерфейсом и прошивкой MicroPython. Логику работы можно изменить во встроенном редакторе кода под вашу задачу.

Быстрый маршрут

Для первого теста не начинайте с полной СКУД. Проверьте последовательно: считывание UID, индикацию, ручное переключение выхода, сетевую отправку одного события — и только затем добавляйте базу пользователей и прикладные правила.

Ключевые возможности

• Поддерживаемые метки. Чтение-запись MIFARE Classic 1K/4K/Mini, MIFARE Plus S/X (SL0/SL1/SL3), MIFARE Ultralight, Ultralight Nano, Ultralight EV1, NTAG 213/215/216, S50/S70 — полная поддержка; MIFARE Plus X (SL2), Ultralight C, DESFire — только чтение UID.
• Работа в локальной сети. Подключение по Ethernet с DHCP или статическим адресом, встроенный веб-интерфейс, передача данных и приём команд по сети.
• Совместимые бесконтактные карты. Устройство может использовать идентификатор, который отдаёт физическая карта; это не обязательно напечатанный номер или платёжный PAN. Мобильный кошелёк может выдавать отдельный и меняющийся идентификатор. Обычный пропуск в Apple Wallet или Google Wallet не становится совместимой NFC-картой автоматически. Подробнее — в статье «Телефон как пропуск».
• Изменяемая логика. Встроенный редактор позволяет задать прикладной алгоритм на MicroPython.
• Дискретный вход и выход. Один вход можно использовать для кнопки, а выход — для управления замком или другой нагрузкой. Проверьте допустимый ток, напряжение и защиту индуктивной нагрузки до подключения.
• Управляемая индикация. Программное управление звуковым излучателем и RGB-светодиодом (ODNFC-LAN); вместо одного диода можно подключить адресную ленту до 40 светодиодов. ODNFC-LAN-C управляет классической парой «красный-зелёный».
• Локальная база данных. Устройство хранит данные о пользователях локально, работает автономно или синхронизируется с сервером.

Исполнения

В конце артикула C означает устройство в корпусе, B — плату без корпуса. Полную расшифровку артикулов см. в разделе поддержки.

Лицевая панель ODNFC-LAN покрыта тонкой защитной транспортировочной плёнкой. Удалите её перед использованием.

Подключение

Интерфейс — Ethernet, питание — Passive PoE 7–24 В. Индикация сети: красный — нет соединения, зелёный — соединение установлено. По умолчанию устройство получает IP-адрес от DHCP-сервера. Если за 30–40 секунд адрес получить не удалось, устройство назначает себе статический адрес 192.168.1.1.

Распиновка Passive PoE для устройств UnitX ODNFC:

• контакты 1 и 2 — Ethernet, первая пара данных;
• контакты 3 и 6 — Ethernet, вторая пара данных;
• контакты 4 и 5 — «+» питания;
• контакты 7 и 8 — «−» питания.

Нумерация относится к контактам разъёма 8P8C (RJ45) или соответствующим контактам колодки. Passive PoE подаёт постоянное напряжение без согласования с устройством — это не IEEE 802.3af/at. Перед включением убедитесь, что напряжение источника входит в допустимый для устройства диапазон.

Веб-интерфейс

Веб-редактор использует WebSocket. Если браузер блокирует незащищённое соединение или смешанный HTTP/HTTPS-контент, откройте интерфейс устройства по HTTP в доверенной локальной сети либо используйте сервисное подключение. Не ослабляйте глобальные настройки безопасности браузера.

Основной экран. Общая информация об устройстве и сообщения из кода (отправленные командой eprint).

Редактор кода. Состоит из трёх элементов: файловый менеджер (создание/удаление файлов и папок, загрузка файлов на устройство), редактор кода и интерактивная консоль. Консоль нужна для экспериментов с кодом — чтобы её активировать, нажмите в ней Ctrl+C. После этого основная программа остановится; для восстановления работы перезагрузите устройство.

Экран настроек. Изменяет основные настройки. Часть из них предназначена для обработки пользовательской программой и устройством не используется. Здесь же можно закрыть паролем редактор и веб-интерфейс целиком.

Обратите особое внимание на пункты:

• «Установить пароль на web» — закрывает веб-интерфейс паролем (basic auth).
• «Установить пароль на Настройки» — задаёт пароль для страницы настроек. Пароль доступен только для записи: при открытии страницы он из устройства не считывается, а браузер может подставить его из кеша — внимательно следите за состоянием этих полей.
• «Включить редактор» — скрывает редактор кода со страницы и закрывает WebSocket для удалённой отладки.

Экран «Об устройстве». Информация об устройстве, обновление веб-интерфейса и переход в веб-загрузчик.

Технические характеристики

1. Чтение и запись меток: MIFARE Classic 1K/4K/Mini, MIFARE Plus S/X (SL0/SL1/SL3), MIFARE Ultralight, Ultralight Nano, Ultralight EV1 80/164, NTAG 213/215/216, S50/S70 — полная поддержка; MIFARE Plus X (SL2), Ultralight C, DESFire — только чтение UID.
2. Дальность считывания: до 6 см.
3. Габариты: 120 × 76 × 22 мм (ODNFC-LAN), 115 × 75 × 20 мм (ODNFC-LAN-C).
4. Проводные интерфейсы: Ethernet.
5. Индикация: RGB-светодиод, звуковой излучатель.
6. Вход: один канал (3 В, подтянут к «1»).
7. Выход: один канал (макс. 1 А), напряжение равно напряжению питания.
8. Крепление: четыре отверстия M3.
9. Питание: Passive PoE 7–24 В.

Чтобы читать не только UID, но и выбранные области памяти карты, задайте строку форматирования.

Код, который идёт в устройстве

Ниже показана основа штатной программы. При запуске устройство подаёт короткий сигнал, читает из настроек параметры сторожевого таймера, строки форматирования и отправки по UDP. Затем оно опрашивает считыватель с двухсекундным фильтром: при успешном чтении отправляет UDP-пакет и на 5 секунд включает выход.

from time import time
from uasyncio import sleep_ms, sleep
from machine import WDT
from rfid_utils import RFID, BUZZ, LED_PIN, CardFilter, OUT
from webserver import eprint
from config import settings
from uasyncio import AsyncUDP
import rfid as urfid
from multi_led import SmartLED

async def door():
    OUT.off()
    await sleep(5)
    OUT.on()

async def run():
    await eprint("User code started")
    rfid = RFID(urfid.G_43dB)
    LEDS = SmartLED(LED_PIN, count=2)
    LEDS.fill('#000000')
    OUT.on()
    c_filter = CardFilter(2)
    wdt_enabled = settings['sys-i-wdt']
    str_format = settings['rfid-format']
    udp_en = (settings['rfid-protocol'] == 'UDP')
    if wdt_enabled:
        wdt = WDT(timeout=10000)
    await BUZZ.beep(100)
    while 1:
        if wdt_enabled:
            wdt.feed()
        await sleep_ms(100)
        c_filter.clean(time())
        uid = rfid.read(str_format)
        if uid and uid not in c_filter:
            c_filter.append(uid)
            LEDS.fill('#00FF00')
            await BUZZ.beep()
            LEDS.fill('#000000')
            if udp_en:
                await AsyncUDP.udp_send(uid, (settings['rfid-dest'], settings['rfid-i-dport']))
            await door()

Сетевые примеры

Готовые шаблоны передачи и приёма данных — переключайте вкладки.

from time import time
from uasyncio import sleep, TCPClient
from rfid_utils import BUZZ
from webserver import eprint
from config import settings

async def run():
    await eprint("User code started")
    client = TCPClient(settings['rfid-dest'], settings['rfid-i-dport'])
    client.connect()

    while 1:
        await BUZZ.beep()
        await client.send('hello')
        await sleep(1)

from time import time
from uasyncio import sleep, AsyncUDP
from rfid_utils import BUZZ
from webserver import eprint

async def run():
    await eprint("User code started")
    while 1:
        await BUZZ.beep()
        await AsyncUDP.udp_send('hello', ('192.168.0.51', 7000))
        await sleep(1)

async def try_send_post(url, data):
    n = 0
    try:
        response = crequests.request(url, crequests.POST, data=dumps(data),
                                     headers={'Content-Type': 'application/json'})
        while not response:
            await uasyncio.sleep_ms(20)
            n += 1
            if n == 100:
                raise
        return response.text()
    except Exception:
        return None

def http_command(data):
    print(data)
    if 'led' in data:
        if data['led'] == 'on':
            GLED.on()
        elif data['led'] == 'off':
            GLED.off()
        else:
            return {'status': 'invalid'}
        return {'status': 'ok'}
    else:
        return {'status': 'unsupported'}

Восстановление устройства

Если записаны неправильные настройки:

1. Выключите устройство.
2. Замкните контакты HARD RESET на плате.
3. Включите устройство, удерживая HARD RESET замкнутым.
4. Дождитесь, пока замигает красный светодиод.
5. Откройте веб-страницу загрузчика. Устройство попробует получить адрес от DHCP; если не удастся за 30–40 секунд — назначит себе 10.10.0.1.
6. Нажмите «Настройки» → «К заводским настройкам» → «Запустить».

Если доступ потерян из-за неправильного usercode.py: выполните шаги 1–5, затем нажмите «Дополнительно», выберите назначение «Пользовательские данные», директория — ., файл — usercode.py (он должен содержать корректный код или быть пустым), нажмите «Загрузить» → «Запустить».

Обновление устройства

1. Откройте вкладку «Об устройстве» и нажмите «Bootloader».
2. Дождитесь, пока замигает красный светодиод, и откройте веб-страницу загрузчика (адрес как при восстановлении).
3. Нажмите «Выбрать» и укажите файл *.efw.
4. Нажмите «Загрузить» и дождитесь окончания (прогресс-бар внизу).
5. Нажмите «Запустить» и убедитесь, что на вкладке «Об устройстве» версия прошивки соответствует желаемой.

Дополнительные материалы

• Кнопка, замок, реле, второй считыватель и адресная RGB-лента
• Программирование на MicroPython — как написать свою программу.
• Строка форматирования — формат данных, считываемых с карты.
• Пример: Modbus TCP на MicroPython.

История обновлений ODNFC на Lua

Если установлена версия ниже 1.7.0, сначала обновите её до 1.7.0, а затем до более новой версии. Перед обновлением отключите сторожевой таймер и сотрите пользовательскую программу.

net.en.setup(
  net.packip(Settings.get("net_ip")),
  net.packip(Settings.get("net_mask")),
  net.packip(Settings.get("net_gw")),
  net.packip(Settings.get("net_dns"))
)
net.en.start()