diff --git a/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_01.jpg b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_01.jpg new file mode 100644 index 00000000..966ff2f8 Binary files /dev/null and b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_01.jpg differ diff --git a/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_02.jpg b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_02.jpg new file mode 100644 index 00000000..4a51b9b4 Binary files /dev/null and b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_02.jpg differ diff --git a/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_03.jpg b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_03.jpg new file mode 100644 index 00000000..a98c76c1 Binary files /dev/null and b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_03.jpg differ diff --git a/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_04.jpg b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_04.jpg new file mode 100644 index 00000000..574a8f84 Binary files /dev/null and b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_04.jpg differ diff --git a/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_05.jpg b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_05.jpg new file mode 100644 index 00000000..fe9cfce5 Binary files /dev/null and b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_05.jpg differ diff --git a/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_06.jpg b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_06.jpg new file mode 100644 index 00000000..40ffd901 Binary files /dev/null and b/docs/assets/img/product_pics/hat/joystick_hat/joystick_hat_06.jpg differ diff --git a/docs/en/hat/hat-beetlec.md b/docs/en/hat/hat-beetlec.md index 3c70f364..25f31efe 100644 --- a/docs/en/hat/hat-beetlec.md +++ b/docs/en/hat/hat-beetlec.md @@ -6,8 +6,6 @@ :memo:**[Description](#Description)**    **[EasyLoader](#EasyLoader)**    🛒**[Purchase](https://m5stack.com/products/beetlec-w-o-m5stickc)** - - ## Description Ever wanted to build your robotic car with tiny body and smooth control? Here comes the BeatleC, features a dual-driver and 7 RGB LEDs, extreme concise design and together with M5StickC (features ESP32-Based Wi-Fi control), makes it the handiest and full-function small robotic car ever. diff --git a/docs/en/hat/hat-joystick.md b/docs/en/hat/hat-joystick.md index 2bc09a26..4047ce69 100644 --- a/docs/en/hat/hat-joystick.md +++ b/docs/en/hat/hat-joystick.md @@ -1,27 +1,27 @@ # Joystick HAT {docsify-ignore-all} - + *** - -:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      :octocat:**[Code](#Code)**      **[EasyLoader](#EasyLoader)**       🛒**[Purchase](https://m5stack.com/products/m5stickc-neofalsh-hat)** + ## Description -**Joystick HAT** is a joystick module designed for M5SticKC. It is embedded with STM32F030F4 main control chip and uses I2C communication protocol to transmit data with host M5StickC. +**Joystick HAT** is one of the HAT module that is specifically designed for M5StickC. We have used a STM32F030F4 microprocessor inside to implement I2C communication with M5StickC. -This mini-volume joystick module supports full angular offset and center press, and outputs angular offset data as well as switching digital signals. +This mini-volume joystick module supports full angular movement and center press, and outputs angular data as well as button digital signals. -With the HAT series unified plug-in design and M5StickC reliable connection, in the most streamlined way, get more human-computer interaction input experience. +With the 'HAT' unified plug-in design it can provide reliable connection, in the most streamlined way. which allowes to get more HMI experience. - + ## Product Features -- onbuild STM32F030F4 +- STM32F030F4 inside - communication protocol: I2C (address: 0x38) -- support full range offset / center button +- support omni-directional movement/button press ## Weight & Dimension @@ -32,55 +32,57 @@ With the HAT series unified plug-in design and M5StickC reliable connection, in - 1x Joystick HAT + + ## Application -- Game Controller -- Wireless joystick device +- Game Handle +- Wireless Joystick Device ## Communication protocol I2C address: 0x38 -register: +Register: 0x01 Read only 4 bytes, single axis value 0 ~ 4096 -`0: x-axis raw data lower 8 bits` +`0: low 8 bits of raw data on X-axis` -`1: x-axis raw data is high 8 bits` +`1: high 8 bits of raw data on X-axis` -`2: y-axis raw data lower 8 bits` +`2: low 8 bits of raw data on Y-axis` -`3: y-axis raw data high 8 bits` +`3: high 8 bits of raw data on Y-axis` -0x02 Read only 3 bytes +0x02 only read 3 bytes -`0: Data after x-axis conversion ( -127 ~ 127)` +`0: x-axis data after transform ( -127 ~ 127)` -`1: Data after y-axis conversion (-127 ~ 127)` +`1: y-axis data after transform ( -127 ~ 127)` -`2: 0 or 1 (button pressed to 0, loosened to 1). +`2: 0 or 1 (press down 0, release 1). -0x03 write only 1 bytes +0x03 only write 1 bytes `0x00: Normal mode` -`0x01: Center point zero` +`0x01: Central spot set 0` -`0x02: Maximum calibration (need to manually rotate the joystick to get the maximum value).` +`0x02: Maximum Calibration (Require manually rotate the joystick to get the maximum value).` -`0x03: Save the center point and maximum data to flash, and restore to normal mode after saving.` +`0x03: Save central spot and Maximum Calibration value to flash, and go to Normal Mode after finish.` -## Schematic + ## EasyLoader - + >1.EasyLoader is a simple and fast program burner. Every product page in EasyLoader provides a product-related case program. It can be burned to the master through simple steps, and a series of function verification can be performed.(**Currently EasyLoader is only available for Windows OS**) @@ -89,19 +91,19 @@ register: ## Code -- **[Arduino](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/neoflash-hat/Arduino)** +- **[Arduino](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/hat-joystick/Arduino/Joystick_hat)** ## Pin Map - +
M5StickCGPIO0GPIO263.3VGND
Joystick HATSCLSDA3.3VGND
Joystick HATSDASCL3.3VGND
## Video \ No newline at end of file diff --git a/docs/en/hat/hat-yun.md b/docs/en/hat/hat-yun.md index f1b3cad2..5f3a2acb 100644 --- a/docs/en/hat/hat-yun.md +++ b/docs/en/hat/hat-yun.md @@ -82,8 +82,8 @@ One hook hole and two 6*4mm magnet mounting positions are reserved on the board, ### Pin Map - - + +
M5StickCGND5V OUTGPIO26GPIO36GPIO0BAT3V35V IN
YUN HATGND+5VSCL/SDABAT+3.3V+5V IN
M5StickCGND5V OUTGPIO26GPIO0GPIO36BAT3V35V IN
YUN HATGND+5VSCLSDA/BAT+3.3V+5V IN
## Video diff --git a/docs/index.md b/docs/index.md index 2a2d12b0..9b1d9585 100644 --- a/docs/index.md +++ b/docs/index.md @@ -747,6 +747,32 @@ +**LED class** + + +
+ + +

RGB LED

+
+
+ + +
+ + +

HEX

+
+
+ + +
+ + +

RGB

+
+
+ **C-HAT class** @@ -850,31 +876,14 @@ -**LED class** - -
- - -

RGB LED

-
+ + +

Joystick

+
-
- - -

HEX

-
-
- - -
- - -

RGB

-
-
*** diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index baa4baf0..4b6a6e8a 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -747,6 +747,32 @@ +**LED类** + + + +
+ + +

RGB LED

+
+
+ +
+ + +

HEX

+
+
+ + +
+ + +

RGB

+
+
+ **C-HAT 类** @@ -853,32 +879,15 @@ - -**LED类** - - -
- - -

RGB LED

-
-
- -
- - -

HEX

-
+ + +

Joystick

+
-
- - -

RGB

-
-
+ *** diff --git a/docs/zh_CN/hat/hat-env.md b/docs/zh_CN/hat/hat-env.md index 1beccacd..6df5f285 100644 --- a/docs/zh_CN/hat/hat-env.md +++ b/docs/zh_CN/hat/hat-env.md @@ -70,5 +70,5 @@ - +
M5StickCGPIO0GPIO263.3VGND
HAT ENVSCLSDA3.3VGND
HAT ENVSDASCL3.3VGND
diff --git a/docs/zh_CN/hat/hat-joystick.md b/docs/zh_CN/hat/hat-joystick.md index 4f7ffaf1..1105454b 100644 --- a/docs/zh_CN/hat/hat-joystick.md +++ b/docs/zh_CN/hat/hat-joystick.md @@ -1,11 +1,10 @@ # Joystick HAT {docsify-ignore-all} - - + *** -:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      :octocat:**[Code](#Code)**      **[EasyLoader](#EasyLoader)**       🛒**[购买链接](https://m5stack.com/products/m5stickc-neofalsh-hat)** - + ## 描述 @@ -16,8 +15,7 @@ 采用HAT系列统一的插接式设计与M5StickC可靠连接,用最精简的方式,获得更多人机交互输入体验. - - + ## 产品特性 @@ -34,6 +32,8 @@ - 1x Joystick HAT + + ## 应用 - 游戏控制器 @@ -73,15 +73,15 @@ `0x03: 保存中心点及最大值数据至flash, 保存后恢复至普通模式 ` -## 原理图 + ## EasyLoader - + >1.EasyLoader是一个简洁快速的程序烧录器,每一个产品页面里的EasyLoader都提供了一个与产品相关的案例程序,通过简单步骤将其烧录至主控,能够进行一系列的功能验证.**(目前EasyLoader仅适用于Windows操作系统)** @@ -90,19 +90,19 @@ ## Code -- **[Arduino](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/neoflash-hat/Arduino)** +- **[Arduino](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/hat-joystick/Arduino/Joystick_hat)** ## 管脚映射 - +
M5StickCGPIO0GPIO263.3VGND
Joystick HATSCLSDA3.3VGND
Joystick HATSDASCL3.3VGND
## 相关视频 \ No newline at end of file diff --git a/docs/zh_CN/hat/hat-yun.md b/docs/zh_CN/hat/hat-yun.md index 32e3c5cb..851c0d72 100644 --- a/docs/zh_CN/hat/hat-yun.md +++ b/docs/zh_CN/hat/hat-yun.md @@ -78,8 +78,8 @@ ### 管脚映射 - - + +
M5StickCGND5V OUTGPIO26GPIO36GPIO0BAT3V35V IN
YUN HATGND+5VSCL/SDABAT+3.3V+5V IN
M5StickCGND5V OUTGPIO26GPIO0GPIO36BAT3V35V IN
YUN HATGND+5VSCLSDA/BAT+3.3V+5V IN