diff --git a/src/_data/poplink.yml b/src/_data/poplink.yml index cb1606f6..cb633a9e 100644 --- a/src/_data/poplink.yml +++ b/src/_data/poplink.yml @@ -23,5 +23,9 @@ poplinks: z-ranger-deck: title: Z-ranger deck V2 default-link: /products/z-ranger-deck-v2/ - content: z-ranger-deck.md + content: z-ranger-deck.md + buzzer-deck: + title: Buzzer deck + default-link: /products/buzzer-deck/ + content: buzzer-deck.md diff --git a/src/_poplink/buzzer-deck.md b/src/_poplink/buzzer-deck.md new file mode 100644 index 00000000..083a5c75 --- /dev/null +++ b/src/_poplink/buzzer-deck.md @@ -0,0 +1,11 @@ +[Buy in store](https://store.bitcraze.io/products/buzzer-deck) + +[Product page](/products/buzzer-deck/) + +[Other deck compatibility](/documentation/system/platform/cf2-expansiondecks/#deck---deck) + +[Tutorial](/documentation/tutorials/getting-started-with-buzzer-deck/) + +[Parameters](/documentation/repository/crazyflie-firmware/master/api/params/#sound) + + diff --git a/src/buy/buyers-guide.md b/src/buy/buyers-guide.md index 505f5a63..bd477554 100644 --- a/src/buy/buyers-guide.md +++ b/src/buy/buyers-guide.md @@ -116,8 +116,7 @@ the dark? {% row_image_text_links I want the Crazyflie to give feedback using sound and light %} {% row_text %} -The {% poplink led-ring-deck %} can be used to display light in any color and the Buzzer deck -can make sounds, useful for giving the user feedback. For automated implementation +The {% poplink led-ring-deck %} can be used to display light in any color and the {% poplink buzzer-deck %} can make sounds, useful for giving the user feedback. For automated implementation it can be very handy to indicate when the system is ready, error states or similar. {% endrow_text %} {% row_links %} diff --git a/src/documentation/system/platform/cf2-expansiondecks.md b/src/documentation/system/platform/cf2-expansiondecks.md index d7289f9b..bf0d8108 100644 --- a/src/documentation/system/platform/cf2-expansiondecks.md +++ b/src/documentation/system/platform/cf2-expansiondecks.md @@ -12,7 +12,7 @@ Here is a list of expansion decks that are available for the Crazyflie 2.X: | Expansion Deck | Description | Technical doc | Additional instructions | |---|---|---|---| | {% poplink led-ring-deck %}|The LED-ring expansion deck |[datasheet](/documentation/hardware/led_ring_deck/led_ring_deck-datasheet.pdf), [schematics](/documentation/hardware/led_ring_deck/led-ring_revb.pdf) | {% id_link led-deck-on-top %}| -| {% id_link product-buzzer-deck%}|The Buzzer expansion deck | [datasheet](/documentation/hardware/buzzer_deck/buzzer_deck-datasheet.pdf), [schematics](/documentation/hardware/buzzer_deck/buzzer-revc.pdf) | [Changing the sound](/documentation/repository/crazyflie-firmware/master/userguides/decks/buzzer-deck/) | +| {% poplink buzzer-deck %} |The Buzzer expansion deck | [datasheet](/documentation/hardware/buzzer_deck/buzzer_deck-datasheet.pdf), [schematics](/documentation/hardware/buzzer_deck/buzzer-revc.pdf) | [Changing the sound](/documentation/repository/crazyflie-firmware/master/userguides/decks/buzzer-deck/) | | {% id_link product-qi-1-2-charger%}|Qi 1.2 compatible wireless charging deck| [datasheet](/documentation/hardware/qi_deck_1_2/qi_deck_1_2-datasheet.pdf), [schematics](/documentation/hardware/qi_deck_1_2/qi_1_2-revc.pdf) | | | {% id_link product-prototyping-deck%}|The prototype expansion deck|[datasheet](/documentation/hardware/prototyping_deck/prototyping_deck-datasheet.pdf), [schematics](/documentation/hardware/prototyping_deck/prototyping-revb.pdf) | | | {% id_link product-breakout-deck%}|The breakout expansion deck|[datasheet](/documentation/hardware/breakout_deck/breakout_deck-datasheet.pdf), [schematics](/documentation/hardware/breakout_deck/breakout-revc.pdf) | | @@ -66,7 +66,7 @@ All expansion boards display a logo describing the correct orientation: ### Two expansion board on top -![Two expancions decks on top](/images/documentation/overview/exp_squetch_2top.png){:width="800px"} +![Two expansions decks on top](/images/documentation/overview/exp_squetch_2top.png){:width="800px"} Expansion port pinout --------------------- @@ -101,7 +101,7 @@ Deck info |------|------|---------------|--------------------|--------|----------------------------|----------------|--------------------------------------------------------------------------| | 0xBC | 0x01 | bcLedRing | {% poplink led-ring-deck %} | 3.3g | 0 - 700mA | Under | [link](https://store.bitcraze.io/products/led-ring-deck) | | 0xBC | 0x02 | bcQi | Qi charger | 5g | N/A | Under | [link](https://store.bitcraze.io/products/qi-1-2-wireless-charging-deck) | -| 0xBC | 0x04 | bcBuzzer | Buzzer | 1.8g | 10mA | Under/Above | [link](https://store.bitcraze.io/products/buzzer-deck) | +| 0xBC | 0x04 | bcBuzzer | {% poplink buzzer-deck %} | 1.8g | 10mA | Under/Above | [link](https://store.bitcraze.io/products/buzzer-deck) | | 0xBC | 0x05 | bcBigQuad | Big quad | 3.8g | N/A | Under/Above | [link](https://store.bitcraze.io/products/bigquad-deck) | | 0xBC | 0x06 | bcDWM | {% poplink loco-positioning-deck %} | 3.3g | 160mA | Under/Above | [link](https://store.bitcraze.io/products/loco-positioning-deck) | | 0xBC | 0x08 | bcUSD | Micro-SD | 1.7g | ~30mA | Under/Above | [link](https://store.bitcraze.io/products/sd-card-deck) | @@ -138,7 +138,7 @@ two decks where the connections collide. | **bcUSD** | | | | | *(CS)* | *(CS)* | *(CS)* | CS | | |X | X |X | | | VCC | | **{% poplink loco-positioning-deck %}** | IRQ | RST | | | CS | *(IRQ)* | *(RST)* | | | |X | X |X | | | VCOM | | **bcBigQuad** | *(X)* | *(X)* | *(X)* | *(X)* | | **X** | **X** | *(X)* | **X** | **X** | *(X)* | *(X)* | *(X)* | | | N/A | -| **bcBuzzer** | | | | | | | | | PWM | PWM | | | | | | N/A | +| **{% poplink buzzer-deck %} ** | | | | | | | | | PWM | PWM | | | | | | N/A | | **bcESP** | | | | | | | | *(X)* | X | X | | | | | | N/A | | **{% poplink z-ranger-deck %}, Z-ranger deck V1** | | | X | X | | *(X)* | | | | | | | | | | VCC | | **{% poplink flow-deck %}, Flow deck V1** | | | X | X | | *(X)* | X | | | | X | X | X | | | VCC | @@ -164,7 +164,7 @@ This table shows which deck that works on which platform. | **Micro-SD** | yes | *1 | | **{% poplink loco-positioning-deck %}** | yes | | | **Big quad** | yes | yes | -| **Buzzer** | yes | | +| **{% poplink buzzer-deck %}** | yes | | | **bcESP** | yes | yes | | **{% poplink z-ranger-deck %}, Z-ranger deck V1** | yes | yes | | **{% poplink flow-deck %}, Flow deck V1** | yes | yes | @@ -193,7 +193,7 @@ compatible. | **Micro-SD** | yes | yes | - | yes *1 | yes | yes | yes | yes | yes *1 | yes | yes | yes | yes | yes | | **{% poplink loco-positioning-deck %}** | yes | yes | yes *1 | - | yes | yes | yes | yes | yes | yes | yes | *2 | yes | *2 | | **Big quad** | | yes | yes | yes | - | | | yes | | yes | yes | *2 | yes | yes | - | **Buzzer** | yes | yes | yes | yes | | - | | yes | yes | yes | yes | yes | yes | yes | + | **{% poplink buzzer-deck %}** | yes | yes | yes | yes | | - | | yes | yes | yes | yes | yes | yes | yes | | **bcESP** | yes | yes | yes | yes | | | - | yes | yes | yes | yes | yes | yes | yes | | **{% poplink z-ranger-deck %}, Z-ranger V1** | | | yes | yes | yes | yes | yes | - | | yes | yes | yes | yes | yes | | **{% poplink flow-deck %}, Flow deck V1** | | | yes *1 | yes | | yes | yes | | - | yes | yes | yes | yes | yes | diff --git a/src/documentation/tutorials/getting-started-with-buzzer-deck.md b/src/documentation/tutorials/getting-started-with-buzzer-deck.md index b91e6874..2c7348d9 100644 --- a/src/documentation/tutorials/getting-started-with-buzzer-deck.md +++ b/src/documentation/tutorials/getting-started-with-buzzer-deck.md @@ -6,16 +6,16 @@ redirects: - /getting-started-with-buzzer-deck/ --- -{% si_intro The buzzer deck %} -The buzzer deck contains a low profile piezo buzzer and has a 1-wire memory which enables the Crazyflie to automatically detect the buzzer. +{% si_intro The Buzzer deck %} +The {% poplink buzzer-deck %} contains a low profile piezo buzzer and has a 1-wire memory which enables the Crazyflie to automatically detect the buzzer. The deck can be installed both on the top and the bottom of the Crazyflie. For more information about how to mount an expansion deck please see the {% id_link getting-started-expansion-decks %} tutorial. -To be able to use the buzzer you need to update the Crazyflie to the latest firmware. For more information on how to update the firmware, see the [update firmware in the Crazyflie]({% id_url getting-started-crazyflie-2; update-fw %}) section in our getting started with Crazyflie 2.X tutorial. +To be able to use the {% poplink buzzer-deck %} you need to update the Crazyflie to the latest firmware. For more information on how to update the firmware, see the [update firmware in the Crazyflie]({% id_url getting-started-crazyflie-2; update-fw %}) section in our getting started with Crazyflie 2.X tutorial. {% endsi_intro %} {% si_step system sounds %} -When the Buzzer deck is installed, the Crazyflie 2.X will play sounds at various events, for instance when the battery is charged. The events are +When the {% poplink buzzer-deck %} is installed, the Crazyflie 2.X will play sounds at various events, for instance when the battery is charged. The events are * Start up * Sensors calibrated @@ -28,7 +28,7 @@ When the Buzzer deck is installed, the Crazyflie 2.X will play sounds at various {% si_step play a sound from the client %} -To start out with the Buzzer deck the Crazyflie is pre-programmed with system sounds and some melodies. +To start out with the {% poplink buzzer-deck %} the Crazyflie is pre-programmed with system sounds and some melodies. To play them you need to use the Python client and set up a connection with your Crazyflie. For more information about how to set up your Crazyflie and install the client go to {% id_link getting-started-crazyflie-2 %}. @@ -63,4 +63,5 @@ Here is a list of the pre-programmed sounds you can choose from: |13 |Siren | | |14 |Tilt |Tilt the Crazyflie to play the sound | +Also check out the [automated documentation of the parameters](/documentation/repository/crazyflie-firmware/master/api/params/#sound) {% endsi_step %} diff --git a/src/products/buzzer-deck.md b/src/products/buzzer-deck.md index c48f7924..5baa8073 100644 --- a/src/products/buzzer-deck.md +++ b/src/products/buzzer-deck.md @@ -19,7 +19,7 @@ Get audio feedback and get creative by composing and playing your own melodies. %} Sometimes LED feedback isn't enough, like when you're flying around in a lab and living room. With the -buzzer deck you'll get audio feedback on system events, like low battery or +{% poplink buzzer-deck %} you'll get audio feedback on system events, like low battery or charging completed. Or why not create your own melodies that will play while you're buzzing around. If you're tapped out on creativity there are already a few melodies pre-programmed that you can use.