# Документация СОНИКС Клиента

Клиент наземной станции для портала [sonik.space](https://sonik.space).

Клиент опрашивает портал на предмет запланированных проходов спутников, во время
каждого прохода управляет SDR-приёмником, трансивером и поворотным устройством
через потоковые графы GNU Radio (`gr-satnogs` / `gr-satellites`), а затем
загружает на портал аудио, водопад и демодулированные кадры.

Поставляется Docker-образом, станции запускают его через `docker compose`.

---

## Куда идти

**Я оператор станции** — подключаю и настраиваю железо.
: Начните с [требований к системе](station/requirements.md), затем
  [установка](station/install.md) и [конфигурация](station/configuration.md).
  Дальше — [эксплуатация](station/operations.md) и полный
  [справочник переменных окружения](station/environment_variables.md).

**Я разработчик** — хочу дорабатывать клиент.
: Начните с [архитектуры](development/architecture.md) — там жизненный цикл
  наблюдения целиком. Затем разделы по подсистемам:
  [потоковый граф](development/flowgraph.md),
  [скрипты и декодеры](development/scripts.md),
  [загрузка данных](development/upload.md),
  [водопад](development/waterfall.md).
  Проверка правки на живом железе — [стенд](development/stand.md).
  Правила участия — в [contributing](development/contributing.md).
  Что известно сломанным и в каком порядке чинится —
  [дорожная карта](roadmap.md).

**Мне нужен справочник по коду.**
: [Справочник API](api/index.md) — автоматически сгенерирован из исходников.

**Я ИИ-агент.**
: Начинайте с [](ai/context.md) — устройство соседних проектов, контракты между
  ними и подтверждённые дефекты на их стороне. Затем
  [](roadmap-network.md) — принятые решения и план работ по всей сети.

```{toctree}
:maxdepth: 2
:caption: Станция

station/requirements
station/install
station/configuration
station/environment_variables
station/rotator
station/operations
station/agent
station/satellites
```

```{toctree}
:maxdepth: 2
:caption: Разработка

development/architecture
development/flowgraph
development/scripts
development/upload
development/waterfall
development/stand
development/contributing
roadmap
roadmap-network
ai/context
```

```{toctree}
:maxdepth: 2
:caption: Справочник API

api/index
```

## Проект

* Исходники: [gitlab.com/space-education-development/soniks/client/soniks-client](https://gitlab.com/space-education-development/soniks/client/soniks-client)
* Определения спутников: [soniks-satyaml](https://gitlab.com/space-education-development/soniks/client/soniks-satyaml)
* Портал: [sonik.space](https://sonik.space), Telegram: [@sonikspace](https://t.me/sonikspace)
* Лицензия: AGPL-3.0