BW3-Core/docu/mkdocs.yml
KoenigMjr 0b9387af08 [feat/multicast]: add multi-instance multicast module with active trigger system
Introduce a robust multicast processing module for POCSAG that correlates
empty tone-RICs (recipients) with subsequent text-RICs (content).

Key Features:
- Four Output Modes: Internally supports 'complete', 'incomplete', 'single',
  and 'control'. Functional alarms are delivered as the first three, while
  technical 'control' packets (Delimiters/NetIdent) are filtered by default.
- Active Trigger System: Implements a loss-free deferred delivery mechanism
  using a loopback socket (TCP) to re-inject wakeup packets, flushing the
  internal queue during auto-clear timeouts.
- Shared State & Multi-Instance: State is shared across instances but
  separated by frequency to prevent crosstalk in multi-frequency setups.
- Data Aggregation: Automatically generates '{FIELD}_list' wildcards (e.g.,
  RIC_LIST, DESCRIPTION_LIST) for all collected recipients, enabling
  consolidated notifications in downstream plugins.
- Dynamic Filtering: Automatically blocks Delimiter and NetIdent RICs from
  reaching subsequent plugins if they are defined in the configuration.

Infrastructural Changes:
- ModuleBase: Expanded return semantics to support:
  * False: Explicitly blocks/drops a packet.
  * List: Allows a module to expand one input into multiple output packets.
- PluginBase: Updated to handle lists of packets, ensuring a full
  setup->alarm->teardown lifecycle for every individual element.
2026-03-05 13:52:48 +01:00

50 lines
1.4 KiB
YAML

site_name: BOSWatch3 Core
site_author: Bastian Schroll & BW3 Dev team
repo_url: https://github.com/BOSWatch/BW3-Core
edit_uri: edit/develop/docu/docs/
nav:
# - BW3: index.md
- Quick Start:
- Installation: install.md
- Konfiguration: config.md
- BOSWatch benutzen: usage.md
- Als Service einrichten: service.md
- Konfigurations Editor: config-editor.html
- Informationen:
- Server/Client Prinzip: information/serverclient.md
- Broadcast Service: information/broadcast.md
# - Modul/Plugin Konzept: tbd.md
- Routing Mechanismus: information/router.md
- Changelog: changelog.md
- Module:
- Descriptor: modul/descriptor.md
- Double Filter: modul/double_filter.md
- Geocoding: modul/geocoding.md
- Mode Filter: modul/mode_filter.md
- Multicast: modul/multicast.md
- Regex Filter: modul/regex_filter.md
- Plugins:
- Http: plugin/http.md
- Telegram: plugin/telegram.md
- Divera: plugin/divera.md
- MySQL: plugin/mysql.md
- Entwickler:
- Eigenes Modul/Plugin schreiben: develop/ModulPlugin.md
- BOSWatch Alarmpaket Format: develop/packet.md
- BW3 Quellcode Dokumentation: api/html/index.html
use_directory_urls: false
theme:
name: mkdocs
highlightjs: true
hljs_style: github
extra_css:
- stylesheets/extra.css
markdown_extensions:
- attr_list