node-red-contrib-tak-registration 0.2.0 → 0.2.1

package/README.md

@@ -1,35 +1,30 @@
 node-red-contrib-tak-registration
 =================================
 
-A <a href="http://nodered.org" target="_new">Node-RED</a> node to register to a TAK server,
-and to help send wrap files as datapackages for TAK.
+A <a href="http://nodered.org" target="_new">Node-RED</a> node to register to a TAK server, to help send wrap files as datapackages for TAK, and to create simple markers from json messages.
 
 **NOTE**: NOT yet for production use.
 
-Install
--------
+## Install
 
 Run the following command in your Node-RED user directory - typically `~/.node-red`
 
     npm i node-red-contrib-tak-registration
 
-Usage
------
+## Usage
 
 Registers a TAK gateway node and sets up a heartbeat.
 
 Works in conjunction with a TCP request node, set to point to the TAK server tcp address and port
 (usually 8087 or 8089), set to return strings, <i>keep connection open</i> mode, and split on "&lt;event/&gt;".
 
-It can also accepts files to be sent to the TAK server by sending a msg as follows:
+It can send various types of messages to TAK.
 
-### Inputs
+### Standard COT event
 
-#### Standard COT event
+If the `msg.payload` is an XML string it will be passed directly though.
 
-if the `msg.payload` is an XML string it will be passed directly though.
-
-#### Sending data packages...
+### Sending data packages...
 
 requires a msg containing the following properties
 
@@ -38,11 +33,13 @@ to send to all users, or **public** to just upload the package to the TAK server
  - **topic** - *string* - the overall package name - IE what you want it to be called on the TAK device (keep it short).
  - **attachments** - *array of objects* - each object must contain at least a **filename** (string) and *content** a buffer of the file/data, for example `[{filename:"foo.kml", content: <buffer of the file>}]`
 
-#### Sending marker position...
+### Sending marker position...
+
+To create or update a simple marker send a msg with the following property
 
  - **payload** - *object* - a "standard" node-red worldmap format msg.payload containing `name, lat, lon, type or SIDC, (alt), (speed), (bearing), (layer)`, where type is the CoT type eg a-f-g-u or the SIDC is the standard mil 2525C code, eg SFGPU. The layer will get turned int a hastag which can then be selected on/off in the TAK app.
 
-#### Updating gateway position...
+### Updating gateway position...
 
 To update the location of the gateway dynamically the node can accept a payload
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name"          : "node-red-contrib-tak-registration",
-    "version"       : "0.2.0",
+    "version"       : "0.2.1",
     "description"   : "A Node-RED node to register to TAK and to help wrap files as datapackages to send to TAK",
     "dependencies"  : {
         "adm-zip": "^0.5.9",

package/tak-registration.html

@@ -123,10 +123,11 @@
     <p>Registers a TAK gateway node and sets up a heartbeat.</p>
     <p>Works in conjunction with a TCP request node, set to point to the TAK server tcp address and port
         (usually 8087 or 8089), set to return strings, <i>keep connection open</i> mode, and split on <code>&lt;event/&gt;</code>.</p>
-    <p>It can also accepts files to be sent to the TAK server by sending a msg as follows:</p>
-    <h3>Inputs</h3>
+    <p>If the `msg.payload` is an XML string it will be passed directly though.</p>
+
+    <h3>Sending data packages...</h3>
     <dl class="message-properties">
-        <dt>sendTo <span class="property-type">string|array</span></dt>
+        <dt>sendTo <span class="property-type">string | array</span></dt>
         <dd>can either be an individual TAK callsign, an array of callsigns, or <b>broadcast</b>
             to send to all users, or <b>public</b> to just upload the package to the TAK server.</dd>
         <dt>topic <span class="property-type">string</span></dt>
@@ -135,6 +136,23 @@
         <dd>each object must contain at least a <b>filename</b> (string) and <b>content</b> a buffer of the file/data.
             eg <code>[{filename:"foo.kml", content: &lt;buffer of the file&gt;}]</code></dd>
     </dl>
+
+    <h3>Sending marker position...</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">object</span></dt>
+        <dd>a "standard" <b>node-red worldmap</b> format msg.payload containing `name, lat, lon, type or SIDC,
+            (alt), (speed), (bearing), (layer)`, where type is the CoT type eg a-f-g-u or the SIDC is
+            the standard mil 2525C code, eg SFGPU. The layer will get turned int a hastag which can then
+            be selected on/off in the TAK app.</dd>
+    </dl>
+
+    <h3>Updating gateway position...</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">string | object</span></dt>
+        <dd>Either an NMEA string starting `$GPGGA` or an object containing `lat` and `lon` and
+            optional `alt` properties (but no name property).</dd>
+    </dl>
+
     <h3>Details</h3>
     <p>This should work almost directly with messages received from an email-in node for example -
         but you will need to add the recipients in the sendTo property and may need to filter out