0.2.2 doxygen update
This commit is contained in:
48
README.md
48
README.md
@@ -4,28 +4,28 @@
|
||||
|
||||
## Структура библиотеки
|
||||
|
||||
*Note: Файлы начинающиеся с `__` и которых нет в этом дереве являются **внутренними/непротестированными/недокументированными***
|
||||
*Note: Файлы начинающиеся с `__` и которых **нет** в этом дереве являются **внутренними/непротестированными/недокументированными***
|
||||
```
|
||||
Modbus/
|
||||
│ inc/
|
||||
│ ├── modbus.h # Главный заголовочный файл
|
||||
│ ├── modbus_core.h # Базовые определения и структуры
|
||||
│ ├── modbus_coils.h # Работа с дискретными выходами
|
||||
│ ├── modbus_holdregs.h # Работа с регистрами хранения
|
||||
│ ├── modbus_inputregs.h # Работа с входными регистрами
|
||||
│ ├── modbus_devid.h # Идентификация устройства
|
||||
│ ├── rs_message.h # Драйвер обмена по RS/UART
|
||||
├── src/
|
||||
│ ├── modbus.c # Основная логика Modbus Slave
|
||||
│ ├── modbus_coils.c # Реализация работы с coils
|
||||
│ ├── modbus_holdregs.c # Реализация регистров хранения
|
||||
│ ├── modbus_inputregs.c # Реализация входных регистров
|
||||
│ ├── modbus_devid.c # Реализация идентификации устройства
|
||||
│ ├── modbus_data.c # Функции доступа к данным
|
||||
│ └── rs_message.c # Реализация драйвера RS
|
||||
├── __modbus_config.h # Конфигурация Modbus (надо заменить)
|
||||
├── __modbus_data.h # Структуры данных (надо заменить)
|
||||
└── __modbus_data.c # Функции доступа (надо заменить)
|
||||
Modbus/ Иерархия:
|
||||
│ inc/ modbus
|
||||
│ ├── modbus.h # Главный заголовочный файл ├── modbus_coils
|
||||
│ ├── modbus_core.h # Базовые определения и структуры ├── modbus_inputregs
|
||||
│ ├── modbus_coils.h # Работа с дискретными выходами ├── modbus_inputregs
|
||||
│ ├── modbus_holdregs.h # Работа с регистрами хранения ├── modbus_devid
|
||||
│ ├── modbus_inputregs.h # Работа с входными регистрами ├── modbus_diag
|
||||
│ ├── modbus_devid.h # Идентификация устройства └── rs_message
|
||||
│ ├── rs_message.h # Драйвер обмена по RS/UART │
|
||||
├── src/ └── modbus_core.h (единое ядро)
|
||||
│ ├── modbus.c # Основная логика Modbus Slave ├── modbus_config
|
||||
│ ├── modbus_coils.c # Реализация работы с coils ├── modbus_data
|
||||
│ ├── modbus_holdregs.c # Реализация регистров хранения └── __crc_algs
|
||||
│ ├── modbus_inputregs.c # Реализация входных регистров
|
||||
│ ├── modbus_devid.c # Реализация идентификации устройства
|
||||
│ ├── modbus_data.c # Функции доступа к данным
|
||||
│ └── rs_message.c # Реализация драйвера RS
|
||||
├── __modbus_config.h # Конфигурация Modbus (надо заменить)
|
||||
├── __modbus_data.h # Структуры данных (надо заменить)
|
||||
└── __modbus_data.c # Функции доступа (надо заменить)
|
||||
```
|
||||
|
||||
## Инструкция по подключению
|
||||
@@ -42,9 +42,9 @@ git submodule update --init --recursive
|
||||
```
|
||||
ProjectRoot/
|
||||
├── Configs/
|
||||
│ ├── modbus_config.h # ← скопировать из __modbus_config.h
|
||||
│ ├── modbus_data.h # ← скопировать из __modbus_data.h
|
||||
│ └── modbus_data.c # ← скопировать из __modbus_data.c (опционально)
|
||||
│ ├── modbus_config.h # скопировать из __modbus_config.h
|
||||
│ ├── modbus_data.h # скопировать из __modbus_data.h
|
||||
│ └── modbus_data.c # скопировать из __modbus_data.c
|
||||
└── Modbus/ # Субмодуль
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user