diff --git a/docs/assets/img/product_pics/unit/M5GO_Unit_dual_button.webp b/docs/assets/img/product_pics/unit/M5GO_Unit_dual_button.webp old mode 100644 new mode 100755 index d94b9a86..a3af7256 Binary files a/docs/assets/img/product_pics/unit/M5GO_Unit_dual_button.webp and b/docs/assets/img/product_pics/unit/M5GO_Unit_dual_button.webp differ diff --git a/docs/assets/js/custom.js b/docs/assets/js/custom.js new file mode 100644 index 00000000..b72e7927 --- /dev/null +++ b/docs/assets/js/custom.js @@ -0,0 +1,392 @@ +const description_icon = ''; +const purchase_icon = ''; +const example_icon = ''; +const video_icon = ''; +const quickstart_icon = ''; +const schematic_icon = ''; +const icon_list = { + "EASYLOADER":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/EASYLOADER_ICON.png", + "CORE":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/CORE_ICON.png", + "MODULE":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/MODULE_ICON.png", + "BASE":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/BASE_ICON.png", + "UNIT":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/UNIT_ICON.png", + "HAT":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/HAT_ICON.png", + "ATOM-BASE":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ATOM_BASE_ICON.png", + "APPLICATION":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/APPLICATION_ICON.png", + "ACCESSORY":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ACCESSORY_ICON.png", + "ALUMINIUM":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ALUMINIUM_ICON.png" +}; + +var Label1 = ''; +var Label2 = 'here is the anchor_name'; +function anchor_create(anchor_name,anchor_id){ + var page_url = window.location.href; + var Part_A = Label1.replace(/here is the anchor_id/, anchor_id); + var Part_B = Label2.replace(/here is the anchor_name/, anchor_name.toUpperCase()); + if((anchor_name == "DESCRIPTION")||(anchor_name == "描述")){ + $(".anchor-box").append(Part_A+description_icon+Part_B); + } + else if((anchor_name == "EXAMPLE")||(anchor_name == "案例程序")){ + $(".anchor-box").append(Part_A+example_icon+Part_B); + } + else if((anchor_name == "SCHEMATIC")||(anchor_name == "原理图")){ + $(".anchor-box").append(Part_A+schematic_icon+Part_B); + } + else if((anchor_name == "VIDEO")||(anchor_name == "相关视频")){ + $(".anchor-box").append(Part_A+video_icon+Part_B); + } + else if(icon_list.hasOwnProperty(anchor_name)){ + $(".anchor-box").append(Part_A+""+Part_B); + if (anchor_name == "EASYLOADER"){ + if(("#example_video").length >0) + $("#play-btn").on("click",function(ev){ + ev.stopPropagation(); + $(".easyloader-mask").toggleClass('video_play'); + $("#example_video")[0].play(); + }) + $("#example_video").on("click",function(ev){ + ev.preventDefault(); + $(".easyloader-mask").toggleClass('video_play'); + $("#example_video")[0].pause(); + }) + } + }else if((page_url.indexOf(/uiflow/) != -1)||(page_url.indexOf(/arduino/) != -1)||(page_url.indexOf(/quick_start/) != -1)||(page_url.indexOf(/related_documents/) != -1)){ + $(".anchor-box").append(Part_A+quickstart_icon+''+anchor_name+''); + } +} + +function anchor_search(purchase_link="none",quickstart_link="none"){ + isSupportWebp(); + var page_url = window.location.href; + if((page_url.slice(-4) == "/en/")||(page_url.slice(-7)== "/zh_CN/")||(page_url.slice(-3)== "/#/")){ + $("#search_note").eq(0).after("
"); + var anchor_list= $(".product_page > div:gt(1)"); + } + else{ + $("h2").eq(0).before("
"); + var anchor_list= $("#main h2"); + } + for (var i=0; i< anchor_list.length ; i++){ + anchor_create(anchor_list[i].id.toUpperCase(), anchor_list[i].id); + } + if(page_url.indexOf(/zh_CN/) != -1) { + var purchase_name = "购买链接" + var quickstart_name = "快速上手" + } + else { + var purchase_name = "PURCHASE" + var quickstart_name = "QUICK START" + } + if(purchase_link!="none"){ + $(".anchor-box").append(''+purchase_icon+''+purchase_name+''+''); + } + if(quickstart_link!="none"){ + $(".anchor-box").append(''+quickstart_icon+''+quickstart_name+''+''); + } +} + +function anchor_scroll(anchor_name,anchor_id,anchor_length){ + var page_url = window.location.href; + var offset = $("#"+anchor_id).offset().top + $("#"+anchor_id).height() - $(window).scrollTop(); + if((offset > 100)&&(offset < ($("#"+anchor_id).height()+700))){ + for (var i= 0; i< anchor_length; i++){ + if( anchor_name == $(".anchor-box span").eq(i).html()){ + $(".anchor-box a").addClass("anchor-quiet"); + $(".anchor-box a").eq(i).removeClass("anchor-quiet"); + $(".anchor-box a").eq(i).addClass("anchor-active"); + if((page_url.indexOf(/uiflow/) != -1)||(page_url.indexOf(/arduino/) != -1)||(page_url.indexOf(/quick_start/) != -1)){ + var marquee_status1 = $(".anchor-box a marquee").eq(i).attr("scrollamount"); + $(".anchor-box a marquee").attr("scrollamount","0"); + $(".anchor-box a marquee").eq(i).attr("scrollamount","2"); + var marquee_status2 = $(".anchor-box a marquee").eq(i).attr("scrollamount"); + if(marquee_status1 != marquee_status2){ + $(".anchor-box a marquee").eq(i)[0].start(); + } + } + return true + } + } + } +} + +var scrollFunc = function (e) { + e = e || window.event; +// if (e.wheelDelta) { //判断浏览器IE，谷歌滑轮事件 + var page_url = window.location.href; + if((page_url.slice(-4) == "/en/")||(page_url.slice(-7)== "/zh_CN/")||(page_url.slice(-3)== "/#/")){ + var anchor_list= $(".product_page > div:gt(1)"); + } + else{ + var anchor_list= $("#main h2"); + } + for (var i=0; i< anchor_list.length ; i++){ + if(anchor_scroll(anchor_list[i].id.toUpperCase(), anchor_list[i].id, anchor_list.length)) break; + } +} + +scrollFunc(); +/*IE、Opera注册事件*/ +if(document.attachEvent){ +document.attachEvent('onmousewheel',scrollFunc); + +} +//Firefox使用addEventListener添加滚轮事件 +if (document.addEventListener) {//firefox +document.addEventListener('DOMMouseScroll', scrollFunc, false); +} +window.onscroll = scrollFunc; + +function product_search(onEnter_content){ + $("#search_note").css("display","block"); + var p = $(".item .item-title"); + var sku = $(".item .mask_sku"); + for (var i=0; i 0) { + pdf.addImage(pageData, 'JPEG', 0, position, imgWidth, imgHeight) + leftHeight -= pageHeight; + position -= 841.89; + if(leftHeight > 0) { + pdf.addPage(); + } + } + } + var page_url = window.location.href; + var a = page_url.indexOf('#') + var pdf_name = page_url.slice(a+2); + pdf.save(pdf_name+".pdf"); + } + }) + $(".anchor-box").removeAttr("style"); + $(".related_links").removeAttr("style"); + $(".easyloader-box").removeAttr("style"); + } \ No newline at end of file diff --git a/docs/assets/js/custom.min.js b/docs/assets/js/custom.min.js new file mode 100644 index 00000000..76223941 --- /dev/null +++ b/docs/assets/js/custom.min.js @@ -0,0 +1 @@ +const description_icon='',purchase_icon='',example_icon='',video_icon='',quickstart_icon='',schematic_icon='',icon_list={EASYLOADER:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/EASYLOADER_ICON.png",CORE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/CORE_ICON.png",MODULE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/MODULE_ICON.png",BASE:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/BASE_ICON.png",UNIT:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/UNIT_ICON.png",HAT:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/HAT_ICON.png","ATOM-BASE":"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ATOM_BASE_ICON.png",APPLICATION:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/APPLICATION_ICON.png",ACCESSORY:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ACCESSORY_ICON.png",ALUMINIUM:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_logo/ALUMINIUM_ICON.png"};var Label1="",Label2='here is the anchor_name';function anchor_create(e,c){var t=window.location.href,n=Label1.replace(/here is the anchor_id/,c),o=Label2.replace(/here is the anchor_name/,e.toUpperCase());"DESCRIPTION"==e||"描述"==e?$(".anchor-box").append(n+description_icon+o):"EXAMPLE"==e||"案例程序"==e?$(".anchor-box").append(n+example_icon+o):"SCHEMATIC"==e||"原理图"==e?$(".anchor-box").append(n+schematic_icon+o):"VIDEO"==e||"相关视频"==e?$(".anchor-box").append(n+video_icon+o):icon_list.hasOwnProperty(e)?($(".anchor-box").append(n+""+o),"EASYLOADER"==e&&("#example_video".length>0&&$("#play-btn").on("click",function(e){e.stopPropagation(),$(".easyloader-mask").toggleClass("video_play"),$("#example_video")[0].play()}),$("#example_video").on("click",function(e){e.preventDefault(),$(".easyloader-mask").toggleClass("video_play"),$("#example_video")[0].pause()}))):-1==t.indexOf(/uiflow/)&&-1==t.indexOf(/arduino/)&&-1==t.indexOf(/quick_start/)&&-1==t.indexOf(/related_documents/)||$(".anchor-box").append(n+quickstart_icon+'"+e+"")}function anchor_search(e="none",c="none"){isSupportWebp();var t=window.location.href;if("/en/"==t.slice(-4)||"/zh_CN/"==t.slice(-7)||"/#/"==t.slice(-3)){$("#search_note").eq(0).after("
");var n=$(".product_page > div:gt(1)")}else{$("h2").eq(0).before("
");n=$("#main h2")}for(var o=0;o'+purchase_icon+''+a+""),"none"!=c&&$(".anchor-box").append("'+quickstart_icon+''+s+"")}function anchor_scroll(e,c,t){var n=window.location.href,o=$("#"+c).offset().top+$("#"+c).height()-$(window).scrollTop();if(o>100&&o<$("#"+c).height()+700)for(var a=0;a div:gt(1)");else t=$("#main h2");for(var n=0;n0;)l.addImage(i,"JPEG",0,a,595.28,s),a-=841.89,(o-=n)>0&&l.addPage();var r=window.location.href,h=r.indexOf("#"),p=r.slice(h+2);l.save(p+".pdf")}}),$(".anchor-box").removeAttr("style"),$(".related_links").removeAttr("style"),$(".easyloader-box").removeAttr("style")}Input.focusin(function(){Input.animate({width:300})}),Input.focusout(function(){Input.animate({width:240})}),$(document).ready(function(){$(".btn-toggle").on("click",function(){$(".btn-toggle").toggleClass("open"),$(".d-flex").toggleClass("open")})}),window.onhashchange=page_loading,page_loading(); \ No newline at end of file diff --git a/docs/en/accessory/485t.md b/docs/en/accessory/485t.md index c673b934..d287eb07 100644 --- a/docs/en/accessory/485t.md +++ b/docs/en/accessory/485t.md @@ -8,12 +8,12 @@ **485T**,This is a T-shape connector for RS485 communication, which can apply to point to point, one point to multi-point connection, plus a POWER LED for indication. The terminal connector specification is 4pin HT3.96. Many M5 products sharing this type of connector, such as PLC, Base26, HAT-RS485, etc. -## Product Feature +## Product Features - Interface type: 4 Pin 3.96mm terminal block - Built-in power indicator: red -## Package Include +## Include - 1x 485T diff --git a/docs/en/accessory/bus_socket.md b/docs/en/accessory/bus_socket.md index e1058206..2c11b1f2 100644 --- a/docs/en/accessory/bus_socket.md +++ b/docs/en/accessory/bus_socket.md @@ -12,7 +12,7 @@ - 90-degree bend pin - 2x15 @ 2.54mm -## Package Includes +## Includes - 1x male socket - 1x female socket diff --git a/docs/en/accessory/cable/grove_cable.md b/docs/en/accessory/cable/grove_cable.md index 858c848d..8f50d09b 100644 --- a/docs/en/accessory/cable/grove_cable.md +++ b/docs/en/accessory/cable/grove_cable.md @@ -8,7 +8,7 @@ **CONNEXT Cable** would be a necessary tool used on M5Stack development, since all PORTs on M5Core are CONNEXT stadard. This CONNEXT cable, compatible with the CONNEXT port on M5Core,simply have 4 lines, two for data, one for power,and one for Ground. We've offered alternative length: 10cm, 20cm, 50cm, 1m, 2m. -## Feature +## Product Features - 5 specifications: 10cm, 20cm, 0.5m, 1m, 2m diff --git a/docs/en/accessory/cable/lego_cable.md b/docs/en/accessory/cable/lego_cable.md index 40fc304d..164a58ce 100644 --- a/docs/en/accessory/cable/lego_cable.md +++ b/docs/en/accessory/cable/lego_cable.md @@ -8,7 +8,7 @@ **LEGO Cable** is used for LEGO motor which is compatible with BALA and M5Module LEGO+. We have prepared different length to fit your needs on different appliactions. -## Feature +## Product Features - 3 specifications: 10cm, 20cm, 30cm diff --git a/docs/en/accessory/converter/grove2grove.md b/docs/en/accessory/converter/grove2grove.md index d0c20a58..6fcce0fa 100644 --- a/docs/en/accessory/converter/grove2grove.md +++ b/docs/en/accessory/converter/grove2grove.md @@ -8,10 +8,10 @@ **GROVE2GROVE** is a GROVE extension connector. Two female GROVE port sit back-to-back. One common use of this part is for the RGB LED strip extension. -## Product Features +## Product Features - Grove connector -## Package Includes +## Include - 5x pcs diff --git a/docs/en/atom_base/TailBat.md b/docs/en/atom_base/TailBat.md new file mode 100644 index 00000000..f6e6c260 --- /dev/null +++ b/docs/en/atom_base/TailBat.md @@ -0,0 +1,90 @@ +# TailBat + +
SKU:
+ +
+ +## Description + +**TailBat** is an external battery accessory designed for ATOM. Inserting the tail of atom can directly supply power for ATOM, which is convenient for users to use in mobile scenes. There is a switch button on the front of TailBat, which contains 190mah battery inside. It is controlled by the power management chip IP5303. When the power is turned on, the red indicator light is on. The operation method is the same as that of m5stack core: Click to turn on the power, double-click to turn off the power. Because tailbat has made a straight through design for the interface on the basis of adding batteries, it will not affect the original GROVE Connection mode and USB function. The built-in battery can only be charged through the typec interface, not through the grove interface. + +## Product Features + +- Adapt to ATOM +- Plug and play +- Built in rechargeable lithium battery +- LED indicator +- Stick/C/V/M5Camera compatible + + +## Include + +- 1x TailBat + +## Application + +- ATOM portable power + +## Specification + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SpecificationParameter
External port1x GROVE
LED1x RED LED
USB portTypeC
Battery capacity190mAh
Size55 x 22 x 14mm
Weight42g
Case materialPlastic ( PC )
+ +## Schematic + + + +## Video + + + + + diff --git a/docs/en/base/base15.md b/docs/en/base/base15.md index 5d70fe36..7ee92d02 100644 --- a/docs/en/base/base15.md +++ b/docs/en/base/base15.md @@ -17,7 +17,7 @@ At the bottom side of the product, we have offered 2 different fitting ways: Di Of course, it is absolutely compatible with the stackable M5module and extendable M5Units. This base gives you an unlimited of combinations, it is powerful, flexible, and covered with an industrial-grade case. If you happen to work in an industrial field, We especially recommend this Base to you which will surely give you the best and the fastest way to resolve your requirement.. -## Feature +## Product Features - Highly Customizable - Alternative parts diff --git a/docs/en/base/base26.md b/docs/en/base/base26.md index 83b6d9a6..e892dae5 100644 --- a/docs/en/base/base26.md +++ b/docs/en/base/base26.md @@ -18,7 +18,7 @@ At the bottom side of the product, we have offered 2 different fitting ways: Di Of course, it is absolutely compatible with the stackable M5module and extendable M5Units. This base gives you an unlimited of combinations, it is powerful, flexible, and covered with an industrial-grade case. If you happen to work in an industrial field, We especially recommend this Base to you which will surely give you the best and the fastest way to resolve your requirement.. -## Feature +## Product Features - Highly Customizable - Alternative parts diff --git a/docs/en/base/basex.md b/docs/en/base/basex.md index f654d974..b5928e94 100644 --- a/docs/en/base/basex.md +++ b/docs/en/base/basex.md @@ -8,7 +8,7 @@ **BaseX** is a special base compatible with LEGO EV3 motor. The structure design is similar to base26, supporting multiple ways of fixation, and an additional LEGO connection base is provided. When building the LEGO structure, Basex can be easily embedded in the work. Basex can be connected to 4-way (RJ11) LEGO motor at the same time, supporting angle / speed reading and control, and perfectly compatible with the original motor functions. In addition, the base provides two servo interfaces, which can directly control the rotation angle of the servo.There is a motherboard PDM microphone for sound collection. In order to adapt to different use scenarios, a UART interface (16 / 17) and a GPIO interface (26 / 36) are provided to make access to various sensors more flexible. A 900mah battery is built in the base, which can be charged through the usb-c interface of m5core to extend the endurance. In order to improve the driving ability of the interface, the base is equipped with a DC power socket, which can be powered by an external 9-12v power supply to provide a stable power supply for the motor. -## Feature +## Product Features - 4-way RJ11 LEGO motor interface (total maximum output current 2A) - 2-way servo interface (total maximum output current 2A) @@ -77,7 +77,7 @@ Mode config method: Motor address + nByte Encoder0x02 -## Product +## Include - 1x BaseX - 1x LEGO base diff --git a/docs/en/base/core_bottom.md b/docs/en/base/core_bottom.md index 2cdf303f..0c49268a 100644 --- a/docs/en/base/core_bottom.md +++ b/docs/en/base/core_bottom.md @@ -10,14 +10,14 @@ -## Include - -- 1x Core BOTTOM - ## Product Features - Li-po battery: 110 mAh @ 3.7V +## Include + +- 1x Core BOTTOM + **M-Bus** M_BUS diff --git a/docs/en/base/iiot_dual_switch_kit_with_core.md b/docs/en/base/iiot_dual_switch_kit_with_core.md index 54c2a031..4d6d00bd 100644 --- a/docs/en/base/iiot_dual_switch_kit_with_core.md +++ b/docs/en/base/iiot_dual_switch_kit_with_core.md @@ -9,7 +9,7 @@ **IIoT Dual-Switch Kit with core** is a functional-orientated module specifically built around BASE26. Mainly implemented a dual-relay control. As is known that BASE26 is created for industrial purpose, where may have plenty of relay-controlled application scenarios, add up the highly-customized features of BASE26, makes it a powerful and full-function node for IIoT. For example, you can stack an IoT module such as LoRa, GSM, LTE, etc, in between the M5 Core and BASE26 to make an IoT node with wireless control. -## Product Feature +## Product Features - Two relays inside - Relay allows on/off current/voltage: diff --git a/docs/en/base/node_base.md b/docs/en/base/node_base.md index 35dccdd9..b39b19f8 100644 --- a/docs/en/base/node_base.md +++ b/docs/en/base/node_base.md @@ -17,7 +17,7 @@ ESP-ADF supports development of audio applications for the Espressif Systems ESP Internet Radio - Voice recognition and integration with online services such as Alexa, DuerOS, and more. -## Product Feature +## Product Features * 1x 12 RGBs * 1x temperature & humidity sensor(DHT12),which can display its own status and perception surrounding environment. diff --git a/docs/en/base/plc_base.md b/docs/en/base/plc_base.md index acb9fb42..30b5f6ff 100644 --- a/docs/en/base/plc_base.md +++ b/docs/en/base/plc_base.md @@ -14,7 +14,7 @@ Does this PLC remind you of the 'PLC' in industrial controll short for 'Programm If you need to add RS485 interface, soldering the RS485 board onto the mian board pin correspondingly. *The serial port pins on the RS485 board will be connected to the GPIO16 and GPIO17 of the PLC backplane.* -## Feature +## Product Features - Support 9-24V voltage input - Individual package weight: 0.1kg diff --git a/docs/en/base/pm2.5.md b/docs/en/base/pm2.5.md index c3b6d1ee..66508631 100644 --- a/docs/en/base/pm2.5.md +++ b/docs/en/base/pm2.5.md @@ -32,7 +32,7 @@ SHT20 is a Humidity and temperature sensor IC. -## Product Feature +## Product Features - DC 5V - Compatible with M5stack stackable and extension system. @@ -40,7 +40,7 @@ SHT20 is a Humidity and temperature sensor IC. - Proto board - USB Type-c port -## Package Includes +## Include - 1x PM2.5 base - 1x M5Stack Basic diff --git a/docs/en/core/basic.md b/docs/en/core/basic.md index c9e2707f..c70b887f 100644 --- a/docs/en/core/basic.md +++ b/docs/en/core/basic.md @@ -26,7 +26,7 @@ M5Stack Basic is consist with two separable parts. The upside part has all kinds - M-Bus Socket & Pins - Program Platform: [UIFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/), [Arduino](http://www.arduino.cc) -## Includes +## Include - 1x BASIC - 10x Dupont diff --git a/docs/en/core/m5go_lite.md b/docs/en/core/m5go_lite.md index 0ce240ad..7ed84f37 100644 --- a/docs/en/core/m5go_lite.md +++ b/docs/en/core/m5go_lite.md @@ -20,7 +20,7 @@ all M5stack development board can be programmed by using Arduino IDE, WebIDE UIF - Development Platform [UIFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/), [Arduino](http://www.arduino.cc) -## Includes +## Include - 1x M5GO - 1x ENV Unit diff --git a/docs/en/hat/hat-8servos.md b/docs/en/hat/hat-8servos.md index a9aeea3d..c0d84902 100644 --- a/docs/en/hat/hat-8servos.md +++ b/docs/en/hat/hat-8servos.md @@ -22,7 +22,7 @@ - Biomimetic Robots - Smart and cognitive toys -## Package Includes +## Include - 1x 8Servos-HAT - 1x 16340 battery(750mAh) diff --git a/docs/en/hat/hat-beetlec.md b/docs/en/hat/hat-beetlec.md index 511e7200..270bc27e 100644 --- a/docs/en/hat/hat-beetlec.md +++ b/docs/en/hat/hat-beetlec.md @@ -34,7 +34,7 @@ Besides, a power switch is placed at the front. - Remote Motor control - Wireless Robotic control -## Package Includes +## Include - 1x BeetleC bottom diff --git a/docs/en/hat/hat-bugc.md b/docs/en/hat/hat-bugc.md index f58f6cdd..fe6021ab 100644 --- a/docs/en/hat/hat-bugc.md +++ b/docs/en/hat/hat-bugc.md @@ -46,7 +46,7 @@ The Bugc base needs to be used in conjunction with the M5StickC controller. The - Robot control - Smart and cognitive toys -## Package Includes +## Include - 1x BugC base - 1x 16340 Battery(750mAh) diff --git a/docs/en/hat/hat-env.md b/docs/en/hat/hat-env.md index 9d16a224..4fecdcb2 100644 --- a/docs/en/hat/hat-env.md +++ b/docs/en/hat/hat-env.md @@ -23,7 +23,7 @@ - Dimension：24mm x 20.3mm x 13.8mm - Weight：3g -## Package Includes +## Include - 1x ENV Hat diff --git a/docs/en/hat/hat-finger.md b/docs/en/hat/hat-finger.md index e1c6d192..63abb108 100644 --- a/docs/en/hat/hat-finger.md +++ b/docs/en/hat/hat-finger.md @@ -32,7 +32,7 @@ UART settings: - Size：55mm * 25mm * 20mm - weight：33g(include battery) -## Included +## Include - 1x FINGER HAT diff --git a/docs/en/hat/hat-joyc.md b/docs/en/hat/hat-joyc.md index 7cbb7685..be8133f3 100644 --- a/docs/en/hat/hat-joyc.md +++ b/docs/en/hat/hat-joyc.md @@ -16,7 +16,7 @@ - Dimension：200mm x 55mm x 50mm - Weight：81g(include 750mAh Battery) -## Package Includes +## Include - 1x JoyC - 1x 16340 Battery diff --git a/docs/en/hat/hat-joystick.md b/docs/en/hat/hat-joystick.md index dca11550..9ba00211 100644 --- a/docs/en/hat/hat-joystick.md +++ b/docs/en/hat/hat-joystick.md @@ -16,7 +16,7 @@ - Dimension：24mm x 30mm x 17mm - Weight：3g -## Package Includes +## Include - 1x Joystick HAT diff --git a/docs/en/hat/hat-neoflash.md b/docs/en/hat/hat-neoflash.md index 253a78d5..62776746 100644 --- a/docs/en/hat/hat-neoflash.md +++ b/docs/en/hat/hat-neoflash.md @@ -24,7 +24,7 @@ If you thinking about adding a display on your project, NeoFlash is a good choic - Dimension：58mm x 23.5mm x 1mm - Weight：2g -## Package Includes +## Includes - 1x Neoflash HAT - 2x 8 pin 2.54mm bend pin set（90°） diff --git a/docs/en/hat/hat-pir.md b/docs/en/hat/hat-pir.md index 094abcb0..ec505ed5 100644 --- a/docs/en/hat/hat-pir.md +++ b/docs/en/hat/hat-pir.md @@ -10,7 +10,7 @@ *Notice: There exist 2 seconds delay* -## Product Feature +## Product Features - Detecting Range: 500cm - Delay time: 2s @@ -18,7 +18,7 @@ - IDDQ : < 60uA - Op.T: -20 - 80 °C -## package Includes +## Include - 1x PIR Hat diff --git a/docs/en/quick_start/m5stickv/m5stickv_quick_start.md b/docs/en/quick_start/m5stickv/m5stickv_quick_start.md index 46ff695b..0f3d213d 100644 --- a/docs/en/quick_start/m5stickv/m5stickv_quick_start.md +++ b/docs/en/quick_start/m5stickv/m5stickv_quick_start.md @@ -8,7 +8,7 @@
- Windows + Windows
@@ -202,6 +202,35 @@ Linux command line to run permissions, then execute commands + +## WS2812 + +The firmware has a built-in WS2812 RGB LED driver library. The following is a reference routine: + +``` +from modules import ws2812 +from fpioa_manager import * +fm.register(board_info.CONNEXT_A) +class_ws2812 = ws2812(board_info.CONNEXT_A,130) +r=0 +dir = True +while True: + if dir: + r += 1 + else: + r -= 1 + if r>=255: + r = 255 + dir = False + elif r<0: + r = 0 + dir = True + for i in range(130): + a = class_ws2812.set_led(i,(0,0,r)) + a=class_ws2812.display() +``` + + ## Library diff --git a/docs/en/quick_start/unitv/unitv_quick_start.md b/docs/en/quick_start/unitv/unitv_quick_start.md index c736d578..df3b2fa0 100644 --- a/docs/en/quick_start/unitv/unitv_quick_start.md +++ b/docs/en/quick_start/unitv/unitv_quick_start.md @@ -21,7 +21,7 @@ - + >1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.For users who don't need to customize the firmware or perform other operations, using EasyLoader to burn firmware for M5StickV is the simplest solution.(**Currently EasyLoader is only available for Windows OS**) @@ -32,7 +32,7 @@ > Users who use an operating system other than Windows or who need to specify a burning file can use **Kflash** for firmware burning. Click the link below to download the firmware. - + ## Flash @@ -249,6 +249,32 @@ V-Training is an online recognition model training service customized for K210 s +## WS2812 + +The firmware has a built-in WS2812 RGB LED driver library. The following is a reference routine. Note: Since the expansion port of UnitV does not have a driving load function, this program is only suitable for driving the built-in RGB LED: + +``` +from modules import ws2812 +from fpioa_manager import * +fm.register(8) +class_ws2812 = ws2812(8,100) +r=0 +dir = True +while True: + if dir: + r += 5 + else: + r -= 5 + if r>=255: + r = 255 + dir = False + elif r<0: + r = 0 + dir = True + for i in range(100): + a = class_ws2812.set_led(i,(0,0,r)) + a=class_ws2812.display() +``` ## Library diff --git a/docs/en/unit/dual_button.md b/docs/en/unit/dual_button.md index fb3e8d4f..11fb56a7 100644 --- a/docs/en/unit/dual_button.md +++ b/docs/en/unit/dual_button.md @@ -10,11 +10,6 @@ This unit communicates with M5Core through GROVE B port. - - -**Output status:** - - ## Product Features diff --git a/docs/en/unit/env.md b/docs/en/unit/env.md index 3fe7890f..640111ef 100644 --- a/docs/en/unit/env.md +++ b/docs/en/unit/env.md @@ -13,7 +13,7 @@ BMP280 is an absolute barometric pressure sensor especially designed for mobile **I2C address:DHT12(0x5C)、BMP280(0x76)** -## Feature +## Product Features - Temperature: - measuring range: -20 ~ 60 ℃ diff --git a/docs/en/unit/unitv.md b/docs/en/unit/unitv.md index f840f43f..fe8dbaf6 100644 --- a/docs/en/unit/unitv.md +++ b/docs/en/unit/unitv.md @@ -205,12 +205,18 @@ UNIT-V does not currently recognize all types of MicroSD cards. We have tested s If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/App/UnitV/track_ball) +## Video + + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 594d9e7e..bbf2c77c 100755 --- a/docs/index.html +++ b/docs/index.html @@ -1,544 +1,5 @@ - - - - - - - - - - M5Stack-Doucment - A series of modular stackable development devices - - - - - - - - - - - - -
-
-
- - Search -
-
-
-

- M5Stack Docs

- -
-
- M5Stack-Twitter - M5Stack-Facebook - M5Stack-Youtube - M5Stack-Github - -
-
-
loading...
- - - - - - - - - - - - - - - - - - - - \ No newline at end of file +M5Stack Docs - The reference docs for M5Stack products.
Search

M5Stack Docs

loading...
diff --git a/docs/index.md b/docs/index.md index 76a44f09..936c74e1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,7 @@
- + + @@ -354,190 +142,7 @@ } if (!canonicalURL) canonicalURL = window.location.href; !function(){var e=/([http|https]:\/\/[a-zA-Z0-9\_\.]+\.baidu\.com)/gi,r=canonicalURL,t=document.referrer;if(!e.test(r)){var n=(String(curProtocol).toLowerCase() === 'https')?"https://sp0.baidu.com/9_Q4simg2RQJ8t7jm9iCKT-xh_/s.gif":"//api.share.baidu.com/s.gif";t?(n+="?r="+encodeURIComponent(document.referrer),r&&(n+="&l="+r)):r&&(n+="?l="+r);var i=new Image;i.src=n}}(window);})(); - - - - - \ No newline at end of file diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index 6d6d7d9f..999665d3 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -5,7 +5,7 @@ - diff --git a/docs/zh_CN/atom_base/Tail-BaT.md b/docs/zh_CN/atom_base/Tail-BaT.md deleted file mode 100644 index 3604d8c8..00000000 --- a/docs/zh_CN/atom_base/Tail-BaT.md +++ /dev/null @@ -1,70 +0,0 @@ -# Tail-Bat - -
SKU:A077
- -
- -## 描述 - -**Tail-Bat** - -## 产品特性 - -- 兼容Atom -- 机身小巧 -- 个性DIY -- 非封闭式设计 - - -## 包含 - - - -## 应用 - -- 外置移动电源 -- -- - -## 规格参数 - - - - - - - - - - - - - - - - - - - - - - - - - - -
规格参数
外接端口VH-3.96 4P
尺寸47 x 34 x 18mm
重量42g
外壳材质Plastic ( PC )
- - - - diff --git a/docs/zh_CN/atom_base/Tail485.md b/docs/zh_CN/atom_base/Tail485.md new file mode 100644 index 00000000..42952a55 --- /dev/null +++ b/docs/zh_CN/atom_base/Tail485.md @@ -0,0 +1,108 @@ +# Tail485 + +
SKU:
+ +
+ +## 描述 + +**Tail485** 是一款为ATOM设计的TTL-RS485转换器，用于TTL电平与RS485电平转换。RS485是一种通信协议标准，用于定义串行通信系统的驱动器和接收器的电气特性,支持多点系统，广泛应用于工业领域。当项目设备需要通过RS485进行通信控制时，使用 RS485 Unit 进行接口类型转接会是一个不错的选择。在Tail485的内部集成有DC/DC降压稳压芯片，可以直接将RS485的12V电压转为5V为TypeC接口供电，免去了单独供电的烦恼。 + +## 产品特性 + +- 适配Atom +- 内置DC/DC +- SP485EEN-L + +## 包含 + +- 1x Tail485 + +## 应用 + +- RS485多点通讯 + +## 规格参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
规格参数
外接端口VH-3.96 4P
转换电平5V<->12V
电平转换ICSP485EEN-L
稳压降压ICAOZ1282CI
尺寸30 x 24 x 9mm
重量42g
外壳材质Plastic ( PC )
+ +## EasyLoader + +>EasyLoader是一个简洁快速的程序烧录器，其内置了一个产品相关的案例程序，通过简单步骤将其烧录至主控，即可进行一系列的功能验证. + +
+
+
+
+ Windows + MacOS + +
+
+
+ +
+ + +

案例描述:

+

通过RS485进行通讯，发送数据.

+
+
+
+ +## 案例程序 + +### 1. Arduino IDE + +[点击这里获取Arduino示例程序](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/RS485) + + + diff --git a/docs/zh_CN/atom_base/TailBat.md b/docs/zh_CN/atom_base/TailBat.md new file mode 100644 index 00000000..82f376f3 --- /dev/null +++ b/docs/zh_CN/atom_base/TailBat.md @@ -0,0 +1,80 @@ +# TailBat + +
SKU:
+ +
+ +## 描述 + +**TailBat** 是一款为ATOM设计的外置电池配件，插入ATOM尾部可以直接为ATOM进行供电，方便用户在移动场景进行使用。TailBat正面设计有一个开关按键，内部含有190mAh电池，由电源管理芯片IP5303进行控制，当电源开启时红色指示灯点亮。使用方法与M5Stack Core的方式相同：单击开启电源，双击关闭电源。由于TailBat在增加电池的基础上对接口做了直通设计，因此不会影响原有的接线方式与接口功能。内置电池仅可以通过TypeC接口充电，不可以通过GROVE接口充电。 + +## 产品特性 + +- 适配ATOM +- 即插即用 +- 内置可充电锂电池 +- LED指示灯 +- 兼容Stick/C/V/M5Camera + +## 包含 + +- 1x TailBat + +## 应用 + +- ATOM外置移动电源 + +## 规格参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
规格参数
外接端口1x GROVE
LED指示灯1x RED LED
USB端口TypeC
电池容量190mAh
尺寸55 x 22 x 14mm
重量42g
外壳材质Plastic ( PC )
+ + + + diff --git a/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md b/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md index 15a03737..064776ee 100644 --- a/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md +++ b/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md @@ -8,7 +8,7 @@
- Windows + Windows
@@ -196,6 +196,32 @@ Linux命令行给运行权限然后,执行命令 +## WS2812 + +固件内置了WS2812 RGB LED驱动库，以下为参考例程： + +``` +from modules import ws2812 +from fpioa_manager import * +fm.register(board_info.CONNEXT_A) +class_ws2812 = ws2812(board_info.CONNEXT_A,130) +r=0 +dir = True +while True: + if dir: + r += 1 + else: + r -= 1 + if r>=255: + r = 255 + dir = False + elif r<0: + r = 0 + dir = True + for i in range(130): + a = class_ws2812.set_led(i,(0,0,r)) + a=class_ws2812.display() +``` ## 程序库 diff --git a/docs/zh_CN/quick_start/unitv/unitv_quick_start.md b/docs/zh_CN/quick_start/unitv/unitv_quick_start.md index dfa32c02..71a686c4 100644 --- a/docs/zh_CN/quick_start/unitv/unitv_quick_start.md +++ b/docs/zh_CN/quick_start/unitv/unitv_quick_start.md @@ -21,7 +21,7 @@ - + >1.EasyLoader是一个简洁快速的程序烧录器，每一个产品页面里的EasyLoader都提供了一个与产品相关的案例程序，对于不需要对固件进行定制或进行其他操作的用户，使用EasyLoader为UnitV烧录固件，会是一个最简洁的方案（**目前EasyLoader仅适用于Windows操作系统**）. @@ -32,7 +32,7 @@ > 需要指定烧录文件的用户可以选用**Kflash**进行固件烧录. - + ## 烧录固件 @@ -246,6 +246,34 @@ V-Training 是由M5Stack推出的一个针对K210系列产品而定制的在线 + +## WS2812 + +固件内置了WS2812 RGB LED驱动库，以下为参考例程. 注意:由于UnitV的拓展端口不具备驱动负载功能，因此该程序仅适用于驱动内置的RGB LED： + +``` +from modules import ws2812 +from fpioa_manager import * +fm.register(8) +class_ws2812 = ws2812(8,100) +r=0 +dir = True +while True: + if dir: + r += 5 + else: + r -= 5 + if r>=255: + r = 255 + dir = False + elif r<0: + r = 0 + dir = True + for i in range(100): + a = class_ws2812.set_led(i,(0,0,r)) + a=class_ws2812.display() +``` + ## 程序库 在程序库文档中，你可以找到更多的API，方便你搭建各式各样的应用。 diff --git a/docs/zh_CN/unit/dual_button.md b/docs/zh_CN/unit/dual_button.md index 0e95d58b..a398e3c3 100644 --- a/docs/zh_CN/unit/dual_button.md +++ b/docs/zh_CN/unit/dual_button.md @@ -8,9 +8,6 @@ **Dual Button**, 是一款双按键 Unit ，提供了两个不同颜色的物理按键供你进行操作.通过检测不同按键输入引脚高/低电平变化，进而判断按键状态.该 Unit 通过GROVE B端口与M5Core进行通信. -**输出状态示意:** - - ## 产品特性 diff --git a/docs/zh_CN/unit/unitv.md b/docs/zh_CN/unit/unitv.md index 511d8e49..f34a652f 100644 --- a/docs/zh_CN/unit/unitv.md +++ b/docs/zh_CN/unit/unitv.md @@ -267,8 +267,9 @@ Unit V目前并不能识别所有类型的MicroSD卡，我们对一些常见的M \ No newline at end of file