From 5f59322d183583ed36b39970b09c7dbcd0fa2be6 Mon Sep 17 00:00:00 2001 From: Greg Albrecht Date: Fri, 12 Jan 2024 23:25:18 -0800 Subject: [PATCH] Updated changelog --- CHANGELOG.md | 12 ++++++++++- docs/configuration.md | 40 +++++++++++++++++++++++++++++++++++++ docs/usage.md | 46 +++---------------------------------------- 3 files changed, 54 insertions(+), 44 deletions(-) create mode 100644 docs/configuration.md diff --git a/CHANGELOG.md b/CHANGELOG.md index d4d99e1..33f5a0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,16 @@ ## ADSBXCOT 6.0.0 -New for 2024! +- New for 2024! - Removed 'light' mode for CoT. +- Documentation Updates. +- Fixes #17. Added ReadTheDocs site. +- Fixes #18: Deprecate ADSBX_URL in favor of FEED_URL akin to adsbcot. +- Fixes #19: Add support for Python 3.10, 3.11, 3.12 +- Fixes #15: Add config parameter for 'only show TIS-B': TISB_ONLY +- Fixes #20: Make _aircot_ a sub-element of detail. +- Fixes #21: Use PyTAK's gen_cot_xml() +- Fixes #22: Move setup.py metadata to setup.cfg +- Fixes #23: Python 3.6 tests failing. +- Fixes #24: Pin Github actions to Ubuntu 20.04 ## ADSBXCOT 5.1.0 - Added XML Declaration header to output CoT XML. diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..c619278 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,40 @@ +ADSBXCOT's configuration parameters can be set two ways: + +1. In an INI-style configuration file. ``adsbxcot -c config.ini`` +2. As environment variables. ``export DEBUG=1;adsbcot`` + +ADSBXCOT has the following built-in configuration parameters: + + +* **`FEED_URL`** + * Default: TK + + ADS-B Aggregator API URL. + +* **`POLL_INTERVAL`** + * Default: ``30`` + + Period, in seconds, to poll API URL. + +* **`KNOWN_CRAFT`**: + * Default: unset + + CSV-style aircraft hints file for overriding callsign, icon, COT Type, etc. + +* **`INCLUDE_TISB`**: + * Default: ``False`` + + If ``True``, includes TIS-B tracks. + +* **`INCLUDE_ALL_CRAFT`**: + * Default: ``False`` + + If ``True`` and ``KNOWN_CRAFT`` is set, will forward all aircraft, including those transformed by the ``KNOWN_CRAFT`` database. + +* **`TISB_ONLY`**: + * Default: ``False`` + + If ``True``, only passes TIS-B tracks. + +Additional configuration parameters, including TAK Server configuration, are included in the [PyTAK Configuration](https://pytak.readthedocs.io/en/latest/configuration/) documentation. + diff --git a/docs/usage.md b/docs/usage.md index 019d0c9..84d053e 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,4 +1,4 @@ -# Command-line +## Command-line Command-line usage is available by running ``adsbxcot -h``. @@ -13,46 +13,6 @@ options: Optional connection preferences package zip file (aka data package). ``` -## Configuration - -ADSBXCOT's configuration parameters can be set two ways: - -1. In an INI-style configuration file. ``adsbxcot -c config.ini`` -2. As environment variables. ``export DEBUG=1;adsbcot`` - -ADSBXCOT has the following built-in configuration parameters: - - -* **`FEED_URL`** - * Default: TK - - ADS-B Aggregator API URL. - - -* **`POLL_INTERVAL`** - * Default: ``30`` - - Period, in seconds, to poll API URL. - -* **`KNOWN_CRAFT`**: - * Default: unset - - CSV-style aircraft hints file for overriding callsign, icon, COT Type, etc. - -* **`INCLUDE_TISB`**: - * Default: ``False`` - - If ``True``, includes TIS-B tracks. - -* **`INCLUDE_ALL_CRAFT`**: - * Default: ``False`` - - If ``True`` and ``KNOWN_CRAFT`` is set, will forward all aircraft, including those transformed by the ``KNOWN_CRAFT`` database. - -* **`TISB_ONLY`**: - * Default: ``False`` - - If ``True``, only passes TIS-B tracks. - -Additional configuration parameters, including TAK Server configuration, are included in the [PyTAK Configuration](https://pytak.readthedocs.io/en/latest/configuration/) documentation. +## Run as a service / Run forever. +TK