Fetch Tools

This package contains the fetch utility to make development easier. For full details of command usage and arguments, run fetch -h and fetch COMMAND -h. It also adds useful aliases for connecting to robots. Below summarizes installation and common usage.

Intended Workflow

This tool was written to help make it easier to develop code and switch between robots with ease. It works by inferring what robot you’re working on from $ROS_MASTER_URI and automating common tasks such as account creation, code syncing, and running commands. It assumes that you always edit code in your ROS Workspace and then push a copy of the workspace to the robot afterwards, so that you can run it. This keeps all code that you are developing on your computer in case someone takes the robot.

Example Workflow

# Start working on freight 0 for the first time
ufr 0
fetch create-account --fullname "Not A. Robot"
fetch push --install-deps --build
fetch run "roslaunch my_awesome_package do_stuff.launch"
# Edit code to fix a bug
fetch push --build "--pkg my_awesome_package"
fetch run "roslaunch my_awesome_package do_stuff.launch"
# Switch over to freight 8, since someone kidnapped freight 0
ufr 8
fetch create-account --fullname "Not A. Robot"
fetch push --install-deps --build
fetch run "roslaunch my_awesome_package do_stuff.launch"

Installation

To install run, checkout the fetchrobotics/sandbox repo and run:

sudo apt-get install ros-noetic-fetch-tools

Afterwards, restart your terminal or run source $(rospack find fetch_tools)/setup.bash.

Common Arguments

Robot

Most operations interact with a robot, in this case they take an optional --robot argument. If the robot parameter is passed in using --robot, that is the value used. If not, the parameter defaults to the robot pointed at by $ROS_MASTER_URI. To set the default value, add the line export FETCH_ROBOT=myrobot to your .bashrc file.

If the robot is not on the DNS (i.e. pinging the robot name does not work), you can add .local to the parameter, e.g. fetch4.local, and communication with the robot will work via zeroconf (avahi).

Workspace

Some operations interact with a workspace, in this case take an optional --workspace argument. If the a parameter is passed in that value is used. If not, the parameter defaults to ~/$ROS_DISTRO. To set the default value, add the line export FETCH_WORKSPACE=/path/to/my/workspace to your .bashrc file. By default, the remote workspace is assumed to match your local workspace. If not, you can use either the --remote-workspace argument or the FETCH_REMOTE_WORKSPACE environment variable to change it.

User

Most operations interact with a robot, in this case they often effect a particular user on that robot, so they take an optional --user argument. If the robot parameter is passed in using --user, that is the value used. If not, the parameter defaults to $USER. To set the default value, add the line export FETCH_USER=myuser to your .bashrc file.

fetch Commands

fetch create-account

To create an account:

fetch create-account

To create an account with another username:

File truncated at 100 lines see the full file

Changelog for package fetch_tools

0.3.3 (2020-10-20)

• Fix argcomplete hook command for python3
• Contributors: Eric Relson

0.3.2 (2020-09-23)

• Fix build dep that was missed for python2->3
• Contributors: Eric Relson

0.3.1 (2020-09-20)

• Update dependencies from py2 to py3
• Contributors: Eric Relson

0.3.0 (2020-09-20)

• Convert to python3 + ROS noetic
• Text improvements to debug_snapshot tool
• Several 18.04 fixes to debug_snapshot tool
• Contributors: Alex Moriarty, Eric Relson, Nick Walker, Russell Toris

0.2.1 (2019-03-26)

• Fixups for indigo->melodic; package format (#13)
  • Updates to debug_snapshot
  • Warning about common failure case when using debug_snapshot
• Contributors: Eric Relson

0.2.0 (2018-07-11)

• updates ownership
• Update create_account.py
• Expand hardware info retrieval and add read_board
• Contributors: Alex Henning, Michael Ferguson, Michael Hwang, Russell Toris

0.1.4 (2016-04-12)

• Added FETCH_USER to sf/sfr & additional usage notes
• Updated readme to detail robothostname.local usage with fetch_tools and how to set ports with ul
• Contributors: Alex Henning, Eric Relson

0.1.3 (2016-03-24)

• Added upstart conf files to debug-snapshot zip
• Contributors: Aaron Blasdel

0.1.2 (2016-02-29)

• Added three commands:
  • [fetch debug-snapshot]{.title-ref}
  • [fetch pull]{.title-ref}
  • [fetch workspace-status]{.title-ref}
• Changed one command:
  • [fetch sync]{.title-ref} is now [fetch push]{.title-ref}
• Improved one command:
  • [fetch run]{.title-ref} now supports multiple workspaces
• Contributors: Alex Henning, Michael Ferguson, Aaron Blasdel

0.1.1 (2015-07-31)

• Initial implementation of fetch_tools Includes four commands:
  • [fetch create-account]{.title-ref}
  • [fetch sync]{.title-ref}
  • [fetch run]{.title-ref}

  - [fetch lint]{.title-ref} Includes five aliases:

  • uf
  • ufr
  • ul
  • sf
  • sfr
• Initial commit
• Contributors: Alex Henning, Michael Ferguson