# API リファレンス

```{warning}
本リポジトリで提供されているソフトウェアおよび API リファレンスは、講師・開発者向けの**参考実装およびデモ用**のものです。
ゼミ参加者（受講生）に対してオープンに提供・公開されているものではありません。
```

C++ (Pico SDK) および Python の API リファレンスです。

## C++ 衛星フライトソフトウェア (satelite)

衛星側で動作する C++ プログラムの API リファレンスです。Doxygen によりソースコードから自動生成されています。

```{doxygenindex}
:project: astrocamp-sat
```

## Python 地上局ソフトウェア (ground)

地上局側で動作する Python モジュールの API リファレンスです。

### Backend
地上局のバックエンドサーバーおよび通信ブリッジです。

```{eval-rst}
.. automodule:: server
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: bridge
   :members:
   :undoc-members:
   :show-inheritance:

   :show-inheritance:
```

### Simulator (SILS)
模擬衛星プログラムです。

```{eval-rst}
.. automodule:: simulator.plant
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: sils.controller
   :members:
   :undoc-members:
   :show-inheritance:
```