Skip to content

Commit a351e0f

Browse files
Make new docs live
Update README and change URLs for handoff to inavflight.github.io
2 parents 80549a4 + a292ae5 commit a351e0f

384 files changed

Lines changed: 70558 additions & 10237 deletions

File tree

Some content is hidden

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

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,27 @@ To build and run the docs locally, install npm on your system and follow the Doc
1717
- Make sure all packages are installed with `npm install`.
1818
- Run the dev server with `npm run start`.
1919

20-
The temporary documentation can be accessed at this URL: https://www.spiffygoose.com/inavdocs/
20+
Documentation can be accessed at this URL: https://inavflight.github.io/
2121

22-
## Versioning Scheme
22+
## For Contributors
23+
24+
### Versioning Scheme
2325

2426
The website utilizes Docusaurus's versioning feature to keep track of major changes to the firmware.
25-
The current version is the active stable release in the main `./docs` directory that is intended to be continually updated with minor updates until the next version.
26-
Upon the release of the next stable version, the current version will be archived (versioned) into its own directory using `npm run docusaurus docs:version x.y.z`
27-
Lastly, the next current version's label will updated in `docusaurus.config.ts`.
27+
The current version is the active stable release in `/versioned_docs/version-x.x.x` directory that has been frozen with no further updates.
28+
Upon the release of the next stable version, it will be created into its own, new directory using `npm run docusaurus docs:version x.y.z`
29+
30+
### Image and Media References
31+
As per the latest Docusaurus file structure, please place new static images in the `/static/img/` directory in an organized fashion.
32+
When referring to an image in a markdown file, please use absolute paths according to the following markdown syntax: `![Image Info](/img/FolderName/NameOfImage.jpg)`
33+
34+
### Linking to Pages
35+
When linking to local pages, please do not use http urls or relative paths to link to other markdown documents that are part of the docusaurus site.
36+
For easier maintenance and organization, use relative paths starting from the root directory eg: `../quickstart/Name_of_markdown.md` if not in the `quickstart` directory, which exists one level above.
37+
Autocomplete on VS Code should find the directories automatically.
38+
Linking to headings within the document work as well by using `#` following the filename.
2839

2940
## Plugins Used
3041

31-
* The search plugin used is docusaurus-lunr-search: https://github.com/praveenn77/docusaurus-lunr-search
42+
* Search plugin: https://github.com/easyops-cn/docusaurus-search-local
3243
* Image zoom plugin: https://github.com/gabrielcsapo/docusaurus-plugin-image-zoom
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Automatic Antenna Tracker
3+
---
4+
5+
## Introduction
6+
7+
Since release 3.0, INAV directly supports embedded video telemetry data to drive the VirtualPilot Sentinel antenna tracker.
8+
9+
This enables the use of directional higher gain antennas to maintain higher quality video in all directions, provide the ability to use lower video transmission power or increase the maximum reception distance over traditional omnidirectional antennas. The AAT provides the benefit of maintaining a more accurate direction over manually mounted antennas without the concern of the aircraft moving outside of the antenna’s dominant reception area.
10+
11+
***
12+
## Configuring - iNAV 3.0 onwards (embedded support)
13+
* Requires minimum of INAV 3.0 and fonts installed
14+
* Enable AAT telemetry in the cli: set osd_telemetry = ON
15+
16+
## Configuring - iNAV earlier versions
17+
* Check content at the link here: [INAV AAT for earlier versions](https://github.com/aat-sentinel/Documentation/blob/main/Sentinel%20AAT%20lite%20User%20Guide.pdf)
18+
19+
## Testing
20+
As telemetry data is not normally visible, the telemetry data can be viewed on the OSD using a cli command:
21+
* Enable AAT telemetry with second test line in the cli: set osd_telemetry = TEST
22+
* Remember to change it back when finished: set osd_telemetry = ON (FC restart required)
23+
24+
***
25+
## Description of operation
26+
* iNAV knows its home launch position, current position and altitude
27+
* iNAV can calculate the pan and tilt information required by the antenna tracker
28+
* The data is sent using video telemetry over an analogue signal
29+
* The video telemetry is sent on OSD row 0 with only pixel line 0 used
30+
* 30 bits of information are sent in each video frame which includes tilt angle, pan angle and error validation check
31+
* Two font characters are used to represent a binary 0 or 1
32+
33+
Positives of using this telemetry method:
34+
* Simple and reliable
35+
* No hardware modules or extra wiring on aircraft
36+
* Supports all RC TX - not limited to TX with telemetry
37+
* Does not require unreliable bluetooth / wifi connections to tracker
38+
* Not impacted by 2.4G RC /Video
39+
* Ultra-fast position updating – up to 30 hz
40+
* Low size packet means higher tracking success rate in poor signal conditions
41+
42+
Negatives of using this telemetry method:
43+
* Tracking data may be recorded by some DVR. Not usually visible in goggles / monitor
44+
* The first row of OSD display becomes unavailable for OSD. However, this row is not usually fully visible
45+
* This does not use tracker GPS location – so cannot be used in a moving vehicle
46+
47+
In the visualisation video below, you can see how the telemetry data is sent. This is a test mode as it is not usually visible in FPV goggles / recordings, however notice how the real telemetry line on pixel row zero is not visible.
48+
49+
[![Telemetry visualisation capture](https://img.youtube.com/vi/FMLUvc-tX4E/0.jpg)](https://youtu.be/FMLUvc-tX4E?t=20)
50+
51+
***
52+
## Sentinel AAT for use with iNAV
53+
Further information on the Sentinel AAT is available by clicking on the image:
54+
55+
[![Sentinel AAT](https://static.rcgroups.net/forums/attachments/2/6/9/6/2/5/a14859253-253-TrackersRCG.png)](https://www.rcgroups.com/forums/showthread.php?3815901-New-product-low-cost-antenna-tracker-for-iNav-Betaflight-Ardupilot-KISS-etc)

0 commit comments

Comments
 (0)