whitelist

[SLOT_n]
mode = whitelist

Виртуальный модуль списка разрешений: сверяет входящую строку со списком в файле на носителе.

Совместимость

Виртуальный модуль, аппаратной части не требует. Доступные слоты: 0-9.

Принцип работы

Команда check сравнивает переданную строку со строками файла filename. При совпадении выполняются связи, объявленные для этой строки в самом файле; если совпадений нет, модуль рапортует событие noMatches.

Файл списка лежит в корне носителя, по одной записи на строку. Сменить файл на лету можно командой setFile. Если файла нет, устройство создаст файл ошибки.

Применяется с номеронабирателем, считывателем RFID-карт или коллектором — всем, что даёт на входе строку-идентификатор.

Топики

База топика события:

• <deviceName>/whitelist_<slot> — например moduleBox/whitelist_0

База топика действия:

• <deviceName>/whitelist_<slot> — например moduleBox/whitelist_0

Полный топик — база плюс направление и имя: moduleBox/whitelist_6/event/noMatches.

Опции

Доступные опции:

• disableOnStart — флаг, стартовать в выключенном состоянии и ждать action/enable со значением 1. По умолчанию модуль активен сразу.
• filename — строка, имя файла со списком. По умолчанию .

События

Топик	Payload	Описание
whitelist_<slot>/event/noMatches	целое	Возвращает если совпадений не найдено
whitelist_<slot>/event/enable	0 / 1	Состояние модуля - активен 1 или спит 0

Пример: топик moduleBox/whitelist_6/event/noMatches, payload 1.

Команды

Топик	Payload	Описание
whitelist_<slot>/action/check	строка	Проверить строку по списку
whitelist_<slot>/action/setFile	строка	Сменить файл списка на лету — имя файла в корне носителя
whitelist_<slot>/action/enable	0 / 1	Включить (1) или выключить (0) модуль

Примеры

[SLOT_6]
mode = whitelist
options = filename:my-list.txt
;если строки нет в списке - проиграть трек с инструкцией
crosslink = whitelist_6/event/noMatches:1->player_0/action/play:1

Подробнее — внутренние связи (crossLink).

Архив

Описание модуля для прошивок до перехода на конституцию — whitelist (архив).