feathersdk.cli.install Module

Install Feather onto the system.

Copies the configs for a given robot revision into a destination directory (default /feathersys/configs).

feathersdk.cli.install.AVAILABLE_VERSIONS = ['v0.4.0', 'v0.5.1', 'v0.5.2', 'v0.6.0']

The available versions of the Feather robot configs.

feathersdk.cli.install.install(version=None, root_dir=None, verify=False, force=False, install_configs=True, install_conda=False, install_system_packages=False, install_setup_ethernet=False, setup_ethernet_method=None)

Install Feather onto the system by copying versioned robot configs.

Parameters:

  • version (str | None) – Config set to copy. Must be one of AVAILABLE_VERSIONS. Not required when verify is True.

  • root_dir (str | Path | None) – The root directory to install Feather into. Defaults to /feathersys.

  • verify (bool) – If True, do not install. Instead, verify that the system is installed correctly.

  • force (bool) – If True, overwrite any existing files or directories. Otherwise, an error is raised if any exist.

  • install_configs (bool) – Whether to install the configs. Defaults to True.

  • install_conda (bool) – Whether to install conda (if not already installed). Defaults to False; pass --all or --install-conda on the CLI.

  • install_system_packages (bool) – Whether to install system packages (EG: make, libnss-mdns, etc). Defaults to False; pass --all or --install-system-packages on the CLI.

  • install_setup_ethernet (bool) – Whether to configure the Teensy ethernet link. Defaults to False; pass --all or --install-setup-ethernet on the CLI.

  • setup_ethernet_method (str | None) – "static" or "dhcp". None detects a DHCP server, then falls back to static.

Returns:

0 on success, 1 on failure.

Return type:

int