node-red-contrib-sitx/docs/build/html/searchindex.js

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

Search.setIndex({"docnames": ["api", "clients", "compat", "config", "examples", "generated/pytak", "generated/pytak.CLITool", "generated/pytak.QueueWorker", "generated/pytak.RXWorker", "generated/pytak.TXWorker", "generated/pytak.Worker", "generated/pytak.cli", "generated/pytak.create_udp_client", "generated/pytak.protocol_factory", "generated/pytak.read_pref_package", "generated/pytak.rxworker_factory", "generated/pytak.txworker_factory", "index", "install"], "filenames": ["api.rst", "clients.rst", "compat.rst", "config.rst", "examples.rst", "generated/pytak.rst", "generated/pytak.CLITool.rst", "generated/pytak.QueueWorker.rst", "generated/pytak.RXWorker.rst", "generated/pytak.TXWorker.rst", "generated/pytak.Worker.rst", "generated/pytak.cli.rst", "generated/pytak.create_udp_client.rst", "generated/pytak.protocol_factory.rst", "generated/pytak.read_pref_package.rst", "generated/pytak.rxworker_factory.rst", "generated/pytak.txworker_factory.rst", "index.rst", "install.rst"], "titles": ["API", "Clients", "Compatibility", "Configuration", "Examples", "pytak", "pytak.CLITool", "pytak.QueueWorker", "pytak.RXWorker", "pytak.TXWorker", "pytak.Worker", "pytak.cli", "pytak.create_udp_client", "pytak.protocol_factory", "pytak.read_pref_package", "pytak.rxworker_factory", "pytak.txworker_factory", "Python Team Awareness Kit Documentation", "Installation"], "terms": {"pytak": [1, 2, 3, 4, 17, 18], "worker": [2, 4, 7, 8, 9, 15, 16, 17], "txworker": [2, 15, 16, 17], "rxworker": [2, 15, 17], "queuework": [4, 9, 17], "clitool": [2, 4, 17], "create_udp_cli": 17, "protocol_factori": [2, 8, 17], "txworker_factori": [9, 17], "rxworker_factori": 17, "cli": 17, "read_pref_packag": 17, "i": [1, 3, 4, 7, 9, 13, 17, 18], "us": [1, 2, 3, 8, 9, 18], "mani": [1, 2], "cot": [1, 2, 3, 4, 7, 15, 16, 17], "tak": [1, 3, 4, 12, 17], "gatewai": [1, 17], "aiscot": 1, "automat": 1, "identif": 1, "system": [1, 2, 18], "ai": 1, "transform": 1, "marin": 1, "posit": 1, "messag": [1, 2, 3, 7], "pli": 1, "event": [1, 2, 3, 4, 7, 8, 15, 16], "adsbcot": 1, "depend": [1, 13], "surveil": 1, "broadcast": [1, 2, 12], "ad": 1, "b": [1, 2, 3], "aircraft": 1, "adsbxcot": 1, "exchang": 1, "stratuxcot": 1, "stratux": 1, "aprscot": 1, "packet": 1, "report": 1, "apr": 1, "spotcot": 1, "globalstar": 1, "spot": 1, "satellit": 1, "inrcot": 1, "garmin": 1, "inreach": 1, "zellocot": 1, "zellowork": 1, "user": 1, "locat": 1, "mission": 2, "critici": 2, "environ": [2, 3], "everi": [2, 4], "dai": 2, "across": 2, "all": [2, 3, 4, 10], "offici": 2, "product": 2, "wintak": 2, "atak": [2, 3], "itak": 2, "takx": 2, "ha": [2, 3], "been": 2, "test": 2, "situat": 2, "awar": [2, 5], "sa": [2, 3], "common": [2, 3], "oper": 2, "pictur": 2, "cop": 2, "taki": 2, "free": 2, "ft": [2, 3], "raptorx": 2, "coper": 2, "support": [2, 4, 17], "follow": [2, 3, 4], "tl": [2, 4, 17], "unicast": [2, 12], "host": 2, "port": [2, 3], "see": [2, 4], "section": 2, "below": [2, 4], "tcp": [2, 4], "udp": [2, 3, 12], "multicast": [2, 3, 12], "group": 2, "aka": 2, "mesh": [2, 3], "write": 2, "onli": 2, "wo": 2, "stdout": 2, "stderr": 2, "log": [2, 3], "requir": [2, 18], "abov": 2, "WILL": 2, "NOT": 2, "work": [2, 9], "It": 2, "should": [2, 7, 9, 18], "run": [2, 4], "almost": 2, "ani": [2, 13], "platform": 2, "includ": [2, 17], "linux": 2, "window": 2, "raspberri": [2, 17], "pi": [2, 17], "android": 2, "et": [2, 4], "al": 2, "built": [2, 3], "anti": 2, "denial": 2, "servic": 2, "do": [2, 3], "which": 2, "restrict": 2, "number": 2, "can": [2, 3, 17, 18], "send": [2, 3, 4, 17], "listen": [2, 3], "current": 2, "thi": [2, 3, 4, 8, 11, 17, 18], "featur": 2, "cannot": 2, "disabl": [2, 3], "chang": 2, "so": 2, "must": [2, 3, 18], "meter": 2, "input": [2, 8], "speed": 2, "To": [2, 3, 4, 18], "base": [2, 15, 16], "set": [2, 3, 4], "fts_compat": [2, 3], "configur": [2, 13, 17], "paramet": [2, 3, 15, 16, 17], "true": 2, "caus": 2, "sleep": [2, 3, 4], "random": [2, 3], "second": [2, 3, 4], "between": [2, 3], "transmit": 2, "altern": [2, 17], "you": [2, 3, 4, 9, 18], "specifi": [2, 3, 13], "static": 2, "period": [2, 3], "pytak_sleep": [2, 3], "an": [2, 3, 7, 8, 9, 12], "integ": 2, "googl": 2, "buffer": [2, 8], "each": 2, "consist": 2, "one": [2, 3], "atakmap": 2, "commoncommo": 2, "v1": 2, "takmessag": 2, "serial": [2, 4, 7, 17], "sourc": [2, 5, 17, 18], "http": [2, 5, 18], "github": [2, 5, 17, 18], "com": [2, 3, 4, 5, 12, 18], "deptofdefens": 2, "androidtacticalassaultkit": 2, "civ": 2, "blob": 2, "master": 2, "core": 2, "impl": 2, "txt": 2, "nativ": 2, "receiv": [2, 3, 8, 17], "0": [2, 3, 4, 17], "plain": [2, 3, 4], "xml": [2, 3, 4], "If": [2, 3], "d": [2, 4], "like": 2, "decod": 2, "instal": [2, 3, 17], "option": [2, 3], "takproto": [2, 18], "modul": [2, 5, 17, 18], "when": 2, "python3": [2, 4, 18], "m": [2, 4, 18], "pip": [2, 18], "with_takproto": [2, 18], "from": [2, 4, 7, 8, 15, 16, 18], "debian": [2, 17], "packag": [2, 3, 14], "tk": 2, "here": 2, "exampl": [2, 3, 12, 17], "n": [2, 3], "The": [2, 4, 7, 18], "data": [2, 3, 4, 9, 14, 17], "type": [2, 4], "return": [2, 4, 15, 16], "implement": [2, 3, 7, 8, 11], "differ": 2, "byte": 2, "v": 2, "object": [2, 6, 13], "usr": [2, 4], "bin": [2, 4], "env": [2, 4], "import": [2, 3, 4], "asyncio": [2, 4, 7, 8, 12, 15, 16], "configpars": [2, 4, 6], "class": [2, 4, 6, 7, 8, 9, 10, 13, 17], "myrxwork": 2, "async": [2, 4, 7, 8, 12, 13, 15, 16], "def": [2, 4], "readcot": 2, "self": [2, 4], "hasattr": 2, "reader": [2, 8], "readuntil": 2, "await": [2, 4], "encod": 2, "utf": 2, "8": 2, "elif": 2, "recv": 2, "src": 2, "tak_v1": 2, "parse_proto": 2, "my_setup": 2, "none": [2, 6, 7, 8, 9, 10, 11, 12], "writer": [2, 9], "config": [2, 3, 4, 6, 7, 8, 9, 10, 13, 15, 16], "write_work": 2, "tx_queue": [2, 4, 6], "read_work": 2, "rx_queue": [2, 6, 8], "add_task": [2, 4], "main": [2, 4], "definit": [2, 4], "your": [2, 4], "program": [2, 4], "param": [2, 4], "add": [2, 3, 4, 8], "task": [2, 4], "list": [2, 3, 4], "mycottool": [2, 4], "cot_url": [2, 3, 4, 13, 15, 16], "239": [2, 3], "2": [2, 3, 4], "6969": [2, 3], "initi": [2, 4, 6, 7, 8, 9, 10], "queue": [2, 4, 6, 7, 8, 9, 10, 15, 16], "start": [2, 4], "__name__": [2, 4], "__main__": [2, 4], "": 3, "two": 3, "wai": 3, "In": 3, "ini": 3, "style": 3, "file": [3, 4], "typic": 3, "As": 3, "variabl": 3, "destin": [3, 15, 16], "cursor": [3, 4, 17], "target": [3, 4, 17], "default": 3, "3": [3, 4, 17, 18], "1": [3, 4, 17], "tak_proto": 3, "protocol": [3, 7, 8, 9, 13, 15, 16, 17], "output": 3, "stream": [3, 12], "debug": 3, "level": 3, "fals": 3, "avoid": 3, "protect": 3, "given": 3, "emit": 3, "pref_packag": [3, 14], "with_crypto": [3, 18], "contain": 3, "server": [3, 4, 17], "connect": [3, 13], "certif": 3, "etc": 3, "zip": 3, "path": 3, "For": [3, 4, 12], "pref": [3, 14], "name": [3, 4, 11], "adsb3_fir": 3, "could": 3, "either": 3, "line": [3, 11], "commandlin": 3, "util": 3, "argument": 3, "p": 3, "dsb3_fire": 3, "over": [3, 17], "minimum": 3, "url": [3, 12, 15, 16], "takserv": [3, 4], "8089": 3, "cert": 3, "pytak_tls_client_cert": 3, "client": [3, 4, 7, 12, 17], "kei": 3, "ca": 3, "pem": 3, "format": 3, "encrypt": 3, "privat": 3, "ar": 3, "save": [3, 4], "clear": [3, 4], "text": 3, "openssl": 3, "rsa": 3, "my_cert": 3, "out": [3, 4, 17], "nopass": 3, "unencrypt": 3, "both": [3, 18], "alon": 3, "later": 3, "case": 3, "pytak_tls_client_kei": 3, "client_cert_and_kei": 3, "associ": 3, "pytak_tls_dont_verifi": 3, "verif": 3, "Will": 3, "print": 3, "warn": 3, "pytak_tls_dont_check_hostnam": 3, "cn": 3, "pytak_tls_client_cafil": 3, "trust": 3, "store": 3, "remot": 3, "pytak_tls_client_ciph": 3, "colon": 3, "seper": 3, "cipher": 3, "suit": 3, "allow": 3, "ecdh": 3, "ecdsa": 3, "aes256": 3, "gcm": 3, "sha384": 3, "python": [4, 5, 18], "7": 4, "code": [4, 17], "creat": [4, 9, 12, 13, 15, 16, 17], "gener": 4, "takpong": 4, "20": 4, "them": [4, 7, 8], "8087": 4, "secur": 4, "block": 4, "py": 4, "command": [4, 11], "etre": 4, "elementtre": 4, "myseri": 4, "defin": 4, "how": 4, "process": 4, "On": 4, "tx": 4, "handle_data": 4, "handl": [4, 7, 17], "pre": 4, "put": [4, 7, 9], "put_queu": 4, "number_of_iter": 4, "loop": 4, "while": 4, "tak_pong": 4, "simpl": 4, "root": 4, "element": 4, "version": [4, 17], "t": 4, "x": 4, "uid": 4, "g": 4, "time": 4, "cot_tim": 4, "stale": 4, "3600": 4, "tostr": 4, "setup": 4, "non": [7, 17], "well": 17, "function": [9, 11, 17], "network": [7, 12, 13, 17], "check": 17, "further": 17, "inform": 17, "project": 17, "behavior": 17, "found": 17, "ubuntu": 17, "protobuf": 17, "compat": [17, 18], "o": 17, "6": [17, 18], "freetakserv": 17, "payload": 17, "index": [17, 18], "search": 17, "page": 17, "distribut": 18, "deb": 18, "most": [8, 18], "contemporari": 18, "onward": 18, "advanc": 18, "tool": 18, "apt": 18, "other": [10, 18], "relat": 18, "download": 18, "sudo": 18, "updat": 18, "y": 18, "wget": 18, "snstac": [5, 18], "releas": 18, "latest": 18, "pytak_latest_al": 18, "f": 18, "deta": 18, "also": 18, "cryptographi": 18, "snstak": 18, "takproto_latest_al": 18, "pypi": 18, "method": [6, 7, 8, 9, 10, 18], "manual": 18, "addit": 18, "librari": 18, "1a": 18, "libffi": 18, "dev": 18, "1b": 18, "redhat": 18, "cento": 18, "yum": 18, "devel": 18, "2a": 18, "2b": 18, "git": 18, "clone": 18, "cd": 18, "team": 5, "kit": 5, "author": [], "greg": [], "albrecht": [], "gba": [], "copyright": [], "2023": [], "sensor": [], "signal": [], "llc": [], "licens": [], "apach": [], "full_config": [], "wrapper": 6, "__init__": [6, 7, 8, 9, 10], "instanc": [6, 7, 8, 9, 10, 13], "attribut": 6, "dict": [7, 8, 9, 10, 14], "read": [7, 8, 14], "similar": 7, "onto": [7, 9], "event_queu": [7, 15, 16], "eventwork": [7, 15, 16], "messagework": 7, "drain": 8, "rx": 8, "socket": 8, "eventreceiv": 8, "hand": 9, "off": 9, "meta": 10, "app_nam": 11, "str": [11, 12, 14], "abstract": 11, "interfac": 11, "app": 11, "call": 11, "parseresult": 12, "tupl": 12, "datagramcli": 12, "A": 12, "pars": 12, "fulli": 12, "qualifi": 12, "urllib": 12, "urlpars": 12, "4242": 12, "sectionproxi": [7, 8, 9, 10, 13, 15, 16], "valu": 13, "prefer": 14, "get": [15, 16], "api": 17, "stuff": [], "pythong": [], "last": [], "seealso": [], "_": [], "ifac": 12, "local_addr": 12}, "objects": {"": [[5, 0, 0, "-", "pytak"]], "pytak": [[6, 1, 1, "", "CLITool"], [7, 1, 1, "", "QueueWorker"], [8, 1, 1, "", "RXWorker"], [9, 1, 1, "", "TXWorker"], [10, 1, 1, "", "Worker"], [11, 3, 1, "", "cli"], [12, 3, 1, "", "create_udp_client"], [13, 3, 1, "", "protocol_factory"], [14, 3, 1, "", "read_pref_package"], [15, 3, 1, "", "rxworker_factory"], [16, 3, 1, "", "txworker_factory"]], "pytak.CLITool": [[6, 2, 1, "", "__init__"]], "pytak.QueueWorker": [[7, 2, 1, "", "__init__"]], "pytak.RXWorker": [[8, 2, 1, "", "__init__"]], "pytak.TXWorker": [[9, 2, 1, "", "__init__"]], "pytak.Worker": [[10, 2, 1, "", "__init__"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"]}, "titleterms": {"api": 0, "client": [1, 2], "compat": 2, "server": 2, "i": 2, "o": 2, "network": 2, "protocol": [2, 18], "python": [2, 17], "3": 2, "6": 2, "freetakserv": 2, "tak": [2, 18], "payload": 2, "version": [2, 18], "1": [2, 18], "protobuf": [2, 18], "configur": 3, "tl": 3, "support": [3, 18], "exampl": 4, "team": 17, "awar": 17, "kit": 17, "document": 17, "content": 17, "indic": 17, "tabl": 17, "instal": 18, "debian": 18, "ubuntu": 18, "raspberri": 18, "pi": 18, "data": 18, "packag": 18, "altern": 18, "pytak": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "clitool": 6, "queuework": 7, "rxworker": 8, "txworker": 9, "worker": 10, "cli": 11, "paramet": [11, 12, 13], "create_udp_cli": 12, "return": [12, 13], "protocol_factori": 13, "read_pref_packag": 14, "rxworker_factori": 15, "txworker_factori": 16, "0": [], "quickstart": []}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"API": [[0, "api"]], "Clients": [[1, "clients"]], "Compatibility": [[2, "compatibility"]], "Clients & Servers": [[2, "clients-servers"]], "I/O & Network Protocols": [[2, "i-o-network-protocols"]], "Python 3.6+": [[2, "python-3-6"]], "FreeTAKServer": [[2, "freetakserver"]], "TAK Protocol Payload - Version 1 (Protobuf)": [[2, "tak-protocol-payload-version-1-protobuf"]], "Configuration": [[3, "configuration"]], "TLS Support": [[3, "tls-support"]], "Examples": [[4, "examples"]], "pytak": [[5, "module-pytak"]], "pytak.CLITool": [[6, "pytak-clitool"]], "pytak.QueueWorker": [[7, "pytak-queueworker"]], "pytak.RXWorker": [[8, "pytak-rxworker"]], "pytak.TXWorker": [[9, "pytak-txworker"]], "pytak.Worker": [[10, "pytak-worker"]], "pytak.cli": [[11, "pytak-cli"]], "Parameters": [[11, "parameters"], [12, "parameters"], [13, "parameters"]], "pytak.create_udp_client": [[12, "pytak-create-udp-client"]], "Returns": [[12, "returns"], [13, "returns"]], "pytak.protocol_factory": [[13, "pytak-protocol-factory"]], "pytak.read_pref_package": [[14, "pytak-read-pref-package"]], "pytak.rxworker_factory": [[15, "pytak-rxworker-factory"]], "pytak.txworker_factory": [[16, "pytak-txworker-factory"]], "Python Team Awareness Kit Documentation": [[17, "python-team-awareness-kit-documentation"]], "Contents": [[17, "contents"]], "Indices and tables": [[17, "indices-and-tables"]], "Installation": [[18, "installation"]], "Debian, Ubuntu, Raspberry Pi": [[18, "debian-ubuntu-raspberry-pi"]], "Data Package Support": [[18, "data-package-support"]], "TAK Protocol Version 1 (protobuf) Support": [[18, "tak-protocol-version-1-protobuf-support"]], "Alternative Installation": [[18, "alternative-installation"]]}, "indexentries": {"module": [[5, "module-pytak"]], "pytak": [[5, "module-pytak"]], "clitool (class in pytak)": [[6, "pytak.CLITool"]], "__init__() (pytak.clitool method)": [[6, "pytak.CLITool.__init__"]], "queueworker (class in pytak)": [[7, "pytak.QueueWorker"]], "__init__() (pytak.queueworker method)": [[7, "pytak.QueueWorker.__init__"]], "rxworker (class in pytak)": [[8, "pytak.RXWorker"]], "__init__() (pytak.rxworker method)": [[8, "pytak.RXWorker.__init__"]], "txworker (class in pytak)": [[9, "pytak.TXWorker"]], "__init__() (pytak.txworker method)": [[9, "pytak.TXWorker.__init__"]], "worker (class in pytak)": [[10, "pytak.Worker"]], "__init__() (pytak.worker method)": [[10, "pytak.Worker.__init__"]], "cli() (in module pytak)": [[11, "pytak.cli"]], "create_udp_client() (in module pytak)": [[12, "pytak.create_udp_client"]], "protocol_factory() (in module pytak)": [[13, "pytak.protocol_factory"]], "read_pref_package() (in module pytak)": [[14, "pytak.read_pref_package"]], "rxworker_factory() (in module pytak)": [[15, "pytak.rxworker_factory"]], "txworker_factory() (in module pytak)": [[16, "pytak.txworker_factory"]]}})