documentation updates

snstac · Jun 21, 2024 · 0051c68 · 0051c68
1 parent c766595
commit 0051c68
Show file tree

Hide file tree

Showing 22 changed files with 33 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![Screenshot of ships in ATAK, via AISCOT.](https://aiscot.readthedocs.io/en/latest/screenshot_1676076870_2962.png)
+![Screenshot of ships in ATAK, via AISCOT.](https://aiscot.readthedocs.io/en/latest/media/aiscot_screenshot_tak_logo.png)
 
 # Display Ships in TAK - AIS to TAK Gateway 
 
@@ -13,15 +13,13 @@ AISCOT has been evaluated with ATAK, WinTAK, iTAK, TAK Server & TAKX, and is kno
 work with other situational awareness (SA) software.
 
 AISCOT supports over-the-air radio (RF) AIS transmissions, local NMEA, and Internet 
-AIS aggregators (like AISHUB). AIS data is displayed in TAK with appropriate icons, a
-ttitude, type, track, bearing, speed, callsign and more.
+AIS aggregators (like AISHUB). AIS data is displayed in TAK with appropriate icons, 
+attitude, type, track, bearing, speed, callsign and more.
 
-AISCOT was original developed to support an open ocean boat race in the Northern 
-Pacific Ocean, as described in this article: http://ampledata.org/boat_race_support.html
+AISCOT was original developed to support an [open ocean boat race in the Northern 
+Pacific Ocean](http://ampledata.org/boat_race_support.html).
 
-[Documentation is available here.](https://aiscot.rtfd.io)
-
-> Want a turn-key AIS to TAK Gateway? Check out [AryaSEA](https://www.snstac.com/aryasea).
+[AISCOT documentation is available here.](https://aiscot.rtfd.io)
 
 ## License & Copyright
 

diff --git a/docs/aiscot operation.graffle b/docs/aiscot operation.graffle
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -52,4 +52,4 @@ AISCOT has the following built-in configuration parameters:
 
     Ignore AIS from Aids to Naviation (buoys, etc).
 
-Additional configuration parameters, including TAK Server configuration, are included in the [PyTAK Configuration](https://pytak.readthedocs.io/en/stable/configuration/) documentation.
+Additional configuration parameters, including TLS & TAK Server configuration, are included in the [PyTAK Configuration](https://pytak.readthedocs.io/en/stable/configuration/) documentation.
diff --git a/docs/conop.md b/docs/conop.md
@@ -7,16 +7,16 @@ AISCOT can operate in two different modes, as described in detail below:
 
 ## AIS Over-the-air Operation (RF)
 
-![AISCOT "AIS Over the Air" CONOP](aiscot_ota.png)
+![AISCOT "AIS Over the Air" CONOP](media/aiscot_ota.png)
 
 Receive AIS data from a VHF AIS receiver, such as the 
-Megwatt `dAISy+ <https://shop.wegmatt.com/products/daisy-ais-receiver>`_. From there 
-AIS can be decoded by `AIS Dispatcher <https://www.aishub.net/ais-dispatcher>`_ and 
-forwarded to AISCOT to be transformed to COT and transmitted to COT destinations.
+Megwatt [dAISy+](https://shop.wegmatt.com/products/daisy-ais-receiver). From there 
+AIS can be decoded by [AIS Dispatcher](https://www.aishub.net/ais-dispatcher) or [AIS-catcher](https://github.com/jvde-github/AIS-catcher) and 
+forwarded to AISCOT to be transformed to CoT and transmitted to TAK.
 
 ## AIS Aggregator Operation (AISHUB.com)
 
-![AISCOT "AIS Aggregator" CONOP](aiscot_agg.png)
+![AISCOT "AIS Aggregator" CONOP](media/aiscot_agg.png)
 
-Receive AIS data from the `AISHUB <https://www.aishub.com>`_ service. 
+Receive AIS data from the [AISHUB](https://www.aishub.com>) service. 
 Requires a subscription to AISHUB.
diff --git a/docs/20180607_094641.jpg → docs/media/20180607_094641.jpg b/docs/20180607_094641.jpg → docs/media/20180607_094641.jpg
diff --git a/...Screen Shot 2021-03-29 at 11.08.52 AM.png → ...Screen Shot 2021-03-29 at 11.08.52 AM.png b/...Screen Shot 2021-03-29 at 11.08.52 AM.png → ...Screen Shot 2021-03-29 at 11.08.52 AM.png
diff --git a/docs/aiscot_agg.png → docs/media/aiscot_agg.png b/docs/aiscot_agg.png → docs/media/aiscot_agg.png
diff --git a/docs/aiscot_home.png → docs/media/aiscot_home.png b/docs/aiscot_home.png → docs/media/aiscot_home.png
diff --git a/docs/aiscot_ota.png → docs/media/aiscot_ota.png b/docs/aiscot_ota.png → docs/media/aiscot_ota.png
diff --git a/docs/screenshot_1676076870_2962.png → docs/media/aiscot_screenshot.png b/docs/screenshot_1676076870_2962.png → docs/media/aiscot_screenshot.png
diff --git a/docs/media/aiscot_screenshot_tak_logo.png b/docs/media/aiscot_screenshot_tak_logo.png
diff --git a/docs/atak_screenshot_with_pytak_logo-x25.png → ...a/atak_screenshot_with_pytak_logo-x25.png b/docs/atak_screenshot_with_pytak_logo-x25.png → ...a/atak_screenshot_with_pytak_logo-x25.png
diff --git a/docs/atak_screenshot_with_pytak_logo.jpg → ...media/atak_screenshot_with_pytak_logo.jpg b/docs/atak_screenshot_with_pytak_logo.jpg → ...media/atak_screenshot_with_pytak_logo.jpg
diff --git a/docs/screenshot-1601068836.png → docs/media/screenshot-1601068836.png b/docs/screenshot-1601068836.png → docs/media/screenshot-1601068836.png
diff --git a/docs/screenshot-1601068866.png → docs/media/screenshot-1601068866.png b/docs/screenshot-1601068866.png → docs/media/screenshot-1601068866.png
diff --git a/docs/screenshot-1601068897.png → docs/media/screenshot-1601068897.png b/docs/screenshot-1601068897.png → docs/media/screenshot-1601068897.png
diff --git a/docs/screenshot-1601068921-25.png → docs/media/screenshot-1601068921-25.png b/docs/screenshot-1601068921-25.png → docs/media/screenshot-1601068921-25.png
diff --git a/docs/screenshot-1601068921.png → docs/media/screenshot-1601068921.png b/docs/screenshot-1601068921.png → docs/media/screenshot-1601068921.png
diff --git a/docs/media/screenshot_1676076870_2962.png b/docs/media/screenshot_1676076870_2962.png
diff --git a/docs/requirements.md b/docs/requirements.md
@@ -0,0 +1,15 @@
+ADSBCOT runs in any Python 3.6+ environment, including Windows, Linux & Raspberry Pi.
+
+Aircraft ADS-B data can be received & decoded from a variety of sources, and can run along-side dump1090 on a single computer, or on seperate computers connected over an IP network.
+
+To receive ADS-B data from aircraft, you'll need:
+
+1. [Recommended software defined radio (SDR)](https://www.amazon.com/Dual-Band-Foreflight-FlightAware-Applications-Adapters/dp/B01K5KAN60/ref=sr_1_15?crid=2HESSUCJX53PB&amp;dib=eyJ2IjoiMSJ9.-BcrVEkozejNi01aZntC01cMv0KcaesQ8bVarAjJXfvBOcpNBZTuE52sF7Ncae2NWJJlsUpahxo7_Lv-B2lsr8gxDgmcuBgDG2IGSR3lJT9D4c0QlAdPm-L47-PiQe70GhQVuaaKSqjb4TiWmIKds_alrhkugTEy44F5k9jA7p93fIm6l6kgwppDBWQ8j3DDJB4rrtTi4diAVoa7Oupa4qqxd8w8wkCcomm16FTuCOs._OoQ15ZrlyppX6-3TFgZUavBlkf1890BnLKywhCAkNo&amp;dib_tag=se&amp;keywords=stratux&amp;qid=1705529274&amp;sprefix=stratux%252Caps%252C168&amp;sr=8-15&amp;ufe=app_do%253Aamzn1.fos.006c50ae-5d4c-4777-9bc0-4513d670b6bc&_encoding=UTF8&tag=ampledata-20&linkCode=ur2&linkId=5567b944046518dfafee00ec1885502f&camp=1789&creative=9325)
+2. [Recommended computer (Raspberry Pi 4)](https://www.amazon.com/RasTech-Raspberry-Starter-Heatsink-Screwdriver/dp/B0C8LV6VNZ/ref=sr_1_11?crid=1E77D6JPU1EYV&amp;dib=eyJ2IjoiMSJ9.GmziFBXjr5waSxQc8tV4UirP2DPEP4YHR9azinNNab80_feQ4H_nwyzD8MttAneBqvOa5ko8TQ5pSxQ9PDx0HMStTqpFiigDPJdpxEEtXUBbMjto4kJZPQjauJgYHP396nz_oVnBd9qupwyea05vFTvRAij1VWCtPOxTfPP3UDrbVpMoLWp6GoDYW0FewjKympsFDFDpg_51OmOy3LFsaQNcApAhyVvx3YN1P3oKrE4.AMS1HrucumtXmJp3lLz_72GORdtCB8TeUAJRc8lbxuo&amp;dib_tag=se&amp;keywords=raspberry+pi&amp;qid=1705529616&amp;sprefix=raspberry+pi%252Caps%252C151&amp;sr=8-11&amp;ufe=app_do%253Aamzn1.fos.006c50ae-5d4c-4777-9bc0-4513d670b6bc&_encoding=UTF8&tag=ampledata-20&linkCode=ur2&linkId=216dea4837fb50857da9ade1f09bf15a&camp=1789&creative=9325)
+3. [Flightaware's dump1090-fa](https://www.flightaware.com/adsb/piaware/install)
+
+There'a also a variety of pre-assembled ADS-B receivers available:
+
+* [Flightaware's PiAware](https://www.flightaware.com/adsb/piaware/)
+* [Flightradar24 Pi24](https://www.flightradar24.com/build-your-own)
+* [ADS-B Exchange](https://www.adsbexchange.com/ways-to-join-the-exchange/build-your-own/)
diff --git a/docs/usage.md b/docs/usage.md
@@ -58,7 +58,7 @@ For example, the following Bound Box paints a large swath around Northern Califo
 4. Start AISCOT: `sudo systemctl start aiscot`
 
 ```ini
-{!debian/aiscot.service}
+{!debian/aiscot.service!}
 ```
 
 

diff --git a/stdeb.cfg b/stdeb.cfg
@@ -0,0 +1,4 @@
+[DEFAULT]
+Package3: aiscot
+Replaces3: python3-aiscot
+Depends3: python3-aiohttp, pytak
Original file line number	Diff line number	Diff line change
Expand Up		@@ -52,4 +52,4 @@ AISCOT has the following built-in configuration parameters:

		Ignore AIS from Aids to Naviation (buoys, etc).

		Additional configuration parameters, including TAK Server configuration, are included in the [PyTAK Configuration](https://pytak.readthedocs.io/en/stable/configuration/) documentation.
		Additional configuration parameters, including TLS & TAK Server configuration, are included in the [PyTAK Configuration](https://pytak.readthedocs.io/en/stable/configuration/) documentation.
-Original file line number
+Diff line change
@@ Expand Up @@
 . Start AISCOT: `sudo systemctl start aiscot`
     ```ini
-    {!debian/aiscot.service}
+    {!debian/aiscot.service!}
     ```
@@ Expand Down @@