Initial all get params

2025-11-24 12:42:56 +03:00
parent ad6a3593da
commit d8cea4e1c6
22 changed files with 939 additions and 143 deletions
--- a/readme.md
+++ b/readme.md
@@ -1,48 +1,89 @@
 # Руководство по использованию команды `jlv135_cli`

 ## Описание
-Команда `jlv135_cli` представляет собой интерфейс командной строки для работы с устройством JLV135.
+Команда `jlv135_cli` представляет собой интерфейс командной строки для работы с устройством JLV135. Программа работает с блоками конфигурации как модулями расширения, каждый из которых имеет методы `get` (просмотр параметров) и `set` (изменение параметров).

-## Вывод текущих настроек
+## Основные команды

-Вызов без параметров позволяет отобразить текущие настройки пульта без изменения текущих.
-
-### Синтаксис
+### Справка
+Вызов без параметров отображает справку по использованию и список доступных блоков:
 ```bash
 jlv135_cli
 ```

-## Изменение скорости
-
-### Синтаксис
+### Просмотр параметров блока (get)
+Просмотр всех параметров блока с текущими значениями и расшифровкой:
 ```bash
-jlv135_cli --modbus --rs485 --speed <значение>
+jlv135_cli get <блок>
 ```

-### Параметры
+### Изменение параметров блока (set)
+Изменение параметров указанного блока:
+```bash
+jlv135_cli set <блок> <параметры...>
+```

-| Параметр   | Описание                                                                |
-|------------|-------------------------------------------------------------------------|
-| `--modbus` | Активирует работу с протоколом Modbus                                   |
-| `--rs485`  | Указывает на использование RS-485                                       |
-| `--speed`  | Задает скорость передачи данных (бодрейт) для RS-485                    |
+## Доступные блоки конфигурации

-### Примеры использования
+Список блоков определяется в `src/jl_modbus/jl_config.c` (массив `backup_blocks`):
+- `modbus` - настройки протокола Modbus
+- `wifi` - настройки WiFi (не реализован)
+- `display` - настройки дисплея (не реализован)
+- `feature` - функциональные возможности (не реализован)
+- `datatime` - дата и время (не реализован)
+- `sensor` - датчики (не реализован)
+- `secure` - безопасность (не реализован)
+- `service` - служебные параметры (не реализован)

-1. Запуск с типичной скоростью 9600 бод:
-   ```bash
-   jlv135_cli --modbus --rs485 --speed 9600
-   ```
+## Примеры использования

-2. Использование высокой скорости 115200 бод:
-   ```bash
-   jlv135_cli --modbus --rs485 --speed 115200
-   ```
+### Блок Modbus

-### Поддерживаемые скорости
-Программа может поддерживать различные стандартные скорости передачи данных:
+#### Просмотр всех параметров Modbus:
+```bash
+jlv135_cli get modbus
+```
+
+Пример вывода:
+```
+Modbus Config:
+  num_port: 1
+  addr:     1
+  tcycle:   100
+
+Modbus RS485 Port:
+  speed:   9600
+  prop_p:  0
+  prop_s:  0
+  repeate: 3
+  timeout: 500
+
+Modbus TCP Port:
+  addr:    192.168.1.100
+  port:    502
+  repeate: 3
+  timeout: 1000
+```
+
+#### Изменение скорости RS485:
+```bash
+jlv135_cli set modbus rs485 speed 9600
+jlv135_cli set modbus rs485 speed 115200
+```
+
+### Поддерживаемые скорости RS485
 - 9600 бод (наиболее распространенная)
 - 19200 бод
 - 38400 бод
 - 57600 бод
- 115200 бод
+- 115200 бод
+
+## Архитектура
+
+Программа построена на модульной архитектуре:
+- Каждый блок конфигурации - это отдельный модуль с методами `get` и `set`
+- Добавление нового блока требует:
+  1. Создания заголовочного файла `inc/jlv135_cli/jl_block_<name>.h`
+  2. Создания файла реализации `src/jlv135_cli/jl_block_<name>.c`
+  3. Регистрации блока в `src/jlv135_cli/jl_block.c`
+  4. Добавления файлов в `CMakeLists.txt`