diff --git a/docs/_data/menu.yml b/docs/_data/menu.yml deleted file mode 100644 index 67816ad..0000000 --- a/docs/_data/menu.yml +++ /dev/null @@ -1,30 +0,0 @@ -- page_id: home -- title: Building and Flashing - subs: - - {page_id: build_flash} - - {page_id: zadig_lps} -- title: User Guide - subs: - - {page_id: anchor-setup} - - {page_id: tools} - - {page_id: twr-reference-setup} - - {page_id: configure-mode} - - {page_id: starting-position} - - {page_id: tdoa3_setup} -- title: Functional areas - subs: - - {page_id: tdoa_principles} - - {page_id: tdoa2-vs-tdoa3} - - {page_id: tdoa3_implementation} -- title: Development - subs: - - {page_id: unit_tests} - - {page_id: anchor-low-level-config} - - {page_id: ros} -- title: protocols - subs: - - {page_id: lpp} - - {page_id: twr-protocol} - - {page_id: tdoa2_protocol} - - {page_id: tdoa3_protocol} - - {page_id: lpp-short-packets-protocol} diff --git a/docs/building/index.md b/docs/building/index.md new file mode 100644 index 0000000..e56f29c --- /dev/null +++ b/docs/building/index.md @@ -0,0 +1,9 @@ +--- +title: Building +page_id: building_index +sort_order: 1 +--- + +This section contains instructions on how to build the firmware + +{% sub_page_menu %} diff --git a/docs/development/index.md b/docs/development/index.md new file mode 100644 index 0000000..c51ee7b --- /dev/null +++ b/docs/development/index.md @@ -0,0 +1,9 @@ +--- +title: Development Instructions +page_id: development_index +sort_order: 4 +--- + +This section contains related to development. + +{% sub_page_menu %} diff --git a/docs/functional-areas/index.md b/docs/functional-areas/index.md new file mode 100644 index 0000000..cd53e26 --- /dev/null +++ b/docs/functional-areas/index.md @@ -0,0 +1,9 @@ +--- +title: Functional areas +page_id: functional_areas_index +sort_order: 3 +--- + +This section describes the functionality of various parts of the system. + +{% sub_page_menu %} diff --git a/docs/protocols/index.md b/docs/protocols/index.md new file mode 100644 index 0000000..5f06cf6 --- /dev/null +++ b/docs/protocols/index.md @@ -0,0 +1,9 @@ +--- +title: Protocols +page_id: protocols_index +sort_order: 5 +--- + +This section contains documentation of the protocols used + +{% sub_page_menu %} diff --git a/docs/user-guides/index.md b/docs/user-guides/index.md new file mode 100644 index 0000000..7c7bc58 --- /dev/null +++ b/docs/user-guides/index.md @@ -0,0 +1,9 @@ +--- +title: Userguides +page_id: userguides_index +sort_order: 2 +--- + +In this section you will find user guides + +{% sub_page_menu %} diff --git a/docs/user-guides/tdoa3_long_range.md b/docs/user-guides/tdoa3_long_range.md new file mode 100644 index 0000000..5ded93a --- /dev/null +++ b/docs/user-guides/tdoa3_long_range.md @@ -0,0 +1,33 @@ +--- +title: TDoA 3 Long Range +page_id: tdoa3_long_range +--- +In the TDoA3 mode the system can be configured in Long Range mode to extend the distance that the Crazyflie can +receive data from the anchors. We have not done any systematic measurements for the maximum distance but we believe +it is at least around 30 - 40 meters. + +## How it works + +The bitrate of the UWB messages is reduced which increases the distance at which messages can be received. Since each +packet takes a longer time to transmit, the packet rate is also reduced. This increases the noise in the estimated +position a bit compared to "normal" TDoA3. + +## How to configure + +Both the anchors and the Crazyflie must be configured in the Long Range mode. You can read about [how to configure the +Crazyflie here](https://www.bitcraze.io/documentation/repository/crazyflie-firmware/master/userguides/configuration/tdoa3-long-range-config). + +The anchors must be configured with the radio mode: `low bitrate, normal preamble`, [see the low level configuration section](/docs/development/anchor-low-level-config) + +## Limitations + +TDoA3 Long Range is supported from version 2022.09. + +Long Range only works with TDoA3 + +If the system is very "flat", the estimate in Z will not be good, the reason is simple geometry. +For good 3D position estimation we recommend that the ratio between the length|width in relation to the height should +not be larger than 3. This is not an absolute requirement but we think it is a good guideline. +When using Long Range mode this can become a problem if the size of the system is increased without moving the +upper anchors higher. One solution is to add more anchors to the system in the ceiling and/or on the ground to create +smaller "cells" with a good ratio between width and height.