Skip to content

SimHub plugin to send telemetry data to ESP32 open-source sim-wheels / button boxes

License

Notifications You must be signed in to change notification settings

afpineda/SimWheelESP32-SimHub-Plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SimHub plugin for ESP32 open-source sim-wheels or button boxes

This project provides a SimHub plugin to send telemetry data to ESP32 open-source sim-wheels and button boxes. Basic device settings can also be configured.

Installing

  1. Download the latest package.

  2. Unzip to the SimHub installation folder, typically: C:\Program Files (x86)\SimHub\

  3. Run SimHub.

  4. It should detect this plugin automatically:

    Plugin detection

  5. Click the right button to activate it, then click "Show in left main menu".

  6. A new item will appear in the left main menu, called "ESP32 Sim-wheel".

Upgrading to a newer version

Just repeat the unzip procedure. There is no need to re-activate this plugin again except when asked.

Running

  • To interact with this plugin, click on "ESP32 Sim-wheel" option in the left menu panel.
  • The plugin does not detect new devices at connection. You can force a refresh in two ways:
    • Pause your game.
    • Click on the 🔄 Refresh button.
  • Telemetry data will be sent to all connected and suitable devices.
  • Pixel data will be sent to all connected and suitable devices if an LED profile was configured and saved.

Bind settings to game and car (how it works)

This feature stores the device configuration for each game and car, and applies it when the game or car is changed.

For bindings to work:

  • The ✅ Bind to current game and car option must be checked.
  • A game must be selected in SimHub.
  • A car must be selected in-game.

Applies to all detected devices. The bound settings are limited to clutch paddles (working mode and bite point), "ALT buttons" (working mode) and DPAD (working mode). You can configure those device settings using SimHub, the companion app or the device itself.

  • SimHub ➡️ device. Saved settings (if any) are restored to each device when:

    • A new device is detected.
    • Current game or car is changed.
    • The user checks ✅ Bind to current game and car.
  • Device ➡️ SimHub. When you press the 🔗 Bind current settings to current game/car button, settings from all devices are bound to the current game and car, then saved.

Device settings

Select a device to configure in the combo box. Only basic configurable options will be shown in the corresponding tab. For advanced configuration use the companion app.

Telemetry data

Devices that accept raw telemetry will receive it as long as they are detected. There is nothing to configure.

Pixel data

Devices capable of individual pixel control will receive pixel data as long as they are detected and an LED profile is configured and stored.

Unlike other SimHub content, LED profiles are not automatically saved or applied. You have to press the 💾 Apply and save button. As a result, you will not be able to see the changes live.

Troubleshooting

Plugin activity is shown in the logs\simhub.txt file relative to your installation folder. Typically: C:\Program Files (x86)\SimHub\logs\simhub.txt. Open that file and look for the string [ESP32 Sim-wheel].

How to reset plugin settings

Settings are stored in the PluginsData\Common\ESP32SimWheelPlugin.GeneralSettings.json file relative to your installation folder. You may delete that file to forget all device/game/car bindings.

LED profiles are stored in the PluginsData\Common\ESP32SimWheelPlugin\ folder relative to your installation folder. Files are named by serial number: one file per device and LED group.

About

SimHub plugin to send telemetry data to ESP32 open-source sim-wheels / button boxes

Topics

Resources

License

Stars

Watchers

Forks