Giter Club home page Giter Club logo

cf-cli's Introduction

Crazyflie CLI

This is a command line interface (CLI) for the Crazyflie 2.X written in Rust. It's intended to be used during development to easily log the console, set parameters and get logging variables. It's not intended to be used from any scripts to make the Crazyflie do things, then using the Crazyflie python library is preferred.

Installation

If you would like to install the CLI, you can do so by running the following command:

git clone https://github.com/evoggy/cf-cli.git
cargo install --path cf-cli

Now the cfcli command should be available in your terminal.

Or if you would like to run it from source use the following command:

git clone https://github.com/evoggy/cf-cli.git
cd cf-cli
cargo run -- <args>

For example:

cargo run -- select

Usage

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

Crazyflie CLI

Usage: cfcli [OPTIONS] <COMMAND>

Commands:
  log      Access to the log subsystem
  param    Access to the parameter subsystem
  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
  help     Print this message or the help of the given subcommand(s)

Options:
  -a, --address <ADDRESS>  Specify address [default: E7E7E7E7E7]
  -h, --help               Print help
  -V, --version            Print version

To use the CLI you must first select which URI to use, this is done by scanning for available Crazyflies and selecting the one you prefer.

cfcli select

Now this URI will be used in all commands until a new one is selected. For instance a parameter can be set using the following command:

cfcli param set motorPowerSet.enable 1

And a log variable can be printed using the following command:

cfcli log print stabilizer.roll 100

cf-cli's People

Contributors

evoggy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.