Adding Simagic P1000 Pedals Support

[Mon-Ouie]

Hey,

I'm looking into how to add support for the haptics feedback of the Simagic Pedals. I think I've figured out most of what's needed about the pedals themselves, just need to know how to make it fit with the rest of monocoque.

They have a vendor id 0x0483, product id 0x0525. The official SimPro manager application sends 4 HID SET_REPORT requests. Each payload has a size of 49 bytes, but most of it is just zeroes. First it always sends this exact message (never seen it change, not sure what it means):

0xF1 0x17 0x00 0x00 0x00 0x01 0x02

then for each pedal:

0xEC [pedal_id] [enabled] [frequency] [strength]

where:

• pedal_id is 0 for the clutch, 1 for the brakes, and 2 for the throttle.
• enabled is 1 if the haptics module should be turned on, 0 otherwise.
• frequency is the vibration frequency in Hertz. The GUI lets you select a frequency between 10 (0x0A) and 50 (0x32).
• strength is how strong the vibrations are, between 0 and 100.

I can trigger them programmatically using hidapi, e.g. with the Python script below:

import hid
from time import sleep

SIMAGIC_VENDOR_ID = 0x0483
SIMAGIC_PRODUCT_ID_P1000 = 0x0525

def zero_pad_buffer(buf, target=49):
    return buf + [0] * (target - len(buf))

def set_haptic_feedback(
        device,
        clutch_vibrating=False, clutch_frequency=10, clutch_strength=0,
        brake_vibrating=False, brake_frequency=10, brake_strength=0,
        throttle_vibrating=False, throttle_frequency=10, throttle_strength=0):
    device.send_feature_report(zero_pad_buffer([
        241, 0xF1, 0x17, 0x00, 0x00, 0x00, 0x01, 0x02
    ]))

    device.send_feature_report(zero_pad_buffer([
        241, 0xEC, 0x00, int(clutch_vibrating), clutch_frequency, clutch_strength
    ]))

    device.send_feature_report(zero_pad_buffer([
        241, 0xEC, 0x01, int(brake_vibrating), brake_frequency, brake_strength
    ]))

    device.send_feature_report(zero_pad_buffer([
        241, 0xEC, 0x02, int(throttle_vibrating), throttle_frequency, throttle_strength
    ]))

device = hid.device()

device.open(SIMAGIC_VENDOR_ID, SIMAGIC_PRODUCT_ID_P1000)

print("clutch")
set_haptic_feedback(device, clutch_vibrating=True, clutch_strength=50, clutch_frequency=50)

sleep(1)

print("brake")
set_haptic_feedback(device, brake_vibrating=True, brake_strength=100, brake_frequency=20)

sleep(1)

print("throttle")
set_haptic_feedback(device, throttle_vibrating=True, throttle_strength=25, throttle_frequency=10)

sleep(1)

print("clutch + brake")
set_haptic_feedback(device,
                    clutch_vibrating=True, clutch_strength=50, clutch_frequency=10,
                    brake_vibrating=True, brake_strength=50, brake_frequency=50)
sleep(1)

print("off")
set_haptic_feedback(device)

device.close()

[Spacefreak18]

Hi there, and thanks for doing all this leg work.

For starters i'd look in the devices/usb folder. I'd start with the cslelitev3 code, and set your config file to use that device for now (in the conf folder in the main branch there are 3 sections for cslelitev3 config), and then when you get it working, hook up the config part of it ( i can help ).
https://github.com/Spacefreak18/monocoque/blob/master/src/monocoque/devices/usb/cslelitev3.c

Also, look at the revburner.c file, because there it uses hidapi to init, and send reports, however cslelitev3 will be hooked into the haptic effects you want. So you'll have to sort of combine the two to do what you need.

For now, you can hard code the frequency and strength, we can set those in the config later. We could also make the frequency dynamic based upon what is happening in game, there are other places in the code that have that sort of logic, but let's ignore that and hard code it to whatever you'd like to get it working first.

for the packet it sends on start, you can send that in the "init" function in cslelitev3.c

Then in the cslelitev3_update function, there is a case statement, where you can send the reports for throttle (tyre slip), brake (tyre lock), and both (abs). I'm not sure what we want the clutch and brake effect to do. we could make that abs, or whatever you wish really.

you can test it with monocoque test ( unfortunately you have to sit through the whole test sequence for now, because i don't have an early exit built into it yet ).

when you get it to work you can then move it to a simmagicp1000.c and simmagicp1000.h and do a pull request, with or without the config part, i can always add the plumbing if you want. Or however you want to send me the code is fine too.

[Spacefreak18]

I initially added support for this based on the wonderful legwork you did.

052ee12

You can test it out with this minimal config:
configs = ( { sim = 0; devices = ( { device = "USB"; type = "Haptic"; subtype = "simagicP1000Pedals"; effect = "TyreSlip"; tyre = "ALL"; } ); } );

I can't test it all the way because I don't have the device, but i can coax it to see that the data being sent looks reasonable. You should see similar statements to this when you run the test sequence with monocoque test
02:21:10.690 <trace>[simagicp1000.c:24] sent bytes ec 02 01 0a ff 00 00

Let me know how it goes.

edit:
i will add that i was confused whether i need to send that first feature report only once to start, or before any feature report. the way i implemented it, i only sent it once after first opening the device.

[SkaterPaul]

Ooh
I’m kinda bad with Linux, but I have a single simagic haptic reactor and the required accessories being mailed to me currently and was going to see if I can figure out how to get these devices to work. If it does, I’ll order two more. But yeah priorities. I’ll try to make sense of the above, but I’m glad to see you two are working on it.

[Mon-Ouie]

i will add that i was confused whether i need to send that first feature report only once to start, or before any feature report. the way i implemented it, i only sent it once after first opening the device.

The Simagic software sends it in between every command, but it doesn't seem to change the behavior of the device to not send it as far as I can tell.

I'm struggling to test in an actual game because I'm getting crashes when running monocoque in e.g. Assetto Corsa Competizione, even though the shared memory files are being mirrored:

19:26:41.431 <debug>Found running process for Assetto Corsa
19:26:41.431 <debug>static and physics files found

Thread 1 "monocoque" received signal SIGBUS, Bus error.
simdatamap (simdata=0x55555559ada0, simmap=0x7ffff7f90010, simmap2=0x0,
    simulator=SIMULATORAPI_ASSETTO_CORSA, udp=false, base=0x0)

962                     simdata->worldposx = *(float*) (char*) (d + offsetof(struct SPageFileCrewChief, vehicle) + ((sizeof(acsVehicleInfo) * 0) + offsetof(acsVehicleInfo, worldPosition) + offsetof(acsVec3, x)));

In the mean time, I have a fork with a couple of changes that get the device to react correctly when running monocoque test: #18

@SkaterPaul: Once my pull request gets merged, you should be able to get the device working without much tinkering, as long as you can get monocoque to read the game data

[Spacefreak18]

i will add that i was confused whether i need to send that first feature report only once to start, or before any feature report. the way i implemented it, i only sent it once after first opening the device.

The Simagic software sends it in between every command, but it doesn't seem to change the behavior of the device to not send it as far as I can tell.

I'm struggling to test in an actual game because I'm getting crashes when running monocoque in e.g. Assetto Corsa Competizione, even though the shared memory files are being mirrored:

19:26:41.431 <debug>Found running process for Assetto Corsa
19:26:41.431 <debug>static and physics files found

Thread 1 "monocoque" received signal SIGBUS, Bus error.
simdatamap (simdata=0x55555559ada0, simmap=0x7ffff7f90010, simmap2=0x0,
    simulator=SIMULATORAPI_ASSETTO_CORSA, udp=false, base=0x0)

962                     simdata->worldposx = *(float*) (char*) (d + offsetof(struct SPageFileCrewChief, vehicle) + ((sizeof(acsVehicleInfo) * 0) + offsetof(acsVehicleInfo, worldPosition) + offsetof(acsVec3, x)));

In the mean time, I have a fork with a couple of changes that get the device to react correctly when running monocoque test: #18

@SkaterPaul: Once my pull request gets merged, you should be able to get the device working without much tinkering, as long as you can get monocoque to read the game data

this is because it's crashing on not having the assetto corsa crewchief plugin, which is a bug, the intended behavior is to be able to continue fine without that plugin enabled (you'd only be missing stuff like car proximity data and what other cars are doing)

you were using acc?

[Mon-Ouie]

Yes, this was ACC

[Spacefreak18]

i'll put a bug up somewhere if i don't fix it quick. acc doesn't have that plugin, so there's work to do there anyways, but that doesn't effect what we're doing here.

[Spacefreak18]

if it's making you stuck though, you can get around it if you have acs, and install the crewchief plugin.

[Mon-Ouie]

I got it working with regular Assetto Corsa. It seems to be vibrating near constantly, even when barely moving:

speed: 0 rpms: 1246 gear: 4 alt: 1 21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:208] wheel vibration
 calculation with wheel config set to 1 configchecked 1 configfile /home/kilian/.config/monocoque/diameters.config car ks_alfa_33_stradale
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:29] tyre diameter data found
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:29] tyre diameter data found
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:29] tyre diameter data found
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:244] attempting wheel slip calculation
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:259] wheelslip values are 0.000000 0.000000 0.000000 0.
000000
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:260] velocities (x,y,z) are -0.000134 0.002381 -0.00004
6

Maybe I need to change some threshold in the settings for it to make sense?

Also is there a hook that USB devices can respond to after this message?

 <info>stopped mapping data, press q again to quit

Probably should turn off the motors when the game closes

[Spacefreak18]

I got it working with regular Assetto Corsa. It seems to be vibrating near constantly, even when barely moving:

speed: 0 rpms: 1246 gear: 4 alt: 1 21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:208] wheel vibration
 calculation with wheel config set to 1 configchecked 1 configfile /home/kilian/.config/monocoque/diameters.config car ks_alfa_33_stradale
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:29] tyre diameter data found
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:29] tyre diameter data found
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:29] tyre diameter data found
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:244] attempting wheel slip calculation
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:259] wheelslip values are 0.000000 0.000000 0.000000 0.
000000
21:06:16.371 <trace>[/home/kilian/code/monocoque/src/monocoque/devices/hapticeffect.c:260] velocities (x,y,z) are -0.000134 0.002381 -0.00004
6

Maybe I need to change some threshold in the settings for it to make sense?

Also is there a hook that USB devices can respond to after this message?

 <info>stopped mapping data, press q again to quit

Probably should turn off the motors when the game closes

yep, just add a line to each config entry that looks like threshold = 0.2 is usually a good value to start with, but it's a value that you have to tweak a bit to your taste. I will say that so far to me the calcs seem good enough that I don't need different settings per sim.

i put code to spin down motors in simagicp1000_free, which gets called in the process of showing that info line. Obviously, put it before you actually close and free something you need to do the spindown. Everything gets reinitialized if you start playing again (it will call simagicp1000_init), so you can leave the program running in the background and play different games (in theory).

[Spacefreak18]

Thread 1 "monocoque" received signal SIGBUS, Bus error.

i couldn't replicate this error. But I put in code to prevent ACC from trying to do that, among various other improvements.