BW3-Core/develop/packet.html

598 lines
20 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>BOSWatch Alarmpaket Format - 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" role="button" data-bs-toggle="dropdown" aria-expanded="false">Module</a>
<ul class="dropdown-menu">
<li>
<a href="../modul/descriptor.html" class="dropdown-item">Descriptor</a>
</li>
<li>
<a href="../modul/geocoding.html" class="dropdown-item">Geocoding</a>
</li>
<li>
<a href="../modul/mode_filter.html" class="dropdown-item">Mode Filter</a>
</li>
<li>
<a href="../modul/regex_filter.html" class="dropdown-item">Regex Filter</a>
</li>
<li>
<a href="../modul/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 active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">Entwickler</a>
<ul class="dropdown-menu">
<li>
<a href="ModulPlugin.html" class="dropdown-item">Eigenes Modul/Plugin schreiben</a>
</li>
<li>
<a href="packet.html" class="dropdown-item active" aria-current="page">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="ModulPlugin.html" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../api/html/index.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/develop/packet.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="#boswatch-paket-format" class="nav-link">BOSWatch Paket Format</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#allgemeine-informationen" class="nav-link">Allgemeine Informationen</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#speziell-fur-pocsag" class="nav-link">Speziell für POCSAG</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#speziell-fur-zvei" class="nav-link">Speziell für ZVEI</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#speziell-fur-fms" class="nav-link">Speziell für FMS</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="boswatch-paket-format"><center>BOSWatch Paket Format</center></h1>
<p>Ein BOSWatch Datenpaket wird in einem Python Dict abgebildet. In der nachfolgenden Tabelle sind die genutzten Felder abgebildet.</p>
<hr />
<h2 id="allgemeine-informationen">Allgemeine Informationen</h2>
<table>
<thead>
<tr>
<th>Feldname</th>
<th style="text-align: center;">FMS</th>
<th style="text-align: center;">POCSAG</th>
<th style="text-align: center;">ZVEI</th>
<th style="text-align: center;">MSG</th>
<th>Wildcard</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td>serverName</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{SNAME}</code></td>
<td>Name der BOSWatch Server Instanz</td>
</tr>
<tr>
<td>serverVersion</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{SVERS}</code></td>
<td></td>
</tr>
<tr>
<td>serverBuildDate</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{SDATE}</code></td>
<td></td>
</tr>
<tr>
<td>serverBranch</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{SBRCH}</code></td>
<td></td>
</tr>
<tr>
<td>clientName</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{CNAME}</code></td>
<td>Name der BOSWatch Client Instanz</td>
</tr>
<tr>
<td>clientIP</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{CIP}</code></td>
<td></td>
</tr>
<tr>
<td>clientVersion</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{CVERS}</code></td>
<td></td>
</tr>
<tr>
<td>clientBuildDate</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{CDATE}</code></td>
<td></td>
</tr>
<tr>
<td>clientBranch</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{CBRCH}</code></td>
<td></td>
</tr>
<tr>
<td>inputSource</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{INSRC}</code></td>
<td>(sdr, audio)</td>
</tr>
<tr>
<td>timestamp</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{TIMES}</code></td>
<td></td>
</tr>
<tr>
<td>frequency</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{FREQ}</code></td>
<td></td>
</tr>
<tr>
<td>mode</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;">X</td>
<td><code>{MODE}</code></td>
<td>(fms, pocsag, zvei, msg)</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="speziell-fur-pocsag">Speziell für POCSAG</h2>
<table>
<thead>
<tr>
<th>Feldname</th>
<th style="text-align: center;">FMS</th>
<th style="text-align: center;">POCSAG</th>
<th style="text-align: center;">ZVEI</th>
<th style="text-align: center;">MSG</th>
<th>Wildcard</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td>bitrate</td>
<td style="text-align: center;"></td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{BIT}</code></td>
<td></td>
</tr>
<tr>
<td>ric</td>
<td style="text-align: center;"></td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{RIC}</code></td>
<td></td>
</tr>
<tr>
<td>subric</td>
<td style="text-align: center;"></td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{SRIC}</code></td>
<td>(1, 2, 3, 4)</td>
</tr>
<tr>
<td>subricText</td>
<td style="text-align: center;"></td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{SRICT}</code></td>
<td>(a, b, c, d)</td>
</tr>
<tr>
<td>message</td>
<td style="text-align: center;"></td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;">X</td>
<td><code>{MSG}</code></td>
<td>Kann außerdem für ein Message Paket genutzt werden</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="speziell-fur-zvei">Speziell für ZVEI</h2>
<table>
<thead>
<tr>
<th>Feldname</th>
<th style="text-align: center;">FMS</th>
<th style="text-align: center;">POCSAG</th>
<th style="text-align: center;">ZVEI</th>
<th style="text-align: center;">MSG</th>
<th>Wildcard</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td>tone</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td><code>{TONE}</code></td>
<td>5-Ton Sequenz nach ZVEI</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="speziell-fur-fms">Speziell für FMS</h2>
<table>
<thead>
<tr>
<th>Feldname</th>
<th style="text-align: center;">FMS</th>
<th style="text-align: center;">POCSAG</th>
<th style="text-align: center;">ZVEI</th>
<th style="text-align: center;">MSG</th>
<th>Wildcard</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td>fms</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{FMS}</code></td>
<td></td>
</tr>
<tr>
<td>service</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{SERV}</code></td>
<td></td>
</tr>
<tr>
<td>country</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{COUNT}</code></td>
<td></td>
</tr>
<tr>
<td>location</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{LOC}</code></td>
<td></td>
</tr>
<tr>
<td>vehicle</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{VEC}</code></td>
<td></td>
</tr>
<tr>
<td>status</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{STAT}</code></td>
<td></td>
</tr>
<tr>
<td>direction</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{DIR}</code></td>
<td></td>
</tr>
<tr>
<td>directionText</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{DIRT}</code></td>
<td>(Fhz-&gt;Lst, Lst-&gt;Fhz)</td>
</tr>
<tr>
<td>tacticalInfo</td>
<td style="text-align: center;">X</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td><code>{TACI}</code></td>
<td>(I, II, III, IV)</td>
</tr>
</tbody>
</table></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>