Skip to content

Commit

Permalink
Updated changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
ampledata committed Jan 13, 2024
1 parent e82cc3b commit 5f59322
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 44 deletions.
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
40 changes: 40 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -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.

46 changes: 3 additions & 43 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Command-line
## Command-line

Command-line usage is available by running ``adsbxcot -h``.

Expand All @@ -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

0 comments on commit 5f59322

Please sign in to comment.