inReach Cursor on Target Gateway.
Project description
Pictured: Screenshot of INRCOT being used on a Search & Rescue mission in Arizona.
The inReach to Cursor on Target Gateway (INRCOT) transforms Garmin inReach position messages into Cursor on Target (CoT) for display on TAK Products such as ATAK, WinTAK, iTAK, et al. Single or multi-device feeds are supported.
Other situational awareness products, including as RaptorX, TAKX & COPERS have been tested.
INRCOT requires a Garmin inReach device with service.
Pictured: Diagram of INRCOT’s Concept of Operations (CONOP).
Support Development
Use Cases
There are numerous applications for satellite based position location information, including:
Wildland fire unit tracking
Blue Force Tracking
Search & Rescue (SAR)
Partner Forces PLI
Asset Tracking
Data diode, CDS & cybersecurity considerations
See also Section 1114.d of the Dingell Act:
Location Systems for Wildland Firefighters.-- (1) In general.--Not later than 2 years after the date of enactment of this Act, subject to the availability of appropriations, the Secretaries, in coordination with State wildland firefighting agencies, shall jointly develop and operate a tracking system (referred to in this subsection as the ``system'') to remotely locate the positions of fire resources for use by wildland firefighters, including, at a minimum, any fire resources assigned to Federal type 1 wildland fire incident management teams.
Requirements
INRCOT uses the Garmin Explore “MapShare” feature.
Login to Garmin Explore: https://explore.garmin.com/
Browse to the “MY INFO” page: https://explore.garmin.com/Inbox
Click “Social”.
Under MapShare > Enable MapShare click to enable ‘MapShare: On’.
Click “Feeds” and note the “Raw KML Data” URL, we’ll use this URL, write it down.
For more information on inReach KML Feeds see: https://support.garmin.com/en-US/?faq=tdlDCyo1fJ5UxjUbA9rMY8
Install
INRCOT functionality is provided via a command-line tool named inrcot. To install inrcot:
Debian, Ubuntu, Raspbian, Raspberry OS:
$ sudo apt update $ wget https://github.com/ampledata/pytak/releases/latest/download/python3-pytak_latest_all.deb $ sudo apt install -f ./python3-pytak_latest_all.deb $ wget https://github.com/ampledata/inrcot/releases/latest/download/python3-inrcot_latest_all.deb $ sudo apt install -f ./python3-inrcot_latest_all.deb
CentOS, et al:
$ sudo python3 -m pip install inrcot
Install from source:
$ git clone https://github.com/ampledata/inrcot.git $ cd inrcot/ $ python3 setup.py install
Usage
The inrcot program has two command-line arguments:
$ inrcot -h usage: inrcot [-h] [-c CONFIG_FILE] [-p PREF_PACKAGE] optional arguments: -h, --help show this help message and exit -c CONFIG_FILE, --CONFIG_FILE CONFIG_FILE Optional configuration file. Default: config.ini -p PREF_PACKAGE, --PREF_PACKAGE PREF_PACKAGE Optional connection preferences package zip file (aka data package).
Configuration
Configuration parameters can be specified either via environment variables or in a INI-stile configuration file. An example configuration file, click here for an example configuration file example-config.ini.
Global Config Parameters:
POLL_INTERVAL: How many seconds between checking for new messages at the Spot API? Default: 120 (seconds).
COT_STALE: How many seconds until CoT is stale? Default: 600 (seconds)
COT_TYPE: CoT Type. Default: a-f-g-e-s
For each feed (1 inReach = 1 feed, multiple feeds supported), these config params can be set:
FEED_URL: URL to the MapShare KML.
COT_STALE: How many seconds until CoT is stale? Default: 600 (seconds)
COT_TYPE: CoT Type. Default: a-f-g-e-s
COT_NAME: CoT Callsign. Defaults to the MapShare KML Placemark name.
COT_ICON: CoT User Icon. If set, will set the CoT usericon element, for use with custom TAK icon sets.
FEED_USERNAME: MapShare username, for use with protected MapShare.
FEED_PASSWORD: MapShare password, for use with protected MapShare.
TLS & other configuration parameters available via PyTAK.
Example Configurations
An example config:
[inrcot] COT_URL = tcp://takserver.example.com:8088 POLL_INTERVAL = 120 [inrcot_feed_aaa] FEED_URL = https://share.garmin.com/Feed/Share/aaa
Multiple feeds can be added by creating multiple inrcot_feed sections:
[inrcot] COT_URL = tcp://takserver.example.com:8088 POLL_INTERVAL = 120 [inrcot_feed_xxx] FEED_URL = https://share.garmin.com/Feed/Share/xxx [inrcot_feed_yyy] FEED_URL = https://share.garmin.com/Feed/Share/yyy
Individual feeds CoT output can be customized as well:
[inrcot] COT_URL = tcp://takserver.example.com:8088 POLL_INTERVAL = 120 [inrcot_feed_zzz] FEED_URL = https://share.garmin.com/Feed/Share/zzz COT_TYPE = a-f-G-U-C COT_STALE = 600 COT_NAME = Team Lead COT_ICON = my_package/team_lead.png
Protected feeds are also supported:
[inrcot] COT_URL = tcp://takserver.example.com:8088 POLL_INTERVAL = 120 [inrcot_feed_ppp] FEED_URL = https://share.garmin.com/Feed/Share/ppp FEED_USERNAME = secretsquirrel FEED_PASSWORD = supersecret
Source
INRCOT Source can be found on Github: https://github.com/ampledata/inrcot
Copyright
INRCOT is Copyright 2023 Greg Albrecht
License
Copyright 2023 Greg Albrecht <oss@undef.net>
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file inrcot-5.2.0.tar.gz
.
File metadata
- Download URL: inrcot-5.2.0.tar.gz
- Upload date:
- Size: 11.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20272440a232ce213433e2af60a2ef9ffe2ec58563be9e27dd32d11791656633 |
|
MD5 | 200592c0fa062218f67ff1b8888fd64d |
|
BLAKE2b-256 | 47507f9aaf33d0e69c9d987d31554f31b99034714777c01460343508df6e49ac |
File details
Details for the file inrcot-5.2.0-py3-none-any.whl
.
File metadata
- Download URL: inrcot-5.2.0-py3-none-any.whl
- Upload date:
- Size: 11.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9196dfe674e4a57c781f995e5850e12f94adaca078149ce234234f970d9f7869 |
|
MD5 | 87c36c97e64cd7ed95d83b161c9b1be0 |
|
BLAKE2b-256 | e27ae256206e4a0e34ccee4892a8deb05dba678051752f66a5b1f176c4446b15 |