#565 Updated links to new url structure and updated internal urls to …

…mirror the menu tree.
bitcraze · Mar 19, 2020 · 96a65fb · 96a65fb
1 parent bfedc1c
commit 96a65fb
Show file tree

Hide file tree

Showing 28 changed files with 84 additions and 104 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,15 +17,10 @@ tags
 /tag.*
 *.gch
 
-/generated-test/**
-**/__pycache__/**
-
 current_platform.mk
 
-# generated files for githubpages
-/docs/_site/*
-/docs/Gemfile.lock
-
+/generated-test/**
+**/__pycache__/**
 
 /docs/.jekyll-metadata
 docs/.jekyll-cache
diff --git a/docs/_data/menu.yml b/docs/_data/menu.yml
@@ -1,8 +1,4 @@
 - page_id: home
-- title: Introduction
-  subs:
-    - {page_id: folder_description}
-    - {page_id: crazyflie-1-support}
 - title: Building and Flashing
   subs:
     - {page_id: build_instructions}

diff --git a/docs/build_instructions.md → ...ilding-and-flashing/build_instructions.md b/docs/build_instructions.md → ...ilding-and-flashing/build_instructions.md
diff --git a/docs/dfu.md → docs/building-and-flashing/dfu.md b/docs/dfu.md → docs/building-and-flashing/dfu.md
diff --git a/docs/crazyflie_1_support.md b/docs/crazyflie_1_support.md
diff --git a/docs/ctrp_index.md b/docs/ctrp_index.md
diff --git a/docs/howto.md → docs/development/howto.md b/docs/howto.md → docs/development/howto.md
diff --git a/docs/openocd_gdb_debugging.md → docs/development/openocd_gdb_debugging.md b/docs/openocd_gdb_debugging.md → docs/development/openocd_gdb_debugging.md
diff --git a/docs/serial.md → docs/development/serial.md b/docs/serial.md → docs/development/serial.md
diff --git a/docs/starting_development.md → docs/development/starting_development.md b/docs/starting_development.md → docs/development/starting_development.md
diff --git a/docs/unit_testing.md → docs/development/unit_testing.md b/docs/unit_testing.md → docs/development/unit_testing.md
diff --git a/docs/ctrp_commander.md → docs/functional-areas/crtp/ctrp_commander.md b/docs/ctrp_commander.md → docs/functional-areas/crtp/ctrp_commander.md
diff --git a/docs/ctrp_console.md → docs/functional-areas/crtp/ctrp_console.md b/docs/ctrp_console.md → docs/functional-areas/crtp/ctrp_console.md
@@ -1,6 +1,6 @@
 ---
-title: Concole
-page_id: ctrp_concole
+title: Console
+page_id: ctrp_console
 ---
 
 This port is used as a one-way text console for printing text from the
@@ -21,5 +21,3 @@ following is fulfilled:
 -   The output buffer (of 31 bytes) is full
 -   A \"newline\" character has to be send (\\n and/or \\r)
 -   A flush command as been issued
-
-
diff --git a/docs/ctrp_generic_setpoint.md → ...ional-areas/crtp/ctrp_generic_setpoint.md b/docs/ctrp_generic_setpoint.md → ...ional-areas/crtp/ctrp_generic_setpoint.md
diff --git a/docs/ctrp_localization.md → ...unctional-areas/crtp/ctrp_localization.md b/docs/ctrp_localization.md → ...unctional-areas/crtp/ctrp_localization.md
@@ -54,7 +54,7 @@ streams. The format of the packet is:
 
 Packet used to send LPP short packet to the loco positioning system. The
 payload is sent to the sytem as an [LPP Short
-Packet](https://www.bitcraze.io/docs/lps-node-firmware/master/lpp/).
+Packet](https://www.bitcraze.io/documentation/repository/lps-node-firmware/master/lpp/).
 
 ### Emergency stop
 

diff --git a/docs/ctrp_log.md → docs/functional-areas/crtp/ctrp_log.md b/docs/ctrp_log.md → docs/functional-areas/crtp/ctrp_log.md
diff --git a/docs/ctrp_mem.md → docs/functional-areas/crtp/ctrp_mem.md b/docs/ctrp_mem.md → docs/functional-areas/crtp/ctrp_mem.md
diff --git a/docs/ctrp_parameters.md → .../functional-areas/crtp/ctrp_parameters.md b/docs/ctrp_parameters.md → .../functional-areas/crtp/ctrp_parameters.md
diff --git a/docs/functional-areas/crtp/index.md b/docs/functional-areas/crtp/index.md
@@ -0,0 +1,72 @@
+---
+title: Communication with the Crazyflie
+page_id: ctrp_index
+---
+
+For communicating with the Crazyflie we have implemented our own
+high-level protocol named CRTP (Crazy RealTime Protocol). It\'s a fairly
+simple protocol using a number of target ports where data can be sent
+and received in either direction, but in most cases the communication is
+driven from the host. The protocol can be implemented on a number of
+mediums, currently we have USB and Crazyradio support.
+
+CRTP
+====
+
+Physical carriers
+-----------------
+
+Currently CRTP is supported over Crazyradio and USB (currently only for
+Crazyflie 2.0).
+
+ | Carrier          | Supports|
+ | -----------------| -------------------|
+ | Crazyradio (PA)  | Crazyflie 1.0/2.0|
+ | USB              | Crazyflie 2.0|
+
+Header
+------
+
+Each packet has a 1 byte header and can carry up to 31 bytes data
+payload. The header field has the following layout:
+
+       7    6    5    4    3    2    1    0
+    +----+----+----+----+----+----+----+----+
+    |       Port        |  Link   |  Chan.  |
+    +----+----+----+----+----+----+----+----+
+
+Where:
+
+-   **Port**: Used to identify the functionality or task that is
+    associated with this message
+-   **Link**: Reserved for future use
+-   **Channel**: Used to identify the sub-task/functionality
+
+Port allocation
+---------------
+
+Current port allocation:
+
+| **Port** |  **Target**                                                       |          **Used for**|
+| ---------| ------------------------------------------------------------------| ----------------------------------------------------------------|
+|  0       | [Console](/functional-areas/crtp/ctrp_console/)                   | Read console text that is printed to the console on the Crazyflie using consoleprintf|
+|  2       | [Parameters](/functional-areas/crtp/ctrp_parameters/)             | Get/set parameters from the Crazyflie. Parameters are defined using a [macro in the Crazyflie source-code](/userguides/logparam/)|
+|  3       | [Commander](/functional-areas/crtp/ctrp_commander/)               | Sending control set-points for the roll/pitch/yaw/thrust regulators|
+|  4       | [Memory access](/functional-areas/crtp/ctrp_mem/)                 | Accessing non-volatile memories like 1-wire and I2C (only supported for Crazyflie 2.0)|
+|  5       | [Data logging](/functional-areas/crtp/ctrp_log/)                  | Set up log blocks with variables that will be sent back to the Crazyflie at a specified period. Log variables are defined using a [macro in the Crazyflie source-code](/userguides/logparam/)|
+|  6       | [Localization](/functional-areas/crtp/ctrp_localization/)         | Packets related to localization|
+|  7       | [Generic Setpoint](/functional-areas/crtp/ctrp_generic_setpoint/) | Allows to send setpoint and control modes|
+|  13      | Platform                                                          | Used for misc platform control, like debugging and power off|
+|  14      | Client-side debugging                                             | Debugging the UI and exists only in the Crazyflie Python API and not in the Crazyflie itself.|
+|  15      | Link layer                                                        | Used to control and query the communication link|
+
+Connection procedure
+--------------------
+
+CRTP is designed to be state-less, so there\'s no handshaking procedure
+that is needed. Any command can be sent at any time, but for some
+logging/param/mem commands the TOC (table of contents) needs to be
+downloaded in order for the host to be able to send the correct
+information. The implementation of the Pyton API will download the
+param/log/mem TOC at connect in order to be able to use all the
+functionality.
diff --git a/docs/deck_memory_format.md → docs/functional-areas/deck_memory_format.md b/docs/deck_memory_format.md → docs/functional-areas/deck_memory_format.md
diff --git a/docs/lighthouse_overview.md → docs/functional-areas/lighthouse_overview.md b/docs/lighthouse_overview.md → docs/functional-areas/lighthouse_overview.md
diff --git a/docs/p2p_api.md → docs/functional-areas/p2p_api.md b/docs/p2p_api.md → docs/functional-areas/p2p_api.md
diff --git a/docs/sensor_to_control.md → docs/functional-areas/sensor_to_control.md b/docs/sensor_to_control.md → docs/functional-areas/sensor_to_control.md
diff --git a/docs/trajectory_formats.md → docs/functional-areas/trajectory_formats.md b/docs/trajectory_formats.md → docs/functional-areas/trajectory_formats.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,12 @@
 ---
 title: Home
-page_id: home 
+page_id: home
 ---
 
-This project contains the documentation of the source code for the firmware used in the Crazyflie range of platforms, including the Crazyflie 2.X and the Roadrunner.
+This project contains the documentation of the source code for the firmware used in the Crazyflie range of platforms, including the Crazyflie 2.X Crazyflie Bolt and the Roadrunner.
 
+### Crazyflie 1.0
+
+The 2017.06 release was the last release with Crazyflie 1.0 support. If you want
+to play with the Crazyflie 1.0 and modify the code, please clone this repo and
+branch off from the 2017.06 tag.
diff --git a/docs/app_layer.md → docs/userguides/app_layer.md b/docs/app_layer.md → docs/userguides/app_layer.md
diff --git a/docs/deck.md → docs/userguides/deck.md b/docs/deck.md → docs/userguides/deck.md
diff --git a/docs/logparam.md → docs/userguides/logparam.md b/docs/logparam.md → docs/userguides/logparam.md