Welcome to the GreatFET Project documentation!

The GreatFET project produces interface tools for hardware hacking, making, and reverse engineering.

User Documentation

• Getting Started with GreatFET
  • Prerequisites
  • GreatFET Host Software Installation
  • Install udev Rules (Linux Only)
  • Test Installation
  • Upgrading to a new release
• GreatFET and GNURadio
  • Requirements
  • Adding our blocks to GNURadio-companion
• Linux Distribution Python Version Matrix
• Troubleshooting
  • Why do I get a No GreatFET devices found! error when my GreatFET is plugged in?

Software

• Using GreatFET APIs
  • Getting a GreatFET object
  • Using APIs
  • Debugging
  • LED
  • GPIO
  • Logic Analyzer
  • Pattern Generator
  • UART
  • ADC
  • DAC
  • SWRA124/Chipcon
  • I²C
• greatfet_i2c
  • Pin Usage
  • Example Usage
  • API
• greatfet_logic
  • Pin Usage
• greatfet_msp430
  • Pin Usage

Firmware

• Getting Started with Firmware Development
  • Fresh install
  • Updating your repository
  • Installing host tools
  • Building and flashing firmware
  • Re-Building and flashing firmware
• LibGreat Verb Signatures
  • Describing Verb Signatures
  • Repeat Specifiers
  • Length Specifiers
  • Element Groups
  • Examples
  • Omitting Verb Signatures
• GreatFET Classes
  • Class Registry

Hardware

• Neighbors
  • already designed
  • some progress made
  • rough ideas
• How to Design a Neighbor
  • Use a Template
  • Required Elements
  • Bonus Row
  • Orientation
  • Neighbor Identification
  • Making Your Neighbor Extra-neighborly
  • Pin Selection
• Board Naming
  • Code Names
  • GreatFET Trademark
  • GreatFET and Great Scott Gadgets URLs
  • Naming Your Neighbor
• I2C Registry

Release Notes

• Release Process
  • Create Environment
  • Dependencies
  • Clone Repository
  • Update RELEASENOTES.md from previous release
  • Prepare release
  • Push Release Tag
  • “Draft a new release” on github
  • Upload release to PyPI
  • Announce the release