Table of Contents

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Disclaimer

By contributing you accept to provide code that comply to the following code rules. Any pull request may be stalled until fixed. It's important for everyone, be it contributors or reviewers, to have a clear compile log so they can easily spot and fix new arising problems / warning.

Code contribution rules

Indent your code. Using automatic indentation is recommended, at least for new apps
Test and take in account the return code each time it's needed
Have an error management in your app
Make reusable content (class, structs, gui filler functions, ...)
Document global processing as well as tricky parts, don't be lazy, some may contribute to your own contribution. Information inside the code is really appreciated
Fix your compilation warnings before making a pull request. ALL your warnings. It's making a terrible noise in the compilation log each time we accept PRs with warnings everywhere
Provide access to your sources via a public repository

A note on Pull Requests

PRs should be up to date with 'next'
Each new functionality should have it's own PR, don't put too much files/commits into a single PR. When it's too much commits, one can make a new branch and report only the modified files in a single commit, to make the review easier
Merging of any PR is up to the maintainers good will

naming and usage rule

Use English
var_and_func_example (snake_case)
_private_member_of_class_example (_snake_case) (not yet covered all in codebase but new apps. You are welcomed to correct them.)
namespaceexample
ClassNameExample (CamelCase)
objectNameExample (camelCase)
func_arg_ex (snake_case and abbreviation is allowed in small scope functions)
Don’t use typedef keyword in C++ code
goto is not allowed

which license of code is safe to use

MIT: It's safe to copy MIT license, as long as you keep original copyright info.
MPL: It's safe to copy MPL license, as long as you follow Mozilla's agreement.
GNU (GPL 2/3 / AGPL): This project is under GPL which means it's safe to use GPL code here as long as you open source your the distro under GPL license.
The Unlicensed: safe to use.
BSD: safe to use.
WTFPL: Safe to use.
CC0: safe to use.

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
Powering the PortaPack
Troubleshooting
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
- 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
- HackRF Mode
- USB Serial Console

Developer Manual

Compilation of the firmware
Create a custom map
Code formatting
PR process
Description of the Structure
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
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

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.