Skip to content

Commit

Permalink
Consistent 2.x family naming usage
Browse files Browse the repository at this point in the history
- The getting started guide for 2.x is actually exclusively for 2.0 and 2.1(+)
- cf2 firmware platform is part of cf2.x, not exclusively
  • Loading branch information
gemenerik committed Oct 16, 2024
1 parent 96d79aa commit 231f6ae
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 30 deletions.
10 changes: 5 additions & 5 deletions src/documentation/tutorials/getting-started-with-aideck.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To run this tutorial and set up the AI deck you will need the following:
{% si_step Attach the AI-deck %}
The AI-deck can be mounted both on top and on the bottom using the provided long header pins. Either position might yield different pros & cons but for development when a JTAG cable needs to be attached the top position works best. Note though that the ESP32 antenna is a bit fragile and can be damaged during crashes. For better resilience during crashes, mount the AI-deck at the bottom, or put a peace of hot-glue as shown in the picture below.

![led deck on crazyflie](/images/tutorials/getting_started_with_aideck/AI-deck-1_1-antenna-hotglue-400.jpg)
![led deck on Crazyflie](/images/tutorials/getting_started_with_aideck/AI-deck-1_1-antenna-hotglue-400.jpg)

{% endsi_step %}

Expand All @@ -50,10 +50,10 @@ Crazyflie (STM32 and nRF51)
1. Open up the cfclient on your computer
1. Make sure that **only** the AI-deck is attached to the Crazyflie, with no other deck.
1. Go to 'Connect'->'bootloader'
1. Type the address of your crazyflie, press 'Scan' and select your crazyflie's URI. Make sure to choose 'radio://...' (not 'usb://'). Now press 'Connect'
1. In the 'Firmware Source' section, select the latest release in 'Available downloads'. Make sure to select the right platform (cf2 is for the crazyflie 2.x ).
1. Press 'Program' and wait for the STM, NRF and ESP MCUs to be re-flashed. The crazyflie will restart a couple of times, and the flashing of the ESP ('bcAI:esp deck memory') takes about 3 minutes.
1. Once the status states 'Idle' and the Crazyflie is disconnected, double check if the flashing has succeded. In the cfclient, connect to the crazyflie and check in the console tab if you see: `ESP32: I (910) SYS: Initialized`. Also LED1 should be flashing with 2 hz.
1. Type the address of your Crazyflie, press 'Scan' and select your Crazyflie's URI. Make sure to choose 'radio://...' (not 'usb://'). Now press 'Connect'
1. In the 'Firmware Source' section, select the latest release in 'Available downloads'. Make sure to select the right platform (cf2 is for the Crazyflie 2.0 and Crazyflie 2.1(+) ).
1. Press 'Program' and wait for the STM, NRF and ESP MCUs to be re-flashed. The Crazyflie will restart a couple of times, and the flashing of the ESP ('bcAI:esp deck memory') takes about 3 minutes.
1. Once the status states 'Idle' and the Crazyflie is disconnected, double check if the flashing has succeded. In the cfclient, connect to the Crazyflie and check in the console tab if you see: `ESP32: I (910) SYS: Initialized`. Also LED1 should be flashing with 2 hz.


{% img Flashing; wide; /images/tutorials/getting_started_with_aideck/cfclient_flash_esp.png %}
Expand Down
44 changes: 22 additions & 22 deletions src/documentation/tutorials/getting-started-with-crazyflie-2-x.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
layout: page-left-menu
title: Getting started with the Crazyflie 2.X
title: Getting started with the Crazyflie 2.0 or Crazyflie 2.1(+)
page_id: getting-started-crazyflie-2
redirects:
- /getting-started-with-the-crazyflie-2-0/
---

{% si_intro Unpacking the Crazyflie %}
The Crazyflie 2.X box contains the following items. Make sure that you
The Crazyflie box contains the following items. Make sure that you
have all of them before you start assembling.
{% endsi_intro %}

{% si_step package contents %}
* 1 x Crazyflie 2.X control board with all components mounted
* 1 x Crazyflie 2.0 or 2.1 control board with all components mounted
* 5 x CW propellers
* 5 x CCW propellers
* 6 x Motor mounts
Expand All @@ -27,17 +27,17 @@ have all of them before you start assembling.


{% si_intro Testing; test %}
The Crazyflie 2.X is tested extensively when produced, but to make sure
The Crazyflie is tested extensively when produced, but to make sure
nothing has happened during shipping/storage you should run the tests before
starting the assembly. Power on the Crazyflie 2.X using a USB source (either
starting the assembly. Power on the Crazyflie using a USB source (either
computer or charger) and check the results of the test below. Note that it’s
important to hold the Crazyflie 2.X steady during the test and away from strong
important to hold the Crazyflie steady during the test and away from strong
magnetic sources.
{% endsi_intro %}

{% si_step self-test %}
Before you start assembling anything, run the power on self-test by
connecting the Crazyflie 2.X to a uUSB power source. The LEDs M1 and M4
connecting the Crazyflie to a uUSB power source. The LEDs M1 and M4
will indicate the result of the test. If the M4 LED blinks GREEN five times
fast, then the test has passed.

Expand All @@ -54,7 +54,7 @@ and does it again. Go to our [support discussions](https://discussions.bitcraze.


{% si_intro Assembling; assembling %}
Assembling your Crazyflie 2.X will probably take less than 10 minutes, but
Assembling your Crazyflie will probably take less than 10 minutes, but
there are a few pitfalls. So make sure to follow the instructions below!
{% endsi_intro %}

Expand Down Expand Up @@ -86,10 +86,10 @@ motor mount.
{% endsi_step %}

{% si_step insert the motor %}
Insert the motor mounts on the Crazyflie 2.X wings. They are press fit and
Insert the motor mounts on the Crazyflie wings. They are press fit and
might need a small amount of force. Make sure they go all the way to the
stop. It’s not important which motor you put where. After it’s been
inserted, connect the motor connectors to the Crazyflie 2.X.
inserted, connect the motor connectors to the Crazyflie.
{% tutorialVideo /videos/insert_the_motor.mp4 %}
{% endsi_step %}

Expand All @@ -114,13 +114,13 @@ Here we are attaching the CW propellers for the Crazyflie 2.1 (not 2.1+ version)
{% tutorialVideo /videos/attach_the_propellers.mp4 %}

Here’s a detailed view of where to attach CW and CCW propellers.
{% img Crazyflie 2.X propeller mounting; medium; /images/getting-started/cf2_props.png %}
{% img Crazyflie propeller mounting; medium; /images/getting-started/cf2_props.png %}

{% endsi_step %}


{% si_step attach the rubber pad %}
The rubber pad should be attached to the Crazyflie 2.X between the
The rubber pad should be attached to the Crazyflie between the
expansion headers. This will create friction, keep the battery from
slipping out and also protect the electronics.
{% tutorialVideo /videos/attach_the_rubber_pad.mp4 %}
Expand Down Expand Up @@ -160,11 +160,11 @@ and the blue LEDs are at the back.

#### Start up sequence

When the Crazyflie 2.X is powered on it will automatically go through a short
When the Crazyflie is powered on it will automatically go through a short
sequence of events to get ready for flight.

1. **Run self tests** - the Crazyflie 2.X checks that the hardware is OK
1. **Calibrate sensors** - the Crazyflie 2.X reads its sensors to get base values.
1. **Run self tests** - the Crazyflie checks that the hardware is OK
1. **Calibrate sensors** - the Crazyflie reads its sensors to get base values.
It must be *absolutely still* to do this, so it's best to put it on a level surface for a second.
1. **Ready to fly!**

Expand All @@ -176,7 +176,7 @@ You also need to understand what the LEDs mean.
front right LED (1) is blinking red twice every second (see the video in the [Power on!](#power-on-) section above.).
* **Power on and all is good but sensors are not yet calibrated:** The blue LEDs
(2 and 3) are fully lit and the front right LED (1) is blinking red with 2 seconds interval.
Put the Crazyflie 2.X on a level surface and keep it absolutely still to calibrate.
Put the Crazyflie on a level surface and keep it absolutely still to calibrate.
* **Radio connected:** The front left LED (4) is flickering in red and/or green.
* **Battery low:** The front right LED (1) is fully lit in red. It's time to
land and re-charge the battery.
Expand All @@ -189,8 +189,8 @@ red pulses with a longer pause between groups.



{% si_intro Controlling the Crazyflie 2.X %}
You can fly the Crazyflie 2.X either from a mobile device or a computer.
{% si_intro Controlling the Crazyflie %}
You can fly the Crazyflie either from a mobile device or a computer.
{% endsi_intro %}

{% si_step choose controller device %}
Expand All @@ -214,7 +214,7 @@ want to use your computer.


{% si_intro Installing on a mobile device %}
It is really easy to install the app and connect to the Crazyflie 2.X.
It is really easy to install the app and connect to the Crazyflie.
All you need is an Android or iOS device that supports Bluetooth Low Energy (BLE).
{% endsi_intro %}

Expand All @@ -225,10 +225,10 @@ The Crazyflie client is available for Android and iOS.

[For iPhone, from Apple iTunes](https://itunes.apple.com/us/app/crazyflie-2.0/id946151480?mt=8)

{% img Crazyflie 2.X app; narrow; /images/getting-started/cf-mobile-app.png %}
{% img Crazyflie app; narrow; /images/getting-started/cf-mobile-app.png %}
{% endsi_step %}

{% si_step connect to the Crazyflie 2.X %}
{% si_step connect to the Crazyflie %}
Start the app and click the connect button. The buttons have different
appearances in the Android and iOS apps, you can see them below.
{% img Connect buttons; medium; /images/getting-started/connect-icons.png %}
Expand Down Expand Up @@ -417,7 +417,7 @@ motor, remove the hair and reinstall the propeller.
{% endsi_step %}

{% si_step charging the battery; charging %}
To charge the battery of the Crazyflie 2.X, just plug in a micro USB cable. Make
To charge the battery of the Crazyflie, just plug in a micro USB cable. Make
sure the Crazyflie is powered on. While the battery is charging, the back left
blue LED will blink. When the LED is fully lit the battery is charged.
{% endsi_step %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ autonomous flight.
{% endsi_intro %}

{% si_step required hardware %}
* 1 x Crazyflie 2.x Kit
* 1 x Crazyflie 2.x kit
* 1 x {% poplink crazyradio-2-0 %} or Crazyradio PA
* 1 x {% poplink flow-deck %}
{% endsi_step %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This getting started guide will help you set up the system and make your first a
{% endsi_intro %}

{% si_step required hardware %}
* 1 x Crazyflie 2.x Kit
* 1 x Crazyflie 2.x kit
* 1 x {% poplink crazyradio-2-0 %} or Crazyradio PA
* 1 x {% poplink flow-deck %}
* 1 x {% poplink multi-ranger-deck%}
Expand All @@ -28,7 +28,7 @@ This guide also requires that you have updated the Crazyflie to the latest firmw
{% endsi_step %}

{% si_step mounting the Flow V2 deck %}
Mount the {% poplink flow-deck %} underneath and the {% poplink multi-ranger-deck%} above the Crazyflie 2.x using the long pin-headers supplied with the Crazyflie 2.x Kit.
Mount the {% poplink flow-deck %} underneath and the {% poplink multi-ranger-deck%} above the Crazyflie 2.x using the long pin-headers supplied with the Crazyflie 2.x kit.
{% img Mounting the Flow V2 deck; wide; /images/tutorials/getting_started_stem_ranging/getting_started_with_stem_ranging_770px.jpg %}
{% img Mounting the Flow V2 deck; wide; /images/tutorials/getting_started_stem_ranging/getting_started_with_stem_ranging_770px-2.jpg %}

Expand Down

0 comments on commit 231f6ae

Please sign in to comment.