Getting Started with GreatFET

Prerequisites

To use GreatFET you will need to ensure the following software is installed:

Python v3.9, or later.

GreatFET Host Software Installation

You can install the GreatFET host software from the Python Package Index (PyPI) or directly from source.

To install the GreatFET host software from PyPI using the pip tool:

pip install greatfet

Note

For more information on installing Python packages from PyPI please refer to the “Installing Packages” section of the Python Packaging User Guide.

Install udev Rules (Linux Only)

Configure your system to allow access to GreatFET for logged in users:

greatfet host-tools --ensure-access

If you’d prefer to perform this step manually, you can find a udev rules file matching your distribution in the host/greatfet/assets/ directory of the GreatFET source repository.

Test Installation

Ensure that GreatFET’s USB0 port is connected to the host and type the following command into a terminal:

greatfet info

If everything is working you will see the following output:

Found a GreatFET One!
  Board ID: 0
  Firmware version: v2024.0.0
  Part ID: xxxxxxxxxxxxxx
  Serial number: xxxxxxxxxxxxxxxxxxxx

Upgrading to a new release

You can upgrade the GreatFET host tools to the latest release with:

pip install --upgrade greatfet

After upgrading the host tools, update your GreatFET firmware to the latest release with:

greatfet_firmware --autoflash