mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2026-01-20 15:40:24 +01:00
404 lines
16 KiB
HTML
404 lines
16 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en" data-bs-theme="light">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
|
||
|
|
<meta name="author" content="Bastian Schroll & BW3 Dev team">
|
||
|
|
|
||
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
||
|
|
<title>Descriptor - BOSWatch3 Core</title>
|
||
|
|
<link href="../css/bootstrap.min.css" rel="stylesheet">
|
||
|
|
<link href="../css/fontawesome.min.css" rel="stylesheet">
|
||
|
|
<link href="../css/brands.min.css" rel="stylesheet">
|
||
|
|
<link href="../css/solid.min.css" rel="stylesheet">
|
||
|
|
<link href="../css/v4-font-face.min.css" rel="stylesheet">
|
||
|
|
<link href="../css/base.css" rel="stylesheet">
|
||
|
|
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
|
||
|
|
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
|
||
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||
|
|
<script>hljs.highlightAll();</script>
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
|
||
|
|
<div class="container">
|
||
|
|
<a class="navbar-brand" href="..">BOSWatch3 Core</a>
|
||
|
|
<!-- Expander button -->
|
||
|
|
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
|
||
|
|
<span class="navbar-toggler-icon"></span>
|
||
|
|
</button>
|
||
|
|
|
||
|
|
<!-- Expanded navigation -->
|
||
|
|
<div id="navbar-collapse" class="navbar-collapse collapse">
|
||
|
|
<!-- Main navigation -->
|
||
|
|
<ul class="nav navbar-nav">
|
||
|
|
<li class="nav-item dropdown">
|
||
|
|
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Quick Start</a>
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../tbd.html" class="dropdown-item">Installation</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../config.html" class="dropdown-item">Konfiguration</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item dropdown">
|
||
|
|
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Informationen</a>
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../information/serverclient.html" class="dropdown-item">Server/Cient Prinzip</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../information/broadcast.html" class="dropdown-item">Broadcast Service</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../information/router.html" class="dropdown-item">Routing Mechanismus</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../changelog.html" class="dropdown-item">Changelog</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item dropdown">
|
||
|
|
<a href="#" class="nav-link dropdown-toggle active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">Module</a>
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="descriptor.html" class="dropdown-item active" aria-current="page">Descriptor</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="geocoding.html" class="dropdown-item">Geocoding</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="mode_filter.html" class="dropdown-item">Mode Filter</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="regex_filter.html" class="dropdown-item">Regex Filter</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="double_filter.html" class="dropdown-item">Double Filter</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item dropdown">
|
||
|
|
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Plugins</a>
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../plugin/http.html" class="dropdown-item">Http</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../plugin/telegram.html" class="dropdown-item">Telegram</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../plugin/divera.html" class="dropdown-item">Divera</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../plugin/mysql.html" class="dropdown-item">MySQL</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item dropdown">
|
||
|
|
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Entwickler</a>
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../develop/ModulPlugin.html" class="dropdown-item">Eigenes Modul/Plugin schreiben</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../develop/packet.html" class="dropdown-item">BOSWatch Alarmpaket Format</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="../api/html/index.html" class="dropdown-item">BW3 Quellcode Dokumentation</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<ul class="nav navbar-nav ms-md-auto">
|
||
|
|
<li class="nav-item">
|
||
|
|
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
|
||
|
|
<i class="fa fa-search"></i> Search
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a rel="prev" href="../changelog.html" class="nav-link">
|
||
|
|
<i class="fa fa-arrow-left"></i> Previous
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a rel="next" href="geocoding.html" class="nav-link">
|
||
|
|
Next <i class="fa fa-arrow-right"></i>
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a href="https://github.com/BOSWatch/BW3-Core/edit/develop/docu/docs/modul/descriptor.md" class="nav-link"><i class="fa-brands fa-github"></i> Edit on GitHub</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="container">
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
|
||
|
|
<div class="navbar-header">
|
||
|
|
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
|
||
|
|
<span class="fa fa-angle-down"></span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
|
||
|
|
<li class="nav-item" data-bs-level="1"><a href="#descriptor" class="nav-link">Descriptor</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
<li class="nav-item" data-bs-level="2"><a href="#beschreibung" class="nav-link">Beschreibung</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item" data-bs-level="2"><a href="#unterstutze-alarmtypen" class="nav-link">Unterstütze Alarmtypen</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item" data-bs-level="2"><a href="#resource" class="nav-link">Resource</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item" data-bs-level="2"><a href="#konfiguration" class="nav-link">Konfiguration</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item" data-bs-level="2"><a href="#modul-abhangigkeiten" class="nav-link">Modul Abhängigkeiten</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item" data-bs-level="2"><a href="#externe-abhangigkeiten" class="nav-link">Externe Abhängigkeiten</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item" data-bs-level="2"><a href="#paket-modifikationen" class="nav-link">Paket Modifikationen</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item" data-bs-level="2"><a href="#zusatzliche-wildcards" class="nav-link">Zusätzliche Wildcards</a>
|
||
|
|
<ul class="nav flex-column">
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div></div>
|
||
|
|
<div class="col-md-9" role="main">
|
||
|
|
|
||
|
|
<h1 id="descriptor"><center>Descriptor</center></h1>
|
||
|
|
<hr />
|
||
|
|
<h2 id="beschreibung">Beschreibung</h2>
|
||
|
|
<p>Mit diesem Modul können einem Alarmpaket beliebige Beschreibungen in Abhänigkeit der enthaltenen Informationen hinzugefügt werden.</p>
|
||
|
|
<h2 id="unterstutze-alarmtypen">Unterstütze Alarmtypen</h2>
|
||
|
|
<ul>
|
||
|
|
<li>Fms</li>
|
||
|
|
<li>Pocsag</li>
|
||
|
|
<li>Zvei</li>
|
||
|
|
<li>Msg</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="resource">Resource</h2>
|
||
|
|
<p><code>descriptor</code></p>
|
||
|
|
<h2 id="konfiguration">Konfiguration</h2>
|
||
|
|
<p>Informationen zum Aufbau eines <a href="../develop/packet.html">BOSWatch Pakets</a></p>
|
||
|
|
<p><strong>Achtung:</strong> Zahlen welche führende Nullen entahlten müssen in Anführungszeichen gesetzt werden Bsp. <code>'0012345'</code></p>
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Feld</th>
|
||
|
|
<th>Beschreibung</th>
|
||
|
|
<th>Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>scanField</td>
|
||
|
|
<td>Feld des BW Pakets welches geprüft werden soll</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>descrField</td>
|
||
|
|
<td>Name des Feldes im BW Paket in welchem die Beschreibung gespeichert werden soll</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>wildcard</td>
|
||
|
|
<td>Optional: Es kann für das angelegte <code>descrField</code> automatisch ein Wildcard registriert werden</td>
|
||
|
|
<td>None</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>descriptions</td>
|
||
|
|
<td>Liste der Beschreibungen</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h4 id="descriptions"><code>descriptions:</code></h4>
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Feld</th>
|
||
|
|
<th>Beschreibung</th>
|
||
|
|
<th>Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>for</td>
|
||
|
|
<td>Inhalt im <code>scanField</code> auf welchem geprüft werden soll</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>add</td>
|
||
|
|
<td>Beschreibungstext welcher im <code>descrField</code> hinterlegt werden soll</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p><strong>Beispiel:</strong></p>
|
||
|
|
<pre><code class="language-yaml">- type: module
|
||
|
|
res: descriptor
|
||
|
|
config:
|
||
|
|
- scanField: tone
|
||
|
|
descrField: description
|
||
|
|
wildcard: "{DESCR}"
|
||
|
|
descriptions:
|
||
|
|
- for: 12345
|
||
|
|
add: FF DescriptorTest
|
||
|
|
- for: '05678' # führende Nullen in '' !
|
||
|
|
add: FF TestDescription
|
||
|
|
- scanField: status
|
||
|
|
descrField: fmsStatDescr
|
||
|
|
wildcard: "{STATUSTEXT}"
|
||
|
|
descriptions:
|
||
|
|
- for: 1
|
||
|
|
add: Frei (Funk)
|
||
|
|
- for: 2
|
||
|
|
add: Frei (Wache)
|
||
|
|
- ...
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="modul-abhangigkeiten">Modul Abhängigkeiten</h2>
|
||
|
|
<ul>
|
||
|
|
<li>keine</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="externe-abhangigkeiten">Externe Abhängigkeiten</h2>
|
||
|
|
<ul>
|
||
|
|
<li>keine</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="paket-modifikationen">Paket Modifikationen</h2>
|
||
|
|
<ul>
|
||
|
|
<li>Wenn im Paket das Feld <code>scanField</code> vorhanden ist, wird das Feld <code>descrField</code> dem Paket hinzugefügt</li>
|
||
|
|
<li>Wenn keine Beschreibung vorhanden ist, wird im Feld <code>descrField</code> der Inhalt des Feldes <code>scanField</code> hinterlegt</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="zusatzliche-wildcards">Zusätzliche Wildcards</h2>
|
||
|
|
<ul>
|
||
|
|
<li>Von der Konfiguration abhängig</li>
|
||
|
|
</ul></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<footer class="col-md-12">
|
||
|
|
<hr>
|
||
|
|
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
|
||
|
|
</footer>
|
||
|
|
<script src="../js/bootstrap.bundle.min.js"></script>
|
||
|
|
<script>
|
||
|
|
var base_url = "..",
|
||
|
|
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
|
||
|
|
</script>
|
||
|
|
<script src="../js/base.js"></script>
|
||
|
|
<script src="../search/main.js"></script>
|
||
|
|
|
||
|
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
||
|
|
<div class="modal-dialog modal-lg">
|
||
|
|
<div class="modal-content">
|
||
|
|
<div class="modal-header">
|
||
|
|
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
||
|
|
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
||
|
|
</div>
|
||
|
|
<div class="modal-body">
|
||
|
|
<p>From here you can search these documents. Enter your search terms below.</p>
|
||
|
|
<form>
|
||
|
|
<div class="form-group">
|
||
|
|
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
||
|
|
</div>
|
||
|
|
</form>
|
||
|
|
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
|
||
|
|
</div>
|
||
|
|
<div class="modal-footer">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
||
|
|
<div class="modal-dialog">
|
||
|
|
<div class="modal-content">
|
||
|
|
<div class="modal-header">
|
||
|
|
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
||
|
|
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
||
|
|
</div>
|
||
|
|
<div class="modal-body">
|
||
|
|
<table class="table">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th style="width: 20%;">Keys</th>
|
||
|
|
<th>Action</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="help shortcut"><kbd>?</kbd></td>
|
||
|
|
<td>Open this help</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="next shortcut"><kbd>n</kbd></td>
|
||
|
|
<td>Next page</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="prev shortcut"><kbd>p</kbd></td>
|
||
|
|
<td>Previous page</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="search shortcut"><kbd>s</kbd></td>
|
||
|
|
<td>Search</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="modal-footer">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|