diff --git a/docs/en/uiflow/FACES.md b/docs/en/uiflow/FACES.md index e69de29b..fc8c2e7b 100644 --- a/docs/en/uiflow/FACES.md +++ b/docs/en/uiflow/FACES.md @@ -0,0 +1,216 @@ +# Calculator +__________________________ + +#### Feature introduction + +> Enter numbers + +> + +>* __Get press string__ +Return keyboard character + +>* __Get press button int value__ +Return keyboard ASIIC value + +>* __Clear press string__ +Clear input characters + +>* __Delete press string last byte__ +Delete the last byte entered + +>* __is new button pressed__ +Press the button to return true + +#### Usage + +> The screen displays the entered number + +> + + +# Encoder +__________________________ + +#### Feature introduction + +> Read encoder value + +> + +>* __Set LED pos color__ +Set the specified LED color + +>* __Clear encode value to zero__ +Encoder value is zeroed + +>* __Get encode value__ +Return encode value + +>* __Get encode direction__ +Return to the direction of rotation + +>* __is encode pressed__ +The encoder knob is pressed back to true + +#### Usage + +> The screen displays the encoder value and press the knob to return to zero. + +> + + +# FINGER +__________________________ + +#### Feature introduction + +> Read fingerprint information + +> + +>* __get state__ +Return sensor status + +>* __get access__ +Return user rights + +>* __get id__ +Return ID + +>* __remove All__ +Remove all fingerprint information + +>* __remove faces_finger id__ +Remove specified fingerprint ID + +>* __faces_finger add user id access__ +Add fingerprint information + +>* __faces_finger read user with id access__ +Verify fingerprint successfully executed callback program + +>* __faces_finger getUnknow__ +Read unknown fingerprint information executive + +#### Usage + +> Read the fingerprint information, match the bright green light to match the bright red light + +> + + +# GameBoy +__________________________ + +#### Feature introduction + +> Read the key value of the gameboy + +> + +>* __Get is press__ +Return button status, continuous detection + +>* __Get was pressed__ +Back button status, check once + +#### Usage + +> If the up button is pressed green, the down button is pressed red. + +> + + + +# Joystick +__________________________ + +#### Feature introduction + +> Return to joystick data + +> + +>* __Get X value__ +Return X-axis direction data + +>* __Get Y value__ +Return Y-axis direction data + +>* __Is pressed__ +Press the button to return true + +>* __Get reverse X value__ +Return X-axis reverse data + +>* __Get reverse Y value__ +Return y-axis reverse data + +>* __Set LED pos color__ +Set the color of the specified location LED + +#### Usage + +> The screen displays the joystick data + +> + + +# KeyBoard +__________________________ + +#### Feature introduction + +> Return keyboard key data + +> + +>* __Get press string__ +Return button character + +>* __Clear press string__ +Clear input characters + +>* __Delete press string last byte__ +Delete the last byte entered + +>* __Get press button int value__ +Return button ASIIC value + +>* __Is new button pressed__ +If the button is pressed back to true + +#### Usage + +> The screen displays the characters entered + +> + + +# RFID +__________________________ + +#### Feature introduction + +> Return RFID card data + +> + +>* __read string from addr__ +Read data from the specified address + +>* __write to addr__ +Write data to address + +>* __card near__ +If the RFID card is close to returning true + +>* __card uid__ +Return RFID card UID + +#### Usage + +> Screen displays RFID card data + +> \ No newline at end of file diff --git a/docs/en/uiflow/Modules.md b/docs/en/uiflow/Modules.md index e69de29b..4a9e6edb 100644 --- a/docs/en/uiflow/Modules.md +++ b/docs/en/uiflow/Modules.md @@ -0,0 +1,181 @@ +# LidarBOT +__________________________ + +#### Feature introduction + +> Radar scan navigation car, control walking and lighting, display map + +> + +>* __Lidarbot set with neopixel__ +Set the radar car led color + +>* __Lidarbot set number with neopixel__ +Set the led color separately + +>* __Lidarbot Seed(0±7)__ +Set walking direction and speed + +>* __Lidarbot set Motor Speed X(-7~7) Y(-7~7) Z(-7~7) A(-7~7)__ +Set the motor speed and direction in the X and Y directions + +>* __Lidarbot set Servo angle__ +Set the steering angle + +>* __Lidarbot X axis speed(0±7）Y axis speed (0±7)__ +Set the X and Y axis directions + +>* __Lidarbot Draw Map__ +Drawing a radar map + +>* __Lidarbot Get Distance__ +Read the specified angle obstacle distance + +#### Usage + +> The car goes forward at 3 speeds for 5 seconds. + +> + + +# STEPMOTOR +__________________________ + +#### Feature introduction + +> Stepper motor control + +> + +>* __Motor Address__ +Module's I2C address + +>* __Motor X Y Z Speed__ +Set the stepping motor X-axis Y-axis Z-axis rotation steps and speed + +>* __Put g code__ +Run G code + +>* __Set mode__ +Set the motor operating mode, distance mode or relative value mode + +>* __lock motor__ +Lock motor + +>* __unlock motor__ +Unlock motor + + +#### Usage + +> Motor is running alternately in reverse + +> + + +# SERVO +__________________________ + +#### Feature introduction + +> Steering gear control + +> + +>* __Set servo rotate__ +Set the specified servo angle + +>* __Set servo write us__ +Set the servo pulse time + +#### Usage + +> Control the 0-5 steering gear to rotate 90 degrees + +> + + +# Bala Motor +__________________________ + +#### Feature introduction + +> Control Bala coded motor operation + +> + +>* __set rotate speed__ +Set the motor rotation direction and speed + +>* __Run Speed__ +Set a certain number of pulses to travel in a running direction at a certain speed + +>* __Go To Position MaxSpeed__ +Run 500 pulses at the set speed + +>* __Stop__ +Motor stop + +>* __Read encode__ +Read encoder value + + +#### Usage + +> A button presses forward 500 pulses at a speed of 255 + +> + + +# LEGO+ +__________________________ + +#### Feature introduction + +> Control lego code motor operation + +> + +>* __Set rotate pwm__ +Set motor direction and speed + +>* __Stop__ +Motor stop + +>* __Clear encode__ +Encoder clear + +>* __Read encode__ +Read encoder data + + +#### Usage + +> + +> + + +# PM2.5 +__________________________ + +#### Feature introduction + +> Dust particle detection, output concentration or quantity + +> + +>* __PM2.5 get value in__ +Set the detection particle diameter and detection mode, return the detection result SPM is the standard particle concentration value APM is the atmospheric environment particle concentration value + +>* __PM2.5 get particles above um number__ +Returns the amount of particulate matter in the specified diameter + + +#### Usage + +> The screen shows the amount of PM2.5 particles + +> + + diff --git a/docs/image/FACES/Calculator.png b/docs/image/FACES/Calculator.png new file mode 100644 index 00000000..d61bc500 Binary files /dev/null and b/docs/image/FACES/Calculator.png differ diff --git a/docs/image/FACES/Calculator_user.gif b/docs/image/FACES/Calculator_user.gif new file mode 100644 index 00000000..e96fb93d Binary files /dev/null and b/docs/image/FACES/Calculator_user.gif differ diff --git a/docs/image/FACES/Encoder.png b/docs/image/FACES/Encoder.png new file mode 100644 index 00000000..92961052 Binary files /dev/null and b/docs/image/FACES/Encoder.png differ diff --git a/docs/image/FACES/Encoder_user.gif b/docs/image/FACES/Encoder_user.gif new file mode 100644 index 00000000..161af352 Binary files /dev/null and b/docs/image/FACES/Encoder_user.gif differ diff --git a/docs/image/FACES/FINGER.png b/docs/image/FACES/FINGER.png new file mode 100644 index 00000000..ec8ae30b Binary files /dev/null and b/docs/image/FACES/FINGER.png differ diff --git a/docs/image/FACES/FINGER_user.gif b/docs/image/FACES/FINGER_user.gif new file mode 100644 index 00000000..19f97111 Binary files /dev/null and b/docs/image/FACES/FINGER_user.gif differ diff --git a/docs/image/FACES/GameBoy.png b/docs/image/FACES/GameBoy.png new file mode 100644 index 00000000..bad32545 Binary files /dev/null and b/docs/image/FACES/GameBoy.png differ diff --git a/docs/image/FACES/GameBoy_user.gif b/docs/image/FACES/GameBoy_user.gif new file mode 100644 index 00000000..f41bab13 Binary files /dev/null and b/docs/image/FACES/GameBoy_user.gif differ diff --git a/docs/image/FACES/Joystick.png b/docs/image/FACES/Joystick.png new file mode 100644 index 00000000..089c4ab4 Binary files /dev/null and b/docs/image/FACES/Joystick.png differ diff --git a/docs/image/FACES/Joystick_user.gif b/docs/image/FACES/Joystick_user.gif new file mode 100644 index 00000000..3aa0f1d8 Binary files /dev/null and b/docs/image/FACES/Joystick_user.gif differ diff --git a/docs/image/FACES/KeyBoard.png b/docs/image/FACES/KeyBoard.png new file mode 100644 index 00000000..224125bf Binary files /dev/null and b/docs/image/FACES/KeyBoard.png differ diff --git a/docs/image/FACES/KeyBoard_user.gif b/docs/image/FACES/KeyBoard_user.gif new file mode 100644 index 00000000..9e4781fb Binary files /dev/null and b/docs/image/FACES/KeyBoard_user.gif differ diff --git a/docs/image/FACES/RFID.png b/docs/image/FACES/RFID.png new file mode 100644 index 00000000..7fd6c35c Binary files /dev/null and b/docs/image/FACES/RFID.png differ diff --git a/docs/image/FACES/RFID_user.gif b/docs/image/FACES/RFID_user.gif new file mode 100644 index 00000000..f2120d05 Binary files /dev/null and b/docs/image/FACES/RFID_user.gif differ diff --git a/docs/image/Modules/BALA.png b/docs/image/Modules/BALA.png new file mode 100644 index 00000000..2b678094 Binary files /dev/null and b/docs/image/Modules/BALA.png differ diff --git a/docs/image/Modules/BALA_user.gif b/docs/image/Modules/BALA_user.gif new file mode 100644 index 00000000..746e791f Binary files /dev/null and b/docs/image/Modules/BALA_user.gif differ diff --git a/docs/image/Modules/Bala Motor.png b/docs/image/Modules/Bala Motor.png new file mode 100644 index 00000000..cbedd36b Binary files /dev/null and b/docs/image/Modules/Bala Motor.png differ diff --git a/docs/image/Modules/Bala Motor_user.gif b/docs/image/Modules/Bala Motor_user.gif new file mode 100644 index 00000000..ab752c93 Binary files /dev/null and b/docs/image/Modules/Bala Motor_user.gif differ diff --git a/docs/image/Modules/LEGO+.png b/docs/image/Modules/LEGO+.png new file mode 100644 index 00000000..f9ad8a5e Binary files /dev/null and b/docs/image/Modules/LEGO+.png differ diff --git a/docs/image/Modules/LEGO+_user.gif b/docs/image/Modules/LEGO+_user.gif new file mode 100644 index 00000000..511c872b Binary files /dev/null and b/docs/image/Modules/LEGO+_user.gif differ diff --git a/docs/image/Modules/LidarBOT.png b/docs/image/Modules/LidarBOT.png new file mode 100644 index 00000000..42c3091c Binary files /dev/null and b/docs/image/Modules/LidarBOT.png differ diff --git a/docs/image/Modules/LoRaWAN.png b/docs/image/Modules/LoRaWAN.png new file mode 100644 index 00000000..77511a36 Binary files /dev/null and b/docs/image/Modules/LoRaWAN.png differ diff --git a/docs/image/Modules/PM2.5.png b/docs/image/Modules/PM2.5.png new file mode 100644 index 00000000..5f5fd6d7 Binary files /dev/null and b/docs/image/Modules/PM2.5.png differ diff --git a/docs/image/Modules/SERVO.png b/docs/image/Modules/SERVO.png new file mode 100644 index 00000000..a166c826 Binary files /dev/null and b/docs/image/Modules/SERVO.png differ diff --git a/docs/image/Modules/SERVO_user.gif b/docs/image/Modules/SERVO_user.gif new file mode 100644 index 00000000..b5c4013e Binary files /dev/null and b/docs/image/Modules/SERVO_user.gif differ diff --git a/docs/image/Modules/STEPMOTOR.png b/docs/image/Modules/STEPMOTOR.png new file mode 100644 index 00000000..7e4b1040 Binary files /dev/null and b/docs/image/Modules/STEPMOTOR.png differ diff --git a/docs/image/Modules/STEPMOTOR_user.gif b/docs/image/Modules/STEPMOTOR_user.gif new file mode 100644 index 00000000..c1a86649 Binary files /dev/null and b/docs/image/Modules/STEPMOTOR_user.gif differ diff --git a/docs/zh_CN/uiflow/FACES.md b/docs/zh_CN/uiflow/FACES.md index e69de29b..a542dcb0 100644 --- a/docs/zh_CN/uiflow/FACES.md +++ b/docs/zh_CN/uiflow/FACES.md @@ -0,0 +1,215 @@ +# Calculator +__________________________ + +#### 功能说明 + +> 数字输入 + +> + +>* __Get press string__ +返回键盘字符 + +>* __Get press button int value__ +返回键盘ASIIC值 + +>* __Clear press string__ +清空输入字符 + +>* __Delete press string last byte__ +删除最后输入的字节 + +>* __is new button pressed__ +按键按下返回真 + +#### Usage + +> 屏幕显示输入的数字 + +> + + +# Encoder +__________________________ + +#### 功能说明 + +> 读取编码器数值 + +> + +>* __Set LED pos color__ +设置指定的LED颜色 + +>* __Clear encode value to zero__ +编码器数值归零 + +>* __Get encode value__ +返回编码值 + +>* __Get encode direction__ +返回旋转方向 + +>* __is encode pressed__ +编码器旋钮被按下返回真 + +#### Usage + +> 屏幕显示编码器数值,按下旋钮归零 + +> + + +# FINGER +__________________________ + +#### 功能说明 + +> 读取指纹信息 + +> + +>* __get state__ +返回传感器状态 + +>* __get access__ +返回用户权限 + +>* __get id__ +返回ID + +>* __remove All__ +移除所有指纹信息 + +>* __remove faces_finger id__ +移除指定指纹ID + +>* __faces_finger add user id access__ +添加指纹信息 + +>* __faces_finger read user with id access__ +验证指纹成功执行程序 + +>* __faces_finger getUnknow__ +读取未知指纹信息执行程序 + +#### Usage + +> 读取指纹信息，匹配亮绿灯不来匹配亮红灯 + +> + + +# GameBoy +__________________________ + +#### 功能说明 + +> 读取游戏键盘的键值 + +> + +>* __Get is press__ +返回按键状态，持续检测 + +>* __Get was pressed__ +返回按键状态，检测一次 + +#### Usage + +> 如果上键按下亮绿灯，下键按下亮红灯 + +> + + +# Joystick +__________________________ + +#### 功能说明 + +> 返回摇杆数据 + +> + +>* __Get X value__ +返回X轴方向数据 + +>* __Get Y value__ +返回Y轴方向数据 + +>* __Is pressed__ +按键按下返回真 + +>* __Get reverse X value__ +返回X轴反向数据 + +>* __Get reverse Y value__ +返回Y轴反向数据 + +>* __Set LED pos color__ +设置指定位置LED的颜色 + +#### Usage + +> 屏幕显示摇杆数据 + +> + + +# KeyBoard +__________________________ + +#### 功能说明 + +> 返回键盘按键数据 + +> + +>* __Get press string__ +返回按键字符 + +>* __Clear press string__ +清除输入字符 + +>* __Delete press string last byte__ +删除最后输入的字节 + +>* __Get press button int value__ +返回按键ASIIC值 + +>* __Is new button pressed__ +如果按键按下返回真 + +#### Usage + +> 屏幕显示输入的字符 + +> + + +# RFID +__________________________ + +#### 功能说明 + +> 返回RFID卡数据 + +> + +>* __read string from addr__ +从指定地址读取数据 + +>* __write to addr__ +向地址写数据 + +>* __card near__ +发现RFID卡靠近返回真 + +>* __card uid__ +返回RFID卡UID + +#### Usage + +> 屏幕显示RFID卡数据 + +> \ No newline at end of file diff --git a/docs/zh_CN/uiflow/Modules.md b/docs/zh_CN/uiflow/Modules.md index ee769953..8b20d4dc 100644 --- a/docs/zh_CN/uiflow/Modules.md +++ b/docs/zh_CN/uiflow/Modules.md @@ -33,7 +33,7 @@ __________________________ #### 使用方法 -> 小车左右平移 +> 小车以3的速度向前走5秒停止 > @@ -70,42 +70,29 @@ Module的I2C地址 >电机正反转交替运行 -> +> -# STEPMOTOR +# SERVO __________________________ #### 功能说明 -> 步进电机控制 +> 舵机控制 -> +> ->* __Motor Address__ -Module的I2C地址 - ->* __Motor X Y Z Speed__ -设置步进电机X轴Y轴Z轴转动步数和速度 - ->* __Put g code__ -运行G代码 - ->* __Set mode__ -设置电机运行模式，距离模式或相对值模式 - ->* __lock motor__ -锁定电机 - ->* __unlock motor__ -解锁电机 +>* __Set servo rotate__ +设置指定舵机角度 +>* __Set servo write us__ +设置舵机脉冲时间 #### 使用方法 ->电机正反转交替运行 +>控制0-5号舵机旋转90度 -> +> # Bala Motor @@ -169,5 +156,26 @@ __________________________ > +# PM2.5 +__________________________ + +#### 功能说明 + +> 灰尘颗粒物检测,输出浓度或数量 + +> + +>* __PM2.5 get value in__ +设置检测颗粒物直径与检测模式，返回检测结果 SPM为标准颗粒物浓度值 APM为大气环境颗粒物浓度值 + +>* __PM2.5 get particles above um number__ +返回指定直径的颗粒物含有数量 + + +#### 使用方法 + +> 屏幕显示PM2.5颗粒物数量 + +>