UNPKG

node-red-contrib-sitx

Version:

Node-RED Nodes for sending & receiving Cursor on Target TAK Data with PAR Sit(x).

194 lines (160 loc) 13.2 kB
<!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>Examples &mdash; 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" /> <!--[if lt IE 9]> <script src="_static/js/html5shiv.min.js"></script> <![endif]--> <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="API" href="api.html" /> <link rel="prev" title="Clients" href="clients.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"><a class="reference internal" href="compat.html">Compatibility</a></li> <li class="toctree-l1"><a class="reference internal" href="clients.html">Clients</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">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" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <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">Examples</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/examples.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="examples"> <h1>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h1> <p>The following Python 3.7+ code example creates a TAK Client that generates <code class="docutils literal notranslate"><span class="pre">takPong</span></code> CoT every 20 seconds, and sends them to a TAK Server at <code class="docutils literal notranslate"><span class="pre">tcp://takserver.example.com:8087</span></code> (plain / clear TCP).</p> <ul class="simple"> <li><p>For secure TLS, see <a class="reference external" href="https://github.com/snstac/pytak#tls-support">TLS Support</a> below.</p></li> </ul> <p>To run this example as-is, save the following code-block out to a file named <code class="docutils literal notranslate"><span class="pre">example.py</span></code> and run the command <code class="docutils literal notranslate"><span class="pre">python3</span> <span class="pre">example.py</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python3</span> <span class="kn">import</span> <span class="nn">asyncio</span> <span class="kn">import</span> <span class="nn">xml.etree.ElementTree</span> <span class="k">as</span> <span class="nn">ET</span> <span class="kn">from</span> <span class="nn">configparser</span> <span class="kn">import</span> <span class="n">ConfigParser</span> <span class="kn">import</span> <span class="nn">pytak</span> <span class="k">class</span> <span class="nc">MySerializer</span><span class="p">(</span><span class="n">pytak</span><span class="o">.</span><span class="n">QueueWorker</span><span class="p">):</span> <span class="w"> </span><span class="sd">&quot;&quot;&quot;</span> <span class="sd"> Defines how you process or generate your Cursor-On-Target Events.</span> <span class="sd"> From there it adds the COT Events to a queue for TX to a COT_URL.</span> <span class="sd"> &quot;&quot;&quot;</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">handle_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> <span class="w"> </span><span class="sd">&quot;&quot;&quot;</span> <span class="sd"> Handles pre-COT data and serializes to COT Events, then puts on queue.</span> <span class="sd"> &quot;&quot;&quot;</span> <span class="n">event</span> <span class="o">=</span> <span class="n">data</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">put_queue</span><span class="p">(</span><span class="n">event</span><span class="p">)</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">number_of_iterations</span><span class="o">=-</span><span class="mi">1</span><span class="p">):</span> <span class="w"> </span><span class="sd">&quot;&quot;&quot;</span> <span class="sd"> Runs the loop for processing or generating pre-COT data.</span> <span class="sd"> &quot;&quot;&quot;</span> <span class="k">while</span> <span class="mi">1</span><span class="p">:</span> <span class="n">data</span> <span class="o">=</span> <span class="n">tak_pong</span><span class="p">()</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle_data</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">20</span><span class="p">)</span> <span class="k">def</span> <span class="nf">tak_pong</span><span class="p">():</span> <span class="w"> </span><span class="sd">&quot;&quot;&quot;</span> <span class="sd"> Generates a simple takPong COT Event.</span> <span class="sd"> &quot;&quot;&quot;</span> <span class="n">root</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s2">&quot;event&quot;</span><span class="p">)</span> <span class="n">root</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;version&quot;</span><span class="p">,</span> <span class="s2">&quot;2.0&quot;</span><span class="p">)</span> <span class="n">root</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;type&quot;</span><span class="p">,</span> <span class="s2">&quot;t-x-d-d&quot;</span><span class="p">)</span> <span class="n">root</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;uid&quot;</span><span class="p">,</span> <span class="s2">&quot;takPong&quot;</span><span class="p">)</span> <span class="n">root</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;how&quot;</span><span class="p">,</span> <span class="s2">&quot;m-g&quot;</span><span class="p">)</span> <span class="n">root</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;time&quot;</span><span class="p">,</span> <span class="n">pytak</span><span class="o">.</span><span class="n">cot_time</span><span class="p">())</span> <span class="n">root</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;start&quot;</span><span class="p">,</span> <span class="n">pytak</span><span class="o">.</span><span class="n">cot_time</span><span class="p">())</span> <span class="n">root</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;stale&quot;</span><span class="p">,</span> <span class="n">pytak</span><span class="o">.</span><span class="n">cot_time</span><span class="p">(</span><span class="mi">3600</span><span class="p">))</span> <span class="k">return</span> <span class="n">ET</span><span class="o">.</span><span class="n">tostring</span><span class="p">(</span><span class="n">root</span><span class="p">)</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span> <span class="w"> </span><span class="sd">&quot;&quot;&quot;</span> <span class="sd"> The main definition of your program, sets config params and</span> <span class="sd"> adds your serializer to the asyncio task list.</span> <span class="sd"> &quot;&quot;&quot;</span> <span class="n">config</span> <span class="o">=</span> <span class="n">ConfigParser</span><span class="p">()</span> <span class="n">config</span><span class="p">[</span><span class="s2">&quot;mycottool&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;COT_URL&quot;</span><span class="p">:</span> <span class="s2">&quot;tcp://takserver.example.com:8087&quot;</span><span class="p">}</span> <span class="n">config</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s2">&quot;mycottool&quot;</span><span class="p">]</span> <span class="c1"># Initializes worker queues and tasks.</span> <span class="n">clitool</span> <span class="o">=</span> <span class="n">pytak</span><span class="o">.</span><span class="n">CLITool</span><span class="p">(</span><span class="n">config</span><span class="p">)</span> <span class="k">await</span> <span class="n">clitool</span><span class="o">.</span><span class="n">setup</span><span class="p">()</span> <span class="c1"># Add your serializer to the asyncio task list.</span> <span class="n">clitool</span><span class="o">.</span><span class="n">add_tasks</span><span class="p">(</span><span class="nb">set</span><span class="p">([</span><span class="n">MySerializer</span><span class="p">(</span><span class="n">clitool</span><span class="o">.</span><span class="n">tx_queue</span><span class="p">,</span> <span class="n">config</span><span class="p">)]))</span> <span class="c1"># Start all tasks.</span> <span class="k">await</span> <span class="n">clitool</span><span class="o">.</span><span class="n">run</span><span class="p">()</span> <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">())</span> </pre></div> </div> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="clients.html" class="btn btn-neutral float-left" title="Clients" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="api.html" class="btn btn-neutral float-right" title="API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>&#169; Copyright 2023 Sensors &amp; Signals LLC.</p> </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>