Merge pull request #177 from bitcraze/rik/cf2x

Consistent "Crazyflie 2.x" formatting and family naming usage

src/about/events/roscon2024.md

@@ -54,7 +54,7 @@ robust and easy to use.
 
 #### The Multiranger deck
 
-The {% poplink multi-ranger-deck %} gives the Crazyflie 2.X the ability to detect objects around it. This is done by measuring the distance to objects in the following 5 directions: front/back/left/right/up with mm precision up to 4 meters.
+The {% poplink multi-ranger-deck %} gives the Crazyflie 2.x the ability to detect objects around it. This is done by measuring the distance to objects in the following 5 directions: front/back/left/right/up with mm precision up to 4 meters.
 
 {% img Multi-ranger deck; narrow; /images/multi-ranger/multi-ranger_deck_585px-1.jpg %}
 

src/buy/buyers-guide.md

@@ -6,9 +6,9 @@ redirects:
   - /crazyflie-2-0-buyers-guide/
 ---
 
-{% row_image_text_links I want to fly the Crazyflie 2.X from my mobile device %}
+{% row_image_text_links I want to fly the Crazyflie 2.x from my mobile device %}
 {% row_text %}
-The Crazyflie 2.X comes with everything you need for flying from a Bluetooth LE
+The Crazyflie 2.x comes with everything you need for flying from a Bluetooth LE
 enabled mobile device. Currently [Android](https://play.google.com/store/apps/details?id=se.bitcraze.crazyfliecontrol2)
 and [IOS](https://itunes.apple.com/us/app/crazyflie-2.0/id946151480?mt=8) devices are supported.
 {% endrow_text %}
@@ -20,12 +20,12 @@ and [IOS](https://itunes.apple.com/us/app/crazyflie-2.0/id946151480?mt=8) device
 {% endrow_image_text_links %}
 
 
-{% row_image_text_links I want to fly the Crazyflie 2.X from my computer using a gamepad %}
+{% row_image_text_links I want to fly the Crazyflie 2.x from my computer using a gamepad %}
 {% row_text %}
 The {% poplink crazyradio-2-0 %}
-enables you to connect the Crazyflie 2.X to a computer. Connect
+enables you to connect the Crazyflie 2.x to a computer. Connect
 a [gamepad](/documentation/repository/crazyflie-clients-python/master/userguides/inputdevices/)
-to the computer and run our client software to control the Crazyflie 2.X.
+to the computer and run our client software to control the Crazyflie 2.x.
 {% endrow_text %}
 {% row_links %}
 **What to buy:**
@@ -37,18 +37,18 @@ Note: gamepad is not included
 {% endrow_image_text_links %}
 
 
-{% row_image_text_links I want to use the Crazyflie 2.X for development %}
+{% row_image_text_links I want to use the Crazyflie 2.x for development %}
 {% row_text %}
 The {% poplink crazyradio-2-0 %}
-enables you to connect the Crazyflie 2.X
+enables you to connect the Crazyflie 2.x
 to a computer wireless and download new firmware, modified to your liking. The logging and parameter
-frameworks provides APIs for getting and setting data in the Crazyflie 2.X live,
+frameworks provides APIs for getting and setting data in the Crazyflie 2.x live,
 even when you are flying!
 All software, firmware as well as clients on the computer is open source and the
 source code is available for you to play with as you like.
 
 You probably also want a [gamepad](/documentation/repository/crazyflie-clients-python/master/userguides/inputdevices/)
-to fly the Crazyflie 2.X when connected to the computer.
+to fly the Crazyflie 2.x when connected to the computer.
 {% endrow_text %}
 {% row_links %}
 **What to buy:**
@@ -60,13 +60,13 @@ Note: gamepad is not included
 {% endrow_image_text_links %}
 
 
-{% row_image_text_links I want to use the Crazyflie 2.X for advanced development %}
+{% row_image_text_links I want to use the Crazyflie 2.x for advanced development %}
 {% row_text %}
-A lot can be achieved with the Crazyflie 2.X and the {% poplink crazyradio-2-0 %} only, but for
+A lot can be achieved with the Crazyflie 2.x and the {% poplink crazyradio-2-0 %} only, but for
 advanced development JTAG/SWD access to the platform is useful.
 The {% id_link product-debug-adapter-kit %}
 enables you to connect your normal JTAG/SWD debugger to
-the Crazyflie 2.X to set break points, single step and so on when debugging.
+the Crazyflie 2.x to set break points, single step and so on when debugging.
 {% endrow_text %}
 {% row_links %}
 **What to buy:**
@@ -78,11 +78,11 @@ Note: JTAG/SWD debugger is not included
 {% endrow_image_text_links %}
 
 
-{% row_image_text_links I want to add a sensor to the Crazyflie 2.X %}
+{% row_image_text_links I want to add a sensor to the Crazyflie 2.x %}
 {% row_text %}
-The expansion ports on the Crazyflie 2.X enables you to connect more or less
+The expansion ports on the Crazyflie 2.x enables you to connect more or less
 any hardware you like. When prototyping the Breakout deck is useful as you can
-use it to connect your Crazyflie 2.X to a bread board and easily debug your
+use it to connect your Crazyflie 2.x to a bread board and easily debug your
 hardware design. When satisfied with the design you can transfer it to a Prototyping
 deck for a more permanent implementation. If you want to take it even further,
 why not manufacture a [deck PCB](https://github.com/bitcraze/crazyflie2-exp-template-electronics) and add Female deck connectors.
@@ -99,11 +99,11 @@ why not manufacture a [deck PCB](https://github.com/bitcraze/crazyflie2-exp-temp
 
 {% row_image_text_links I want to paint in the dark with a Crazyflie %}
 {% row_text %}
-The Crazyflie 2.X is fun to fly as is but adding the {% poplink led-ring-deck %} and flying
+The Crazyflie 2.x is fun to fly as is but adding the {% poplink led-ring-deck %} and flying
 in the dark adds a new dimension. The RGB LEDs lets you chose any colour and with
 some coding any light sequence can be displayed, for instance controlled by the
 on board sensors.
-Why not take photos with an open shutter of a moving Crayflie 2.X and paint in
+Why not take photos with an open shutter of a moving Crayflie 2.x and paint in
 the dark?
 {% endrow_text %}
 {% row_links %}
@@ -128,13 +128,13 @@ it can be very handy to indicate when the system is ready, error states or simil
 {% endrow_image_text_links %}
 
 
-{% row_image_text_links I want a bigger Crazyflie 2.X %}
+{% row_image_text_links I want a bigger Crazyflie 2.x %}
 {% row_text %}
-The BigQuad deck is used to control a bigger quad copter frame with a Crazyflie 2.X.
+The BigQuad deck is used to control a bigger quad copter frame with a Crazyflie 2.x.
 Remove the motors on the Crazyflie, add the BigQuad deck and mount it on a bigger
 frame. Connect the motor controllers (ESCs) for the brushless motors of the frame
 to the BigQuad deck and you are ready to go. You get the full ecosystem of the
-Crazyflie 2.X but super sized.
+Crazyflie 2.x but super sized.
 {% endrow_text %}
 {% row_links %}
 **What to buy:**
@@ -150,7 +150,7 @@ Note: the bigger frame, brushless motors and ESCs are not included
 {% row_image_text_links I want wireless charging of my Crazyflie %}
 {% row_text %}
 The Qi deck gives the Crazyflie wireless charging capabilities. The battery is
-automatically charged when the Crazyflie 2.X is placed on top of a wireless charger,
+automatically charged when the Crazyflie 2.x is placed on top of a wireless charger,
 no need to connect a cable.
 {% endrow_text %}
 {% row_links %}
@@ -163,7 +163,7 @@ Note: wireless charger not included
 {% endrow_image_text_links %}
 
 
-{% row_image_text_links I want to record data when flying my Crazyflie 2.X %}
+{% row_image_text_links I want to record data when flying my Crazyflie 2.x %}
 {% row_text %}
 If large volumes of data needs to be recorded when flying, the {% poplink crazyradio-2-0 %} might
 not have sufficient bandwidth in some cases. The {% poplink sd-card-deck %} adds access to the
@@ -236,7 +236,7 @@ Note: gamepad is not included
 {% row_text %}
 The {% poplink multi-ranger-deck%} measures the distance to objects forward/back/left/right and up.
 It can be used for obstacle avoidance, mapping a room or games where the
-Crazyflie 2.X "bounces" between the walls of a room.
+Crazyflie 2.x "bounces" between the walls of a room.
 Combine with a {% poplink flow-deck %} to measure the distance to the floor as well and
 support autonomous flight.
 {% endrow_text %}
@@ -267,7 +267,7 @@ robotics and computers up to university level.
 
 {% row_image_text_links The STEM drone bundle %}
 {% row_text %}
-With the STEM drone bundle the Crayflie 2.X can fly autonomously using the Flow
+With the STEM drone bundle the Crayflie 2.x can fly autonomously using the Flow
 deck and it can be controlled from a remote computer using simple python scripts,
 perfect for getting started with robotics.
 For higher education, students can for instance re-implement the controller
@@ -286,7 +286,7 @@ the equipment home for extended studies and insights.
 {% row_text %}
 The STEM ranging bundle contains everything in the STEM drone bundle with the
 addition of the {% poplink multi-ranger-deck%}. The Multi-ranger deck makes it possible to interact
-with the Crazyflie 2.X or use it to map a room.
+with the Crazyflie 2.x or use it to map a room.
 {% endrow_text %}
 {% row_links %}
 **What to buy:**
@@ -300,7 +300,7 @@ with the Crazyflie 2.X or use it to map a room.
 
 ---
 
-## I want to fly autonomously and control the Crazyflie 2.X from a computer
+## I want to fly autonomously and control the Crazyflie 2.x from a computer
 
 For fully autonomous flight the Crazyflie must get position data from an
 external source, the internal sensors are only good for one or a few seconds of

src/development/external-projects.md

@@ -37,15 +37,15 @@ Alternate firmware implementations and uses for the Crazyradio
 
 ## Crazyflie simulators
 
-Projects aimed to modeling, developing and integrating the Crazyflie 2.X nano-quadcopter in simulated environments.
+Projects aimed to modeling, developing and integrating the Crazyflie 2.x nano-quadcopter in simulated environments.
 
 | CrazySim |  Crazyflie SITL simulation with Gazebo for MPC control for a decentralized swarm | <https://github.com/gtfactslab/Llanes_ICRA2024> |
 | Sim_CF2 | The ROS2 upgrade of the Sim_CF project | <https://github.com/CrazyflieTHI/sim_cf2> |
 | LamdaFlight | A minimal SITL for Haskell to be used for webots | <https://github.com/simondlevy/LambdaFlight> |
 | Webots | Webots has a model of the Crazyflie 2.x | <https://www.cyberbotics.com/doc/guide/crazyflie> |
 | CrazyS | The University of Sannio in Benevento, Italy, has implemented a software-in-the-loop simulation platform for simulating Crazyflie behavior in the Gazebo 3D simulation environment. | <https://github.com/gsilano/CrazyS> |
 | gym-pybullet-drones | A [Gym environment](https://github.com/openai/gym) based on [PyBullet](https://github.com/bulletphysics/bullet3) to simulate the dynamics and learn the control of Crazyflie 2.x nano-quadcopters. | <https://github.com/JacopoPan/gym-pybullet-drones> |
-| Nvidia Isaac | Crazyflie 2.X simulation in Nvidia Isaac | <https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/reference_assets.html#crazyflie>
+| Nvidia Isaac | Crazyflie 2.x simulation in Nvidia Isaac | <https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/reference_assets.html#crazyflie>
 | Rviz Simulator | Crazyflie 2.0 Simulation in Rviz | <https://github.com/malintha/multi_uav_simulator/tree/crazyflie> |
 | Sim_cf | Crazyflie HITL and SITL simulation with Gazebo and ROS | <https://github.com/wuwushrek/sim_cf> |
 
@@ -59,7 +59,7 @@ Projects aiming at supporting swarms. They might also be useful for controlling
 | ![ROS](/images/icons/ros_64.png)  | The ACT lab at USC has implemented a ROS 1 library to handle large swarms of Crazyflies. | <https://crazyswarm.readthedocs.io/en/latest/> |
 | ![ROS](/images/icons/ros_64.png) |A Crazyflie control packages (deprecated, use Crazyswarm instead)| <https://github.com/whoenig/crazyflie_ros> |
 | Crazyserver | A server exposing a REST API to control a swarm of Crazyflies. Written in Go. | <https://github.com/mikehamer/crazyserver> |
-| LaMoucheFolle | Cross-platform OSC server for controlling multiple Crazyflies 2.X | <https://github.com/benkuper/LaMoucheFolle> |
+| LaMoucheFolle | Cross-platform OSC server for controlling multiple Crazyflies 2.x | <https://github.com/benkuper/LaMoucheFolle> |
 
 ## Connectivity libraries
 

src/documentation/lighthouse.md

@@ -10,7 +10,7 @@ redirects:
 ## An affordable positioning system for your research and classes
 ------
 
-The lighthouse system is our latest high-precision method of positioning on the Crazyflie 2.X. The [Lighthouse Base Stations](https://store.bitcraze.io//products/lighthouse-v2-base-station/) emit infrared light which is detected by our {% poplink lighthouse-deck %}. This enables the crazyflie to calculate its own position on board.
+The lighthouse system is our latest high-precision method of positioning on the Crazyflie 2.x. The [Lighthouse Base Stations](https://store.bitcraze.io//products/lighthouse-v2-base-station/) emit infrared light which is detected by our {% poplink lighthouse-deck %}. This enables the crazyflie to calculate its own position on board.
 
 #### Tutorial
 Did you just receive your Lighthouse system? Go do our Getting started tutorial!

src/documentation/start.md

@@ -11,7 +11,7 @@ redirects:
 
 ## Let's get started!
 
-If you just bought a Crazyflie 2.X and  a good way to start is to head over to the
+If you just bought a Crazyflie 2.x and  a good way to start is to head over to the
 getting started guide, to see how to assemble the kit and take off for your first flight.
 
 {% inline_button Getting Started with Crazyflie Tutorial; /documentation/tutorials/getting-started-with-crazyflie-2-x/ %}
@@ -20,7 +20,7 @@ If you have just gotten a new Crazyradio 2.0, here are some instructions to get
 
 {% inline_button Getting Started with Crazyradio 2.0 Tutorial; /documentation/tutorials/getting-started-with-crazyradio-2-0/ %}
 
-If you want to add one of our many expansion decks to the Crazyflie 2.X and need help getting started we have made a Expansion decks tutorial.
+If you want to add one of our many expansion decks to the Crazyflie 2.x and need help getting started we have made a Expansion decks tutorial.
 
  {% inline_button Getting Started with Expansion decks tutorial; /documentation/tutorials/getting-started-with-expansion-decks/ %}
 
@@ -60,7 +60,7 @@ and this is also where you will the source of documentation related to each repo
 {% inline_button Repository overview page; /documentation/repository/ %}
 
 Maybe you want to add a sensor or some other hardware? Heat up your soldering
-iron and dive into it! Find more information about the expansion bus on the expansion decks of the Crazyflie 2.X.
+iron and dive into it! Find more information about the expansion bus on the expansion decks of the Crazyflie 2.x.
 
 
 {% inline_button Expansion Decks Page; /documentation/system/platform/cf2-expansiondecks/ %}

src/documentation/system/client-and-library/index.md

@@ -23,7 +23,7 @@ There are mobile phone apps for Android and IOS that connects via BLE, mainly fo
 
 {% row_image_text_links PC clients; /images/documentation/overview/pc_thumbnail.jpg %}
 {% row_text %}
-We have a Crazyflie 2.X python-based client for the PC, of which all the documentation can be found [here](/documentation/repository/crazyflie-clients-python/master/). The PC client runs on the Crazyflie library (CFlib), of which all the documentation can be found [here](/documentation/repository/crazyflie-lib-python/master/).
+We have a Crazyflie 2.x python-based client for the PC, of which all the documentation can be found [here](/documentation/repository/crazyflie-clients-python/master/). The PC client runs on the Crazyflie library (CFlib), of which all the documentation can be found [here](/documentation/repository/crazyflie-lib-python/master/).
 
 {% endrow_text %}
 {% row_links %}
@@ -35,7 +35,7 @@ We have a Crazyflie 2.X python-based client for the PC, of which all the documen
 
 {% row_image_text_links Crazyradio 2.0; /images/documentation/overview/crazyradioPA_thumbnail.jpg %}
 {% row_text %}
-The PC needs a {% poplink crazyradio-2-0 %} or Crazyradio PA in order to communicate with the Crazyflie 2.X. This relays the CTRP protocol from the PC client or the Crazyflie library to and from the CF2. The documentation also explains how to setup the USB permissions on your specific OS or machine.
+The PC needs a {% poplink crazyradio-2-0 %} or Crazyradio PA in order to communicate with the Crazyflie 2.x. This relays the CTRP protocol from the PC client or the Crazyflie library to and from the CF2. The documentation also explains how to setup the USB permissions on your specific OS or machine.
 {% endrow_text %}
 {% row_links %}
 * [Crazyradio 2.0 documentation](/documentation/repository/crazyradio2-firmware/main/).
@@ -46,7 +46,7 @@ The PC needs a {% poplink crazyradio-2-0 %} or Crazyradio PA in order to communi
 
 {% row_image_text_links Mobile Phone Clients; /images/documentation/overview/mobile_thumbnail.jpg %}
 {% row_text %}
-There are apps existing for controlling the Crazyflie 2.X on both [IOS](https://apps.apple.com/us/app/crazyflie-2-0/id946151480) and [Android](https://play.google.com/store/apps/details?id=se.bitcraze.crazyfliecontrol2) with Bluetooth LE communication.
+There are apps existing for controlling the Crazyflie 2.x on both [IOS](https://apps.apple.com/us/app/crazyflie-2-0/id946151480) and [Android](https://play.google.com/store/apps/details?id=se.bitcraze.crazyfliecontrol2) with Bluetooth LE communication.
 {% endrow_text %}
 {% row_links %}
 * [Android Client Documentation](/documentation/repository/crazyflie-android-client/master/)

src/documentation/system/platform/cf2-architecture.md

@@ -1,12 +1,12 @@
 ---
 layout: page
-title: Hardware Architecture of the Crazyflie 2.X
+title: Hardware Architecture of the Crazyflie 2.x
 page_id: cf2_architecture
 redirects:
   - /docs/cf2_architecture/
 ---
 
-Crazyflie 2.X is architectured around 2 microcontrollers:
+Crazyflie 2.x is architectured around 2 microcontrollers:
 
 -   A **NRF51**, Cortex-M0, that handles radio communication and power
     management:
@@ -35,7 +35,7 @@ The two main tasks for the nRF51 is to handle the radio communication
 and the power management. It acts as a radio bridge (it communicates raw
 data packet to the STM).
 
-Crazyflie 2.X use the radio for both CRTP and BLE, but the hardware also
+Crazyflie 2.x use the radio for both CRTP and BLE, but the hardware also
 supports other protocols like ANT. The CRTP mode is compatible with the
 Crazyradio USB dongle and it provides a 2Mbit/seconds data link with low
 latency. Test shows that the latency of the radio link is between 360us
@@ -45,7 +45,7 @@ current implementation is more around 20ms. The main benefit of the CRTP
 link with the Crazyradio is that it's easily implemented on any system
 that supports USB host which, makes it the first choice to hack and
 experiment with the Crazyflie. BLE is implemented mostly with the use
-case of controlling the Crazyflie 2.X from a mobile device.
+case of controlling the Crazyflie 2.x from a mobile device.
 
 One of the other particularities of the nRF51 chip is that it was
 designed to run from a coin battery, which means that it is pretty well

src/documentation/system/platform/cf2-components.md

@@ -1,6 +1,6 @@
 ---
 layout: page
-title: Component explanation of the Crazyflie 2.X
+title: Component explanation of the Crazyflie 2.x
 page_id: cf2_component_explanation
 redirects:
   - /docs/cf2_component_explanation/

src/documentation/system/platform/cf2-coordinate-system.md

@@ -1,10 +1,10 @@
 ---
 layout: page
-title: The Coordinate System of the Crazyflie 2.X
+title: The Coordinate System of the Crazyflie 2.x
 page_id: cf2_coordinate_system
 ---
 
-This page shows the coordinate system used in the **[Crazyflie 2.X family]({% id_url overview_crazyflie %})**. The global coordinate system (X, Y, Z) is in the EAST NORTH UP (ENU) convention, as is the body fixed (local) coordinate system (x, y, z). The attitude angles roll, pitch and yaw (φ, θ, ψ) are in the following rotation rules
+This page shows the coordinate system used in the **[Crazyflie 2.x family]({% id_url overview_crazyflie %})**. The global coordinate system (X, Y, Z) is in the EAST NORTH UP (ENU) convention, as is the body fixed (local) coordinate system (x, y, z). The attitude angles roll, pitch and yaw (φ, θ, ψ) are in the following rotation rules
 * __roll__ and __yaw__ are clockwise rotating around the axis looking from the origin (right-hand-thumb)
 * __pitch__ are counter-clockwise rotating around the axis looking from the origin (left-hand-thumb)