Skip to content

Commit d58c75f

Browse files
ampledataampledata
committed
Checkpoint checkin for 2024.
- Fixed formatting of CHANGELOG.md - Fixes #37: Move RTFD docs over to Markdown. - Fixes #38: Don't discard ImportError exception.
1 parent 9a0d6bc commit d58c75f

20 files changed

+323
-389
lines changed

‎.readthedocs.yml

+4-18
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,16 @@
22
# Read the Docs configuration file
33
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
44

5-
# Required
65
version: 2
76

8-
# Set the version of Python and other tools you might need
97
build:
108
os: ubuntu-22.04
119
tools:
1210
python: "3.11"
13-
# You can also specify other tool versions:
14-
# nodejs: "19"
15-
# rust: "1.64"
16-
# golang: "1.19"
1711

18-
# Build documentation in the docs/ directory with Sphinx
19-
sphinx:
20-
configuration: docs/source/conf.py
12+
mkdocs:
13+
configuration: mkdocs.yml
2114

22-
# If using Sphinx, optionally build your docs in additional formats such as PDF
23-
# formats:
24-
# - pdf
25-
26-
# Optionally declare the Python requirements required to build your docs
2715
python:
28-
install:
29-
- requirements: docs/requirements.txt
30-
- method: pip
31-
path: .
16+
install:
17+
- requirements: docs/requirements.txt

‎CHANGELOG.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
1-
ADSBCOT 6.1.0
2-
-------------
3-
Added optional altitude filters: ALT_UPPER, ALT_LOWER
1+
## ADSBCOT beta
42

3+
- Fixed formatting of CHANGELOG.md
4+
5+
## ADSBCOT 6.1.0
6+
7+
Added optional altitude filters: ALT_UPPER, ALT_LOWER:
58
- ALT_UPPER: Upper Altitude Limit, geometric (GNSS / INS) altitude in feet referenced to the WGS84 ellipsoid.
69
- ALT_LOWER: Lower Altitude Limit, same ref as ALT_UPPER.
710

8-
ADSBCOT 6.0.0
9-
-------------
11+
## ADSBCOT 6.0.0
12+
1013
Improved support for AirTAK.
1114
- Added a Read the Docs documentation site: https://adsbcot.readthedocs.io
1215
- Added ability to read file:// URLs, including reading aircraft.json from local fs.
1316
- Replaced setup.py metadata with setup.cfg.
1417
- Code cleanup.
1518

16-
ADSBCOT 5.1.2
17-
-------------
19+
## ADSBCOT 5.1.2
20+
1821
- Fixed #17: Incorrect course/track for some dump1090 feeds. Thanks @dnlbaldwin
1922
- Code cleanup.
2023

21-
ADSBCOT 5.1.1
22-
-------------
24+
## ADSBCOT 5.1.1
25+
2326
Adding CoT XML Declaration to output CoT.
2427

25-
ADSBCOT 5.0.5
26-
-------------
28+
## ADSBCOT 5.0.5
29+
2730
Updated adsbexchange.com Raspberry Pi installation instructions.

‎LICENSE

+193-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,199 @@
1-
Copyright 2023 Sensors & Signals LLC
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
2191

3192
Licensed under the Apache License, Version 2.0 (the "License");
4193
you may not use this file except in compliance with the License.
5-
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
6197

7198
Unless required by applicable law or agreed to in writing, software
8199
distributed under the License is distributed on an "AS IS" BASIS,

‎Makefile

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright 2023 Sensors & Signals LLC
2+
# Copyright Sensors & Signals LLC https://www.snstac.com
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
@@ -13,9 +13,6 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
# Author:: Greg Albrecht <gba@snstac.com>
17-
# License:: Apache License, Version 2.0
18-
#
1916

2017
this_app = adsbcot
2118
.DEFAULT_GOAL := all
@@ -75,3 +72,7 @@ test_cov:
7572

7673
black:
7774
black .
75+
76+
mkdocs:
77+
pip install -r docs/requirements.txt
78+
mkdocs serve

‎README.rst

+46-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,50 @@
1-
ADS-B to TAK Gateway
2-
********************
1+
.. image:: https://adsbxcot.readthedocs.io/en/latest/atak_screenshot_with_pytak_logo-x25.png
2+
:alt: ATAK screenshot with PyTAK logo.
33

4-
.. image:: https://github.com/snstac/adsbcot/blob/main/docs/atak_screenshot_with_pytak_logo-x25.jpg
5-
:alt: ATAK Screenshot with PyTAK Logo.
6-
:target: https://github.com/snstac/adsbcot/blob/main/docs/atak_screenshot_with_pytak_logo.jpg
4+
Display Aircraft in TAK
5+
************************
6+
7+
ADSBCOT is software for monitoring and analyzing aviation surveillance data via the Team Awareness Kit (TAK) ecosystem of products.
8+
9+
ADSBCOT captures & reports real-time ADS-B data received from aircraft (or other airbrone vehicles and drones) into TAK products using native TAK protocols, including Cursor on Target (CoT).
10+
11+
ADSBCOT has been evaluated with WinTAK, iTAK, ATAK & TAK Server.
12+
13+
ADSBCOT is in active use today in a variety of missions.
14+
15+
`Documentation is available here. <https://adsbcot.rtfd.io>`_
16+
17+
Use ADS-B Aggregators? Check out my sister software `ADSBXCOT <https://adsbxcot.rtfd.io>`_.
18+
19+
License
20+
=======
21+
22+
Copyright Sensors & Signals LLC https://www.snstac.com
23+
24+
Licensed under the Apache License, Version 2.0 (the "License");
25+
you may not use this file except in compliance with the License.
26+
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
27+
28+
Unless required by applicable law or agreed to in writing, software
29+
distributed under the License is distributed on an "AS IS" BASIS,
30+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
31+
See the License for the specific language governing permissions and
32+
limitations under the License.
33+
34+
35+
36+
Tracks within TAK retain the aircraft's position, course & speed, and remarks contain the received Flight, Tail & Category ADS-B data.
37+
38+
ADSBCOT includes a set of filters and transforms TK TK TK.
39+
40+
41+
ADSBCOT runs in any Python 3.6+ environment, including Windows & Linux.
42+
43+
44+
45+
46+
47+
ADSBCOT is a PyTAK gatew
748

849
The ADS-B to TAK Gateway (ADSBCOT) transforms Automatic Dependent
950
Surveillance-Broadcast (ADS-B) aircraft position information into Cursor on

0 commit comments

Comments
 (0)