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.
Tip
Please read the wiki first; it resolves 99% of issues. Think of it as your troubleshooting sidekick.
If your problem isn't documented, ask in our GitHub issues or on our Discord server. To save time, follow these guidelines:
- Be specific.
- Provide detailed descriptions.
- Avoid cross-posting in Discord channels.
- Use screenshots, not phone camera photos. If you must use a camera, zoom in to avoid moiré patterns.
- For hardware issues, take clear, well-lit photos.
- Use markdown syntax for code or error messages.
Examples
Good Question
I have {specific problem}. I followed the {guide}, but it failed at {step}. The error message is {error}. Here’s a screenshot. My computer environment is {details}, and my device is {details}. Here are some clear photos that might help.
I did {detailed steps of what you did} and it caused {details of your ploblem}. I followed the {guide}, but it failed at {step}. The error message is {error}. Here’s a screenshot. My computer environment is {details}, and my device is {details} with {firmware version}. Here are some clear photos that might help.
Bad Questions
Asking Vaguely
- Can anyone help me? I need help. Please.
- Hello, anybody here?
- Help me!
Too Wide-Ranging
- How do I write an app for this device?
- How do I attack/jam/copy/clone {device/station/fob/remote}?
Lacking Detail
- {Feature} not working.
- My device is not working, please help.
- I can't update firmware.
- I can't receive.
- I can't transmit.
Easily Googled Questions
How to collaborate
How to ask questions correctly
User manual
- First steps
- Usage cautions
- Intended use and Legality
- Features
- PortaPack Versions (which one to buy)
- HackRF Versions
- Firmware update procedure
- Description of the hardware
- User interface
- Powering the PortaPack
- Troubleshooting
- Applications
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
- Software Dev Guides
- Tools
- Research
- 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.