Skip to content

Commit

Permalink
Merge pull request #66 from babeloff/main
Browse files Browse the repository at this point in the history
Exercise Raspberry Pi Installation Procedure and Update
  • Loading branch information
brothercorvo authored Feb 6, 2024
2 parents dd32e7b + 0dd99c0 commit 81570f5
Show file tree
Hide file tree
Showing 55 changed files with 866 additions and 210 deletions.
7 changes: 4 additions & 3 deletions docs/docs/API/REST_API_Doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ status: ood

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

## How FTS manages the information
Expand Down Expand Up @@ -111,6 +111,7 @@ Set of commands relative to API management.
#### getHelp

Retrieve API version and supported endpoints.

* verb: GET
* endpoint: /manageAPI/getHelp
* returns: json containing API version and supported endpoints
Expand Down Expand Up @@ -290,7 +291,7 @@ A GeoObject is an element place on a map. It has a name, characteristics, and an

###### List of supported HOW
the following list contains
API term : Translation in the COT
API term : Translation in the CoT

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

uid
: OPTIONAL input parameter, needed to update existing drone COT.
: OPTIONAL input parameter, needed to update existing drone CoT.

SPIName
: 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).
Expand Down
12 changes: 11 additions & 1 deletion docs/docs/API/REST_API_InternalDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -509,15 +509,18 @@ code: `200`
]
}
```

* uid: uid of the user
* Group: new user group (optional)
* Token: new api token of user(optional)
* Password: new password for user(optional)

# DataPackageTable
## description
Endpoint used to access data regarding DataPackages

### methods

* POST
* GET
* DELETE
Expand All @@ -535,6 +538,7 @@ returns JSON data containing information regarding all DataPackages currently on

## POST
accepts the zipped form of the file in the body of the message and the following arguments in the url

* filename: the name of the zipped file
* creatorUid(optional): the uid of the user associated with the DataPackage defaults to ```server``` if none is provided

Expand All @@ -559,6 +563,7 @@ accepts the following JSON data
]
}
```

* PrimaryKey: primary key of DataPackage to be modified
* Name: optional new name of DataPackage if not set name will not be changed
* Keywords: optional new keywords of DataPackage if not set keywords will not be changed
Expand All @@ -569,6 +574,7 @@ accepts the following JSON data
Endpoint used to access data regarding mission packages

## methods

* GET
* POST
* DELETE
Expand Down Expand Up @@ -630,10 +636,11 @@ not yet implemented
not yet implemented

# ExCheckTable
Endpoint used to access data regarding ExCheck items such as checklists and templates
Endpoint used to access data regarding `ExCheck` items such as checklists and templates

## POST
creates a template on the server from a supplied xml file accepting the following URL encoded values:

* clientUid: the uid of the client to be recognized as the creator of the template

body of the message should be the xml of the template
Expand All @@ -649,6 +656,7 @@ accepts the following data
}
}
```

`uid`: the uid of those Checklists and Templates to be deleted

## GET
Expand Down Expand Up @@ -683,6 +691,7 @@ return JSON data containing the following information about Checklists and Templ
}
```
### Templates

* "filename": name of file containing template xml
* "name": name associated with template
* "submissionTime": time template was submitted to server
Expand All @@ -693,6 +702,7 @@ return JSON data containing the following information about Checklists and Templ
* "description": description of template

### Checklists

* "filename": name of file containing checklist xml
* "name": name associated with template
* "startTime": time checklist was created
Expand Down
7 changes: 5 additions & 2 deletions docs/docs/About/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@ FTS is a TAK server written in Python that connects all your TAK devices.
We released our software under the "Eclipse Public License" allowing not only private usage but also commercial products built on top of it.

## TAK clients on the same network can communicate directly! So, why should I use a server?
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.
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.

## There are other servers for TAK. Why should I use FTS?
FTS is not only powerful–it's also more user-friendly when [compared](FeaturesCompared.md) to other systems.
Also, FTS is a community-driven Open Source project at its core.
Under the covers, FTS is based on a [domain model](architecture/COTDomain.md),
Under the covers, FTS is based on a [domain model](architecture/CoTDomain.md),
so it is the only TAK server that can provide analysis and interpretation
of the information it collects–not just receive requests from clients
and provides the requested data or perform the requested actions.
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/About/FeaturesCompared.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ Users have spoken: FTS is the best TAK server on github!
| Data Package | O | O | O | O |
| Data Sync | X | O | O | X |
| Easy Certificate | O | X | O | X |
| COT Database Recording | O | O | O | O |
| CoT Database Recording | O | O | O | O |
| KML Generation | O | O | O | X |
| ExCheck Support | O | O | O | X |
| SSL Encryption | O | O | O | O |
| REST API | O (Full) | Ø | O (Extended) | X |
| XML COT | O | O | O | O |
| Protobuf COT | X | O | O | X |
| XML CoT | O | O | O | O |
| Protobuf CoT | X | O | O | X |
| WebMAP | O | O | O | X |
| Video Server | O | X | O | X |
| Voice Server | O | X | O | X |
Expand Down
4 changes: 3 additions & 1 deletion docs/docs/About/PubServer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ status: ood

We support a public instance of FTS hosted by DigitalOcean.

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.
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.

### FTS Public Instance Server Rules

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/About/architecture/.pages
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nav:
- Cursor On Target:
- COT Domain: COTDomain.md
- COT Class Hierarchy: COTHierarchyTree.md
- COT Table: COTTable.md
- Common Warfighting Symbology 2525: MilSTD2525.md
- CoT Domain: cot_domain.md
- CoT Class Hierarchy: cot_hierarchy.md
- CoT Table: cot_table.md
- Common Warfighting Symbology 2525: mil_std_2525.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
status: todo
---

# **COT Domain Model**
# **CoT Domain Model**

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

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


## \_\_serverdestination
Expand Down Expand Up @@ -741,7 +741,8 @@ some type of location?

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

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.
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.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
status: todo
---

# Work in progress COT Hierarchy Tree
# Work in progress CoT Hierarchy Tree

<details>
<summary> COT Hierarchy Tree</summary>
<summary> CoT Hierarchy Tree</summary>

### Heading

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
status: todo
---

# Center On Target (COT)
# Center On Target (CoT)

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

| **COTID** | **Hierarchy** | **Name** | **nickname** | **"ID"** | **CIDC** | **Category1** | **Category2** | **Category3** |
|:--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:---------|:-------------------------|:-------------------------------------|:------------------------------------|:-----------------------------------------------|
Expand Down
Loading

0 comments on commit 81570f5

Please sign in to comment.