mirror
/
amqtt
kopia lustrzana https://github.com/Yakifo/amqtt
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
amqtt/docs/references/client_config.md

81 wiersze
1.6 KiB
Markdown
Czysty Bezpośredni odnośnik Zwykły widok Historia

adding favicon, broker and client config documents.
2025-05-28 12:39:02 +00:00
# Client Configuration
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
This configuration structure is either a `amqtt.contexts.ClientConfig` or a python dictionary with identical structure
when instantiating `amqtt.broker.MQTTClient` or as a yaml formatted file passed to the `amqtt_pub` script.
adding favicon, broker and client config documents.
2025-05-28 12:39:02 +00:00
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
If not specified, the `MQTTClient()` will be started with the default `ClientConfig()`, as represented in yaml format:
adding favicon, broker and client config documents.
2025-05-28 12:39:02 +00:00
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
```yaml
---
keep_alive: 10
ping_delay: 1
default_qos: 0
default_retain: false
auto_reconnect: true
connection_timeout: 60
reconnect_retries: 2
reconnect_max_interval: 10
cleansession: true
broker:
uri: "mqtt://127.0.0.1"
plugins:
amqtt.plugins.logging_amqtt.PacketLoggerPlugin:
```
fixing config parameters for MQTTClient and updating docs to match. refining sample scripts to rely less on accessing external broker for successful completion
2025-06-26 02:23:20 +00:00
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
::: amqtt.contexts.ClientConfig
options:
heading_level: 3
extra:
class_style: "simple"
adding documentation for additional client configuration options
2025-06-03 04:05:20 +00:00
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
::: amqtt.contexts.TopicConfig
options:
heading_level: 3
extra:
class_style: "simple"
updating broker and client config documentation. updating description on how to create a custom plugin.
2025-06-29 03:02:02 +00:00
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
::: amqtt.contexts.WillConfig
options:
heading_level: 3
extra:
class_style: "simple"
updating broker and client config documentation. updating description on how to create a custom plugin.
2025-06-29 03:02:02 +00:00
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
::: amqtt.contexts.ConnectionConfig
options:
heading_level: 3
extra:
class_style: "simple"
adding favicon, broker and client config documents.
2025-05-28 12:39:02 +00:00
## Example
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
A more expansive `ClientConfig` in equivalent yaml format:
adding favicon, broker and client config documents.
2025-05-28 12:39:02 +00:00
```yaml
keep_alive: 10
ping_delay: 1
adding documentation for additional client configuration options
2025-06-03 04:05:20 +00:00
default_qos: 0
adding favicon, broker and client config documents.
2025-05-28 12:39:02 +00:00
default_retain: false
auto_reconnect: true
adding documentation for additional client configuration options
2025-06-03 04:05:20 +00:00
reconnect_max_interval: 5
adding favicon, broker and client config documents.
2025-05-28 12:39:02 +00:00
reconnect_retries: 10
topics:
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
topic/subtopic:
fixes Yakifo/amqtt#159 : tests/test_client.py::test_client_publish_will_with_retain
2025-06-03 14:57:13 +00:00
qos: 0
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
topic/other:
fixes Yakifo/amqtt#159 : tests/test_client.py::test_client_publish_will_with_retain
2025-06-03 14:57:13 +00:00
qos: 2
retain: true
adding documentation for additional client configuration options
2025-06-03 04:05:20 +00:00
will:
topic: will/messages
message: "client ABC has disconnected"
qos: 1
retain: false
broker:
Structured broker and client configurations (#269) * wip for structured configs * updating docs to pull descriptions from structured configs * display 'default_factory' in a field as the actual value * finalizing the dataclass style, format and content of the documentation for the BrokerConfig. * updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses * all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries * type correction and linting fixes * updates to support python 3.10 * fixes to handle wonky yaml files * removing non-modified template files * adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field' * refining documentation * removing duplicate logger
2025-07-26 16:37:25 +00:00
uri: 'mqtt://localhost:1883'
cafile: '/path/to/ca/file'
updating broker and client config documentation. updating description on how to create a custom plugin.
2025-06-29 03:02:02 +00:00
plugins:
- amqtt.plugins.logging_amqtt.PacketLoggerPlugin:
adding favicon, broker and client config documents.
2025-05-28 12:39:02 +00:00
```