update readme.md and readme.zh.md

Author: YukMingLaw

Readme.md

@@ -2,10 +2,13 @@
 
 ## Statement
 
-### This is a joy library for Atmega32UX chip with force feedback, which can be used to make game handle with vibration, game steering wheel with force feedback, etc. (equipment requiring multi axis force feedback, such as flight rocker, is not supported temporarily, and will be updated later,maybe this week).
+### This is a joy library for Atmega32UX chip with force feedback, which can be used to make game handle with vibration, game steering wheel with force feedback, etc.Multi-axis-force-feedback feature is added.
 
 
 ## Usage
+
+### 0. example：`examples/JoystickWithFFB/JoystickWithFFB.ino`
+
 ### 1. create `JoyStick` object
 
 | params            | describe                                     |
@@ -94,13 +97,17 @@
 
 ### 4.Finally,get the force value with
 
-`JoyStick.getForce()`
+`JoyStick.getForce(int32_t* forces)`
 
-return type `int32`
+params `int32_t* forces` is an `int32` array of length 2
 
-range`[-255,255]`
+`forces[0]` is the X-Axis force data
 
-only one axis is supported；
+`forces[1]` is the Y-Axis force data
+
+return type `void`
+
+range`[-255,255]`
 
 ## Ref
 

Readme.zh.md

@@ -2,10 +2,13 @@
 
 ## 声明
 
-### 这是一个适用于Atmega32UX芯片带力反馈的Joystick库，可用于制作带震动的游戏手柄、带力反馈的游戏方向盘等（飞行摇杆等需要多轴力反馈的设备暂时不支持，后续更新）。
+### 这是一个适用于Atmega32UX芯片带力反馈的Joystick库，可用于制作带震动的游戏手柄、带力反馈的游戏方向盘等。支持两轴力反馈。
 
 
 ## 用法
+
+### 0.例程：`examples/JoystickWithFFB/JoystickWithFFB.ino`
+
 ### 1. 创建JoyStick对象
 
 | 参数表          | 描述                                     |
@@ -96,7 +99,9 @@
 #### 8）设置摩擦力最大位置差参数
 ` JoyStick.setFrictionMaxPositionChange(int32_t value)；`
 
-### 4.通过：`JoyStick.getForce()`获取计算好的力，返回值范围`[-255,255]`,目前仅支持单轴；
+### 4.通过：`JoyStick.getForce(int32_t* forces)`获取计算好的力
+
+#### 传入参数为一个长度为2的int32_t数组，输出范围`[-255,255]`；
 
 ## 引用
 

examples/JoystickWithFFB/JoystickWithFFB.ino

@@ -1,4 +1,7 @@
 #include "Joystick.h"
+
+int32_t forces[2] = { 0 };
+
 Joystick_ Joystick(JOYSTICK_DEFAULT_REPORT_ID,JOYSTICK_TYPE_JOYSTICK,
   8, 0,                  // Button Count, Hat Switch Count
   true, true, false,     // X and Y, but no Z Axis
@@ -29,6 +32,9 @@ void loop(){
   Joystick.setSpringPosition(0);
   Joystick.setSpringMaxPosition(180);
   //Get Force [-255,255] you can set PWM with this value
-  int32_t force = Joystick.getForce();
-  Serial.println(force);
+  Joystick.getForce(forces);
+  Serial.print("XF: ");
+  Serial.print(forces[0]);
+  Serial.print("  YF: ");
+  Serial.println(forces[1]);
 }

src/Joystick.cpp

@@ -750,7 +750,7 @@ void Joystick_::ApplyDirection(volatile TEffectState& effect, int32_t force, int
 	{
 		float angle = (directionX * 360.0 / 255.0) * DEG_TO_RAD;
 		forces[0] += (int32_t)(sin(angle) * force);
-		forces[1] += (int32_t)(cos(angle) * force);
+		forces[1] += (int32_t)(-1 * cos(angle) * force);
 	}
 	else
 	{
@@ -762,7 +762,7 @@ void Joystick_::ApplyDirection(volatile TEffectState& effect, int32_t force, int
 		if (effect.enableAxis & Y_AXIS_ENABLE)
 		{
 			float angle = (directionY * 360.0 / 255.0) * DEG_TO_RAD;
-			forces[1] += (int32_t)(cos(angle) * force);
+			forces[1] += (int32_t)(-1 * cos(angle) * force);
 		}
 	}
 }