force feedback support for joystick

[joesphan]

Hello! Is there a way to get force feedback support? I found the usb hid descriptors for a ffb joystick here, original code was for the 32u4: https://github.com/YukMingLaw/ArduinoJoystickWithFFBLibrary

/*
  Force Feedback Joystick
  USB HID descriptors for a force feedback joystick.
  Copyright 2012  Tero Loimuneva (tloimu [at] gmail [dot] com)
  Copyright 2016  Jaka Simonic (telesimke [at] gmail [dot] com)
  Copyright 2019  Hoan Tran (tranvanhoan206 [at] gmail [dot] com)
  Copyright 2020  Yo Law (lymmm3 [at] gmail [dot] com)
  MIT License.
  Permission to use, copy, modify, distribute, and sell this
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
  software without specific, written prior permission.
  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

#ifndef _PIDREPORTTYPE_H
#define _PIDREPORTTYPE_H

#define MAX_EFFECTS 14
#define SIZE_EFFECT sizeof(TEffectState)
#define MEMORY_SIZE (uint16_t)(MAX_EFFECTS*SIZE_EFFECT)
#define TO_LT_END_16(x) ((x<<8)&0xFF00)|((x>>8)&0x00FF)

////refer to FFBDescriptor.h

///Device-->Host

typedef struct//PID state
{
    uint8_t reportId;//2
    uint8_t status;// Bits: 0=Device Paused,1=Actuators Enabled,2=Safety Switch,3=Actuator Override Switch,4=Actuator Power
    uint8_t effectBlockIndex;// Bit7=Effect Playing, Bit0..7=EffectId (1..40)
}USB_FFBReport_PIDStatus_Input_Data_t;

///Host-->Device

typedef struct //FFB: Set Effect Output Report
{
    uint8_t reportId;   // =1
    uint8_t effectBlockIndex;   // 1..40
    uint8_t effectType; // 1..12 (effect usages: 26,27,30,31,32,33,34,40,41,42,43,28)
    uint16_t duration; // 0..32767 ms
    uint16_t triggerRepeatInterval; // 0..32767 ms
    uint16_t samplePeriod;  // 0..32767 ms
    uint8_t gain;   // 0..255    (physical 0..10000)
    uint8_t triggerButton;  // button ID (0..8)
    uint8_t enableAxis; // bits: 0=X, 1=Y, 2=DirectionEnable
    uint8_t directionX; // angle (0=0 .. 255=360deg)
    uint8_t directionY; // angle (0=0 .. 255=360deg)
    //  uint16_t    startDelay; // 0..32767 ms
} USB_FFBReport_SetEffect_Output_Data_t;

typedef struct//FFB: Set Envelope Output Report
{
    uint8_t reportId;   // =2
    uint8_t effectBlockIndex;   // 1..40
    uint16_t attackLevel;
    uint16_t    fadeLevel;
    uint16_t    attackTime; // ms
    uint16_t    fadeTime;   // ms
} USB_FFBReport_SetEnvelope_Output_Data_t;

typedef struct// FFB: Set Condition Output Report
{
    uint8_t reportId;   // =3
    uint8_t effectBlockIndex;   // 1..40
    uint8_t parameterBlockOffset;   // bits: 0..3=parameterBlockOffset, 4..5=instance1, 6..7=instance2
    int16_t cpOffset;   // 0..255
    int16_t positiveCoefficient;    // -128..127
    int16_t negativeCoefficient;    // -128..127
    uint16_t    positiveSaturation; // -    128..127
    uint16_t    negativeSaturation; // -128..127
    uint16_t    deadBand;   // 0..255
} USB_FFBReport_SetCondition_Output_Data_t;

typedef struct//FFB: Set Periodic Output Report
{
    uint8_t reportId;   // =4
    uint8_t effectBlockIndex;   // 1..40
    uint16_t magnitude;
    int16_t offset;
    uint16_t    phase;  // 0..255 (=0..359, exp-2)
    uint16_t    period; // 0..32767 ms
} USB_FFBReport_SetPeriodic_Output_Data_t;

typedef struct//FFB: Set ConstantForce Output Report
{
    uint8_t reportId;   // =5
    uint8_t effectBlockIndex;   // 1..40
    int16_t magnitude;  // -255..255
} USB_FFBReport_SetConstantForce_Output_Data_t;

typedef struct//FFB: Set RampForce Output Report
{
    uint8_t reportId;   // =6
    uint8_t effectBlockIndex;   // 1..40
    int16_t startMagnitude;
    int16_t endMagnitude;
} USB_FFBReport_SetRampForce_Output_Data_t;

typedef struct//FFB: Set CustomForceData Output Report
{
    uint8_t reportId;   // =7
    uint8_t effectBlockIndex;   // 1..40
    uint16_t dataOffset;
    int8_t  data[12];
} USB_FFBReport_SetCustomForceData_Output_Data_t;

typedef struct//FFB: Set DownloadForceSample Output Report
{
    uint8_t reportId;   // =8
    int8_t  x;
    int8_t  y;
} USB_FFBReport_SetDownloadForceSample_Output_Data_t;

typedef struct//FFB: Set EffectOperation Output Report
{ 
    uint8_t reportId;   // =10
    uint8_t effectBlockIndex;   // 1..40
    uint8_t operation; // 1=Start, 2=StartSolo, 3=Stop
    uint8_t loopCount;
} USB_FFBReport_EffectOperation_Output_Data_t;

typedef struct//FFB: Block Free Output Report
{
    uint8_t reportId;   // =11
    uint8_t effectBlockIndex;   // 1..40
} USB_FFBReport_BlockFree_Output_Data_t;

typedef struct//FFB: Device Control Output Report
{
    uint8_t reportId;   // =12
    uint8_t control;    // 1=Enable Actuators, 2=Disable Actuators, 4=Stop All Effects, 8=Reset, 16=Pause, 32=Continue
} USB_FFBReport_DeviceControl_Output_Data_t;

typedef struct//FFB: DeviceGain Output Report
{
    uint8_t reportId;   // =13
    uint8_t gain;
} USB_FFBReport_DeviceGain_Output_Data_t;

typedef struct// FFB: Set Custom Force Output Report
{
    uint8_t     reportId;   // =14
    uint8_t effectBlockIndex;   // 1..40
    uint8_t sampleCount;
    uint16_t    samplePeriod;   // 0..32767 ms
} USB_FFBReport_SetCustomForce_Output_Data_t;

///Feature
typedef struct //FFB: Create New Effect Feature Report
{
    uint8_t     reportId;   //5
    uint8_t effectType; // Enum (1..12): ET 26,27,30,31,32,33,34,40,41,42,43,28
    uint16_t    byteCount;  // 0..511
} USB_FFBReport_CreateNewEffect_Feature_Data_t;

typedef struct// FFB: PID Block Load Feature Report
{
    uint8_t reportId;   // =6
    uint8_t effectBlockIndex;   // 1..40
    uint8_t loadStatus; // 1=Success,2=Full,3=Error
    uint16_t    ramPoolAvailable;   // =0 or 0xFFFF?
} USB_FFBReport_PIDBlockLoad_Feature_Data_t;

typedef struct// FFB: PID Pool Feature Report
{
    uint8_t reportId;   // =7
    uint16_t    ramPoolSize;    // ?
    uint8_t     maxSimultaneousEffects; // ?? 40?
    uint8_t     memoryManagement;   // Bits: 0=DeviceManagedPool, 1=SharedParameterBlocks
} USB_FFBReport_PIDPool_Feature_Data_t;

///effect
#define USB_DURATION_INFINITE       0x7FFF

#define USB_EFFECT_CONSTANT         0x01
#define USB_EFFECT_RAMP             0x02
#define USB_EFFECT_SQUARE           0x03
#define USB_EFFECT_SINE             0x04
#define USB_EFFECT_TRIANGLE         0x05
#define USB_EFFECT_SAWTOOTHDOWN     0x06
#define USB_EFFECT_SAWTOOTHUP       0x07
#define USB_EFFECT_SPRING           0x08
#define USB_EFFECT_DAMPER           0x09
#define USB_EFFECT_INERTIA          0x0A
#define USB_EFFECT_FRICTION         0x0B
#define USB_EFFECT_CUSTOM           0x0C
// Bit-masks for effect states
#define MEFFECTSTATE_FREE           0x00
#define MEFFECTSTATE_ALLOCATED      0x01
#define MEFFECTSTATE_PLAYING        0x02

#define X_AXIS_ENABLE               0x01
#define Y_AXIS_ENABLE               0x02
#define DIRECTION_ENABLE            0x04
//these were needed for testing
#define INERTIA_FORCE               0xFF
#define FRICTION_FORCE              0xFF
#define INERTIA_DEADBAND            0x30
#define FRICTION_DEADBAND           0x30

typedef struct {
    volatile uint8_t state;  // see constants <MEffectState_*>
    uint8_t effectType; //
    int16_t offset;
    uint8_t gain;
    int16_t attackLevel, fadeLevel;
    int16_t magnitude;
    uint8_t enableAxis; // bits: 0=X, 1=Y, 2=DirectionEnable
    uint8_t directionX; // angle (0=0 .. 255=360deg)
    uint8_t directionY; // angle (0=0 .. 255=360deg)
    int16_t cpOffset; // -128..127
    int16_t  positiveCoefficient; // -128..127
    int16_t  negativeCoefficient; // -128..127
    uint16_t positiveSaturation;  // -128..127
    uint16_t negativeSaturation;  // -128..127
    uint16_t deadBand;  // 0..255
    uint16_t phase;  // 0..255 (=0..359, exp-2)
    int16_t startMagnitude;
    int16_t  endMagnitude;
    uint16_t  period; // 0..32767 ms
    uint16_t duration, fadeTime, attackTime, elapsedTime;
    uint64_t startTime;
} TEffectState;
#endif

[huseyinctlbs]

Did you do or find something about using ffb effect with this library?

[arpruss]

I think you will have to write your own support for force feedback by registering your code to read the reports from the host.

I implemented rumble support when emulating the XBox360 controller here: https://github.com/arpruss/gamecube-usb-adapter

[joesphan]

Did you do or find something about using ffb effect with this library?

I didn't end up using this library, I migrated to atmega32u4.

[huseyinctlbs]

Did you do or find something about using ffb effect with this library?

I didn't end up using this library, I migrated to atmega32u4.

I know there is some ffb firmware code made before with arduino leonardo which has atmega32u4. But there is no maked project with bluepill yet. I'm at noob level on coding and i want to drive a dc motor as a ffb motor with the stm32 bluepill with a motor driver but don't find any maked project for it yet. Is there any differencies on hid descriptor used on arduino and stm32? Does the same descriptor would work on both card? If it could be, can i try the arduino's code on stm32? BEcause i have tried some pre maked ffb codes on arduino before. Im very confused :))

[joesphan]

This project has no PID associated with it. I think thats what's required for the hid device to receive ffb data.

On Tue, Feb 23, 2021, 2:46 AM hüseyin varol notifications@github.com wrote:

Did you do or find something about using ffb effect with this library?

I didn't end up using this library, I migrated to atmega32u4.

I know there is some ffb firmware code made before with arduino leonardo which has atmega32u4. But there is no maked project with bluepill yet. I'm at noob level on coding and i want to drive a dc motor as a ffb motor with the stm32 bluepill with a motor driver but don't find any maked project for it yet. Is there any differencies on hid descriptor used on arduino and stm32? Does the same descriptor would work on both card? If it could be, can i try the arduino's code on stm32? BEcause i have tried some pre maked ffb codes on arduino before. Im very confused :))

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/arpruss/USBComposite_stm32f1/issues/71#issuecomment-784108713, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJE33QS2MP2KOD4RJVYT5QDTAOBPZANCNFSM4P6BXKPA .

[huseyinctlbs]

This project has no PID associated with it. I think thats what's required for the hid device to receive ffb data. … On Tue, Feb 23, 2021, 2:46 AM hüseyin varol @.***> wrote: Did you do or find something about using ffb effect with this library? I didn't end up using this library, I migrated to atmega32u4. I know there is some ffb firmware code made before with arduino leonardo which has atmega32u4. But there is no maked project with bluepill yet. I'm at noob level on coding and i want to drive a dc motor as a ffb motor with the stm32 bluepill with a motor driver but don't find any maked project for it yet. Is there any differencies on hid descriptor used on arduino and stm32? Does the same descriptor would work on both card? If it could be, can i try the arduino's code on stm32? BEcause i have tried some pre maked ffb codes on arduino before. Im very confused :)) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#71 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJE33QS2MP2KOD4RJVYT5QDTAOBPZANCNFSM4P6BXKPA .

And you saying we need a ffb compatible device's Product ID to receive ffb reports am i understand right?

[joesphan]

https://github.com/YukMingLaw/ArduinoJoystickWithFFBLibrary

I am not too sure of the internal workings myself, but i think the theory goes is unlike hid keyboard and mice, ffb devices need a good sized return data trunk. If you look at the repo above, src/dynamichid there are more files, specifically the pid descriptor.

On Tue, Feb 23, 2021, 3:04 AM hüseyin varol notifications@github.com wrote:

This project has no PID associated with it. I think thats what's required for the hid device to receive ffb data. … <#m-147512813681984871> On Tue, Feb 23, 2021, 2:46 AM hüseyin varol @.***> wrote: Did you do or find something about using ffb effect with this library? I didn't end up using this library, I migrated to atmega32u4. I know there is some ffb firmware code made before with arduino leonardo which has atmega32u4. But there is no maked project with bluepill yet. I'm at noob level on coding and i want to drive a dc motor as a ffb motor with the stm32 bluepill with a motor driver but don't find any maked project for it yet. Is there any differencies on hid descriptor used on arduino and stm32? Does the same descriptor would work on both card? If it could be, can i try the arduino's code on stm32? BEcause i have tried some pre maked ffb codes on arduino before. Im very confused :)) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#71 (comment) https://github.com/arpruss/USBComposite_stm32f1/issues/71#issuecomment-784108713>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJE33QS2MP2KOD4RJVYT5QDTAOBPZANCNFSM4P6BXKPA .

And you saying we need a ffb compatible device's Product ID to receive ffb reports am i right?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/arpruss/USBComposite_stm32f1/issues/71#issuecomment-784118928, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJE33QSZHBEC2QC6IYWH7L3TAODTLANCNFSM4P6BXKPA .

[huseyinctlbs]

Thanks for your helps. But as i said im not good at coding. Im just making some little changes on this codes to use myself. Integrating both codes eachother or making a similiar code for making ffb compatible this repo will be very complex and hard thing for me now. But i will try to find a way to make it happen. I will not give up. Thanks again.

[joesphan]

Anytime. Sorry I couldn't be of more help, loaded with coursework right now.

On Sun, Feb 28, 2021, 8:08 AM hüseyin notifications@github.com wrote:

Thanks for your helps. But as i said im not good at coding. Im just making some little changes on this codes to use myself. Integrating both codes eachother or making a similiar code for making ffb compatible this repo will be very complex and hard thing for me now. But i will try to find a way to make it happen. I will not give up. Thanks again.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/arpruss/USBComposite_stm32f1/issues/71#issuecomment-787475788, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJE33QSUHNR7UZADHZUEB33TBJTALANCNFSM4P6BXKPA .