> For the complete documentation index, see [llms.txt](https://termostat-sfedu.gitbook.io/termostat/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://termostat-sfedu.gitbook.io/termostat/readme.md).

# Введение

Добро пожаловать в документацию проекта **TermoStat**.

Этот проект представляет собой высокопроизводительный сервер, предназначенный для создания автоматизированной системы мониторинга температуры. Основная задача системы — сбор, хранение и анализ данных о температуре, получаемых с распределенной сети IoT-датчиков. Проект был инициирован с целью контроля температуры на входах в здания для своевременного выявления людей с повышенной температурой и предотвращения их прохода.

## Ключевые возможности

* **Сбор данных:** Сервер предоставляет стабильный API для приема показаний температуры с аппаратных датчиков.
* **Визуализация:** Интерактивная панель мониторинга в реальном времени позволяет отслеживать общую статистику, статус каждого устройства и просматривать исторические данные на графиках.
* **Гибкая настройка:** Все ключевые параметры, такие как частота отправки данных датчиками или правила очистки старых записей, настраиваются через удобный административный интерфейс.
* **Система уведомлений:** Встроенная система вебхуков позволяет настроить отправку уведомлений о важных событиях (например, обнаружение DoS-атаки или подключение нового устройства) в мессенджеры (Telegram, Slack) или другие внешние системы.
* **Масштабируемость и развертывание:** Проект полностью контейнеризирован с помощью Docker, что обеспечивает простое и надежное развертывание в любой среде.

## Для кого эта документация?

Эта документация разделена на несколько разделов, предназначенных для разных ролей:

* [**Руководство пользователя**](/termostat/user-guide.md)**:** Для операторов, которые будут использовать панель мониторинга и настраивать систему.
* [**Руководство по аппаратному обеспечению**](/termostat/hardware-guide.md)**:** Для инженеров, разрабатывающих и настраивающих физические датчики.
* [**Развертывание**](/termostat/deployment.md)**:** Для системных администраторов и DevOps-инженеров, отвечающих за установку и поддержку сервера.
* [**Руководство разработчика**](/termostat/developer-guide.md)**:** Для программистов, которые хотят внести свой вклад в проект или интегрировать его с другими системами.
* [**Справочник по API**](/termostat/api-reference.md)**:** Техническая документация по всем доступным API-эндпоинтам.