31 Home

Erwin Ried edited this page 2024-10-03 10:36:15 +02:00

Thanks for buying your HackRF+PortaPack device. That is what I would say if I was actually the one selling them as the intro line for the documentation, but I am not. I am just trying to document the great work of a lot of people involved in this project, listed here.

The following documentation is split in two parts. The User manual intends to emulate a typical instruction manual for the end user, while the Developer manual documents all the apis available in order to write custom apps.

Important

Before you begin using the device, please carefully read First step, Intended use and Legality, and Usage cautions. This will help you avoid damaging your device or encountering legal issues.

Problems? Won't boot? Check Troubleshooting.

Enjoy!

Start here

How to collaborate
How to ask questions correctly

User manual

• First steps
  • About firmwares
  • Redirections on this manual/project
• Usage cautions
• Intended use and Legality
• Features
• PortaPack Versions (which one to buy)
• HackRF Versions
  • Original GSG HackRF One
  • Clifford's-version
• Firmware update procedure
  • Updating the Xilinx CPLD on hackrf board
• Description of the hardware
  • Enclosure/cases
    • 3d printed enclosure
  • Internal speaker
  • SMD buttons and caps
  • Encoder knob
  • SMA Antenna connector
• User interface
  • Splash screen
  • Title bar
  • Main menu
  • Main Controls
  • SD Card content and modification
  • Text Entry
• Powering the PortaPack
• Troubleshooting
  • Won't boot
  • Config Menu
  • Firmware upgrade
  • Diagnose firmware update in Windows
  • Receive Quality Issues
  • No TX/RX
  • TX Carrier Only
  • H2+ speaker modifications
  • Dead Coin Cell Battery
  • Factory Defaults
  • SD card not recognized by PC with the SD-card over USB selected
  • DFU overlay
  • Full reset
  • SolveBoard
• Applications
  • Receivers
    • ADS-B
    • AFSK
    • AIS Boats
    • Analog TV
    • APRS
    • Audio
    • BLE RX
    • ERT Meter
    • Level
    • NRF
    • POCSAG
    • Radiosonde
    • Recon
    • Search
    • TPMS Cars
    • Weather/SubGhzD
    • Fox-Hunt
    • ProtoView
  • Transmitters
    • ADS-B(S)
    • APRS
    • BHT Xy/EP
    • BLE TX
    • Burger Pager
    • GPS Sim
    • Jammer
    • LGE Tool
    • Morse
    • OOK
    • OOK Editor
    • POCSAG
    • RDS
    • Soundboard
    • Spectrum Painter
    • SSTV
    • TEDI/LCR
    • TouchTunes
    • BLESpam
  • Capture
    • C16 Format
  • Replay
  • Remote
  • Scanner
  • Microphone Transceiver
  • Looking Glass
  • Utilities
    • Antenna length
    • File manager
    • Freq manager
    • Notepad
    • IQ Trim
    • SD over USB
    • Signal gen
    • Wav Viewer
    • Flash Utility
    • Wipe SD card
    • Pac-Man
    • WardriveMap
    • Random password
  • Settings
    • App Settings
    • Audio
    • Blacklist
    • Calibration
    • Touchscreen Threshold
    • Config Mode
    • Converter
    • Date/time
    • Encoder Dial
    • Freq. Correct
    • P.Mem Mgmt
    • QR code
    • Radio
    • User Interface
    • Brightness
    • Menu Color
  • Debug
    • Memory Usage
    • SD Card
    • Peripherals
    • Temperature
    • Buttons Test
    • Touch Test
    • P.Memory
    • Debug Dump
    • M0 Stack Dump
    • Fonts Viewer
    • Audio Test
  • HackRF Mode
  • USB Serial Console

Developer Manual

• Compilation of the firmware
  • Compile on WSL with ninja
  • How to compile on Windows faster with WSL 2
  • Using Docker and Kitematic
  • Docker command-line reference
  • Using Buddyworks and other CI platforms
  • Notes for Buddy.Works (and other CI platforms)
  • Using ARM on Debian host
  • All in one script for ARM on Debian host
  • Compile on Arch based distro (exclude Asahi)
  • Dev build versions
  • Notes About ccache
• Create a custom map
• Code formatting
• PR process
• Description of the Structure
  • At First Glance
  • Boot Process
  • Firmware Architecture
  • Persistent Memory
  • ChibiOS Notes
• Software Dev Guides
  • Code contribution rules
  • Create a Simple App
  • Building External Apps
  • Widgets
  • SD Card
  • Access Radio Hardware
  • Interpret Guru meditation crashes
  • Create a Complex App
  • Theme-system
  • Debug via SWD & JTAG
  • Debug with serial
  • I2C drivers
• Tools
  • make_airlines_db.py
  • make_icao24_db.py
  • world_map.bin
  • converter
  • Bitmap reverse decode
• Research
  • Dissecting the Temperature Logger
  • Differences between H1 and H2
• UI Screenshots
• Maintaining
  • Creating a prod/stable release (Maintainers only)
  • Maintaining rules
• Development States Notes
  • Work Needed (Future Enhancement Suggestions)
  • External App Roadmap
  • SD card

Note

The wiki is incomplete. Please add content and collaborate.

Important

• This is a public wiki. Everything is visible to everyone. Don't use it for personal notes.
• Avoid linking to external tutorials/articles; they may become outdated or contain false information.