diff --git a/README.md b/README.md index 5a426b0..0da7c73 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,53 @@ Кнопка "Подключиться" отправляет запрос на чтение шести Input Register'ов по адресу `200` (модель устройства/платы для устройств Gidrolock). -Сообщает об ошибке после двух секунд ожидания ответа. +## Конфигурации и автоопрос +Конфигурация — это `.json` файл с описанием команд чтения для конкретных моделей устройств. Поддерживает парсинг в UTF-8. + +Поля и возможные значения: + +```json +{ + // имя шаблона/устройства + "name" : "Gidrolock Standard Wi-Fi RS-485", + + // Описание устройства + "description" : "Smart valve controller unit with wired and wireless leak sensor support.", + + // список данных, получаемых с устройства + // каждая запись является отдельным полем данных + // и поддерживает опрос нескольких регистров, + // а также парсинг в стандартные типы данных (UTF-8, int и т.д.) + "entries" : [ + { + // имя записи + "name": "Modbus ID", + + // тип опрашиваемых регистров: + // "coil", "discrete", "input", "holding" + "registerType": "holding", + + // адрес стартового регистра + // отсчет с 0 + "address": 128, + + // количество опрашиваемых регистров + // значение по-умолчанию: 1 + "length": 1, + + // тип данных для парсинга + // поддерживаемые типы: bool, uint16, uint32, utf8 + // значение по умолчанию: uint16 + "dataType": "utf8" + } + ] + +} +``` + ## To-Do 1. Обработка `.json` шаблонов для любых устройств 2. Настраиваемый цикличный опрос регистров -3. Поддержка Modbus TCP \ No newline at end of file +3. Поддержка Modbus TCP +