Skip to content

Home

Jump to bottom
Intelektika team edited this page Aug 31, 2025 · 2 revisions

Patch: Frequently Asked Questions (FAQ)

🔌 Connection and Setup

Q: How do I connect Patch to a computer for the first time? A: 1. Connect Patch to a USB port. 2. Launch the PatchWorks software on your computer. 3. Enter the unique ID of your device (printed on the packaging). 4. The software will automatically find and connect to the device.

Q: Patch is not being detected by the software. What should I do? A: 1. Ensure the USB cable supports data transfer. 2. Check that the ID was entered correctly, without any typos. 3. Restart the device (disconnect and reconnect the USB cable).

Q: How do I connect multiple Patch devices at the same time? A: Each device has a unique ID. Simply enter the ID of the device you want to control at that moment into the software. The software can only work with one device at a time.

⌨️ Action Assignment

Q: What data format does Patch send when a button is pressed? A: The device sends a string in the format {device}-{number}-{action}-{state}\n via the virtual COM port. For example: button-1-pressed-1 or encoder-1-rotated-10.

Q: Can I use Patch without your PatchWorks software? A: Yes. Patch communicates via a serial port (UART) using an open protocol. You can write your own program in any language that listens to the port and reacts to the device's commands.

🔧 For Developers

Q: Where can I find the source code? A: The source code for the client-side software (PatchWorks), which handles device communication, scripting, and the user interface, is open-source and available in our GitHub organization: Intelektika-team. The firmware running on the Patch hardware itself is closed-source.

Q: Can I develop my own client for Patch? A: Yes! Patch uses an open text-based protocol over a virtual serial port (UART). You can write your own application in any programming language to listen to the port, parse commands (like button-1-pressed-1), and trigger your own actions. The communication protocol is documented above.

Q: How can I contribute to the project? A: We welcome contributions to the open-source ecosystem around Patch! You can:

  • Develop and share plugins or scripts for PatchWorks.
  • Improve the PatchWorks desktop application itself.
  • Create documentation, tutorials, or share your use cases.
  • Report bugs or suggest features for the PatchWorks software via GitHub Issues.

Clone this wiki locally