Docs
Documentation
Documentation Ferrum Setup

Ferrum Setup

Install the driver and Ferrum app, connect your board, and configure it to bridge your mouse and keyboard between your Main PC and Radar PC.

πŸ“¦ Required Downloads

CP210x USB Driver Extract the zip and run install.bat β€” Download β†—
Ferrum Installer Run ferrum-installer.exe β€” available in the Ferrum Discord β†—
Support discord.gg/ferrum β†— β€” Join for downloads, help, and support.

πŸ”Œ 1. Connect USB Cables

Make sure the USB ports are facing toward you before connecting cables. The port labels below assume this orientation.

Ferrum port layout
Left USB-C Port Connect to your Main PC β€” use a motherboard port, not a case port.
Middle USB-A Port Connect to your mouse.
Right USB-C Port Connect to your Radar PC (2nd PC).

πŸ’Ύ 2. Install CP210x Driver

  1. Extract CP210x_Universal_Windows_Driver.zip to a folder.
  2. Run install.bat to install the driver package for Windows.
CP210x driver installer

βš™οΈ 3. Install the Ferrum App

  1. Run ferrum-installer.exe to install the Ferrum application.
  2. Launch the Ferrum app once installation is complete.
Ferrum application

If you see a Backend Status: Disconnected error after installing, try rebooting your PC and/or reopening the Ferrum app.


πŸ–₯️ 4. View Connected Boards

If everything was successful, your connected Ferrum board(s) will appear in the Boards tab.

If the menu shows No Boards Connected, verify your board is plugged in as shown in Step 1 and check your cables.

Ferrum boards tab

πŸ–±οΈ 5. Select Device Type

  • If your device is your main keyboard, select Keyboard only.
  • If it is your main mouse, select Mouse (the default).
  • If it handles both (e.g. a shared USB receiver/dongle), select Mouse and Keyboard.

You can also change your language in the bottom left corner of the app.

Ferrum device type selection

πŸ”— 6. Connect Provider Software

To connect your provider's software to Ferrum, use one of the following methods:

Serial API Use the COM Port shown in the Serial API tab.
Net API Use the IP address and port shown in the Net API tab.
Provider software connection Ferrum Net API tab

πŸ”§ Troubleshooting

Backend Status: Disconnected

  • Try rebooting your PC.
  • Close and reopen the Ferrum app.
  • Verify the CP210x driver was installed correctly.

No Boards Connected

  • Make sure your Ferrum board is plugged in correctly as shown in Step 1.
  • Ensure USB cables are good quality and properly connected.
  • Try different USB ports on your PC.

Mouse or Keyboard not working

  • Verify you selected the correct device type (Mouse, Keyboard, or Both).
  • Ensure all USB connections are secure.
  • Try reconnecting the device to the Middle USB-A Port.

Still stuck? Join the Ferrum Discord β†— for dedicated support from the Ferrum team.

Was this helpful?
Docs
Copyright Β© Deception.GG. All rights reserved.