mirror of
https://github.com/m5stack/m5-docs.git
synced 2026-05-20 10:23:01 -07:00
Correct some content syntax errors
This commit is contained in:
Gitshaoxiang
+15
-15
@@ -2,7 +2,7 @@
|
||||
|
||||
#### Feature introduction
|
||||
|
||||
> Enter numbers
|
||||
>Input numbers
|
||||
|
||||
><img src="/image/FACES/Calculator.png" width="40%">
|
||||
|
||||
@@ -40,16 +40,16 @@ Press the button to return true
|
||||
Set the specified LED color
|
||||
|
||||
* __Clear encode value to zero__
|
||||
Encoder value is zeroed
|
||||
Encoder value becomes zero
|
||||
|
||||
* __Get encode value__
|
||||
Return encode value
|
||||
|
||||
* __Get encode direction__
|
||||
Return to the direction of rotation
|
||||
Return the direction of rotation
|
||||
|
||||
* __is encode pressed__
|
||||
The encoder knob is pressed back to true
|
||||
Return True when the encoder knob is pressed
|
||||
|
||||
#### Usage
|
||||
|
||||
@@ -85,14 +85,14 @@ Remove specified fingerprint ID
|
||||
Add fingerprint information
|
||||
|
||||
* __faces_finger read user with id access__
|
||||
Verify fingerprint successfully executed callback program
|
||||
Verify fingerprint successfully executed program
|
||||
|
||||
* __faces_finger getUnknow__
|
||||
Read unknown fingerprint information executive
|
||||
Read unknown fingerprint information execution program
|
||||
|
||||
#### Usage
|
||||
|
||||
> Read the fingerprint information, match the bright green light to match the bright red light
|
||||
>Read the fingerprint information, the light turns green if it matches. Otherwise the light turns red.
|
||||
|
||||
><img src="/image/FACES/FINGER_user.gif" width="50%">
|
||||
|
||||
@@ -109,11 +109,11 @@ Read unknown fingerprint information executive
|
||||
Return button status, continuous detection
|
||||
|
||||
* __Get was pressed__
|
||||
Back button status, check once
|
||||
Return button status, check once
|
||||
|
||||
#### Usage
|
||||
|
||||
> If the up button is pressed green, the down button is pressed red.
|
||||
>If the up button is pressed, light turns green. If the down button is pressed, light turns red.
|
||||
|
||||
><img src="/image/FACES/GameBoy_user.gif" width="50%">
|
||||
|
||||
@@ -123,7 +123,7 @@ Back button status, check once
|
||||
|
||||
#### Feature introduction
|
||||
|
||||
> Return to joystick data
|
||||
> Return joystick data
|
||||
|
||||
><img src="/image/FACES/Joystick.png" width="40%">
|
||||
|
||||
@@ -134,7 +134,7 @@ Return X-axis direction data
|
||||
Return Y-axis direction data
|
||||
|
||||
* __Is pressed__
|
||||
Press the button to return true
|
||||
Return True when the button is pressed
|
||||
|
||||
* __Get reverse X value__
|
||||
Return X-axis reverse data
|
||||
@@ -143,7 +143,7 @@ Return X-axis reverse data
|
||||
Return y-axis reverse data
|
||||
|
||||
* __Set LED pos color__
|
||||
Set the color of the specified location LED
|
||||
Set the color of the LED in specified place
|
||||
|
||||
#### Usage
|
||||
|
||||
@@ -173,11 +173,11 @@ Delete the last byte entered
|
||||
Return button ASIIC value
|
||||
|
||||
* __Is new button pressed__
|
||||
If the button is pressed back to true
|
||||
Return true if the button is pressed
|
||||
|
||||
#### Usage
|
||||
|
||||
> The screen displays the characters entered
|
||||
> The screen displays the input number
|
||||
|
||||
><img src="/image/FACES/KeyBoard_user.gif" width="50%">
|
||||
|
||||
@@ -197,7 +197,7 @@ Read data from the specified address
|
||||
Write data to address
|
||||
|
||||
* __card near__
|
||||
If the RFID card is close to returning true
|
||||
Return true if the RFID card is close
|
||||
|
||||
* __card uid__
|
||||
Return RFID card UID
|
||||
|
||||
+12
-11
@@ -2,7 +2,7 @@
|
||||
|
||||
#### Feature introduction
|
||||
|
||||
> Radar scan navigation car, control walking and lighting, display map
|
||||
> Radar scan navigation car，which can control light，walking and display map
|
||||
|
||||
><img src="/image/Modules/LidarBOT.png" width="50%">
|
||||
|
||||
@@ -55,7 +55,7 @@ Set the stepping motor X-axis Y-axis Z-axis rotation steps and speed
|
||||
Run G code
|
||||
|
||||
* __Set mode__
|
||||
Set the motor operating mode, distance mode or relative value mode
|
||||
Set the motor into operating mode, distance mode or relative value mode
|
||||
|
||||
* __lock motor__
|
||||
Lock motor
|
||||
@@ -96,7 +96,7 @@ Set the servo pulse time
|
||||
|
||||
#### Feature introduction
|
||||
|
||||
> Control Bala coded motor operation
|
||||
> Control the operation of Bala coded motor
|
||||
|
||||
><img src="/image/Modules/Bala Motor.png" width="40%">
|
||||
|
||||
@@ -118,7 +118,7 @@ Read encoder value
|
||||
|
||||
#### Usage
|
||||
|
||||
> A button presses forward 500 pulses at a speed of 255
|
||||
> Press button A and it will move forward 500 pulses at a speed of 255
|
||||
|
||||
><img src="/image/Modules/Bala Motor_user.gif" width="70%">
|
||||
|
||||
@@ -127,7 +127,7 @@ Read encoder value
|
||||
|
||||
#### Feature introduction
|
||||
|
||||
> Control Bala operation
|
||||
> Control the operation of Bala
|
||||
|
||||
><img src="/image/Modules/BALA.png" width="40%">
|
||||
|
||||
@@ -135,7 +135,7 @@ Read encoder value
|
||||
Set the motor rotation direction and speed
|
||||
|
||||
* __Turn__
|
||||
Set the number of turn pulses
|
||||
Set the number of turning pulses
|
||||
|
||||
* __Rotate to__
|
||||
Set the turning degree
|
||||
@@ -151,7 +151,7 @@ Auto balance
|
||||
|
||||
#### Feature introduction
|
||||
|
||||
> Bala advances 500 pulse turns 45 degrees
|
||||
>Bala will turn 45 degree in advancing every 500 pulses
|
||||
|
||||
><img src="/image/Modules/BALA_user.gif" width="70%">
|
||||
|
||||
@@ -160,7 +160,7 @@ Auto balance
|
||||
|
||||
#### Feature introduction
|
||||
|
||||
> Control lego code motor operation
|
||||
>Control the operation of lego code motor
|
||||
|
||||
><img src="/image/Modules/LEGO+.png" width="40%">
|
||||
|
||||
@@ -178,7 +178,7 @@ Read encoder data
|
||||
|
||||
#### Usage
|
||||
|
||||
> Set the motor to stop for 5 seconds
|
||||
>Set the motor to stop after running for 5 seconds
|
||||
|
||||
><img src="/image/Modules/LEGO+_user.gif" width="70%">
|
||||
|
||||
@@ -192,10 +192,11 @@ Read encoder data
|
||||
><img src="/image/Modules/PM2.5.png" width="40%">
|
||||
|
||||
* __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
|
||||
Set the mode into particle diameter detecting and checking, return the detection result - SPM is the standard particle concentration value while 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
|
||||
Return the amount of particulate matter in the specified diameter
|
||||
|
||||
|
||||
#### Usage
|
||||
|
||||
@@ -86,7 +86,7 @@ Set the pattern on HEX and customize the color
|
||||
Return data on the X axis
|
||||
|
||||
* __Get Y__
|
||||
Return data for the Y axis
|
||||
Return data from the Y axis
|
||||
|
||||
* __Get is pressed__
|
||||
Return the value of the button
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
#### Function Description
|
||||
|
||||
>Remote control via device such as mobile phone or computer M5GO
|
||||
>Remote control M5GO via devices such as mobile phone or computer
|
||||
|
||||
><img src="/image/Remote/Remote.jpg" width="50%">
|
||||
|
||||
@@ -39,7 +39,7 @@ Display information, you can choose some built-in label types, or enter custom t
|
||||
|
||||
#### Function Description
|
||||
|
||||
> In addition to the remote control features that are consistent with Remote, Remote-Beta provides a more powerful data panel function. Currently supports two data chart styles of polyline/column, the layout style of the page can be freely adjusted, and will be based on The user API Key is saved to achieve the persistence of the layout style.
|
||||
> In addition to the remote control features that are consistent with Remote, Remote-Beta provides a more powerful data panel function. Currently it supports two data chart styles of polyline/column, the layout style of the page can be freely adjusted, and will be based on the user API Key to save and achieve the persistence of the layout style.
|
||||
|
||||
><img src="image\Remote_beta\remote_beta_01.jpg" width="60%">
|
||||
|
||||
@@ -70,7 +70,7 @@ __Note: A table can only use one data source. If multiple tables with the same n
|
||||
><img src="image\Remote_beta\remote_beta_03.jpg" width="60%">
|
||||
|
||||
|
||||
> After entering the control page, keep the M5 device running normally, you can see the data in the chart is refreshed according to the interval we configured. Drag the arrow in the lower right corner of the chart to zoom the entire chart. Click the upper left corner to open the side. Navigation, providing shades of theme color switching and layout switches. (After opening the layout switch, the user is free to modify the position of the chart and other elements placed on the page)
|
||||
> After entering the control page, keep the M5 device running normally, you can see the data in the chart is refreshed according to the interval we configured. Drag the arrow in the lower right corner of the chart to zoom the entire chart. Click the upper left corner to open the side navigation, providing shades of theme color switching and layout switches. (After opening the layout switch, the user is free to modify the position of the chart and other elements placed on the page)
|
||||
|
||||
><img src="image\Remote_beta\remote_beta_04.jpg" width="60%">
|
||||
><img src="image\Remote_beta\remote_beta_05.jpg" width="60%">
|
||||
@@ -81,7 +81,7 @@ __Note: A table can only use one data source. If multiple tables with the same n
|
||||
|
||||
#### Function Description
|
||||
|
||||
>ESP-NOW is a short-range, low-power communication protocol that enables multiple devices to communicate without or without Wi-Fi. This protocol is similar to the low-power 2.4GHz wireless connection found in wireless mice—devices are paired before communicating. After pairing, the connections between devices are continuous, peer-to-peer, and do not require a handshake protocol.
|
||||
>ESP-NOW is a short-range, low-power communication protocol that enables multiple devices to communicate without Wi-Fi. This protocol is similar to the low-power 2.4GHz wireless connection found in wireless mice—devices are paired before communicating. After pairing, the connections between devices are continuous, peer-to-peer, and do not require a handshake protocol.
|
||||
|
||||
><img src="image\ESP_now\esp_now_01.jpg" width="60%">
|
||||
|
||||
@@ -111,7 +111,7 @@ Send data to the device with the specified id.
|
||||
|
||||
<h3><mark>Receiver</mark></h3>
|
||||
|
||||
> Display the local mac address on the screen, use the data receiving block and create two variables for receiving the sender's address and data content. The data is processed inside the receiving block function for display or judgment and other operations. For example, the lower program controls the LED light switch by judging whether the received data is "1".
|
||||
> Display the local mac address on the screen, use the data receiving block and create two variables for receiving the sender's address and data content. The data is processed inside the receiving block function for display or judgment and other operations. For example, the following program controls the LED light switch by judging whether the received data is "1".
|
||||
|
||||
__Note: The created variable name is not allowed to be consistent with the parameter name, ie variables with the names "addr" and "data" are not allowed to be used for data acquisition __
|
||||
|
||||
@@ -255,7 +255,7 @@ __Note: The created variable name is not allowed to be consistent with the param
|
||||
|
||||
#### Implementation function
|
||||
|
||||
> Use a CORE to program a simple use case to verify functionality, even if the publisher (Publish), is the subscriber (Subscribe)
|
||||
> Use a CORE to program a simple use case to verify functionality, it’s not inly a publisher (Publish), but a subscriber (Subscribe) as well
|
||||
|
||||
* __complete program__
|
||||
|
||||
@@ -301,11 +301,11 @@ Connect with ssid and password.
|
||||
Establish a point-to-point connection based on mqtt,Remote with other M5Stack and you should input the APIkey and Message to send.
|
||||
|
||||
* __P2P Read__
|
||||
Establish a point-to-point connection,Read the Message form other M5Stack
|
||||
Establish a point-to-point connection,Read the Message from other M5Stacks
|
||||
|
||||
#### Instructions
|
||||
|
||||
>Establish a point-to-point connection to the remote host and send a message,the other M5Stack.
|
||||
>Establish a point-to-point connection to the remote host and send a message from other M5Stacks.
|
||||
|
||||
><img src="/image/Network/P2PSend_user.gif" width="50%">
|
||||
|
||||
|
||||
@@ -115,7 +115,7 @@ change the value of key in map.
|
||||
Delete specified key
|
||||
|
||||
#### Instructions
|
||||
>Add a create map to create an map, add some elements to the map, Specify keywords and values
|
||||
>Add a create map to create a map, add some elements to the map, Specify keywords and values
|
||||
|
||||
><img src="/image/Operation/map_creat_user.gif" width="50%">
|
||||
|
||||
@@ -147,7 +147,7 @@ Customize an array
|
||||
Get the index value of an index element
|
||||
|
||||
* __in list get sub-list from__
|
||||
Intercepting an element from an array as a new array
|
||||
Set an index to the specified value in the array
|
||||
|
||||
* __icreat list with item repeated times__
|
||||
Create an array and use the element to repeat a certain number of times to fill
|
||||
@@ -163,7 +163,7 @@ Create an array from text, using a separator
|
||||
|
||||
|
||||
#### Instructions
|
||||
>Add a create list to create an array, add some elements to the array, call iteratively or otherwise
|
||||
>Add a create list to create an array, add some elements to the array, call elements iteratively or by using other methods
|
||||
|
||||
><img src="/image/Operation/List_user.gif" width="50%">
|
||||
|
||||
@@ -184,7 +184,7 @@ Decode an encoded JSON string into a Python object.
|
||||
|
||||
|
||||
#### Instructions
|
||||
>Creat a map dumps to json
|
||||
>Creat a map and turn it into json format
|
||||
|
||||
><img src="/image/Operation/JSON_dump_user.gif" width="50%">
|
||||
|
||||
@@ -207,7 +207,7 @@ Convert text to uppercase or lowercase.
|
||||
Get the specified character from the text.
|
||||
|
||||
* __count in__
|
||||
Find the number of occurrences of characters.
|
||||
Find the number of occurrences of specific characters.
|
||||
|
||||
* __is empty__
|
||||
Returns whether it is empty text.
|
||||
@@ -219,16 +219,16 @@ Return text length.
|
||||
Print text.
|
||||
|
||||
* __replace with in__
|
||||
Replace string of text.
|
||||
Replace text.
|
||||
|
||||
* __trim spaces from both sides__
|
||||
Remove spaces from both sides.
|
||||
Remove spaces from both sides of the string.
|
||||
|
||||
* __Convert to str__
|
||||
Convert other types to strings.
|
||||
|
||||
* __" "+__
|
||||
String merging.
|
||||
Text merging.
|
||||
|
||||
* __decode__
|
||||
Decode the string in the encoding format specified by encoding.
|
||||
|
||||
@@ -90,7 +90,7 @@ Get the Angular velocity from z axis
|
||||
|
||||
#### Usage
|
||||
|
||||
>The accelerometer could be used to create a game controlled by tilt or a device that can alert others if an elderly person falls down
|
||||
>Use labels to show IMU data or data can also be used to do computing or logic judging.
|
||||
|
||||
><img src="/image/Hardwares/IMU_user.gif" width="50%">
|
||||
|
||||
@@ -99,7 +99,7 @@ Get the Angular velocity from z axis
|
||||
|
||||
#### Feature introduction
|
||||
|
||||
>Set power management charge or get power.
|
||||
>Set device charging or get battery level.
|
||||
|
||||
|
||||
><img src="/image/Hardwares/Power5306.png" width="30%">
|
||||
@@ -119,7 +119,7 @@ Return battery level
|
||||
|
||||
#### Usage
|
||||
|
||||
>If the charge RGB is RED else BLACK
|
||||
>If it’s charging，RGB turns RED. Otherwise it will be BLACK
|
||||
|
||||
><img src="/image/Hardwares/Power_user.gif" width="50%">
|
||||
|
||||
@@ -139,7 +139,7 @@ Return to charging state
|
||||
Return battery voltage
|
||||
|
||||
* __Get battery current__
|
||||
Return battery voltage
|
||||
Return battery current
|
||||
|
||||
* __Get Vin voltage__
|
||||
Return VIN input voltage
|
||||
|
||||
@@ -111,12 +111,12 @@ Draw an ellipse from the x/y origin, set the radius with 2 parameters and choose
|
||||
Draw a polygon at the x/y origin with a set radius and amount of sides
|
||||
|
||||
#### Attention
|
||||
>The M5GO screen dimentions are 320X240
|
||||
>The M5GO screen resolution is 320X240
|
||||
|
||||
|
||||
#### Example
|
||||
|
||||
>Create a triangle and set it's color to red
|
||||
>Create a triangle and set its color to red
|
||||
|
||||
><img src="/image/Display/Graphic_user.gif" width="50%">
|
||||
|
||||
|
||||
@@ -87,14 +87,14 @@
|
||||
|
||||
#### 使用方法
|
||||
|
||||
>使用标签显示采集到的数据，或是将数据用作运算或逻辑判断
|
||||
>使用标签显示IMU数据，或是将数据用作运算或逻辑判断
|
||||
|
||||
><img src="/image/Hardwares/IMU_user.gif" width="50%">
|
||||
|
||||
|
||||
# 电源管理(M5Stack)
|
||||
|
||||
#### 功能说明
|
||||
#### 功能说明
|
||||
|
||||
>设置充电或者获取电量.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user