diff --git a/docs/assets/img/product_pics/icon_core.png b/docs/assets/img/product_pics/icon_core.png new file mode 100644 index 00000000..b33e5021 Binary files /dev/null and b/docs/assets/img/product_pics/icon_core.png differ diff --git a/docs/assets/img/product_pics/unit/unit_example/RGB/example_unit_rgb_01.png b/docs/assets/img/product_pics/unit/unit_example/RGB/example_unit_rgb_01.png new file mode 100644 index 00000000..e729a831 Binary files /dev/null and b/docs/assets/img/product_pics/unit/unit_example/RGB/example_unit_rgb_01.png differ diff --git a/docs/en/api/gpio.md b/docs/en/api/gpio.md index b3a88417..de868a6b 100644 --- a/docs/en/api/gpio.md +++ b/docs/en/api/gpio.md @@ -2,7 +2,7 @@ *Refer to GPIO API of [Arduino](http://www.arduino.cc)* -### digitalRead +### digitalRead > uint32 digitalRead(uint8 pin); Read the value of `pin` diff --git a/docs/en/api/speaker.md b/docs/en/api/speaker.md index f2c3e127..4d79b799 100644 --- a/docs/en/api/speaker.md +++ b/docs/en/api/speaker.md @@ -1,15 +1,26 @@ # Speaker -### tone -> M5.Speaker.tone(uint32_t freq); +### tone -Set the pitch of speaker. +**Function prototype:** -| Param | Type | Description | -| --- | --- | --- | -| freq | uint32_t | frequency | +tone(uint16_t freq); // for arduino + +tone(uint16_t freq, uint32_t duration); // for arduino + + +**Function: Set the pitch of speaker.** + +| Param | Description | +| --- | --- | +| freq | frequency | +| duration | duration (unit: millisecond) | **Example** ```arduino -M5.Speaker.tone(100); +#include + +M5.begin(); + +M5.Speaker.tone(900, 1000); ``` \ No newline at end of file diff --git a/docs/en/unit/rgb.md b/docs/en/unit/rgb.md index 79a23b91..91f9aac1 100644 --- a/docs/en/unit/rgb.md +++ b/docs/en/unit/rgb.md @@ -55,11 +55,11 @@ pixels.setPixelColor(2, pixels.Color(0,0,100)); pixels.show(); // This sends the updated pixel color to the hardware. ``` - + diff --git a/docs/index.md b/docs/index.md index 6ac5c1b5..227cc601 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ [![core_basic.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/core/core_basic_01.png)](en/core/basic)         [![core_gray.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/core/core_gray_01.png)](en/core/gray)         [![product_pic_fire.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/core/core_fire_01.png)](en/core/fire) -            **BASIC**                                   **GRAY**                                   **FIRE** +            *BASIC*                                   *GRAY*                                   *FIRE*   @@ -29,7 +29,7 @@ [![kit_m5go_lite.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/core/kit_m5go_lite_01.png)](en/core/m5go_lite)         [![kit_m5go.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/core/kit_m5go_01.png)](en/core/m5go)         [![kit_faces.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/core/kit_faces_01.png)](en/core/face_kit) -        **M5GO Lite**                          **M5GO Kit**                            **FACES Kit** +        *M5GO Lite*                          *M5GO Kit*                            *FACES Kit* *** @@ -43,7 +43,7 @@ [![module_gps.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_gps_01.png)](en/module/gps)         [![module_lora.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_lora_01.png)](en/module/lora)         [![module_lorawan.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_lorawan_01.png)](en/module/lorawan)         [![module_sim800.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_sim800_01.png)](en/module/sim800) -            **GPS**                                    **LORA**                                  **LoRaWAN**                          **SIM800L** +            *GPS*                                    *LORA*                                  *LoRaWAN*                          *SIM800L*   @@ -57,11 +57,11 @@ [![battery_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_battery_01.png)](en/module/battery)         [![proto_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_proto_01.png)](en/module/proto)         [![plus_1.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_plus_01.png)](en/module/plus)         [![module_usb.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_usb_01.png)](en/module/usb) -          **BATTERY**                                **PROTO**                                  **PLUS**                                  **USB** +          *BATTERY*                                *PROTO*                                  *PLUS*                                  *USB* [![module_bus.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_bus_01.png)](en/module/bus) -              **BUS** +              *BUS*   @@ -69,7 +69,7 @@ [![stepmotor_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_stepmotor_01.png)](en/module/stepmotor)         [![servo_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_servo_01.png)](en/module/servo)         [![lego+_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_lego_plus_01.png)](en/module/lego_plus) -      **STEPMOTOR**                           **SERVO**                                 **LEGO+** +      *STEPMOTOR*                           *SERVO*                                 *LEGO+*   @@ -77,7 +77,7 @@ [![encoder_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_encoder_01.png)](en/module/encoder)         [![joystick_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/module/module_joystick_01.png)](en/module/joystick) -        **ENCODER**                             **JOYSTICK** +        *ENCODER*                             *JOYSTICK* *** @@ -89,13 +89,13 @@ [![lan_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/base/base_lan_01.png)](en/base/lan_base)         [![node_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/base/base_node_01.png)](en/base/node_base)         [![btc_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/base/base_btc_01.png)](en/base/btc_base)         [![plc_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/base/base_plc_01.png)](en/base/plc_base) -            **LAN**                                    **NODE**                                    **BTC**                                    **PLC** +            *LAN*                                    *NODE*                                    *BTC*                                    *PLC*   [![core_bottom_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/base/base_core_bottom_01.png)](en/base/core_bottom)         [![m5go_bottom_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/base/base_m5go_bottom_01.png)](en/base/m5go_bottom)         [![m5go_rfid_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/base/base_m5go_rfid_01.png)](en/base/m5go_rfid)         [![m5go_base_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/base/base_m5go_base_01.png)](en/base/m5go_charger) -     **Core BOTTOM**                   **M5GO BOTTOM**                    **M5GO RFID**                     **M5GO CHARGER** +     *Core BOTTOM*                   *M5GO BOTTOM*                    *M5GO RFID*                     *M5GO CHARGER* *** @@ -109,55 +109,55 @@ [![unit_esp32cam.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_esp32cam_01.png)](en/unit/esp32cam)         [![unit_m5camera.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_m5camera_01.png)](en/unit/m5camera)         [![unit_m5camera_f.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_m5camera_f_01.png)](en/unit/m5camera_f) -        **ESP32CAM**                         **M5Camera**                        **M5CameraF** +        *ESP32CAM*                         *M5Camera*                        *M5CameraF*   [![unit_env.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_env_01.png)](en/unit/env)         [![unit_earth.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_earth_01.png)](en/unit/earth)         [![unit_light.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_light_01.png)](en/unit/light)         [![unit_angle.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_angle_01.png)](en/unit/angle) -            **ENV**                                   **EARTH**                                 **LIGHT**                               **ANGLE** +            *ENV*                                   *EARTH*                                 *LIGHT*                               *ANGLE*   [![unit_ir.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_ir_01.png)](en/unit/ir)         [![unit_pir.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_pir_01.png)](en/unit/pir)         [![unit_ncir.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_ncir_01.png)](en/unit/ncir)         [![unit_thermal.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_thermal_01.png)](en/unit/thermal) -                **IR**                                      **PIR**                                  **NCIR**                               **THERMAL** +                *IR*                                      *PIR*                                  *NCIR*                               *THERMAL*   [![unit_button.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_button_01.png)](en/unit/button)         [![unit_dual_button.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_dual_button_01.png)](en/unit/dual_button)         [![unit_joystick.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_joystick_01.png)](en/unit/joystick)         [![unit_cardkb.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_cardkb_01.png)](en/unit/cardkb) -          **BUTTOM**                        **Dual-BUTTOM**                      **JOYSTICK**                               **CardKB** +          *BUTTOM*                        *Dual-BUTTOM*                      *JOYSTICK*                               *CardKB*   [![unit_color.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_color_01.png)](en/unit/color)         [![unit_tof.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_tof_01.png)](en/unit/tof)         [![unit_heart.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_heart_01.png)](en/unit/heart)         [![unit_rfid.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_rfid_01.png)](en/unit/rfid) -            **COLOR**                                   **ToF**                                 **HEART**                                  **RFID** +            *COLOR*                                   *ToF*                                 *HEART*                                  *RFID*   [![unit_adc.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_adc_01.png)](en/unit/adc)         [![unit_dac.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_dac_01.png)](en/unit/dac)         [![unit_makey.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_makey_01.png)](en/unit/makey)         [![unit_rgb.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_rgb_01.png)](en/unit/rgb) -            **ADC**                                    **DAC**                                    **LIGHT**                                **ANGLE** +            *ADC*                                    *DAC*                                    *LIGHT*                                *ANGLE*   [![unit_relay.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_relay_01.png)](en/unit/relay)         [![unit_hub.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_hub_01.png)](en/unit/hub)         [![unit_396port.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_396port_01.png)](en/unit/396port)         [![unit_proto.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_proto_01.png)](en/unit/proto) -            **RELAY**                                   **HUB**                                 **3.96Port**                              **PROTO** +            *RELAY*                                   *HUB*                                 *3.96Port*                              *PROTO*   [![unit_extio.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_extio_01.png)](en/unit/extio)         [![unit_rs485.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_rs485_01.png)](en/unit/rs485)         [![unit_gps.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_gps_01.png)](en/unit/gps)         [![unit_finger.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_finger_01.png)](en/unit/finger) -            **EXT.IO**                                 **RS485**                                **GPS**                                  **FINGER** +            *EXT.IO*                                 *RS485*                                *GPS*                                  *FINGER*   [![unit_weight.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_weight_01.png)](en/unit/weight)         [![unit_trace.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_trace_01.png)](en/unit/trace) -          **WEIGHT**                               **TRACE** +          *WEIGHT*                               *TRACE*   @@ -165,13 +165,13 @@ [![unit_neopixel.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_neopixel_01.png)](en/unit/neopixel)         [![unit_catear.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_catear_01.png)](en/unit/catear)         [![unit_hex.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_hex_01.png)](en/unit/hex)         [![unit_neoflash.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_neoflash_01.png)](en/unit/neoflash) -          **NeoPixel**                               **CatEar**                                  **HEX**                                **NeoFlash** +          *NeoPixel*                               *CatEar*                                  *HEX*                                *NeoFlash*   [![unit_butterfly.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_butterfly_01.png)](en/unit/butterfly) -         **BUTTERFLY** +         *BUTTERFLY* *** @@ -183,7 +183,7 @@ [![bala_1.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/app/app_bala_01.png)](en/app/bala)         [![lidarbot.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/app/app_lidarbot_01.png)](en/app/lidarbot)         [![app_piano.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/app/app_piano_01.png)](en/app/piano)         [![app_flir.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/app/app_flir_01.png)](en/app/flir) -            **BALA**                                 **LidarBOT**                              **PIANO**                                  **FLIR** +            *BALA*                                 *LidarBOT*                              *PIANO*                                  *FLIR* *** @@ -195,7 +195,7 @@ [![grove_t_01.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/accessory/grove_t_01.png)](en/accessory/convertor/grove_t) -            **Grove-T** +            *Grove-T* diff --git a/docs/ja/api/speaker.md b/docs/ja/api/speaker.md index d10b1033..bf69e263 100644 --- a/docs/ja/api/speaker.md +++ b/docs/ja/api/speaker.md @@ -1,7 +1,7 @@ # Speaker - + \ No newline at end of file diff --git a/docs/ja/unit/rgb.md b/docs/ja/unit/rgb.md index ca44e824..856cacaa 100644 --- a/docs/ja/unit/rgb.md +++ b/docs/ja/unit/rgb.md @@ -48,11 +48,11 @@ pixels.setPixelColor(2, pixels.Color(0,0,100)); pixels.show(); // This sends the updated pixel color to the hardware. ``` - + diff --git a/docs/zh_CN/api/speaker.md b/docs/zh_CN/api/speaker.md index 171eb32a..e825fc9e 100644 --- a/docs/zh_CN/api/speaker.md +++ b/docs/zh_CN/api/speaker.md @@ -1,6 +1,6 @@ # 喇叭 -### tone + ### tone() **函数原型:** tone(uint16_t freq); // for arduino + tone(uint16_t freq, uint32_t duration); // for arduino @@ -29,7 +30,7 @@ M5.Speaker.tone(100); | freq | 声音频率 | | duration | 持续时间 (单位:毫秒) | -*如果函数的 duration 值没给出,则使用当前的背景颜色。* + **例程** ```arduino diff --git a/docs/zh_CN/unit/rgb.md b/docs/zh_CN/unit/rgb.md index a62ff9cf..d3541efc 100644 --- a/docs/zh_CN/unit/rgb.md +++ b/docs/zh_CN/unit/rgb.md @@ -53,11 +53,11 @@ pixels.setPixelColor(2, pixels.Color(0,0,100)); pixels.show(); // This sends the updated pixel color to the hardware. ``` - +