mirror of
https://github.com/OMGeeky/flucto-heisskleber.git
synced 2026-01-07 12:11:27 +01:00
40 lines
711 B
Markdown
40 lines
711 B
Markdown
# Reference
|
|
|
|
## Network
|
|
|
|
```{eval-rst}
|
|
.. automodule:: heisskleber
|
|
:members:
|
|
.. automodule:: heisskleber.mqtt
|
|
:members:
|
|
.. automodule:: heisskleber.zmq
|
|
:members:
|
|
.. automodule:: heisskleber.serial
|
|
:members:
|
|
.. automodule:: heisskleber.config
|
|
:members:
|
|
```
|
|
|
|
### Broker
|
|
|
|
```{eval-rst}
|
|
```
|
|
|
|
## Config
|
|
|
|
### Loading configs
|
|
```{eval-rst}
|
|
.. automodule:: heisskleber.config
|
|
:members: load_config
|
|
```
|
|
|
|
### Config types
|
|
|
|
Configs are extended dataclasses, which inherit from the BaseConf class.
|
|
```{eval-rst}
|
|
.. autoclass:: heisskleber.config.BaseConf
|
|
.. autoclass:: heisskleber.mqtt.config.MqttConf
|
|
.. autoclass:: heisskleber.zmq.config.ZmqConf
|
|
.. autoclass:: heisskleber.serial.config.SerialConf
|
|
```
|