node-red-contrib-sitx

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Compatibility — PyTAK 0.1.1 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script> <script src="_static/sphinx_highlight.js"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Clients" href="clients.html" /> <link rel="prev" title="Configuration" href="config.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> PyTAK </a> <div class="version"> 0.1.1 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="config.html">Configuration</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Compatibility</a><ul> <li class="toctree-l2"><a class="reference internal" href="#clients-servers">Clients & Servers</a></li> <li class="toctree-l2"><a class="reference internal" href="#i-o-network-protocols">I/O & Network Protocols</a></li> <li class="toctree-l2"><a class="reference internal" href="#python-3-6">Python 3.6+</a></li> <li class="toctree-l2"><a class="reference internal" href="#freetakserver">FreeTAKServer</a></li> <li class="toctree-l2"><a class="reference internal" href="#tak-protocol-payload-version-1-protobuf">TAK Protocol Payload - Version 1 (Protobuf)</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="clients.html">Clients</a></li> <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> <li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">PyTAK</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Compatibility</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/compat.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="compatibility"> <h1>Compatibility<a class="headerlink" href="#compatibility" title="Permalink to this heading"></a></h1> <section id="clients-servers"> <h2>Clients & Servers<a class="headerlink" href="#clients-servers" title="Permalink to this heading"></a></h2> PyTAK is used in mission criticial environments, every day, across all official <a class="reference external" href="https://tak.gov">TAK Products</a>: <ul class="simple"> <li><a class="reference external" href="https://tak.gov/">WinTAK</a></li> <li><a class="reference external" href="https://tak.gov/">ATAK</a></li> <li><a class="reference external" href="https://tak.gov/">iTAK</a></li> <li><a class="reference external" href="https://tak.gov/">TAKX</a></li> <li><a class="reference external" href="https://tak.gov/">TAK Server</a></li> </ul> PyTAK has been tested and is compatible with many situational awareness (SA) & common operating picture (COP) systems: <ul class="simple"> <li><a class="reference external" href="https://github.com/tkuester/taky">taky</a></li> <li><a class="reference external" href="https://github.com/FreeTAKTeam/FreeTakServer">Free TAK Server (FTS/FreeTAKServer)</a></li> <li>RaptorX</li> <li>COPERS</li> </ul> </section> <section id="i-o-network-protocols"> <h2>I/O & Network Protocols<a class="headerlink" href="#i-o-network-protocols" title="Permalink to this heading"></a></h2> PyTAK supports the following I/O & network protocols: <ul class="simple"> <li>TLS Unicast: <code class="docutils literal notranslate">tls://host:port</code> (see <a class="reference external" href="https://github.com/snstac/pytak#tls-support">TLS Support</a> section below)</li> <li>TCP Unicast: <code class="docutils literal notranslate">tcp://host:port</code></li> <li>UDP Multicast: <code class="docutils literal notranslate">udp://group:port</code> (aka Mesh SA)</li> <li>UDP Unicast: <code class="docutils literal notranslate">udp://host:port</code></li> <li>UDP Broadcast: <code class="docutils literal notranslate">udp+broadcast://network:port</code></li> <li>UDP Write-only: <code class="docutils literal notranslate">udp+wo://host:port</code></li> <li>stdout or stderr: <code class="docutils literal notranslate">log://stdout</code> or <code class="docutils literal notranslate">log://stderr</code></li> </ul> </section> <section id="python-3-6"> <h2>Python 3.6+<a class="headerlink" href="#python-3-6" title="Permalink to this heading"></a></h2> PyTAK requires Python 3.6 or above and WILL NOT work on Python versions below 3.6. It should run on almost any platform that supports Python 3.6+, including Linux, Windows, Raspberry Pi, Android, et al. </section> <section id="freetakserver"> <h2>FreeTAKServer<a class="headerlink" href="#freetakserver" title="Permalink to this heading"></a></h2> FTS (Free TAK Server) has built-in anti-Denial-of-Service (DoS) support, which restricts the number of CoT Events a client can send to a listening TCP Port. Currently this FTS feature cannot be disabled or changed, so clients must meter their input speed. To use a PyTAK-based client with FTS, set the <code class="docutils literal notranslate">FTS_COMPAT</code> configuration parameter to <code class="docutils literal notranslate">True</code>. This will cause the PyTAK client to sleep a random number of seconds between transmitting CoT to a FTS server: <div class="highlight-default notranslate"><div class="highlight"><pre>FTS_COMPAT = True </pre></div> </div> Alternatively you can specify a static sleep period by setting <code class="docutils literal notranslate">PYTAK_SLEEP</code> to an integer number of seconds: <div class="highlight-default notranslate"><div class="highlight"><pre>PYTAK_SLEEP = 3 </pre></div> </div> </section> <section id="tak-protocol-payload-version-1-protobuf"> <h2>TAK Protocol Payload - Version 1 (Protobuf)<a class="headerlink" href="#tak-protocol-payload-version-1-protobuf" title="Permalink to this heading"></a></h2> <blockquote> <div>Version 1 of the TAK Protocol Payload is a Google Protocol Buffer based payload. Each Payload consists of one (and only one) atakmap::commoncommo::v1::TakMessage message which is serialized using Google protocol buffers version 3. Source: <a class="reference external" href="https://github.com/deptofdefense/AndroidTacticalAssaultKit-CIV/blob/master/commoncommo/core/impl/protobuf/protocol.txt">https://github.com/deptofdefense/AndroidTacticalAssaultKit-CIV/blob/master/commoncommo/core/impl/protobuf/protocol.txt</a> </div></blockquote> PyTAK natively sends and receives “TAK Protocol Payload - Version 0”, aka plain XML. If you’d like to receive & decode “Version 1” protobuf with PyTAK, install the optional <a class="reference external" href="https://github.com/snstac/takproto">takproto</a> Python module: When installing PyTAK: <div class="highlight-default notranslate"><div class="highlight"><pre>$ python3 -m pip install pytak[with_takproto] </pre></div> </div> Alternative, installing from a Debian package: <div class="highlight-default notranslate"><div class="highlight"><pre>$ TK TK </pre></div> </div> Here is an example of receiving & decoding “Version 1” using <code class="docutils literal notranslate">takproto</code>. N.B. The data type returned from this implementation differs from that of the “Version 0” implementation (<code class="docutils literal notranslate">bytes</code> vs <code class="docutils literal notranslate">object</code>): <div class="highlight-default notranslate"><div class="highlight"><pre>#!/usr/bin/env python3 import asyncio from configparser import ConfigParser import takproto import pytak class MyRXWorker(pytak.RXWorker): async def readcot(self): if hasattr(self.reader, 'readuntil'): cot = await self.reader.readuntil("</event>".encode("UTF-8")) elif hasattr(self.reader, 'recv'): cot, src = await self.reader.recv() tak_v1 = takproto.parse_proto(cot) if tak_v1 != -1: cot = tak_v1 return cot async def my_setup(clitool) -> None: reader, writer = await pytak.protocol_factory(clitool.config) write_worker = pytak.TXWorker(clitool.tx_queue, clitool.config, writer) read_worker = MyRXWorker(clitool.rx_queue, clitool.config, reader) clitool.add_task(write_worker) clitool.add_task(read_worker) async def main(): """ The main definition of your program, sets config params and adds your serializer to the asyncio task list. """ config = ConfigParser() config["mycottool"] = {"COT_URL": "udp://239.2.3.1:6969"} config = config["mycottool"] # Initializes worker queues and tasks. clitool = pytak.CLITool(config) await my_setup(clitool) # Start all tasks. await clitool.run() if __name__ == "__main__": asyncio.run(main()) </pre></div> </div> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="config.html" class="btn btn-neutral float-left" title="Configuration" accesskey="p" rel="prev"> Previous</a> <a href="clients.html" class="btn btn-neutral float-right" title="Clients" accesskey="n" rel="next">Next </a> </div> <hr/> <div role="contentinfo"> © Copyright 2023 Sensors & Signals LLC. </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>