node-red-contrib-tak-registration 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +16 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,13 +1,15 @@
1
1
  node-red-contrib-tak-registration
2
2
  =================================
3
3
 
4
- 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.
4
+ A <a href="http://nodered.org" target="_new">Node-RED</a> node to register to a TAK server, to help wrap and send
5
+ files as datapackages for TAK, and to create and update markers from json messages.
5
6
 
6
7
  **NOTE**: NOT yet for production use.
7
8
 
8
9
  ## Install
9
10
 
10
- Run the following command in your Node-RED user directory - typically `~/.node-red`
11
+ Either use the Menu - Manage Palette - Install option, or run the following command in your Node-RED user
12
+ directory - typically `~/.node-red`
11
13
 
12
14
  npm i node-red-contrib-tak-registration
13
15
 
@@ -15,18 +17,20 @@ Run the following command in your Node-RED user directory - typically `~/.node-r
15
17
 
16
18
  Registers a TAK gateway node and sets up a heartbeat.
17
19
 
18
- Works in conjunction with a TCP request node, set to point to the TAK server tcp address and port
20
+ It must be connected to a TCP request node, configured to point to the TAK server tcp address and port
19
21
  (usually 8087 or 8089), set to return strings, <i>keep connection open</i> mode, and split on "&lt;/event&gt;".
20
22
 
21
23
  It can send various types of messages to TAK.
22
24
 
25
+ As it registers to the gateway it should be possible for other team members to send messages and markers to the gateway.
26
+
23
27
  ### Standard COT event
24
28
 
25
29
  If the `msg.payload` is an XML string it will be passed directly though.
26
30
 
27
31
  ### Sending data packages...
28
32
 
29
- requires a msg containing the following properties
33
+ requires a `msg` containing the following properties
30
34
 
31
35
  - **sendTo** - *string|array* - can either be an individual TAK callsign, an array of callsigns, or **broadcast**
32
36
  to send to all users, or **public** to just upload the package to the TAK server.
@@ -39,15 +43,18 @@ To create or update a simple marker send a msg with the following property
39
43
 
40
44
  - **payload** - *object* - a "standard" node-red worldmap format msg.payload containing `name, lat, lon, cottype or SIDC, (alt), (speed), (bearing), (layer)`, where `cottype` is the CoT type eg a-f-g-u, or `SIDC` is the standard mil 2525C code, eg SFGPU. The `layer` will get turned into a hashtag which can then be selected on/off in the TAK app layers control.
41
45
 
42
- ### Updating gateway position...
46
+ ### Sending drawing layer...
47
+
48
+ The node will also accept drawing type messages incoming from the drawing layer of the
49
+ [node-red-contrib-web-worldmap](https://flows.nodered.org/node/node-red-contrib-web-worldmap),
50
+ and convert them to CoT objects for display. To do this configure a *worldmap-in* node to pass on drawing layer messages.
51
+
52
+ ### Updating the gateway position...
43
53
 
44
54
  To update the location of the gateway dynamically the node can accept a payload
45
55
 
46
- - **payload** - *string|object* - Either a string starting `$GPGGA` (for example from a locally attached serial GPS device) - or an object containing `lat` and `lon` and optional `alt` properties (but no name property).
56
+ - **payload** - *string|object* - Either an NMEA string starting `$GPGGA` (for example from a locally attached serial GPS device) - or an object containing `lat` and `lon` and optional `alt` properties (**but no name** property).
47
57
 
48
58
  ### Details
49
59
 
50
60
  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 unwanted messages first.
51
-
52
- As well as accepting simple worldmap type marker object it will accept "draw" actions from the
53
- worldmap drawing layer and convert them to CoT objects for display.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "node-red-contrib-tak-registration",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "A Node-RED node to register to TAK and to help wrap files as datapackages to send to TAK",
5
5
  "dependencies": {
6
6
  "@turf/turf": "^6.5.0",