🌱 JXCT 7-в-1 - Документация¶
Профессиональная IoT система мониторинга почвы на базе ESP32
🚀 Быстрый старт¶
Для пользователей¶
- 📋 Руководство пользователя - Начало работы
- 🌱 Агрономические рекомендации - Лучшие практики
- 🔬 Руководство по компенсации - Настройка алгоритмов
Для разработчиков¶
- 🧪 Руководство по тестированию - Система тестирования
- 📊 Текущие результаты - Метрики качества
- 🏗️ Архитектура - Общая архитектура
📚 Полная документация¶
👥 Пользовательская документация¶
| Документ | Описание |
|---|---|
| 📋 Руководство пользователя | Основное руководство по использованию |
| 🔧 Техническая документация | Технические детали и спецификации |
| 🌱 Агрономические рекомендации | Рекомендации для сельского хозяйства |
| 📊 API документация | Интерфейсы программирования |
| 🔬 Руководство по компенсации | Алгоритмы компенсации измерений |
👨💻 Документация разработчика¶
| Документ | Описание |
|---|---|
| 🧪 Руководство по тестированию | Полная система тестирования |
| 📊 Текущие результаты тестирования | Актуальные метрики качества |
| 🔄 Интеграция отчётов | Веб-интеграция и API |
| 📋 Отчёт о завершении Этапа 2 | Итоговый отчёт |
| 🏗️ Архитектура проекта | Общая архитектура |
| 🔧 План рефакторинга | Планы развития |
| ⚠️ Отчёт о техническом долге | Анализ качества кода |
📖 Дополнительные ресурсы¶
| Ресурс | Описание |
|---|---|
| 📄 Обзор API | Краткий обзор API |
| 🔧 Руководство по контрибьюции | Как участвовать в разработке |
| 🌐 HTML документация | Doxygen документация |
| 📖 Навигация по docs | Полная навигация |
📊 Текущий статус проекта¶
✅ Завершённые этапы¶
- Этап 1: ✅ Реализация тестов с отчётами
- Этап 2: ✅ Интеграция отчётов с сайтом
🎯 Текущие метрики качества¶
| Метрика | Значение | Цель |
|---|---|---|
| Тесты | 13/13 (100%) | ✅ Достигнуто |
| Уязвимости безопасности | 134 | 🔴 Критично |
| Code Smells | 75 | 🟡 Средний приоритет |
| Покрытие кода | 70.8% | 🟡 Цель: 90%+ |
| Рейтинг качества | D | 🔴 Цель: A |
🚀 Следующие шаги¶
- Этап 3: Уменьшение технического долга
- Приоритет 1: Устранение 134 уязвимостей безопасности
- Приоритет 2: Рефакторинг 6 функций высокой сложности
🔧 Основные возможности¶
🌱 Измерения¶
- Температура почвы (-40°C до +80°C)
- Влажность почвы (0-100% VWC)
- Электропроводность (0-23 mS/cm)
- pH почвы (3-9 pH)
- NPK удобрения (0-1999 mg/kg)
🧠 Алгоритмы компенсации¶
- Модель Арчи - компенсация температуры для EC
- Уравнение Нернста - температурная компенсация pH
- FAO 56 - расчёт ET0 для орошения
🌐 IoT интеграция¶
- MQTT - публикация данных
- ThingSpeak - облачное хранение
- Modbus RTU - промышленный протокол
- REST API - веб-интерфейс
🔧 Разработка¶
- PlatformIO - среда разработки
- Docker - контейнеризация
- GitHub Actions - CI/CD
- Doxygen - документация кода
🤝 Поддержка¶
- Telegram: @Gfermoto
- Issues: GitHub Issues
- Документация: GitHub Pages
📄 Лицензия¶
Этот проект распространяется под лицензией GNU Affero General Public License v3.0 (AGPL-3.0).
Для коммерческого использования без раскрытия исходников доступна платная лицензия: - Email: eyera.team@gmail.com - Telegram: @Gfermoto
EYERA Development Team | Версия 3.6.0 | Июнь 2025