cfcli Bitcraze

Use this command to install cfcli:

winget install --id=Bitcraze.cfcli -e

Cfcli is a command-line interface (CLI) designed to control and interact with Bitcraze Crazyflie drones. It provides developers and researchers with tools to manage firmware, access logs, configure parameters, and perform system operations.

Key Features:

Firmware Management: Flash firmware for nRF51, STM32F4 boards, and Crazyflie decks.
Console Output: View real-time console data from the Crazyflie.
Log Variables: Monitor and log variables such as stabilizer roll or pitch.
Parameter Management: Set and retrieve parameters to customize drone behavior.
Memory Operations: Read, write, display, or erase memory contents.
Radio Configuration: Adjust radio settings like channel, address, and speed.

Audience & Benefit:

Ideal for developers and researchers working on Crazyflie projects, cfcli simplifies interaction with the drone's subsystems without requiring custom script development. It enables quick testing, debugging, and system configuration, streamlining the development process.

Installation via winget is supported for easy setup.

Crazyflie CLI

This is a command line interface (CLI) for the Bitcraze Crazyflie written in Rust. It's intended to be used during development to quickly access various subsystems in the Crazyflie and supports features like:

Flash firmware (nRF51/STM32F4 as well as decks)
Get console output
Log variables
Get and set parameters
Read and write (as well as display and erase some) memories
Configure radio settings like channel, address and speed
Turn the platform on/off or put it to sleep/wake it up
Run stability tests with the Crazyflie
High-level commander (takeoff, land, go-to, trajectories)

It's not intended to be used for creating more advanced scripts or functionality, it's better to use the the Crazyflie python library for that.

Installation

Standalone .deb package

Download latest released .deb file from GitHub Releases and install using:

sudo apt install ./cfcli_x.y.z_amd64.deb

This will also add the APT so you can install updates when they are released.

APT repository (Debian/Ubuntu)

# Add repository
curl -fsSL https://evoggy.github.io/cfcli/cfcli-repo.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/cfcli-archive-keyring.gpg
echo "deb [arch=amd64,arm64 signed-by=/usr/share/keyrings/cfcli-archive-keyring.gpg] https://evoggy.github.io/cfcli stable main" | sudo tee /etc/apt/sources.list.d/cfcli.list

# Install
sudo apt update
sudo apt install cfcli

Homebrew (OSX and Linux)

To add and install run the following:

brew tap evoggy/cfcli
brew install cfcli

To update run:

brew upgrade cfcli

Usage

To see how to use the CLI type cfcli in your terminal and you will get the following help message:

Crazyflie command-line client

Usage: cfcli [OPTIONS] 

Commands:
  log       Access to the log subsystem
  param     Access to the parameter subsystem
  mem       Access to the memory subsystem
  config    Configure the Crazyflie (radio settings, etc)
  util      Various supporting utilities for the Crazyflie and its ecosystem
  bootload  Bootload the Crazyflie and decks
  test      Run tests with the Crazyflie
  platform  Access platform functionality
  scan      List the Crazyflies found while scanning (on the selected address)
  select    Scan for Crazyflies and select which one to save for later interactions
  console   Print the console text from a Crazyflie
  loco      Loco Positioning System
  hlc       High-level commander operations (takeoff, land, go-to, trajectory, etc.)
  help      Print this message or the help of the given subcommand(s)

Options:
  -n, --no-toc-cache  Do not use TOC cache
  -d, --debug         Enable debug mode
  -h, --help          Print help
  -V, --version       Print version