Skip to content

Commit 81570f5

Browse files
authored
Merge pull request #66 from babeloff/main
Exercise Raspberry Pi Installation Procedure and Update
2 parents dd32e7b + 0dd99c0 commit 81570f5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+866
-210
lines changed

docs/docs/API/REST_API_Doc.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ status: ood
66

77
The FreeTAKServer REST API is a human-readable approach to the TAK world.
88
The API allows you to easily connect third parties to the TAK family,
9-
without the need to understand the complexity of the COT structure or what a TCP connection is.
9+
without the need to understand the complexity of the CoT structure or what a TCP connection is.
1010
FTS also supports an [Internal API](REST_API_InternalDoc.md).
1111

1212
## How FTS manages the information
@@ -111,6 +111,7 @@ Set of commands relative to API management.
111111
#### getHelp
112112

113113
Retrieve API version and supported endpoints.
114+
114115
* verb: GET
115116
* endpoint: /manageAPI/getHelp
116117
* returns: json containing API version and supported endpoints
@@ -290,7 +291,7 @@ A GeoObject is an element place on a map. It has a name, characteristics, and an
290291

291292
###### List of supported HOW
292293
the following list contains
293-
API term : Translation in the COT
294+
API term : Translation in the CoT
294295

295296
* "nonCoT": "h-g-i-g-o",
296297
* "mensurated": "m-i",
@@ -835,7 +836,7 @@ latitude
835836
: the angular distance of the geoobject from the earths equator expressed in positive or negative float. (e.g. 43.855682).
836837

837838
uid
838-
: OPTIONAL input parameter, needed to update existing drone COT.
839+
: OPTIONAL input parameter, needed to update existing drone CoT.
839840

840841
SPIName
841842
: the name of the Sensor Point of Interest the UAS is currently aiming to. currently will NOT work in an update message (when you send the UID).

docs/docs/API/REST_API_InternalDoc.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,15 +509,18 @@ code: `200`
509509
]
510510
}
511511
```
512+
512513
* uid: uid of the user
513514
* Group: new user group (optional)
514515
* Token: new api token of user(optional)
515516
* Password: new password for user(optional)
517+
516518
# DataPackageTable
517519
## description
518520
Endpoint used to access data regarding DataPackages
519521

520522
### methods
523+
521524
* POST
522525
* GET
523526
* DELETE
@@ -535,6 +538,7 @@ returns JSON data containing information regarding all DataPackages currently on
535538

536539
## POST
537540
accepts the zipped form of the file in the body of the message and the following arguments in the url
541+
538542
* filename: the name of the zipped file
539543
* creatorUid(optional): the uid of the user associated with the DataPackage defaults to ```server``` if none is provided
540544

@@ -559,6 +563,7 @@ accepts the following JSON data
559563
]
560564
}
561565
```
566+
562567
* PrimaryKey: primary key of DataPackage to be modified
563568
* Name: optional new name of DataPackage if not set name will not be changed
564569
* Keywords: optional new keywords of DataPackage if not set keywords will not be changed
@@ -569,6 +574,7 @@ accepts the following JSON data
569574
Endpoint used to access data regarding mission packages
570575

571576
## methods
577+
572578
* GET
573579
* POST
574580
* DELETE
@@ -630,10 +636,11 @@ not yet implemented
630636
not yet implemented
631637

632638
# ExCheckTable
633-
Endpoint used to access data regarding ExCheck items such as checklists and templates
639+
Endpoint used to access data regarding `ExCheck` items such as checklists and templates
634640

635641
## POST
636642
creates a template on the server from a supplied xml file accepting the following URL encoded values:
643+
637644
* clientUid: the uid of the client to be recognized as the creator of the template
638645

639646
body of the message should be the xml of the template
@@ -649,6 +656,7 @@ accepts the following data
649656
}
650657
}
651658
```
659+
652660
`uid`: the uid of those Checklists and Templates to be deleted
653661

654662
## GET
@@ -683,6 +691,7 @@ return JSON data containing the following information about Checklists and Templ
683691
}
684692
```
685693
### Templates
694+
686695
* "filename": name of file containing template xml
687696
* "name": name associated with template
688697
* "submissionTime": time template was submitted to server
@@ -693,6 +702,7 @@ return JSON data containing the following information about Checklists and Templ
693702
* "description": description of template
694703

695704
### Checklists
705+
696706
* "filename": name of file containing checklist xml
697707
* "name": name associated with template
698708
* "startTime": time checklist was created

docs/docs/About/FAQ.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ FTS is a TAK server written in Python that connects all your TAK devices.
1111
We released our software under the "Eclipse Public License" allowing not only private usage but also commercial products built on top of it.
1212

1313
## TAK clients on the same network can communicate directly! So, why should I use a server?
14-
There are many reasons for using a server, including the availability of a centralized repository of information (data packages), the administration of users and security (SSL), server-side functions (e.g., ExCheck, Data Sync), and integration with other non-TAK systems (e.g., video, audio, Telegram) using the FTS API.
14+
There are many reasons for using a server, including the availability of a centralized repository of information (data packages),
15+
the administration of users and security (SSL),
16+
server-side functions (e.g., `ExCheck`, Data Sync),
17+
and integration with other non-TAK systems (e.g., video, audio, Telegram) using the FTS API.
1518

1619
## There are other servers for TAK. Why should I use FTS?
1720
FTS is not only powerful–it's also more user-friendly when [compared](FeaturesCompared.md) to other systems.
1821
Also, FTS is a community-driven Open Source project at its core.
19-
Under the covers, FTS is based on a [domain model](architecture/COTDomain.md),
22+
Under the covers, FTS is based on a [domain model](architecture/CoTDomain.md),
2023
so it is the only TAK server that can provide analysis and interpretation
2124
of the information it collects–not just receive requests from clients
2225
and provides the requested data or perform the requested actions.

docs/docs/About/FeaturesCompared.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ Users have spoken: FTS is the best TAK server on github!
3030
| Data Package | O | O | O | O |
3131
| Data Sync | X | O | O | X |
3232
| Easy Certificate | O | X | O | X |
33-
| COT Database Recording | O | O | O | O |
33+
| CoT Database Recording | O | O | O | O |
3434
| KML Generation | O | O | O | X |
3535
| ExCheck Support | O | O | O | X |
3636
| SSL Encryption | O | O | O | O |
3737
| REST API | O (Full) | Ø | O (Extended) | X |
38-
| XML COT | O | O | O | O |
39-
| Protobuf COT | X | O | O | X |
38+
| XML CoT | O | O | O | O |
39+
| Protobuf CoT | X | O | O | X |
4040
| WebMAP | O | O | O | X |
4141
| Video Server | O | X | O | X |
4242
| Voice Server | O | X | O | X |

docs/docs/About/PubServer.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ status: ood
88

99
We support a public instance of FTS hosted by DigitalOcean.
1010

11-
The Public server (PUB) is an instance of FTS made available for you to test and play with. We are not going to spy on you, but keep in mind that information will be shared with all the connected users. For production consider to install your own instance.
11+
The Public server (PUB) is an instance of FTS made available for you to test and play with.
12+
We are not going to spy on you, but keep in mind that information will be shared with all the connected users.
13+
For production consider to install your own instance.
1214

1315
### FTS Public Instance Server Rules
1416

docs/docs/About/architecture/.pages

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
nav:
22
- Cursor On Target:
3-
- COT Domain: COTDomain.md
4-
- COT Class Hierarchy: COTHierarchyTree.md
5-
- COT Table: COTTable.md
6-
- Common Warfighting Symbology 2525: MilSTD2525.md
3+
- CoT Domain: cot_domain.md
4+
- CoT Class Hierarchy: cot_hierarchy.md
5+
- CoT Table: cot_table.md
6+
- Common Warfighting Symbology 2525: mil_std_2525.md

docs/docs/About/architecture/COTDomain.md renamed to docs/docs/About/architecture/cot_domain.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
status: todo
33
---
44

5-
# **COT Domain Model**
5+
# **CoT Domain Model**
66

77
The Cursor-On-Target (CoT) Event data model defines a Domain model
88
as a system of abstractions that describes selected aspects
@@ -13,7 +13,7 @@ The Domain model can be translated into an XML data schema
1313
for exchanging time sensitive position of moving objects,
1414
or "what", "when", and "where" (WWW) information, between systems.
1515

16-
![FTS COT domain Model](https://user-images.githubusercontent.com/60719165/193834333-ea041722-e3ea-46f9-9eb6-7417c19807ea.png)
16+
![FTS CoT domain Model](https://user-images.githubusercontent.com/60719165/193834333-ea041722-e3ea-46f9-9eb6-7417c19807ea.png)
1717

1818

1919
## \_\_serverdestination
@@ -741,7 +741,8 @@ some type of location?
741741

742742
This is a Cursor On TargetClass for a generic remarks (aka "FreeText").
743743

744-
Provides a place to annotate CoT with free text information. e.g. comments from other users about the current COT. Used also for the geoChat.
744+
Provides a place to annotate CoT with free text information. e.g. comments from other users about the current CoT.
745+
Used also for the geoChat.
745746

746747
**the xml body of this class is used to transport the chat message**
747748

docs/docs/About/architecture/COTHierarchyTree.md renamed to docs/docs/About/architecture/cot_hierarchy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
status: todo
33
---
44

5-
# Work in progress COT Hierarchy Tree
5+
# Work in progress CoT Hierarchy Tree
66

77
<details>
8-
<summary> COT Hierarchy Tree</summary>
8+
<summary> CoT Hierarchy Tree</summary>
99

1010
### Heading
1111

docs/docs/About/architecture/COTTable.md renamed to docs/docs/About/architecture/cot_table.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
status: todo
33
---
44

5-
# Center On Target (COT)
5+
# Center On Target (CoT)
66

77
The following table combines Center On Target information found in COTTYpes.XML,
88
aligning it to MIL-STD-2525 CIDC code (when possible).
9-
To find more information read the [MilSTD2525 documentation](MilSTD2525.md)
9+
To find more information read the [MIL-STD-D-D-D-2525 documentation](MilSTD2525.md)
1010

1111
| **COTID** | **Hierarchy** | **Name** | **nickname** | **"ID"** | **CIDC** | **Category1** | **Category2** | **Category3** |
1212
|:--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:---------|:-------------------------|:-------------------------------------|:------------------------------------|:-----------------------------------------------|

0 commit comments

Comments
 (0)