diff --git a/.eslintrc.js b/.eslintrc.js index 5ad82278..2c395dbb 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,42 +1,42 @@ -module.exports = { - "env": { - "browser" : true, - "commonjs": true, - "es6" : true, - "node" : true - }, - "extends": "eslint:recommended", - "parserOptions": { - "ecmaVersion": 6, - "sourceType" : "module" - }, - "plugins": [ - "html" - ], - "rules": { - "array-bracket-spacing" : ["error", "never"], - "array-callback-return" : ["error"], - "block-scoped-var" : ["error"], - "block-spacing" : ["error", "always"], - "curly" : ["error"], - "dot-notation" : ["error"], - "eqeqeq" : ["error"], - "indent" : ["error", 4], - "linebreak-style" : ["error", "unix"], - "no-console" : ["warn"], - "no-floating-decimal" : ["error"], - "no-implicit-coercion" : ["error"], - "no-implicit-globals" : ["error"], - "no-loop-func" : ["error"], - "no-return-assign" : ["error"], - "no-template-curly-in-string": ["error"], - "no-unneeded-ternary" : ["error"], - "no-unused-vars" : ["error", { "args": "none" }], - "no-useless-computed-key" : ["error"], - "no-useless-return" : ["error"], - "no-var" : ["error"], - "prefer-const" : ["error"], - "quotes" : ["error", "single"], - "semi" : ["error", "always"] - } -}; +module.exports = { + "env": { + "browser" : true, + "commonjs": true, + "es6" : true, + "node" : true + }, + "extends": "eslint:recommended", + "parserOptions": { + "ecmaVersion": 6, + "sourceType" : "module" + }, + "plugins": [ + "html" + ], + "rules": { + "array-bracket-spacing" : ["error", "never"], + "array-callback-return" : ["error"], + "block-scoped-var" : ["error"], + "block-spacing" : ["error", "always"], + "curly" : ["error"], + "dot-notation" : ["error"], + "eqeqeq" : ["error"], + "indent" : ["error", 4], + "linebreak-style" : ["error", "unix"], + "no-console" : ["warn"], + "no-floating-decimal" : ["error"], + "no-implicit-coercion" : ["error"], + "no-implicit-globals" : ["error"], + "no-loop-func" : ["error"], + "no-return-assign" : ["error"], + "no-template-curly-in-string": ["error"], + "no-unneeded-ternary" : ["error"], + "no-unused-vars" : ["error", { "args": "none" }], + "no-useless-computed-key" : ["error"], + "no-useless-return" : ["error"], + "no-var" : ["error"], + "prefer-const" : ["error"], + "quotes" : ["error", "single"], + "semi" : ["error", "always"] + } +}; diff --git a/.gitignore b/.gitignore index 09e3aea9..c81d14a9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,15 @@ -# Folders -build -coverage -dist -node_modules -.vscode - -# Files -*.log - -# OS -._* -.cache -.DS_Store -*.mp4 +# Folders +build +coverage +dist +node_modules +.vscode + +# Files +*.log + +# OS +._* +.cache +.DS_Store +*.mp4 diff --git a/LICENSE b/LICENSE index 51e689fe..f9bfe5a5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,21 @@ -MIT License - -Copyright (c) 2018 John Hildenbiddle - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +MIT License + +Copyright (c) 2018 John Hildenbiddle + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index b43a8e17..ee80ec8e 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ -# M5Stack - -[中文](https://github.com/watson8544/m5stack-documentation/tree/master/docs/zh_CN/README_zh_CN.md) | English | [日本語](https://github.com/watson8544/m5stack-documentation/tree/master/docs/ja/README_ja.md) - -**Welcome to M5Stack Documents!** - -## Introduction - -**M5 stack is a modular stackable development device. The M stands for Modular and 5 stands for the the units compact 5 x 5 cm size.** - -**The M5 stack aims to take the pain out of developing your new inventions and ideas. M5 stack comes packed with sensors, wifi, bluetooth, a screen and its own power supply which avoids the inconvenience of messy wires strewn across breadboards and adding new functionality is as simple as stacking it on top of one of the many expansion modules or plugging in a unit via the handy grove connectors.** - -Our a series of core boards are based on **ESP32** chip. - -Our aim is "**Stackable Board is Product**". Here's the [Official Website](http://www.m5stack.com) - - -## Contact & Support - -- :computer: Visit [Official Website](http://www.m5stack.com) for newest product -- :busts_in_silhouette: Sign in our [Forum](http://forum.m5stack.com) for more designs with M5Stack -- :mailbox_with_mail: If you have any questions, you can contact us by Email -- :convenience_store: If you want to get our products, access our [store](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) +# M5Stack + +[中文](https://github.com/watson8544/m5stack-documentation/tree/master/docs/zh_CN/README_zh_CN.md) | English | [日本語](https://github.com/watson8544/m5stack-documentation/tree/master/docs/ja/README_ja.md) + +**Welcome to M5Stack Documents!** + +## Introduction + +**M5 stack is a modular stackable development device. The M stands for Modular and 5 stands for the the units compact 5 x 5 cm size.** + +**The M5 stack aims to take the pain out of developing your new inventions and ideas. M5 stack comes packed with sensors, wifi, bluetooth, a screen and its own power supply which avoids the inconvenience of messy wires strewn across breadboards and adding new functionality is as simple as stacking it on top of one of the many expansion modules or plugging in a unit via the handy grove connectors.** + +Our a series of core boards are based on **ESP32** chip. + +Our aim is "**Stackable Board is Product**". Here's the [Official Website](http://www.m5stack.com) + + +## Contact & Support + +- :computer: Visit [Official Website](http://www.m5stack.com) for newest product +- :busts_in_silhouette: Sign in our [Forum](http://forum.m5stack.com) for more designs with M5Stack +- :mailbox_with_mail: If you have any questions, you can contact us by Email +- :convenience_store: If you want to get our products, access our [store](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) diff --git a/docs/_redirects b/docs/_redirects index ebb755ae..b0e170db 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,4 +1,4 @@ -/* /index.html 200 - -# Redirect default Netlify subdomain to primary domain +/* /index.html 200 + +# Redirect default Netlify subdomain to primary domain http://m5-docs.netlify.com/* http://docs.m5stack.com/:splat 301! \ No newline at end of file diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css index 77743a08..e99bd9b1 100644 --- a/docs/assets/css/main.css +++ b/docs/assets/css/main.css @@ -1,48 +1,48 @@ -:root {--theme-color: hsl(204, 90%, 45%);} - -.markdown-section a { - color: var(--theme-color,#42b983); -} - -.markdown-section iframe[src*="buttons.github.io"] { - margin: 0; -} - -figure.thumbnails img { - margin: 0.75em 0; - border-radius: 3px; - box-shadow: 0 2px 6px rgba(0,0,0,0.1), 0 4px 12px rgba(0,0,0,0.15); -} - -@media (min-width: 30em) { - figure.thumbnails:after { - content: ""; - display: table; - clear: both; - } - - figure.thumbnails img { - float: left; - width: calc(50% - 0.75em); - } - - figure.thumbnails img:nth-child(even) { - margin-left: 1.5em; - } - - @supports (display: flex) { - figure.thumbnails { - display: flex; - align-items: center; - } - - figure.thumbnails img { - flex-grow: 1; - width: 0; - } - - figure.thumbnails img + img { - margin: 0 0 0 1.5em; - } - } -} +:root {--theme-color: hsl(204, 90%, 45%);} + +.markdown-section a { + color: var(--theme-color,#42b983); +} + +.markdown-section iframe[src*="buttons.github.io"] { + margin: 0; +} + +figure.thumbnails img { + margin: 0.75em 0; + border-radius: 3px; + box-shadow: 0 2px 6px rgba(0,0,0,0.1), 0 4px 12px rgba(0,0,0,0.15); +} + +@media (min-width: 30em) { + figure.thumbnails:after { + content: ""; + display: table; + clear: both; + } + + figure.thumbnails img { + float: left; + width: calc(50% - 0.75em); + } + + figure.thumbnails img:nth-child(even) { + margin-left: 1.5em; + } + + @supports (display: flex) { + figure.thumbnails { + display: flex; + align-items: center; + } + + figure.thumbnails img { + flex-grow: 1; + width: 0; + } + + figure.thumbnails img + img { + margin: 0 0 0 1.5em; + } + } +} diff --git a/docs/assets/js/.eslintrc.js b/docs/assets/js/.eslintrc.js index 36ac1fa7..aafbff21 100644 --- a/docs/assets/js/.eslintrc.js +++ b/docs/assets/js/.eslintrc.js @@ -1,15 +1,15 @@ -module.exports = { - "parserOptions": { - "ecmaVersion": 5, - "sourceType": "script" - }, - "env": { - "commonjs": false, - "es6" : false, - "node" : false - }, - "rules": { - "no-var" : "off", - "prefer-const": "off" - } +module.exports = { + "parserOptions": { + "ecmaVersion": 5, + "sourceType": "script" + }, + "env": { + "commonjs": false, + "es6" : false, + "node" : false + }, + "rules": { + "no-var" : "off", + "prefer-const": "off" + } } \ No newline at end of file diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js index 1029804c..4d2e4fcc 100644 --- a/docs/assets/js/main.js +++ b/docs/assets/js/main.js @@ -1,121 +1,121 @@ -(function() { - // Functions - // ========================================================================= - /** - * Adds event listeners to change active stylesheet and restore previously - * activated stylesheet on reload. - * - * @example - * - * This link: - * Foo - * Will active this existing link: - * - * - * @example - * - * This link: - * Bar - * Will activate this existing link: - * - * Or generate this active link: - * - */ - function initStyleSwitcher() { - var isInitialzed = false; - var sessionStorageKey = 'activeStylesheetHref'; - - function handleSwitch(activeHref, activeTitle) { - var activeElm = document.querySelector('link[href*="' + activeHref +'"],link[title="' + activeTitle +'"]'); - - if (!activeElm && activeHref) { - activeElm = document.createElement('link'); - activeElm.setAttribute('href', activeHref); - activeElm.setAttribute('rel', 'stylesheet'); - activeElm.setAttribute('title', activeTitle); - - document.head.appendChild(activeElm); - - activeElm.addEventListener('load', function linkOnLoad() { - activeElm.removeEventListener('load', linkOnLoad); - setActiveLink(activeElm); - }); - } - else if (activeElm) { - setActiveLink(activeElm); - } - } - - function setActiveLink(activeElm) { - var activeHref = activeElm.getAttribute('href'); - var activeTitle = activeElm.getAttribute('title'); - var inactiveElms = document.querySelectorAll('link[title]:not([href*="' + activeHref +'"]):not([title="' + activeTitle +'"])'); - - // Remove "alternate" keyword - activeElm.setAttribute('rel', (activeElm.rel || '').replace(/\s*alternate/g, '').trim()); - - // Force enable stylesheet (required for some browsers) - activeElm.disabled = true; - activeElm.disabled = false; - - // Store active style sheet - sessionStorage.setItem(sessionStorageKey, activeHref); - - // Disable other elms - for (var i = 0; i < inactiveElms.length; i++) { - var elm = inactiveElms[i]; - - elm.disabled = true; - - // Fix for browsersync and alternate stylesheet updates. Will - // cause FOUC when switching stylesheets during development, but - // required to properly apply style updates when alternate - // stylesheets are enabled. - if (window.browsersyncObserver) { - var linkRel = elm.getAttribute('rel') || ''; - var linkRelAlt = linkRel.indexOf('alternate') > -1 ? linkRel : (linkRel + ' alternate').trim(); - - elm.setAttribute('rel', linkRelAlt); - } - } - - // CSS custom property ponyfil - if ((window.$docsify || {}).themeable) { - window.$docsify.themeable.util.cssVars(); - } - } - - // Event listeners - if (!isInitialzed) { - isInitialzed = true; - - // Restore active stylesheet - document.addEventListener('DOMContentLoaded', function() { - var activeHref = sessionStorage.getItem(sessionStorageKey); - - if (activeHref) { - handleSwitch(activeHref); - } - }); - - // Update active stylesheet - document.addEventListener('click', function(evt) { - var dataHref = evt.target.getAttribute('data-link-href'); - var dataTitle = evt.target.getAttribute('data-link-title') - - if (dataHref || dataTitle) { - dataTitle = dataTitle - || evt.target.textContent - || '_' + Math.random().toString(36).substr(2, 9); // UID - - handleSwitch(dataHref, dataTitle); - evt.preventDefault(); - } - }); - } - } - - // Main - // ========================================================================= - initStyleSwitcher(); -})(); +(function() { + // Functions + // ========================================================================= + /** + * Adds event listeners to change active stylesheet and restore previously + * activated stylesheet on reload. + * + * @example + * + * This link: + * Foo + * Will active this existing link: + * + * + * @example + * + * This link: + * Bar + * Will activate this existing link: + * + * Or generate this active link: + * + */ + function initStyleSwitcher() { + var isInitialzed = false; + var sessionStorageKey = 'activeStylesheetHref'; + + function handleSwitch(activeHref, activeTitle) { + var activeElm = document.querySelector('link[href*="' + activeHref +'"],link[title="' + activeTitle +'"]'); + + if (!activeElm && activeHref) { + activeElm = document.createElement('link'); + activeElm.setAttribute('href', activeHref); + activeElm.setAttribute('rel', 'stylesheet'); + activeElm.setAttribute('title', activeTitle); + + document.head.appendChild(activeElm); + + activeElm.addEventListener('load', function linkOnLoad() { + activeElm.removeEventListener('load', linkOnLoad); + setActiveLink(activeElm); + }); + } + else if (activeElm) { + setActiveLink(activeElm); + } + } + + function setActiveLink(activeElm) { + var activeHref = activeElm.getAttribute('href'); + var activeTitle = activeElm.getAttribute('title'); + var inactiveElms = document.querySelectorAll('link[title]:not([href*="' + activeHref +'"]):not([title="' + activeTitle +'"])'); + + // Remove "alternate" keyword + activeElm.setAttribute('rel', (activeElm.rel || '').replace(/\s*alternate/g, '').trim()); + + // Force enable stylesheet (required for some browsers) + activeElm.disabled = true; + activeElm.disabled = false; + + // Store active style sheet + sessionStorage.setItem(sessionStorageKey, activeHref); + + // Disable other elms + for (var i = 0; i < inactiveElms.length; i++) { + var elm = inactiveElms[i]; + + elm.disabled = true; + + // Fix for browsersync and alternate stylesheet updates. Will + // cause FOUC when switching stylesheets during development, but + // required to properly apply style updates when alternate + // stylesheets are enabled. + if (window.browsersyncObserver) { + var linkRel = elm.getAttribute('rel') || ''; + var linkRelAlt = linkRel.indexOf('alternate') > -1 ? linkRel : (linkRel + ' alternate').trim(); + + elm.setAttribute('rel', linkRelAlt); + } + } + + // CSS custom property ponyfil + if ((window.$docsify || {}).themeable) { + window.$docsify.themeable.util.cssVars(); + } + } + + // Event listeners + if (!isInitialzed) { + isInitialzed = true; + + // Restore active stylesheet + document.addEventListener('DOMContentLoaded', function() { + var activeHref = sessionStorage.getItem(sessionStorageKey); + + if (activeHref) { + handleSwitch(activeHref); + } + }); + + // Update active stylesheet + document.addEventListener('click', function(evt) { + var dataHref = evt.target.getAttribute('data-link-href'); + var dataTitle = evt.target.getAttribute('data-link-title') + + if (dataHref || dataTitle) { + dataTitle = dataTitle + || evt.target.textContent + || '_' + Math.random().toString(36).substr(2, 9); // UID + + handleSwitch(dataHref, dataTitle); + evt.preventDefault(); + } + }); + } + } + + // Main + // ========================================================================= + initStyleSwitcher(); +})(); diff --git a/docs/assets/styles.css b/docs/assets/styles.css index aef12471..5fecf2c5 100644 --- a/docs/assets/styles.css +++ b/docs/assets/styles.css @@ -1,393 +1,393 @@ -:root { - --theme-color: #1FC5BF; - --theme-color-light: #99EBE2; - --theme-color-dark: #00B3AC; - --theme-color-secondary: #6A5096; - --theme-color-secondary-dark: #3F1C77; - --theme-color-secondary-light: #C4B2E1; - - --text-color-base: #2E2E46; - --text-color-secondary: #646473; - --text-color-tertiary: #81818E; -} - - -::selection { - background: var(--theme-color-light); -} - -body { - font-size: 100%; - line-height: 1.5; - font-family: 'Source Sans Pro','Open Sans','Helvetica Neue',Arial,sans-serif; - color: var(--text-color-base); -} - -* { - text-decoration: none !important; -} - -a { - transition: all 0.3s linear; -} - -div.search { - border-bottom: 2px solid #787881; - border: none; - background-color: var(--theme-color-secondary-light); - padding: 0; -} - -.sidebar .search input { - background: none; - background-color: rgba(255,255,255,0.5); - padding: 1rem; - transition: background-color 0.3s ease; -} - -.sidebar .search input:focus { - background-color: rgba(255,255,255,1); -} - -aside.sidebar { - border: none; - background-color: var(--theme-color-secondary); - color: #fff; - width: 20%; -} - -body.close .sidebar { - transform: translateX(-100%); -} - -.sidebar ul li a { - color: rgba(255,255,255,0.8); - color: var(--theme-color-light); - font-size: 1rem; -} - -.sidebar ul li.active>a { - border-width: 0.1rem; -} - -.sidebar ul li a:hover { - text-decoration: none; - color: rgba(255,255,255,1); -} - -.sidebar .sidebar-nav ul li.active>a { - color: #fff; - border-right: 0.2rem solid var(--theme-color-secondary-light,#29D0CA); -} - -.search .results-panel.show { - background-color: #05827E; - background-color: #fff; - color: #000; -} - -.sidebar .search .matching-post { - padding: 0; - border-bottom: 0.2rem solid #E4E4E6; -} - -.sidebar .search .matching-post:first-child { - border-top: 0.2rem solid #E4E4E6; -} - -.search .search-keyword { - /* color: #fff; */ -} - -.search a { - padding: 1rem; - display: block; - transition: background-color 0.3s ease; -} - -.search a:hover { - color: var(--theme-color-dark); -} - -.search p.empty { - margin: 0; - padding: 1rem; - background-color: #F1F1F2; -} - -.sidebar > h1 { - font-size: 2rem; -} - -.sidebar-logo { - display: block; - width: 4rem; - vertical-align: bottom; - line-height: 1.6; - height: 4rem; - margin: 0 auto; -} - -body .sidebar-toggle { - background: none; - bottom: 1rem; - left: 1rem; - cursor: pointer; - width: 1.5rem; - height: 1.5rem; - padding: 0; -} - -body .sidebar-toggle span { - transition: all 0.3s linear; - background-color: var(--theme-color-light); - height: 0.25rem; - width: 1.5rem; - position: absolute; - left: 0; - margin: 0; - transform-origin: 0; -} - -body.close .sidebar-toggle { - width: 1.5rem; - height: 1.5rem; -} - -body.close .sidebar-toggle span { - transform-origin: center; -} - -body .sidebar-toggle span:nth-child(1) { top:0; } -body .sidebar-toggle span:nth-child(2) { top:0.65rem; } -body .sidebar-toggle span:nth-child(3) { top:1.25rem; } - -.sidebar-toggle .sidebar-toggle-button:hover { opacity: 1; } - -.sidebar-toggle:hover span:nth-child(1) { transform: rotate(45deg); width: 1.75rem; } -.sidebar-toggle:hover span:nth-child(2) { opacity: 0; } -.sidebar-toggle:hover span:nth-child(3) { transform: rotate(-45deg); width: 1.75rem; } - -.close .sidebar-toggle:hover span:nth-child(1) { transform:rotate(0); width:1.5rem; top:0.65rem; } -.close .sidebar-toggle:hover span:nth-child(2) { opacity: 1; transform:rotate(90deg); } -.close .sidebar-toggle:hover span:nth-child(3) { transform:rotate(0); width:1.5rem; top:0.65rem; } - -th { - text-align: left; -} - -.markdown-section blockquote { - margin: 1em 0; -} - -.markdown-section em, -.markdown-section blockquote { - color: var(--text-color-tertiary); -} - -.cover-main img { - max-width: 10rem; - max-height: 10rem; -} - -section.cover p { - line-height: inherit; -} - -section.cover .cover-main a { - font-weight: 600; -} - -section.cover .cover-main a::before { - display: none; -} - -section.cover .cover-main blockquote { - font-style: italic; - color: #868C91; -} - -section.cover .cover-main>p:last-child a:first-child { - border-width: 0.2rem; - color: var(--theme-color-secondary); - border-color: var(--theme-color-secondary); -} - -section.cover .cover-main>p:last-child a:last-child { - background-color: var(--theme-color-secondary); - border-color: var(--theme-color-secondary); -} - -section.cover .cover-main>p:last-child a:hover { - color: var(--theme-color-secondary-dark); - border-color: var(--theme-color-secondary-dark); - opacity: 1; -} - -section.cover .cover-main>p:last-child a:last-child:hover { - background-color: var(--theme-color-secondary-dark); - border-color: var(--theme-color-secondary-dark); - color: #fff; - opacity: 1; -} - -.anchor { - position: relative; -} - -.anchor::before { - content: '\1F449'; - position: absolute; - top: 0; - left: -1.25em; - opacity: 0; - font-size: 0.875em; -} - -.anchor:hover::before { - opacity: 1; -} - -section.cover .cover-main { - margin: 20vh 20vw; -} - -.app-name-link { - white-space: nowrap; -} - -.app-sub-sidebar li:before { - display: none; -} - -.markdown-section pre, -.markdown-section pre > code { - background-color: #2E2E46; - color: rgba(255,255,255,0.75); - font-size: 1em; - line-height: 1.5; -} - -.markdown-section code { - display: inline-block; - font-family: 'Source Code Pro', monospace; -} - -.markdown-section pre { - padding: 2rem; -} - -.markdown-section pre > code { - padding: 0; -} - -.markdown-section hr { - border-bottom: 5px solid transparent; -} - -.token.punctuation { - color: #585967; -} - -.token.comment, -.token.block-comment, -.token.prolog, -.token.doctype, -.token.cdata{color:#999999;} -.token.property, -.token.number, -.token.function-name, -.token.constant, -.token.symbol, -.token.deleted{color:#5a9bcf;}.token.boolean{color:#ff8b50;}.token.tag{color:#fc929e;}.token.string{color:#8dc891;}.token.punctuation{color:#5FB3B3;} -.token.selector, -.token.char, -.token.builtin, -.token.inserted{color:#D8DEE9;}.token.function{color:#79b6f2;} -.token.operator, -.token.entity, -.token.url, -.token.variable{color:#d7deea;}.token.attr-value{color:#8dc891;}.token.keyword{color:#c5a5c5;} - -.lang-scss .token.variable { - color: #8dc891; -} - -.markdown-section { - max-width: 75rem; - padding: 1rem 3rem; -} - -.markdown-section ol, .markdown-section p, .markdown-section ul { - line-height: inherit; -} - -.markdown-section code { - color: inherit; - border-radius: 0; - font-size: 0.9em; - padding: 6px 10px; - /* color: #111; */ -} - -.markdown-section table { - display: table; -} - -.markdown-section table tr { - border-width: 0.2rem 0; - border-style: solid; - border-color: #F1F1F2; -} - -.markdown-section table tr:nth-child(2n) { - background-color: transparent; -} - -.markdown-section table td, -.markdown-section table th { - border: none; - padding: 1.5rem 0.5rem; - text-align: left; -} - -.markdown-section table td p { - margin: 0; -} - -.markdown-section a { - text-decoration: none; - border-bottom: 0.1rem solid var(--theme-color-light); - transition: all 0.3s ease; -} - -.markdown-section a:hover { - border-color: var(--theme-color); - color: var(--theme-color-dark); -} - - -/* Badges */ -.markdown-section > p:first-child > a { - border: none; -} - -.docsify-copy-code-button { - background: var(--theme-color); -} - -.sidebar::-webkit-scrollbar { - width:0; -} - -@media (min-width: 1200px) { - body { - font-size: 112.5%; - } -} - -@media (min-width: 1400px) { - body { - font-size: 125%; - } -} +:root { + --theme-color: #1FC5BF; + --theme-color-light: #99EBE2; + --theme-color-dark: #00B3AC; + --theme-color-secondary: #6A5096; + --theme-color-secondary-dark: #3F1C77; + --theme-color-secondary-light: #C4B2E1; + + --text-color-base: #2E2E46; + --text-color-secondary: #646473; + --text-color-tertiary: #81818E; +} + + +::selection { + background: var(--theme-color-light); +} + +body { + font-size: 100%; + line-height: 1.5; + font-family: 'Source Sans Pro','Open Sans','Helvetica Neue',Arial,sans-serif; + color: var(--text-color-base); +} + +* { + text-decoration: none !important; +} + +a { + transition: all 0.3s linear; +} + +div.search { + border-bottom: 2px solid #787881; + border: none; + background-color: var(--theme-color-secondary-light); + padding: 0; +} + +.sidebar .search input { + background: none; + background-color: rgba(255,255,255,0.5); + padding: 1rem; + transition: background-color 0.3s ease; +} + +.sidebar .search input:focus { + background-color: rgba(255,255,255,1); +} + +aside.sidebar { + border: none; + background-color: var(--theme-color-secondary); + color: #fff; + width: 20%; +} + +body.close .sidebar { + transform: translateX(-100%); +} + +.sidebar ul li a { + color: rgba(255,255,255,0.8); + color: var(--theme-color-light); + font-size: 1rem; +} + +.sidebar ul li.active>a { + border-width: 0.1rem; +} + +.sidebar ul li a:hover { + text-decoration: none; + color: rgba(255,255,255,1); +} + +.sidebar .sidebar-nav ul li.active>a { + color: #fff; + border-right: 0.2rem solid var(--theme-color-secondary-light,#29D0CA); +} + +.search .results-panel.show { + background-color: #05827E; + background-color: #fff; + color: #000; +} + +.sidebar .search .matching-post { + padding: 0; + border-bottom: 0.2rem solid #E4E4E6; +} + +.sidebar .search .matching-post:first-child { + border-top: 0.2rem solid #E4E4E6; +} + +.search .search-keyword { + /* color: #fff; */ +} + +.search a { + padding: 1rem; + display: block; + transition: background-color 0.3s ease; +} + +.search a:hover { + color: var(--theme-color-dark); +} + +.search p.empty { + margin: 0; + padding: 1rem; + background-color: #F1F1F2; +} + +.sidebar > h1 { + font-size: 2rem; +} + +.sidebar-logo { + display: block; + width: 4rem; + vertical-align: bottom; + line-height: 1.6; + height: 4rem; + margin: 0 auto; +} + +body .sidebar-toggle { + background: none; + bottom: 1rem; + left: 1rem; + cursor: pointer; + width: 1.5rem; + height: 1.5rem; + padding: 0; +} + +body .sidebar-toggle span { + transition: all 0.3s linear; + background-color: var(--theme-color-light); + height: 0.25rem; + width: 1.5rem; + position: absolute; + left: 0; + margin: 0; + transform-origin: 0; +} + +body.close .sidebar-toggle { + width: 1.5rem; + height: 1.5rem; +} + +body.close .sidebar-toggle span { + transform-origin: center; +} + +body .sidebar-toggle span:nth-child(1) { top:0; } +body .sidebar-toggle span:nth-child(2) { top:0.65rem; } +body .sidebar-toggle span:nth-child(3) { top:1.25rem; } + +.sidebar-toggle .sidebar-toggle-button:hover { opacity: 1; } + +.sidebar-toggle:hover span:nth-child(1) { transform: rotate(45deg); width: 1.75rem; } +.sidebar-toggle:hover span:nth-child(2) { opacity: 0; } +.sidebar-toggle:hover span:nth-child(3) { transform: rotate(-45deg); width: 1.75rem; } + +.close .sidebar-toggle:hover span:nth-child(1) { transform:rotate(0); width:1.5rem; top:0.65rem; } +.close .sidebar-toggle:hover span:nth-child(2) { opacity: 1; transform:rotate(90deg); } +.close .sidebar-toggle:hover span:nth-child(3) { transform:rotate(0); width:1.5rem; top:0.65rem; } + +th { + text-align: left; +} + +.markdown-section blockquote { + margin: 1em 0; +} + +.markdown-section em, +.markdown-section blockquote { + color: var(--text-color-tertiary); +} + +.cover-main img { + max-width: 10rem; + max-height: 10rem; +} + +section.cover p { + line-height: inherit; +} + +section.cover .cover-main a { + font-weight: 600; +} + +section.cover .cover-main a::before { + display: none; +} + +section.cover .cover-main blockquote { + font-style: italic; + color: #868C91; +} + +section.cover .cover-main>p:last-child a:first-child { + border-width: 0.2rem; + color: var(--theme-color-secondary); + border-color: var(--theme-color-secondary); +} + +section.cover .cover-main>p:last-child a:last-child { + background-color: var(--theme-color-secondary); + border-color: var(--theme-color-secondary); +} + +section.cover .cover-main>p:last-child a:hover { + color: var(--theme-color-secondary-dark); + border-color: var(--theme-color-secondary-dark); + opacity: 1; +} + +section.cover .cover-main>p:last-child a:last-child:hover { + background-color: var(--theme-color-secondary-dark); + border-color: var(--theme-color-secondary-dark); + color: #fff; + opacity: 1; +} + +.anchor { + position: relative; +} + +.anchor::before { + content: '\1F449'; + position: absolute; + top: 0; + left: -1.25em; + opacity: 0; + font-size: 0.875em; +} + +.anchor:hover::before { + opacity: 1; +} + +section.cover .cover-main { + margin: 20vh 20vw; +} + +.app-name-link { + white-space: nowrap; +} + +.app-sub-sidebar li:before { + display: none; +} + +.markdown-section pre, +.markdown-section pre > code { + background-color: #2E2E46; + color: rgba(255,255,255,0.75); + font-size: 1em; + line-height: 1.5; +} + +.markdown-section code { + display: inline-block; + font-family: 'Source Code Pro', monospace; +} + +.markdown-section pre { + padding: 2rem; +} + +.markdown-section pre > code { + padding: 0; +} + +.markdown-section hr { + border-bottom: 5px solid transparent; +} + +.token.punctuation { + color: #585967; +} + +.token.comment, +.token.block-comment, +.token.prolog, +.token.doctype, +.token.cdata{color:#999999;} +.token.property, +.token.number, +.token.function-name, +.token.constant, +.token.symbol, +.token.deleted{color:#5a9bcf;}.token.boolean{color:#ff8b50;}.token.tag{color:#fc929e;}.token.string{color:#8dc891;}.token.punctuation{color:#5FB3B3;} +.token.selector, +.token.char, +.token.builtin, +.token.inserted{color:#D8DEE9;}.token.function{color:#79b6f2;} +.token.operator, +.token.entity, +.token.url, +.token.variable{color:#d7deea;}.token.attr-value{color:#8dc891;}.token.keyword{color:#c5a5c5;} + +.lang-scss .token.variable { + color: #8dc891; +} + +.markdown-section { + max-width: 75rem; + padding: 1rem 3rem; +} + +.markdown-section ol, .markdown-section p, .markdown-section ul { + line-height: inherit; +} + +.markdown-section code { + color: inherit; + border-radius: 0; + font-size: 0.9em; + padding: 6px 10px; + /* color: #111; */ +} + +.markdown-section table { + display: table; +} + +.markdown-section table tr { + border-width: 0.2rem 0; + border-style: solid; + border-color: #F1F1F2; +} + +.markdown-section table tr:nth-child(2n) { + background-color: transparent; +} + +.markdown-section table td, +.markdown-section table th { + border: none; + padding: 1.5rem 0.5rem; + text-align: left; +} + +.markdown-section table td p { + margin: 0; +} + +.markdown-section a { + text-decoration: none; + border-bottom: 0.1rem solid var(--theme-color-light); + transition: all 0.3s ease; +} + +.markdown-section a:hover { + border-color: var(--theme-color); + color: var(--theme-color-dark); +} + + +/* Badges */ +.markdown-section > p:first-child > a { + border: none; +} + +.docsify-copy-code-button { + background: var(--theme-color); +} + +.sidebar::-webkit-scrollbar { + width:0; +} + +@media (min-width: 1200px) { + body { + font-size: 112.5%; + } +} + +@media (min-width: 1400px) { + body { + font-size: 125%; + } +} diff --git a/docs/coverpage.md b/docs/coverpage.md index 569c9df9..ed714b1b 100644 --- a/docs/coverpage.md +++ b/docs/coverpage.md @@ -1,11 +1,11 @@ - - -> A documentation for [M5Stack](https://www.m5stack.com) - -- A series of modular stackable development devices integrating WIFI/BLE -- For Industry Development/STEM Education -- Programming with UiFlow(Blockly/MicroPython) - -[Official Website](http://www.m5stack.com) -[Introdction](#main) -[Quick Start](/en/quick_start) + + +> A documentation for [M5Stack](https://www.m5stack.com) + +- A series of modular stackable development devices integrating WIFI/BLE +- For Industry Development/STEM Education +- Programming with UiFlow(Blockly/MicroPython) + +[Official Website](http://www.m5stack.com) +[Introdction](#main) +[Quick Start](/en/quick_start) diff --git a/docs/en/accessory/cables/lego_cable.md b/docs/en/accessory/cables/lego_cable.md index 26f9bba2..28b16279 100644 --- a/docs/en/accessory/cables/lego_cable.md +++ b/docs/en/accessory/cables/lego_cable.md @@ -1,18 +1,18 @@ -# LEGO Cable - -## Description - -LEGO Cableis designed for connecting GRVOE interface and LEGO, particularly, using for connecting M5Core and LEGO. - -## Feature - -- 3 specifications: 10cm, 20cm, 30cm - -## Related Link - - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** - -
- lego_cable_01 +# LEGO Cable + +## Description + +LEGO Cableis designed for connecting GRVOE interface and LEGO, particularly, using for connecting M5Core and LEGO. + +## Feature + +- 3 specifications: 10cm, 20cm, 30cm + +## Related Link + + +- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** + +
+ lego_cable_01
\ No newline at end of file diff --git a/docs/en/accessory/frame.md b/docs/en/accessory/frame.md index bb3604c4..1a474ffe 100644 --- a/docs/en/accessory/frame.md +++ b/docs/en/accessory/frame.md @@ -1,22 +1,22 @@ -# Frame - -## Description - -Frameis designed as a fixed frame for M5Core. - -## Related Link - -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) - -
- frame_01 -
-
- frame_02 -
-
- frame_03 -
-
- frame_04 +# Frame + +## Description + +Frameis designed as a fixed frame for M5Core. + +## Related Link + +- [Purchase](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) + +
+ frame_01 +
+
+ frame_02 +
+
+ frame_03 +
+
+ frame_04
\ No newline at end of file diff --git a/docs/en/accessory/headers_socket.md b/docs/en/accessory/headers_socket.md index 4436886e..a9c7812a 100644 --- a/docs/en/accessory/headers_socket.md +++ b/docs/en/accessory/headers_socket.md @@ -1,3 +1,3 @@ -# Headers Socket - -## (coming soom...) +# Headers Socket + +## (coming soom...) diff --git a/docs/en/api.md b/docs/en/api.md index 41ba380a..2ddfa866 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -1,10 +1,10 @@ -# API Reference - -| MicroPython | Arduino | -|:------------|:--------| -|[LCD](en/api_reference/micropython/api_lcd) | / | - - - +# API Reference + +| MicroPython | Arduino | +|:------------|:--------| +|[LCD](en/api_reference/micropython/api_lcd) | / | + + + diff --git a/docs/en/api/gpio.md b/docs/en/api/gpio.md index 76abbad3..7713b98a 100644 --- a/docs/en/api/gpio.md +++ b/docs/en/api/gpio.md @@ -1,21 +1,21 @@ -# GPIO - -*Refer to GPIO API of [Arduino](http://www.arduino.cc)* - -### digitalRead -> uint32 digitalRead(uint8 pin); - -Read the value of `pin` - -| Param | Type | Description | -| --- | --- | --- | -| pin | uint8 | the number of pin | - -Return: - digital level(0/1) - -**Example** -```c++ -uint32_t pin21_data; -pin21_data = digitalRead(21); +# GPIO + +*Refer to GPIO API of [Arduino](http://www.arduino.cc)* + +### digitalRead +> uint32 digitalRead(uint8 pin); + +Read the value of `pin` + +| Param | Type | Description | +| --- | --- | --- | +| pin | uint8 | the number of pin | + +Return: + digital level(0/1) + +**Example** +```c++ +uint32_t pin21_data; +pin21_data = digitalRead(21); ``` \ No newline at end of file diff --git a/docs/en/api/lcd.md b/docs/en/api/lcd.md index 792e2e8b..c82c488c 100644 --- a/docs/en/api/lcd.md +++ b/docs/en/api/lcd.md @@ -1,205 +1,205 @@ -# LCD - -### lcd.setRotation(degree) - -**Example** -```python -lcd.setRotation(90) -``` - -**Set the angle of rotation of the entire screen.** - -| Param | Description | -| --- | --- | -| degree | the angle of setRotation | - - - -* * * - - -### lcd.setColor(color [, background_color]) -**Example** -```python -lcd.setColor(lcd.RED) -lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) -``` - -**Set the default foreground/background color of text.** - -| Param | Description | -| --- | --- | -| color | the color of text | -| background_color| the fill color of text | - -* * * - -### lcd.fillScreen(color) -**Example** -```python -lcd.fillScreen(lcd.RED) -``` -**Fill the entire screen with the given color.** - -| Param | Description | -| --- | --- | -| color | color value | - - - -* * * - -### lcd.drawPixel(x, y [,color]) -**Example** -```python -lcd.drawPixel(22,22,lcd.RED) -``` -**Draw the pixel at position (x,y)** - -*If color is not given, current foreground color is used* - -| Param | Description | -| --- | --- | -| color | color value | - - - -* * * - -### lcd.drawLine(x, y, x1, y1 [,color]) -**Example** -```python -lcd.drawLine(0,0,12,12,lcd.WHITE) -``` -**Draw the line from point (x,y) to point (x1,y1)** - -*If color is not given, current foreground color is used* - -| Param | Description | -| --- | --- | -| color | color value | - - -* * * - -### lcd.drawTriangle(x, y, x1, y1, x2, y2 [,color]) - -**Example** -```python -lcd.drawTriangle(22,22,69,98,51,22,lcd.RED) -``` - -**Draw the triangel between points (x,y), (x1,y1) and (x2,y2).** - -*If color is not given, current foreground color is used* - -| Param | Description | -| --- | --- | -| color | color value | - -* * * - -### lcd.fillTriangle(x, y, x1, y1, x2, y2 [,color]) - -**Example** -```python -lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) -``` -**Fill the triangel between points (x,y), (x1,y1) and (x2,y2).** - -*If color is not given, current foreground color is used* - -| Param | Description | -| --- | --- | -| color | color value | - - -* * * -### lcd.drawRect(x, y, w, h, [,color]) -**Example** -```python -lcd.drawRect(180, 12, 122, 10, lcd.BLUE) -``` -**Draw the rectangle from the upper left point at (x,y) and width and height.** - -*If color is not given, current foreground color is used* - -| Param | Description | -| --- | --- | -| w | display phisical width in pixels (display’s smaller dimension) | -| h | display phisical height in pixels (display’s larger dimension) | -| color | color value | - - - - -* * * - -### lcd.drawRoundRect(x, y, w, h, r [,color]) -**Example** -```python -lcd.fillRoundRect(180,70,122,10,4,lcd.BLUE) -``` -**Draw the rectangle with rounded corners from the upper left point at (x,y) and width and height. Corner radius is given by r argument.** - -*If color is not given, current foreground color is used* - -| Param | Description | -| --- | --- | -| w | display phisical width in pixels (display’s smaller dimension) | -| h | display phisical height in pixels (display’s larger dimension) | -| r | the radius of circle | -| color | color value | - - - - -* * * -### lcd.print(‘text’, [x, y]) -**Example** -```python -lcd.print('this is a print text function', 80, 80) -``` -**Print the text at position (x,y).** - -| Param | Description | -| --- | --- | -| text | the string need to print | - - -* * * - -### lcd.clear([color]) - -**Example** -```python -lcd.clear() -``` - -**Clear the screen with default background color orspecific color if given.** - - -* * * - -### Usage - -```python -from machine import SPI, Pin -from display import LCD - -spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) - -lcd = LCD(spi = spi) #lcd init -lcd.fillScreen(lcd.BLACK) #set the default background color - -lcd.drawLine(0, 0, lcd.WHITE) -lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) -lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) -lcd.drawCircle(180, 180, 10, lcd.BLUE) -lcd.fillcircle(100, 100, 10, lcd.BLUE) -lcd.drawRect(180, 12, 122, 10, lcd.BLUE) -lcd.fillRect(180, 30, 122, 10, lcd.BLUE) -lcd.drawRoundRect(180, 50, 122, 10, 4, lcd.BLUE) -lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) -lcd.print('this is a print text function', 80, 80) -``` +# LCD + +### lcd.setRotation(degree) + +**Example** +```python +lcd.setRotation(90) +``` + +**Set the angle of rotation of the entire screen.** + +| Param | Description | +| --- | --- | +| degree | the angle of setRotation | + + + +* * * + + +### lcd.setColor(color [, background_color]) +**Example** +```python +lcd.setColor(lcd.RED) +lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) +``` + +**Set the default foreground/background color of text.** + +| Param | Description | +| --- | --- | +| color | the color of text | +| background_color| the fill color of text | + +* * * + +### lcd.fillScreen(color) +**Example** +```python +lcd.fillScreen(lcd.RED) +``` +**Fill the entire screen with the given color.** + +| Param | Description | +| --- | --- | +| color | color value | + + + +* * * + +### lcd.drawPixel(x, y [,color]) +**Example** +```python +lcd.drawPixel(22,22,lcd.RED) +``` +**Draw the pixel at position (x,y)** + +*If color is not given, current foreground color is used* + +| Param | Description | +| --- | --- | +| color | color value | + + + +* * * + +### lcd.drawLine(x, y, x1, y1 [,color]) +**Example** +```python +lcd.drawLine(0,0,12,12,lcd.WHITE) +``` +**Draw the line from point (x,y) to point (x1,y1)** + +*If color is not given, current foreground color is used* + +| Param | Description | +| --- | --- | +| color | color value | + + +* * * + +### lcd.drawTriangle(x, y, x1, y1, x2, y2 [,color]) + +**Example** +```python +lcd.drawTriangle(22,22,69,98,51,22,lcd.RED) +``` + +**Draw the triangel between points (x,y), (x1,y1) and (x2,y2).** + +*If color is not given, current foreground color is used* + +| Param | Description | +| --- | --- | +| color | color value | + +* * * + +### lcd.fillTriangle(x, y, x1, y1, x2, y2 [,color]) + +**Example** +```python +lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) +``` +**Fill the triangel between points (x,y), (x1,y1) and (x2,y2).** + +*If color is not given, current foreground color is used* + +| Param | Description | +| --- | --- | +| color | color value | + + +* * * +### lcd.drawRect(x, y, w, h, [,color]) +**Example** +```python +lcd.drawRect(180, 12, 122, 10, lcd.BLUE) +``` +**Draw the rectangle from the upper left point at (x,y) and width and height.** + +*If color is not given, current foreground color is used* + +| Param | Description | +| --- | --- | +| w | display phisical width in pixels (display’s smaller dimension) | +| h | display phisical height in pixels (display’s larger dimension) | +| color | color value | + + + + +* * * + +### lcd.drawRoundRect(x, y, w, h, r [,color]) +**Example** +```python +lcd.fillRoundRect(180,70,122,10,4,lcd.BLUE) +``` +**Draw the rectangle with rounded corners from the upper left point at (x,y) and width and height. Corner radius is given by r argument.** + +*If color is not given, current foreground color is used* + +| Param | Description | +| --- | --- | +| w | display phisical width in pixels (display’s smaller dimension) | +| h | display phisical height in pixels (display’s larger dimension) | +| r | the radius of circle | +| color | color value | + + + + +* * * +### lcd.print(‘text’, [x, y]) +**Example** +```python +lcd.print('this is a print text function', 80, 80) +``` +**Print the text at position (x,y).** + +| Param | Description | +| --- | --- | +| text | the string need to print | + + +* * * + +### lcd.clear([color]) + +**Example** +```python +lcd.clear() +``` + +**Clear the screen with default background color orspecific color if given.** + + +* * * + +### Usage + +```python +from machine import SPI, Pin +from display import LCD + +spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) + +lcd = LCD(spi = spi) #lcd init +lcd.fillScreen(lcd.BLACK) #set the default background color + +lcd.drawLine(0, 0, lcd.WHITE) +lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) +lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) +lcd.drawCircle(180, 180, 10, lcd.BLUE) +lcd.fillcircle(100, 100, 10, lcd.BLUE) +lcd.drawRect(180, 12, 122, 10, lcd.BLUE) +lcd.fillRect(180, 30, 122, 10, lcd.BLUE) +lcd.drawRoundRect(180, 50, 122, 10, 4, lcd.BLUE) +lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) +lcd.print('this is a print text function', 80, 80) +``` diff --git a/docs/en/api/speaker.md b/docs/en/api/speaker.md index 8936220a..f554e80e 100644 --- a/docs/en/api/speaker.md +++ b/docs/en/api/speaker.md @@ -1,15 +1,15 @@ -# Speaker - -### tone -> M5.Speaker.tone(uint32_t freq); - -Set the pitch of speaker. - -| Param | Type | Description | -| --- | --- | --- | -| freq | uint32_t | frequency | - -**Example** -```c++ -M5.Speaker.tone(100); +# Speaker + +### tone +> M5.Speaker.tone(uint32_t freq); + +Set the pitch of speaker. + +| Param | Type | Description | +| --- | --- | --- | +| freq | uint32_t | frequency | + +**Example** +```c++ +M5.Speaker.tone(100); ``` \ No newline at end of file diff --git a/docs/en/app/bala.md b/docs/en/app/bala.md index 7bf63f4a..8f22f28f 100644 --- a/docs/en/app/bala.md +++ b/docs/en/app/bala.md @@ -1,48 +1,48 @@ -# BALA - Balanced Car - - - -* * * - -:memo:**[Description](#Description)**   :bulb:**[Quick Start](/zh_CN/quick_start/bala/bala_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Bala/tree/master/examples)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Satck-New-BALA-Car-ESP32-Development-Mini-Electric-Self-balancing-Car-2DC-Motor-with-Encoder-PSRAM/3226069_32904033658.html?spm=2114.12010615.8148356.40.1fd3724dW3O2Bu.html)** - -## Description - -The M5Stack BALA is a balance bot based on M5Stack FIRE, including a 2 DC driver module based on Mega328p which is a core chip on Arduino UNO -You can even program The M5Stack BALA through Arduino or MicroPython with few code - -The 2 DC driver module communicates with M5Stack FIRE through I2C bus. It's default I2C address is **0x56** - -## Feature - -- Programming Support - + Python -- Compatible LEGO -- POGO Pin -- TF Card Support - -## PARAMETER - -Model | M5Stack FIRE ----|--- -ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth -Flash | 16MB Flash + 4MB pSRAM -Input | 5V @ 500mA -Interface | TypeC x 1, GROVE(I2C+I/0+UART), Pogo Pin x 1 -LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 -Speaker | 1W-0928 -Microphone | MEMS Analog BSE3729 Microphone -LED | SK6812 3535 RGB LED x 10 -MEMS | MPU9250 (MPU6500 + AK8963) -Battery | 550mAh @ 3.7V, inside -Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) -Size | 54 x 54 x 21 mm -C.A.S.E | Plastic ( PC ) -Weight | 56g - -## Include - -- 1x M5Stack BALA -- 1x Motor Driver -- 2x N20(Encoder included) -- Type-C USB Cable +# BALA - Balanced Car + + + +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](/zh_CN/quick_start/bala/bala_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Bala/tree/master/examples)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Satck-New-BALA-Car-ESP32-Development-Mini-Electric-Self-balancing-Car-2DC-Motor-with-Encoder-PSRAM/3226069_32904033658.html?spm=2114.12010615.8148356.40.1fd3724dW3O2Bu.html)** + +## Description + +The M5Stack BALA is a balance bot based on M5Stack FIRE, including a 2 DC driver module based on Mega328p which is a core chip on Arduino UNO +You can even program The M5Stack BALA through Arduino or MicroPython with few code + +The 2 DC driver module communicates with M5Stack FIRE through I2C bus. It's default I2C address is **0x56** + +## Feature + +- Programming Support + + Python +- Compatible LEGO +- POGO Pin +- TF Card Support + +## PARAMETER + +Model | M5Stack FIRE +---|--- +ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth +Flash | 16MB Flash + 4MB pSRAM +Input | 5V @ 500mA +Interface | TypeC x 1, GROVE(I2C+I/0+UART), Pogo Pin x 1 +LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 +Speaker | 1W-0928 +Microphone | MEMS Analog BSE3729 Microphone +LED | SK6812 3535 RGB LED x 10 +MEMS | MPU9250 (MPU6500 + AK8963) +Battery | 550mAh @ 3.7V, inside +Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) +Size | 54 x 54 x 21 mm +C.A.S.E | Plastic ( PC ) +Weight | 56g + +## Include + +- 1x M5Stack BALA +- 1x Motor Driver +- 2x N20(Encoder included) +- Type-C USB Cable diff --git a/docs/en/app/lidarbot.md b/docs/en/app/lidarbot.md index 35ee779d..421712b1 100644 --- a/docs/en/app/lidarbot.md +++ b/docs/en/app/lidarbot.md @@ -1,63 +1,63 @@ -# LidarBot - - - -* * * - -:memo:**[Description](#Description)**   :octocat:**[Example](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Lidar-Bot-Mini-Car-Lidar-8m-6Hz-McNamm-Wheels-NeoPixel-LED-Bar-with-ESP32/3226069_32951134988.html?spm=a2g1y.12024536.productList_5885013.subject_7)** - -## Description - -LidarBot is a four-wheeled car based on indoor navigation. The car body is loaded with lidar, four Mecanum wheels, control-wheel bottom board(based on MEGA328), two RGB bars, M5Core(CarMainController) and some LEGO holes. - -Real-time communication via ESP-NOW between the car and the remote control handle. After receiving the control signal, the car master controlls the wheels and RGB bars through the specified protocol format. - -And in addition to controlling the car's flexible front, rear, left and right movements, the indoor terrain can also be displayed on the display screens of the car master(M5Core) and the remote control handle. - -## Feature - -- Lidar: 8m @ 6Hz -- Programming Support - + Arduino -- Compatible LEGO - -## Protocol for CarBottomBoard - -*Protocol Format：Data Header(command type) + Data Packet + Data Tail* - -| Control Target | Protocol Format | -| :-------------: |:------------------------------------: | -| Wheels | 0xAA,SpeedX,SpeedY,SpeedZ,SpeedA,0x55 | -| One RGB | 0xAB,LedIndex,R,G,B,0x55 | -| Front RGB Bar | 0xAC,R,G,B,0x55 | -| Back RGB Bar | 0xAD,R,G,B,0x55 | -| All RGB | 0xAE,R,G,B,0x55 | -| ServoMotor0 | 0xAF,Angle,0x55 | -| ServoMotor1 | 0xB0,Angle,0x55 | - -## PARAMETER - -- Communication Parameter - - M5Core(CarMain) <-> Lidar(GPIO16 <-> Lidar) - Serial Configuration: "230400bps, 8, n, 1"(8 bits data, no parity, 1 stop bit) - - M5Core(CarMain) <-> CarBottomBoard(GPIO17 <-> Lidar) - Serial Configuration: "115200bps, 8, n, 1"(8 bits data, no parity, 1 stop bit) -- PinMap - - ServoMotor0 <-> A0(MEGA328) - - ServoMotor1 <-> A1(MEGA328) - - NeoPixelRGB <-> 11(MEGA328) - -## Include - -- 1x LidarBot -- 1x Remote Control Handle -- 2x Battery(1300mAh @ 11.1V) -- 1x Power Charger -- 1x Type-C USB Cable - -## APPLICATIONS - -- Indoor Navigation -- Autonomous walking maze -- Route plan +# LidarBot + + + +* * * + +:memo:**[Description](#Description)**   :octocat:**[Example](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Lidar-Bot-Mini-Car-Lidar-8m-6Hz-McNamm-Wheels-NeoPixel-LED-Bar-with-ESP32/3226069_32951134988.html?spm=a2g1y.12024536.productList_5885013.subject_7)** + +## Description + +LidarBot is a four-wheeled car based on indoor navigation. The car body is loaded with lidar, four Mecanum wheels, control-wheel bottom board(based on MEGA328), two RGB bars, M5Core(CarMainController) and some LEGO holes. + +Real-time communication via ESP-NOW between the car and the remote control handle. After receiving the control signal, the car master controlls the wheels and RGB bars through the specified protocol format. + +And in addition to controlling the car's flexible front, rear, left and right movements, the indoor terrain can also be displayed on the display screens of the car master(M5Core) and the remote control handle. + +## Feature + +- Lidar: 8m @ 6Hz +- Programming Support + + Arduino +- Compatible LEGO + +## Protocol for CarBottomBoard + +*Protocol Format：Data Header(command type) + Data Packet + Data Tail* + +| Control Target | Protocol Format | +| :-------------: |:------------------------------------: | +| Wheels | 0xAA,SpeedX,SpeedY,SpeedZ,SpeedA,0x55 | +| One RGB | 0xAB,LedIndex,R,G,B,0x55 | +| Front RGB Bar | 0xAC,R,G,B,0x55 | +| Back RGB Bar | 0xAD,R,G,B,0x55 | +| All RGB | 0xAE,R,G,B,0x55 | +| ServoMotor0 | 0xAF,Angle,0x55 | +| ServoMotor1 | 0xB0,Angle,0x55 | + +## PARAMETER + +- Communication Parameter + - M5Core(CarMain) <-> Lidar(GPIO16 <-> Lidar) + Serial Configuration: "230400bps, 8, n, 1"(8 bits data, no parity, 1 stop bit) + - M5Core(CarMain) <-> CarBottomBoard(GPIO17 <-> Lidar) + Serial Configuration: "115200bps, 8, n, 1"(8 bits data, no parity, 1 stop bit) +- PinMap + - ServoMotor0 <-> A0(MEGA328) + - ServoMotor1 <-> A1(MEGA328) + - NeoPixelRGB <-> 11(MEGA328) + +## Include + +- 1x LidarBot +- 1x Remote Control Handle +- 2x Battery(1300mAh @ 11.1V) +- 1x Power Charger +- 1x Type-C USB Cable + +## APPLICATIONS + +- Indoor Navigation +- Autonomous walking maze +- Route plan - Autopilot \ No newline at end of file diff --git a/docs/en/base/face_base.md b/docs/en/base/face_base.md index b76299fc..c2932099 100644 --- a/docs/en/base/face_base.md +++ b/docs/en/base/face_base.md @@ -1,24 +1,24 @@ -# FACE Base - -## Description - -FACE Base is a base of [FACES Kit](en/core/face_kit). It's composed of M5Core base and battery as shown below. - - - -There are some expanding gpio(see the last picture) of M-Bus at the back of FACES Base, in order for you make a complex project conveniently. Obsolutely, a battery(600mAh) is built in base, so that you can use FACES Kit without usb cable. - -## Usage - -**Please stack M5Core and FACES Keyboard(*i.e. QWERTY, GameBoy, Calculator*) over Base when use it as shown below** - - - -## Related Link - -- **[Purchase FACES Kit](https://www.aliexpress.com/store/product/M5Stack-NEW-Offer-ESP32-Open-Source-Faces-Pocket-Computer-with-Keyboard-Gameboy-Calculator-for-Micropython-Arduino/3226069_32843973578.html?spm=2114.12010615.8148356.2.75cdb3ceTGkLQo)** - - -## M-Bus - -basic_05 +# FACE Base + +## Description + +FACE Base is a base of [FACES Kit](en/core/face_kit). It's composed of M5Core base and battery as shown below. + + + +There are some expanding gpio(see the last picture) of M-Bus at the back of FACES Base, in order for you make a complex project conveniently. Obsolutely, a battery(600mAh) is built in base, so that you can use FACES Kit without usb cable. + +## Usage + +**Please stack M5Core and FACES Keyboard(*i.e. QWERTY, GameBoy, Calculator*) over Base when use it as shown below** + + + +## Related Link + +- **[Purchase FACES Kit](https://www.aliexpress.com/store/product/M5Stack-NEW-Offer-ESP32-Open-Source-Faces-Pocket-Computer-with-Keyboard-Gameboy-Calculator-for-Micropython-Arduino/3226069_32843973578.html?spm=2114.12010615.8148356.2.75cdb3ceTGkLQo)** + + +## M-Bus + +basic_05 diff --git a/docs/en/base/lan_base.md b/docs/en/base/lan_base.md index baafd7e7..9714ff01 100644 --- a/docs/en/base/lan_base.md +++ b/docs/en/base/lan_base.md @@ -1,45 +1,45 @@ -# LAN Base - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Base/LAN/Arduino)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** - -## Description - -LAN Base is base built in W5500 chip which designed for meeting the demand of wired network. If your project only can access network through network cable, LAN Base is fit. - -In addition, if you want to communicate with LAN through RS485, we also supply a adapter for converting TLL to RS485. - -## PinMap - -**W5500** - -| W5500 | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO26 | -| RST | GPIO13 | -| INTn | GPIO34 | - - - -**M-Bus** - - - -## Feature - -- Input Supply Voltage: 9-24V -- HT3.96 port for supporting RS485 -- Easy to fixed on the wall - - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** +# LAN Base + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Base/LAN/Arduino)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** + +## Description + +LAN Base is base built in W5500 chip which designed for meeting the demand of wired network. If your project only can access network through network cable, LAN Base is fit. + +In addition, if you want to communicate with LAN through RS485, we also supply a adapter for converting TLL to RS485. + +## PinMap + +**W5500** + +| W5500 | ESP32 Chip | +| :----------: |:------------: | +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO26 | +| RST | GPIO13 | +| INTn | GPIO34 | + + + +**M-Bus** + + + +## Feature + +- Input Supply Voltage: 9-24V +- HT3.96 port for supporting RS485 +- Easy to fixed on the wall + + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/base/m5go_base.md b/docs/en/base/m5go_base.md index f1b91e2c..0471e7b4 100644 --- a/docs/en/base/m5go_base.md +++ b/docs/en/base/m5go_base.md @@ -1,74 +1,74 @@ -# M5GO Base - -## Description - -M5GO Baseis a base of [M5GO IOT Starter Kit](en/product_documents/m5stack-core/m5go_iot_starter_kit) or [M5Fire](en/product_documents/m5stack-core/m5core_fire). - -M5GO Base is composed of battery(600mAh), M-Bus interface, charging indicator(red led), two RGB Bar, PORT B and PORT C. - -The charging indicator light will blink when base is charging, but the light will keep on when charge completed. - -## PinMap - -**POGO Pin** - -| POGO Pin | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LED Bar** - -*There are 10 RGB Leds built in M5GO Base* - -| LED Pin | ESP32 Chip | -| :----------: |:------------: | -| LED Pin | GPIO15 | - -**MIC** - -| MIC Pin | ESP32 Chip | -| :----------: |:------------: | -| MIC Pin | GPIO34 | - -**GROVE** - -| PORT A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -| :----------: |:------------: | -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -| :----------: |:------------: | -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**M-Bus** - -
- M_BUS -
- -## Related Link - -- **[Schematic](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** -- **[M5GO IOT Starter Kit Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.2.52385ab04i7vIu)** - -
- -
- -
- +# M5GO Base + +## Description + +M5GO Baseis a base of [M5GO IOT Starter Kit](en/product_documents/m5stack-core/m5go_iot_starter_kit) or [M5Fire](en/product_documents/m5stack-core/m5core_fire). + +M5GO Base is composed of battery(600mAh), M-Bus interface, charging indicator(red led), two RGB Bar, PORT B and PORT C. + +The charging indicator light will blink when base is charging, but the light will keep on when charge completed. + +## PinMap + +**POGO Pin** + +| POGO Pin | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | + +**LED Bar** + +*There are 10 RGB Leds built in M5GO Base* + +| LED Pin | ESP32 Chip | +| :----------: |:------------: | +| LED Pin | GPIO15 | + +**MIC** + +| MIC Pin | ESP32 Chip | +| :----------: |:------------: | +| MIC Pin | GPIO34 | + +**GROVE** + +| PORT A(I2C) | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +| PORT B(I/O) | ESP32 Chip | +| :----------: |:------------: | +| G36 | GPIO36 | +| G26 | GPIO26 | +| 5V | 5V | +| GND | GND | + +| PORT C(UART2) | ESP32 Chip | +| :----------: |:------------: | +| RXD | GPIO16 | +| TXD | GPIO17 | +| 5V | 5V | +| GND | GND | + +**M-Bus** + +
+ M_BUS +
+ +## Related Link + +- **[Schematic](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** +- **[M5GO IOT Starter Kit Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.2.52385ab04i7vIu)** + +
+ +
+ +
+
\ No newline at end of file diff --git a/docs/en/base/node_base.md b/docs/en/base/node_base.md index 8c4e5a61..299e4ad7 100644 --- a/docs/en/base/node_base.md +++ b/docs/en/base/node_base.md @@ -1,39 +1,39 @@ -# Node Module - - - -*** -:memo:**[Description](#Description)**      :octocat:**[Example](https://github.com/m5stack/M5StackModule-Node/tree/master/example)**      :electric_plug:**[Schematic](https://github.com/m5stack/Bases-Node/tree/master/schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-NODE-Samrt-Speaker-WM8978-Audio-Development-Board-I2S-Module-with-DHT12-Sensor-MIC-IR/3226069_32949773234.html)** - -## Description - -Node is a base as a intelligent node in the IOT. If stacked a M5Core, it will be a intelligent node that can communicate with surrounding equipments via IR, Bluetooth or WIFI. - -* Including 12 RGBs and one temperature and humidity sensor(DHT12), it means Node can display its own status and perception surrounding environment. -* There are 4 IR Transmitter LED at four corners and two IR Receiver -* There are two MIC -* A Codec chip(WM8978) inside that is often used to be applied for Hi-Fi Speaker. - -## Feature - -- Including 12 RGBLed -- Including a HiFi stereo codec chip(Up to 24bit DAC) -- Including a lithium battery interface - -## Include - -- 1x Node Module -- Wall holder -- 4x screws -- 4x Type-C USB Cable - - -## Applications - -- Intelligent IOT node -- Webradio -- Intelligent sound box - -## Related Link - -- **[WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) (WM8978)** +# Node Module + + + +*** +:memo:**[Description](#Description)**      :octocat:**[Example](https://github.com/m5stack/M5StackModule-Node/tree/master/example)**      :electric_plug:**[Schematic](https://github.com/m5stack/Bases-Node/tree/master/schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-NODE-Samrt-Speaker-WM8978-Audio-Development-Board-I2S-Module-with-DHT12-Sensor-MIC-IR/3226069_32949773234.html)** + +## Description + +Node is a base as a intelligent node in the IOT. If stacked a M5Core, it will be a intelligent node that can communicate with surrounding equipments via IR, Bluetooth or WIFI. + +* Including 12 RGBs and one temperature and humidity sensor(DHT12), it means Node can display its own status and perception surrounding environment. +* There are 4 IR Transmitter LED at four corners and two IR Receiver +* There are two MIC +* A Codec chip(WM8978) inside that is often used to be applied for Hi-Fi Speaker. + +## Feature + +- Including 12 RGBLed +- Including a HiFi stereo codec chip(Up to 24bit DAC) +- Including a lithium battery interface + +## Include + +- 1x Node Module +- Wall holder +- 4x screws +- 4x Type-C USB Cable + + +## Applications + +- Intelligent IOT node +- Webradio +- Intelligent sound box + +## Related Link + +- **[WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) (WM8978)** diff --git a/docs/en/base/plc_base.md b/docs/en/base/plc_base.md index 05afb952..acc42030 100644 --- a/docs/en/base/plc_base.md +++ b/docs/en/base/plc_base.md @@ -1,3 +1,3 @@ -# PLC-Base - +# PLC-Base + ## (coming soon...) \ No newline at end of file diff --git a/docs/en/case.md b/docs/en/case.md index 96f6e31e..c17aadcd 100644 --- a/docs/en/case.md +++ b/docs/en/case.md @@ -1,71 +1,71 @@ -# M5Stack Cases - - - -## STEM Education Cases - -## M5Stack Awesome - -* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD - card - -* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - TFT library for the ESP8266 and ESP32 that supports different driver chips - - -* [M5Widgets](https://github.com/Kongduino/M5Widgets) - Widgets for the M5Stack - -* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack - -* [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32) - -* [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - A lightweight GUI framework suitable for embedded displays - -* [M5ez](https://github.com/ropg/M5ez) - The easy way to program on the M5Stack - - -* [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - A M5Stack firmware made on PlatformIO - - -* [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - A fully functional oscilloscope based on ESP32 M5Stack - -* [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) - An M5Stack library for rendering avatar faces - -* [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - Crack your M5Stack!! - -* [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - M5_Shuttle_Run - -* [nixietubeM5](https://github.com/drayde/nixietubeM5) - (Fake) Nixie Tube Display on a M5Stack - -* [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - A small Bitcoin price ticker using an M5Stack (ESP32) and the Coindesk API - -* [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - Dependence on example Wifi Setting to get ETH Price from Maicoin - -* [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - M5Stack ESP32 Packet Monitor - -* [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - Graphic Equalizer on the M5Stack platform - -* [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - Playing mp3 stream out of internet using M5Stack prototype - -* [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - MP3 player for M5Stack - -* [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - M5STACK Arduino WiFi Photo Backup device - -* [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - You can send ctrl+alt+del to your PC from M5Stack - -* [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) - Markdown & icons loaded from an Micro SD card/TF card to run a web page - -* [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - Tetris for M5Stack Ported to M5Stack by macsbug - https://macsbug.wordpress.com/ - -* [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - M5Stack FlappyBird Playable - -* [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - Space Invaders knock-off for M5Stack - -* [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - Pacman on M5Stack/PSP Joypad, with sounds - -* [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - M5Stack Thermal Camera with AMG8833 thermal sensor - -* [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) - Links to files for 3D printing custom case parts for the M5Stack - -* [truetype2gfx](https://github.com/ropg/truetype2gfx) - Converting fonts from TrueType to Adafruit GFX - +# M5Stack Cases + + + +## STEM Education Cases + +## M5Stack Awesome + +* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD + card + +* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - TFT library for the ESP8266 and ESP32 that supports different driver chips + + +* [M5Widgets](https://github.com/Kongduino/M5Widgets) - Widgets for the M5Stack + +* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack + +* [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32) + +* [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - A lightweight GUI framework suitable for embedded displays + +* [M5ez](https://github.com/ropg/M5ez) - The easy way to program on the M5Stack + + +* [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - A M5Stack firmware made on PlatformIO + + +* [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - A fully functional oscilloscope based on ESP32 M5Stack + +* [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) - An M5Stack library for rendering avatar faces + +* [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - Crack your M5Stack!! + +* [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - M5_Shuttle_Run + +* [nixietubeM5](https://github.com/drayde/nixietubeM5) - (Fake) Nixie Tube Display on a M5Stack + +* [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - A small Bitcoin price ticker using an M5Stack (ESP32) and the Coindesk API + +* [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - Dependence on example Wifi Setting to get ETH Price from Maicoin + +* [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - M5Stack ESP32 Packet Monitor + +* [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - Graphic Equalizer on the M5Stack platform + +* [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - Playing mp3 stream out of internet using M5Stack prototype + +* [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - MP3 player for M5Stack + +* [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - M5STACK Arduino WiFi Photo Backup device + +* [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - You can send ctrl+alt+del to your PC from M5Stack + +* [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) - Markdown & icons loaded from an Micro SD card/TF card to run a web page + +* [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - Tetris for M5Stack Ported to M5Stack by macsbug - https://macsbug.wordpress.com/ + +* [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - M5Stack FlappyBird Playable + +* [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - Space Invaders knock-off for M5Stack + +* [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - Pacman on M5Stack/PSP Joypad, with sounds + +* [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - M5Stack Thermal Camera with AMG8833 thermal sensor + +* [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) - Links to files for 3D printing custom case parts for the M5Stack + +* [truetype2gfx](https://github.com/ropg/truetype2gfx) - Converting fonts from TrueType to Adafruit GFX + * [m5stack-onscreen-keyboard](https://github.com/yellowelise/m5stack-onscreen-keyboard) - Full size qwerty keyboard for M5Stack \ No newline at end of file diff --git a/docs/en/core/basic.md b/docs/en/core/basic.md index 1b653c53..6c3289cf 100644 --- a/docs/en/core/basic.md +++ b/docs/en/core/basic.md @@ -1,124 +1,124 @@ -# M5Core BASIC - -basic_02 basic_03 basic_04 - -* * * - -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**     :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**     🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)**   :clapper:**[Related Video](#Related-Video)** - -## Description - -**The M5Stack BASIC** is a black development kit based on **ESP32** chip composed of a black M5Core and a Bottom Base board. You can even program The M5Stack BASIC through Blockly, Arduino or MicroPython. The black core is a basic kit and **it does not own any MEMS chip(like MPU9250...)**. - -The a Bottom board on the back of M5Core. It's designed for expanding gpio on M-Bus besides I2S Pins(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)for DIY. Each gpio on M-Bus is expanded as pin and port for convenience and flexibility. - -## Feature - -- Programming Support: [UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/) and [Arduino](http://www.arduino.cc) -- TF Card Support(Up to 16GB) - -## Source PinMap - -*We have several kinds of M5Cores, There is [their difference in schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md).* - -**LCD & TF Card** - -*LCD Resolution: 320x240* - - - - - - -
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
- -**Button & Speaker** - - - - - -
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
Button PinBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
- -**GROVE A** - - - - -
ESP32 ChipGPIO22GPIO21
GROVE ASCLSDA
- -## Parameter - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash4M-Bytes
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
Battery150mAh @ 3.7V
Op.Temp.32°F to 104°F ( 0°C to 40°C )
Size54 x 54 x 12.5 mm
C.A.S.EPlastic ( PC )
Weight120g with bottom, 100g only core
- -## Include - -- 1x M5Stack BASIC -- 1x M5Stack BASIC Bottom -- Type-C USB Cable -- User Manual - - - - - - - -## Related Link - -- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - -## Related Video - -- **m5stack instroduce** - - +# M5Core BASIC + +basic_02 basic_03 basic_04 + +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**     :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**     🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)**   :clapper:**[Related Video](#Related-Video)** + +## Description + +**The M5Stack BASIC** is a black development kit based on **ESP32** chip composed of a black M5Core and a Bottom Base board. You can even program The M5Stack BASIC through Blockly, Arduino or MicroPython. The black core is a basic kit and **it does not own any MEMS chip(like MPU9250...)**. + +The a Bottom board on the back of M5Core. It's designed for expanding gpio on M-Bus besides I2S Pins(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)for DIY. Each gpio on M-Bus is expanded as pin and port for convenience and flexibility. + +## Feature + +- Programming Support: [UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/) and [Arduino](http://www.arduino.cc) +- TF Card Support(Up to 16GB) + +## Source PinMap + +*We have several kinds of M5Cores, There is [their difference in schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md).* + +**LCD & TF Card** + +*LCD Resolution: 320x240* + + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
+ +**Button & Speaker** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
Button PinBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
+ +**GROVE A** + + + + +
ESP32 ChipGPIO22GPIO21
GROVE ASCLSDA
+ +## Parameter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash4M-Bytes
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
Battery150mAh @ 3.7V
Op.Temp.32°F to 104°F ( 0°C to 40°C )
Size54 x 54 x 12.5 mm
C.A.S.EPlastic ( PC )
Weight120g with bottom, 100g only core
+ +## Include + +- 1x M5Stack BASIC +- 1x M5Stack BASIC Bottom +- Type-C USB Cable +- User Manual + + + + + + + +## Related Link + +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) + +## Related Video + +- **m5stack instroduce** + + diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index d2a734f2..41148bde 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -1,52 +1,52 @@ -# FACES Kit - -**FACES Kit** is a kit composed of M5Core GRAY, functional keyboards, FACES Base, FACES Charger and some accessories(including DuPont lines, lanyard, M3 fixing screws and so on). Currently, the functional keyboards are composed of GameBoy, Calculator and QWERTY. We'll add other keyboards to FACES Kit. You can program it through Arduino IDE or MicroPython. For different applications, you can stack corresponding keyboard on FACES Base and burn corresponding firmware into M5Core. And here, you can learn more about [FACES Base](en/base/face_base). - -*For each keyboard, it's integrated **MEGA328** chip, so that when you press a button, a corresponding value(**hexadecimal format**) will be sent from keyboard to M5Core. They(keyboard and m5core) are communicating using I2C. And the I2C address of each keyboard is 0x08.* - -Now, here's the picture of the whole kit. - -
- -
- -### 1. GameBoy Keyboard - -When create a handheld game, you can stack a GameBoy keyboard over FACES Base straight. And burn a Nintendo Entertainment System emulator. - -Here is the method of burning emulator and a game: [download game](en/quick_start/faces/gameboy_burn_a_nes_game) - -
- -
- -### 2. Calculator Keyboard - -When create a calculator, you need the Calculator Keyboard. Burn your firmware into M5Core. The button which was pressed will execute the callback specifical function, so the calculator is created. - -
- -
- -### 3. QWERTY Keyboard - -When your project needs full keyboard input, just to stack QWERTY over Base. - -Burn the following example(example function: M5Core and serial terminal will print button you pressed) - -- **source file of example** - a. [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) - b. [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES)(for M5Cloud) - -- **M5Cloud usage** - [MicroPython(M5Cloud)](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) - -
- -
- - -### 4. FACES Charger - -**FACES Charger** built in some magnets. When charging, the FACES can be attached with charger. They are connected by PIGO Pin. - -
- -
+# FACES Kit + +**FACES Kit** is a kit composed of M5Core GRAY, functional keyboards, FACES Base, FACES Charger and some accessories(including DuPont lines, lanyard, M3 fixing screws and so on). Currently, the functional keyboards are composed of GameBoy, Calculator and QWERTY. We'll add other keyboards to FACES Kit. You can program it through Arduino IDE or MicroPython. For different applications, you can stack corresponding keyboard on FACES Base and burn corresponding firmware into M5Core. And here, you can learn more about [FACES Base](en/base/face_base). + +*For each keyboard, it's integrated **MEGA328** chip, so that when you press a button, a corresponding value(**hexadecimal format**) will be sent from keyboard to M5Core. They(keyboard and m5core) are communicating using I2C. And the I2C address of each keyboard is 0x08.* + +Now, here's the picture of the whole kit. + +
+ +
+ +### 1. GameBoy Keyboard + +When create a handheld game, you can stack a GameBoy keyboard over FACES Base straight. And burn a Nintendo Entertainment System emulator. + +Here is the method of burning emulator and a game: [download game](en/quick_start/faces/gameboy_burn_a_nes_game) + +
+ +
+ +### 2. Calculator Keyboard + +When create a calculator, you need the Calculator Keyboard. Burn your firmware into M5Core. The button which was pressed will execute the callback specifical function, so the calculator is created. + +
+ +
+ +### 3. QWERTY Keyboard + +When your project needs full keyboard input, just to stack QWERTY over Base. + +Burn the following example(example function: M5Core and serial terminal will print button you pressed) + +- **source file of example** - a. [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) - b. [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES)(for M5Cloud) + +- **M5Cloud usage** - [MicroPython(M5Cloud)](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) + +
+ +
+ + +### 4. FACES Charger + +**FACES Charger** built in some magnets. When charging, the FACES can be attached with charger. They are connected by PIGO Pin. + +
+ +
diff --git a/docs/en/core/fire.md b/docs/en/core/fire.md index 610df978..cfb69038 100644 --- a/docs/en/core/fire.md +++ b/docs/en/core/fire.md @@ -1,172 +1,172 @@ -# M5Stack FIRE - -fire_01 - -* * * - -:memo:**[Description](#Description)**   :bulb:**[Quick Start](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-NEW-PSRAM-2-0-FIRE-IoT-Kit-Dual-Core-ESP32-16M-FLash-4M-PSRAM-Development/3226069_32847906756.html?spm=2114.12010615.8148356.10.1c93724d7cJ5rG.html)**   :clapper:**[Related Video](#Related-Video)** - -## Description - -The M5Stack **FIRE** is a development kit based on ESP32 chip. FIRE is a kit which composed of red m5core, M5Go Base and M5Go CHG. Base(for charging red m5core). You can even program The M5Stack FIRE through Blockly, Arduino or MicroPython. - -The M5Stack FIRE equips the ESP32 with everything necessary to program, run and develop on the wonderchip. It also features a 9-Axis (Gyro + Accelerometer + Magnetometer) MEMS (**MPU-9250**) and a TFT LCD, so you can create a 3D remote gesture controller, a simple "Leap Motion" via M5Stack FIRE in a day in stead of couple weeks and so on. - -M5Go CHG. Base is composed of POGO pin. M5Go Base is composed of PORT B, PORT C, 2 RGBLed Bars(SK6812), a microphone and a Battery(600mAh). - -## Feature - -- Programming Support - - UiFlow - - MicroPython - - Arduino -- Compatible LEGO -- TF Card Support - -## PinMap - -*We have several kinds of m5core board on sale, click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md) for their difference.* - -#### MainBoard Pinmap - -**LCD & TF Card** - -*LCD Pixel：320x240* -*Maximum storage of TF Card: 16GB* - - - - - -
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341(LCD Driver)/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
- -**Button & Speaker** - - - - - -
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
ButtonBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
- -**GROVE A** - - - - -
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
- -**9-axis IMU sensor(MPU9250)** - -*I2C Address: 0x68* - - - - -
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
- -#### M5GO Base Pinmap - -**GROVE B** - - - - -
ESP32 ChipGPIO36GPIO265VGND
GROVE BGPIO36GPIO265VGND
- -**GROVE C** - - - - -
ESP32 ChipGPIO16GPIO175VGND
GROVE CRXDTXD5VGND
- -**LED Bar & MicroPhone** - - - - - -
ESP32 ChipGPIO15GPIO34
LED BarSIG Pin
MicroPhone MIC Pin
- -## PARAMETER - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
M5Core SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash & PSRAM16MB Flash + 4MB pSRAM
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
MicrophoneMEMS Analog BSE3729 Microphone
LEDSK6812 3535 RGB LED x 10
MEMSMPU9250
Battery550mAh @ 3.7V, inside vb
Op.Temp.32°F to 104°F ( 0°C to 40°C )
Size54 x 54 x 12.5 mm
C.A.S.EPlastic ( PC )
Weight120g with bottom, 100g only core
- -## Include - -- 1x M5Stack FIRE -- 1x M5GO Base -- 1x M5GO CHG BASE -- Type-C USB Cable -- User Manual - -## Related Link - -- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -## Related Video - -- **m5stack instroduce** - - +# M5Stack FIRE + +fire_01 + +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-NEW-PSRAM-2-0-FIRE-IoT-Kit-Dual-Core-ESP32-16M-FLash-4M-PSRAM-Development/3226069_32847906756.html?spm=2114.12010615.8148356.10.1c93724d7cJ5rG.html)**   :clapper:**[Related Video](#Related-Video)** + +## Description + +The M5Stack **FIRE** is a development kit based on ESP32 chip. FIRE is a kit which composed of red m5core, M5Go Base and M5Go CHG. Base(for charging red m5core). You can even program The M5Stack FIRE through Blockly, Arduino or MicroPython. + +The M5Stack FIRE equips the ESP32 with everything necessary to program, run and develop on the wonderchip. It also features a 9-Axis (Gyro + Accelerometer + Magnetometer) MEMS (**MPU-9250**) and a TFT LCD, so you can create a 3D remote gesture controller, a simple "Leap Motion" via M5Stack FIRE in a day in stead of couple weeks and so on. + +M5Go CHG. Base is composed of POGO pin. M5Go Base is composed of PORT B, PORT C, 2 RGBLed Bars(SK6812), a microphone and a Battery(600mAh). + +## Feature + +- Programming Support + - UiFlow + - MicroPython + - Arduino +- Compatible LEGO +- TF Card Support + +## PinMap + +*We have several kinds of m5core board on sale, click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md) for their difference.* + +#### MainBoard Pinmap + +**LCD & TF Card** + +*LCD Pixel：320x240* +*Maximum storage of TF Card: 16GB* + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341(LCD Driver)/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
+ +**Button & Speaker** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
ButtonBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
+ +**GROVE A** + + + + +
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
+ +**9-axis IMU sensor(MPU9250)** + +*I2C Address: 0x68* + + + + +
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
+ +#### M5GO Base Pinmap + +**GROVE B** + + + + +
ESP32 ChipGPIO36GPIO265VGND
GROVE BGPIO36GPIO265VGND
+ +**GROVE C** + + + + +
ESP32 ChipGPIO16GPIO175VGND
GROVE CRXDTXD5VGND
+ +**LED Bar & MicroPhone** + + + + + +
ESP32 ChipGPIO15GPIO34
LED BarSIG Pin
MicroPhone MIC Pin
+ +## PARAMETER + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
M5Core SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash & PSRAM16MB Flash + 4MB pSRAM
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
MicrophoneMEMS Analog BSE3729 Microphone
LEDSK6812 3535 RGB LED x 10
MEMSMPU9250
Battery550mAh @ 3.7V, inside vb
Op.Temp.32°F to 104°F ( 0°C to 40°C )
Size54 x 54 x 12.5 mm
C.A.S.EPlastic ( PC )
Weight120g with bottom, 100g only core
+ +## Include + +- 1x M5Stack FIRE +- 1x M5GO Base +- 1x M5GO CHG BASE +- Type-C USB Cable +- User Manual + +## Related Link + +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +## Related Video + +- **m5stack instroduce** + + diff --git a/docs/en/core/gray.md b/docs/en/core/gray.md index 7571e297..abba0ece 100644 --- a/docs/en/core/gray.md +++ b/docs/en/core/gray.md @@ -1,171 +1,171 @@ -# 灰色升级版M5Core - -gray_02 gray_02 gray_04 - - - -* * * - -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)**   :clapper:**[Related Video](#Related-Video)** - -## Description - -**M5Core GRAY** is a development kit based on ESP32 chip composed of a gray M5Core and a Bottom Base board. You can even program The M5Core GRAY through Blockly, Arduino or MicroPython. - -The M5Core GRAY equips the ESP32 with everything necessary to program, run and develop on the wonderchip. It also features a MEMS Chip(**MPU9250**), and a TF `T LCD, so you can create a 3D remote gesture controller, a simple "Leap Motion" via M5Core GRAY in a day in stead of couple weeks and so on. - -The a Bottom board on the back of M5Core. It's designed for expanding gpio on M-Bus besides I2S Pins(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)for DIY. Each gpio on M-Bus is expanded as pin and port for convenience and flexibility. - -## Feature - -- Programming Support: [UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/) and [Arduino](http://www.arduino.cc) -- TF Card Support(Up to 16GB) - -## PinMap - -*We have several kinds of m5core board on sale, click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md) for their difference.* - -#### MainBoard Pinmap - -**LCD & TF Card** - -*LCD Pixel：320x240* -*Maximum storage of TF Card: 16GB* - - - - - -
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341(LCD Driver)/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
- -**Button & Speaker** - - - - - -
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
ButtonBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
- -**GROVE A** - - - - -
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
- -**9-axis IMU sensor(MPU9250)** - -*I2C Address: 0x68* - - - - -
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
- -#### M5GO Base Pinmap - -**GROVE B** - - - - -
ESP32 ChipGPIO36GPIO265VGND
GROVE BGPIO36GPIO265VGND
- -**GROVE C** - - - - -
ESP32 ChipGPIO16GPIO175VGND
GROVE CRXDTXD5VGND
- -**LED Bar & MicroPhone** - - - - - -
ESP32 ChipGPIO15GPIO34
LED BarSIG Pin
MicroPhone MIC Pin
- -## PARAMETER - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
M5Core SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash4MB
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
MicrophoneMEMS Analog BSE3729 Microphone
LEDSK6812 3535 RGB LED x 10
MEMSMPU9250
Battery550mAh @ 3.7V, inside vb
Op.Temp.32°F to 104°F ( 0°C to 40°C )
Size54 x 54 x 12.5 mm
C.A.S.EPlastic ( PC )
Weight120g with bottom, 100g only core
- -## Include - -- 1x M5Core GRAY -- 1x M5Core Bottom -- Type-C USB Cable -- User Manual - -## Related Link - -- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - -## Related Video - -- **m5stack instroduce** - - +# 灰色升级版M5Core + +gray_02 gray_02 gray_04 + + + +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)**   :clapper:**[Related Video](#Related-Video)** + +## Description + +**M5Core GRAY** is a development kit based on ESP32 chip composed of a gray M5Core and a Bottom Base board. You can even program The M5Core GRAY through Blockly, Arduino or MicroPython. + +The M5Core GRAY equips the ESP32 with everything necessary to program, run and develop on the wonderchip. It also features a MEMS Chip(**MPU9250**), and a TF `T LCD, so you can create a 3D remote gesture controller, a simple "Leap Motion" via M5Core GRAY in a day in stead of couple weeks and so on. + +The a Bottom board on the back of M5Core. It's designed for expanding gpio on M-Bus besides I2S Pins(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)for DIY. Each gpio on M-Bus is expanded as pin and port for convenience and flexibility. + +## Feature + +- Programming Support: [UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/) and [Arduino](http://www.arduino.cc) +- TF Card Support(Up to 16GB) + +## PinMap + +*We have several kinds of m5core board on sale, click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md) for their difference.* + +#### MainBoard Pinmap + +**LCD & TF Card** + +*LCD Pixel：320x240* +*Maximum storage of TF Card: 16GB* + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341(LCD Driver)/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
+ +**Button & Speaker** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
ButtonBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
+ +**GROVE A** + + + + +
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
+ +**9-axis IMU sensor(MPU9250)** + +*I2C Address: 0x68* + + + + +
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
+ +#### M5GO Base Pinmap + +**GROVE B** + + + + +
ESP32 ChipGPIO36GPIO265VGND
GROVE BGPIO36GPIO265VGND
+ +**GROVE C** + + + + +
ESP32 ChipGPIO16GPIO175VGND
GROVE CRXDTXD5VGND
+ +**LED Bar & MicroPhone** + + + + + +
ESP32 ChipGPIO15GPIO34
LED BarSIG Pin
MicroPhone MIC Pin
+ +## PARAMETER + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
M5Core SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash4MB
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
MicrophoneMEMS Analog BSE3729 Microphone
LEDSK6812 3535 RGB LED x 10
MEMSMPU9250
Battery550mAh @ 3.7V, inside vb
Op.Temp.32°F to 104°F ( 0°C to 40°C )
Size54 x 54 x 12.5 mm
C.A.S.EPlastic ( PC )
Weight120g with bottom, 100g only core
+ +## Include + +- 1x M5Core GRAY +- 1x M5Core Bottom +- Type-C USB Cable +- User Manual + +## Related Link + +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) + +## Related Video + +- **m5stack instroduce** + + diff --git a/docs/en/core/m5go_iot_starter_kit.md b/docs/en/core/m5go_iot_starter_kit.md index 61fc1c84..dbd93650 100644 --- a/docs/en/core/m5go_iot_starter_kit.md +++ b/docs/en/core/m5go_iot_starter_kit.md @@ -1,51 +1,51 @@ -# M5GO IOT Starter Kit - -gray_02 gray_02 gray_04 - - - -* * * - -:memo:**[Description](#Description)**   :bulb:**[Quick Start](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.4.44fa29faDagj56)**   :clapper:**[Related Video](#Related-Video)** - -## Description - -**M5GO IOT Starter Kit** is a kit designed for learning IOT programming which consists of 6 units(ENV, IR, RGB, PIR, ANGLE, HUB) and one white M5Core(based on ESP32 chip). - -Programming M5GO with [UiFlow](http://flow.m5stack.com) or Arduino IDE. - -We also supply some courses for teaching IOT programming. If you are interesting in it, contact us through Email please. - -## Feature - -- Programming Support -- Arduino -- ESP-IDF -- MicroPython -- TF Card Support - -## Include - -- 1x white M5Core -- 1x M5GO Base -- 6x Units -- 4x LEGO Accessories -- 3x GROVE Cables -- Type-C USB Cable -- User Manual - - - - - - - -## Related Link - -- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -## Related Video - -- **m5stack instroduce** - +# M5GO IOT Starter Kit + +gray_02 gray_02 gray_04 + + + +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.4.44fa29faDagj56)**   :clapper:**[Related Video](#Related-Video)** + +## Description + +**M5GO IOT Starter Kit** is a kit designed for learning IOT programming which consists of 6 units(ENV, IR, RGB, PIR, ANGLE, HUB) and one white M5Core(based on ESP32 chip). + +Programming M5GO with [UiFlow](http://flow.m5stack.com) or Arduino IDE. + +We also supply some courses for teaching IOT programming. If you are interesting in it, contact us through Email please. + +## Feature + +- Programming Support +- Arduino +- ESP-IDF +- MicroPython +- TF Card Support + +## Include + +- 1x white M5Core +- 1x M5GO Base +- 6x Units +- 4x LEGO Accessories +- 3x GROVE Cables +- Type-C USB Cable +- User Manual + + + + + + + +## Related Link + +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +## Related Video + +- **m5stack instroduce** + \ No newline at end of file diff --git a/docs/en/core/m5stick.md b/docs/en/core/m5stick.md index 08ab5a76..5d476e2a 100644 --- a/docs/en/core/m5stick.md +++ b/docs/en/core/m5stick.md @@ -1,64 +1,64 @@ -# M5Stick - -gray_02 gray_02 gray_04 - -* * * - -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stick_get_started_arduino)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Stick/FactoryTest)**     :electric_plug:**[Schematic](#Schematic)**     🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-M5Stick-Mini-Development-Kit-ESP32-1-3-OLED-80mAh-Battery-Inside-Buzzer-IR/3226069_32947692973.html?spm=a2g1y.12024536.productList_5885011.subject_1)**    - -## Description - -**M5Stick** is a mini esp32 development board including 1.3' OLED Screen(64x128), led, button, buzzer, IR Transmitter, 80mAh-Battery and **optional MEMS(MPU9250)**. Usually, you can put it on your wrist with `WATCH BELT` or band it on the wall with `WALL` or `BRICK`. - -There are two version of it. One M5Stick does not contain MPU9250, another version contains MPU9250 and some accessories(likes `WATCH BELT`, `WALL` and `BRICK`). - -## Feature - -- Programming Support: Arduino, UiFlow(Blockly, MicroPython) -- Wearable -- Optional MEMS: MPU9250 - -## PinMap - -| *BLUE_LED* | *ESP32* | -| :----------: |:------------: | -| LED_Pin | GPIO19 | - -| *BUTTON* | *ESP32* | -| :----------: |:------------: | -| Button_Pin | GPIO35 | - -| *BUZZER* | *ESP32* | -| :----------: |:------------: | -| Buzzer_Pin | GPIO26 | - -| *IR* | *ESP32* | -| :----------: |:------------: | -| Buzzer_Pin | GPIO17 | - -| *GROVE* | *ESP32* | -| :----------: |:------------: | -| SDA | GPIO25 | -| SCL | GPIO13 | - - -**Optional:** - -| *MPU9250* | *ESP32* | -| :----------: |:------------: | -| SDA | GPIO22 | -| SCL | GPIO21 | - - - -## Include - -- 1x M5Stick including 80mAh-Battery -- 1x Type-C USB Cable - -**MPU9250 Version:** -- Some accessories: `WATCH BELT`, `WALL` and `BRICK` - -## Related Link - -- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) +# M5Stick + +gray_02 gray_02 gray_04 + +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stick_get_started_arduino)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Stick/FactoryTest)**     :electric_plug:**[Schematic](#Schematic)**     🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-M5Stick-Mini-Development-Kit-ESP32-1-3-OLED-80mAh-Battery-Inside-Buzzer-IR/3226069_32947692973.html?spm=a2g1y.12024536.productList_5885011.subject_1)**    + +## Description + +**M5Stick** is a mini esp32 development board including 1.3' OLED Screen(64x128), led, button, buzzer, IR Transmitter, 80mAh-Battery and **optional MEMS(MPU9250)**. Usually, you can put it on your wrist with `WATCH BELT` or band it on the wall with `WALL` or `BRICK`. + +There are two version of it. One M5Stick does not contain MPU9250, another version contains MPU9250 and some accessories(likes `WATCH BELT`, `WALL` and `BRICK`). + +## Feature + +- Programming Support: Arduino, UiFlow(Blockly, MicroPython) +- Wearable +- Optional MEMS: MPU9250 + +## PinMap + +| *BLUE_LED* | *ESP32* | +| :----------: |:------------: | +| LED_Pin | GPIO19 | + +| *BUTTON* | *ESP32* | +| :----------: |:------------: | +| Button_Pin | GPIO35 | + +| *BUZZER* | *ESP32* | +| :----------: |:------------: | +| Buzzer_Pin | GPIO26 | + +| *IR* | *ESP32* | +| :----------: |:------------: | +| Buzzer_Pin | GPIO17 | + +| *GROVE* | *ESP32* | +| :----------: |:------------: | +| SDA | GPIO25 | +| SCL | GPIO13 | + + +**Optional:** + +| *MPU9250* | *ESP32* | +| :----------: |:------------: | +| SDA | GPIO22 | +| SCL | GPIO21 | + + + +## Include + +- 1x M5Stick including 80mAh-Battery +- 1x Type-C USB Cable + +**MPU9250 Version:** +- Some accessories: `WATCH BELT`, `WALL` and `BRICK` + +## Related Link + +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) diff --git a/docs/en/core/white.md b/docs/en/core/white.md index 2213a743..74e333a4 100644 --- a/docs/en/core/white.md +++ b/docs/en/core/white.md @@ -1,157 +1,157 @@ -# M5Core WHITE - -[中文](/zh_CN/product_documents/m5stack-core/m5core_white) | English | [日本語](ja/product_documents/m5stack-core/m5core_white) - -## Description - -**The White M5Core is a main board of M5GO IOT Starter Kit.** The White M5Core is similar with M5Core GRAY. But it's bottom module is M5GO Base, not the same as M5Core GRAY. - -It equips the ESP32 with everything necessary to program, run and develop on the wonderchip. It also features a MEMS Chip(**MPU9250**), and a TFT LCD, so you can create a 3D remote gesture controller, a simple "Leap Motion" via M5Stack GRAY in a day in stead of couple weeks and so on. - -The a Bottom board on the back of M5Core. It's designed for expanding gpio on M-Bus besides I2S Pins(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)for DIY. Each gpio on M-Bus is expanded as pin and port for convenience and flexibility. - -## Feature - -- Programming Support - - UiFlow - - MicroPython - - Arduino -- Compatible LEGO -- TF Card Support - -## PARAMETER - -| Source | Parameter | -| :----------: |:------------: | -| ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth | -| Flash | 16MB | -| Input | 5V @ 500mA | -| Interface | TypeC x 1, GROVE(I2C+I/0+UART) x 1 | -| LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 | -| Speaker | 1W-0928 | -| **MEMS** | MPU9250 | -| Battery | 150mAh @ 3.7V, inside vb | -| Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) | -| Size | 54 x 54 x 12.5 mm | -| C.A.S.E | Plastic ( PC ) | -| Weight | 120g with bottom, 100g only core | - -## PinMap - -**POGO Pin** - -| POGO Pin | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LED Bar** - -| LED Pin | ESP32 Chip | -| :----------: |:------------: | -| LED Pin | GPIO15 | - -**MIC** - -| MIC Pin | ESP32 Chip | -| :----------: |:------------: | -| MIC Pin | GPIO34 | - -**Speak** - -| Speak Pin | ESP32 Chip | -| :----------: |:------------: | -| Speak Pin | GPIO25 | - -**Button** - -| Button Pin | ESP32 Chip | -| :----------: |:------------: | -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**GROVE** - -| PORT A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -| :----------: |:------------: | -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -| :----------: |:------------: | -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**MEMS Chip** - -*MPU9250 i2c address: 0x68* - -| MPU9250 | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -**LCD** - -| ILI9341 | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | - -**TF Card** - -| TFCard Pin | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | - -**M-Bus** - -
- M_BUS -
- -## Include - -- 1x M5Core WHITE -- 1x M5GO Base -- 1x M5GO CHG BASE -- Type-C USB Cable -- User Manual - -## Related Link - -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.6.44fa2da3D2i5Yi)** - -- **Quick Start** - - Arduino - [MacOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) - -- **[The difference between M5Cores](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md)** - -
- -
+# M5Core WHITE + +[中文](/zh_CN/product_documents/m5stack-core/m5core_white) | English | [日本語](ja/product_documents/m5stack-core/m5core_white) + +## Description + +**The White M5Core is a main board of M5GO IOT Starter Kit.** The White M5Core is similar with M5Core GRAY. But it's bottom module is M5GO Base, not the same as M5Core GRAY. + +It equips the ESP32 with everything necessary to program, run and develop on the wonderchip. It also features a MEMS Chip(**MPU9250**), and a TFT LCD, so you can create a 3D remote gesture controller, a simple "Leap Motion" via M5Stack GRAY in a day in stead of couple weeks and so on. + +The a Bottom board on the back of M5Core. It's designed for expanding gpio on M-Bus besides I2S Pins(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)for DIY. Each gpio on M-Bus is expanded as pin and port for convenience and flexibility. + +## Feature + +- Programming Support + - UiFlow + - MicroPython + - Arduino +- Compatible LEGO +- TF Card Support + +## PARAMETER + +| Source | Parameter | +| :----------: |:------------: | +| ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth | +| Flash | 16MB | +| Input | 5V @ 500mA | +| Interface | TypeC x 1, GROVE(I2C+I/0+UART) x 1 | +| LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 | +| Speaker | 1W-0928 | +| **MEMS** | MPU9250 | +| Battery | 150mAh @ 3.7V, inside vb | +| Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) | +| Size | 54 x 54 x 12.5 mm | +| C.A.S.E | Plastic ( PC ) | +| Weight | 120g with bottom, 100g only core | + +## PinMap + +**POGO Pin** + +| POGO Pin | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | + +**LED Bar** + +| LED Pin | ESP32 Chip | +| :----------: |:------------: | +| LED Pin | GPIO15 | + +**MIC** + +| MIC Pin | ESP32 Chip | +| :----------: |:------------: | +| MIC Pin | GPIO34 | + +**Speak** + +| Speak Pin | ESP32 Chip | +| :----------: |:------------: | +| Speak Pin | GPIO25 | + +**Button** + +| Button Pin | ESP32 Chip | +| :----------: |:------------: | +| BUTTON A | GPIO39 | +| BUTTON B | GPIO38 | +| BUTTON C | GPIO37 | + +**GROVE** + +| PORT A(I2C) | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +| PORT B(I/O) | ESP32 Chip | +| :----------: |:------------: | +| G36 | GPIO36 | +| G26 | GPIO26 | +| 5V | 5V | +| GND | GND | + +| PORT C(UART2) | ESP32 Chip | +| :----------: |:------------: | +| RXD | GPIO16 | +| TXD | GPIO17 | +| 5V | 5V | +| GND | GND | + +**MEMS Chip** + +*MPU9250 i2c address: 0x68* + +| MPU9250 | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +**LCD** + +| ILI9341 | ESP32 Chip | +| :----------: |:------------: | +| MOSI | GPIO23 | +| MISO | / | +| CLK | GPIO18 | +| CS | GPIO14 | +| DC | GPIO27 | +| RST | GPIO33 | +| BL | GPIO32 | + +**TF Card** + +| TFCard Pin | ESP32 Chip | +| :----------: |:------------: | +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO4 | + +**M-Bus** + +
+ M_BUS +
+ +## Include + +- 1x M5Core WHITE +- 1x M5GO Base +- 1x M5GO CHG BASE +- Type-C USB Cable +- User Manual + +## Related Link + +- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) + +- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.6.44fa2da3D2i5Yi)** + +- **Quick Start** + - Arduino - [MacOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) + +- **[The difference between M5Cores](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md)** + +
+ +
diff --git a/docs/en/faq.md b/docs/en/faq.md index 64e5b1be..5019d4a5 100644 --- a/docs/en/faq.md +++ b/docs/en/faq.md @@ -1,5 +1,5 @@ -# FAQ - - - +# FAQ + + + ## (coming soon...) \ No newline at end of file diff --git a/docs/en/module/battery.md b/docs/en/module/battery.md index 2ac4b227..5792c9a2 100644 --- a/docs/en/module/battery.md +++ b/docs/en/module/battery.md @@ -1,27 +1,27 @@ -# M5Stack BATTERY Module - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-Battery-Module-for-Arduino-ESP32-Core-Development-Kit-Capacity-850mAh-Stackable-IoT/3226069_32839688875.html?spm=2114.12010610.8148356.8.7b26c4a1uVFob3.html)** - -# Description - -The M5Stack BATTERY Module is module with 850mAh High-Capacity Battery. -User can create a portble device with any series of M5Stack Core and -M5Stack BATTERY Module easily. - -# Feature - -- 850mAh High-Capacity Battery - -# Include - -- 1x M5Stack BATTERY Module - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** +# M5Stack BATTERY Module + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-Battery-Module-for-Arduino-ESP32-Core-Development-Kit-Capacity-850mAh-Stackable-IoT/3226069_32839688875.html?spm=2114.12010610.8148356.8.7b26c4a1uVFob3.html)** + +# Description + +The M5Stack BATTERY Module is module with 850mAh High-Capacity Battery. +User can create a portble device with any series of M5Stack Core and +M5Stack BATTERY Module easily. + +# Feature + +- 850mAh High-Capacity Battery + +# Include + +- 1x M5Stack BATTERY Module + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/module/btc.md b/docs/en/module/btc.md index 7ebcce18..eb0c8c77 100644 --- a/docs/en/module/btc.md +++ b/docs/en/module/btc.md @@ -1,48 +1,48 @@ -# M5Stack BTC Module - - - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-GPS-Module-with-Internal-External-Antenna-MCX-Interface-IoT-Development-Board-for/3226069_32840757048.html?spm=2114.12010615.8148356.2.7c6c2743BZthY3)** - -# Description - -The M5Stack BTC Module is a base including DHT12 module which can detect -temperature and humidity. Your M5Stack Core board can stay as a small -displayer(like a small TV or a small IOT central contronller) after -adding this BTC Module. Absolutely, it is more easier to charge M5Stack -Core via Type-C Cable after adding this BTC Module. - -# Feature - -- DHT12 inside - -# Include - -- Type-C USB Cable -- M3 x 16 -- Tools - -# PinMap - -**DHT12** - -| DHT12 | ESP32 | -| :----------: |:------------:| -| SCL | G22 | -| GND | GND | -| SDA | G21 | -| 3V3 | 3V3 | - - - - -# Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - +# M5Stack BTC Module + + + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-GPS-Module-with-Internal-External-Antenna-MCX-Interface-IoT-Development-Board-for/3226069_32840757048.html?spm=2114.12010615.8148356.2.7c6c2743BZthY3)** + +# Description + +The M5Stack BTC Module is a base including DHT12 module which can detect +temperature and humidity. Your M5Stack Core board can stay as a small +displayer(like a small TV or a small IOT central contronller) after +adding this BTC Module. Absolutely, it is more easier to charge M5Stack +Core via Type-C Cable after adding this BTC Module. + +# Feature + +- DHT12 inside + +# Include + +- Type-C USB Cable +- M3 x 16 +- Tools + +# PinMap + +**DHT12** + +| DHT12 | ESP32 | +| :----------: |:------------:| +| SCL | G22 | +| GND | GND | +| SDA | G21 | +| 3V3 | 3V3 | + + + + +# Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + diff --git a/docs/en/module/commu.md b/docs/en/module/commu.md index a5f100b7..78708e8a 100644 --- a/docs/en/module/commu.md +++ b/docs/en/module/commu.md @@ -1,47 +1,47 @@ -# COMMU - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-COMMU-Module-Extend-RS485-TTL-CAN-I2C-Port-with-MCP2515-TJA1051-SP3485-Development-Board/3226069_32954475633.html?spm=a2g1y.12024536.productList_5885013.subject_2)** - -## Description - -COMMU is a communication interface converter which can meet most of the application design. Now, COMMU owns two I2C interfaces, one CAN interface and one RS485 interface. Simultaneously, COMMU also owns a TTL level interface. It means you just need to stack it underneath M5Core when you want to control a CAN device or RS485 device. - -Be care about TTL Interface. It is a UART Interface actually by default. But you can switch it to connect with UART2 after changed those jumpers(J6, J7, J9, J10). - -## Feature - -- 2x I2C Interface -- 1x CAN Interface -- 1x RS485 Interface -- 1x TTL Interface - -## Include - -- 1x M5Stack COMMU Module - -## PinMap - -| *CAN* | *ESP32 Chip* | -| :----------: |:------------: | -| CAN_CS | GPIO12 | -| CAN_INT | GPIO15 | -| CAN_SCK | GPIO18 | -| CAN_MISO | GPIO19 | -| CAN_MOSI | GPIO23 | - - -| *I2C Interface* | *ESP32 Chip* | -| :--------------: |:------------: | -| IIC_SDA | GPIO21 | -| IIC_SCL | GPIO22 | - - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** +# COMMU + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-COMMU-Module-Extend-RS485-TTL-CAN-I2C-Port-with-MCP2515-TJA1051-SP3485-Development-Board/3226069_32954475633.html?spm=a2g1y.12024536.productList_5885013.subject_2)** + +## Description + +COMMU is a communication interface converter which can meet most of the application design. Now, COMMU owns two I2C interfaces, one CAN interface and one RS485 interface. Simultaneously, COMMU also owns a TTL level interface. It means you just need to stack it underneath M5Core when you want to control a CAN device or RS485 device. + +Be care about TTL Interface. It is a UART Interface actually by default. But you can switch it to connect with UART2 after changed those jumpers(J6, J7, J9, J10). + +## Feature + +- 2x I2C Interface +- 1x CAN Interface +- 1x RS485 Interface +- 1x TTL Interface + +## Include + +- 1x M5Stack COMMU Module + +## PinMap + +| *CAN* | *ESP32 Chip* | +| :----------: |:------------: | +| CAN_CS | GPIO12 | +| CAN_INT | GPIO15 | +| CAN_SCK | GPIO18 | +| CAN_MISO | GPIO19 | +| CAN_MOSI | GPIO23 | + + +| *I2C Interface* | *ESP32 Chip* | +| :--------------: |:------------: | +| IIC_SDA | GPIO21 | +| IIC_SCL | GPIO22 | + + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/module/gps.md b/docs/en/module/gps.md index dae5ed8e..aaf956de 100644 --- a/docs/en/module/gps.md +++ b/docs/en/module/gps.md @@ -1,49 +1,49 @@ -# GPS - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-GPS-Module-with-Internal-External-Antenna-MCX-Interface-IoT-Development-Board-for/3226069_32840757048.html?spm=2114.12010615.8148356.2.7c6c2743BZthY3)** - -## Description - -The M5Stack GPS Module is a module with small GPS module. The small GPS -module named UBLOX NEO-M8N. You can program it through Blockly, Arduino -or MicroPython after connected to any series of M5Stack Core. - -GPS module is built on the high performing u-blox M8 GNSS engine and -exhibit high performance and high sensitivity.And it can supply your -global positioning information even you in the wild and get lost. - -## Feature - -- GPS NEO-M8N Module -- high-performance -- high-sensitivity -- Concurrent reception of up to 3 GNSS -- Industry leading –167 dBm navigation sensitivity - -## Include - -- 1x M5Stack GPS Module -- 1x M5Stack Antenna - -## Application - -- Child positioning bracelet -- Logistics Tracking Management based on GPS - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **[GPS Info](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) - -## Example - -## Schematic - - +# GPS + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-GPS-Module-with-Internal-External-Antenna-MCX-Interface-IoT-Development-Board-for/3226069_32840757048.html?spm=2114.12010615.8148356.2.7c6c2743BZthY3)** + +## Description + +The M5Stack GPS Module is a module with small GPS module. The small GPS +module named UBLOX NEO-M8N. You can program it through Blockly, Arduino +or MicroPython after connected to any series of M5Stack Core. + +GPS module is built on the high performing u-blox M8 GNSS engine and +exhibit high performance and high sensitivity.And it can supply your +global positioning information even you in the wild and get lost. + +## Feature + +- GPS NEO-M8N Module +- high-performance +- high-sensitivity +- Concurrent reception of up to 3 GNSS +- Industry leading –167 dBm navigation sensitivity + +## Include + +- 1x M5Stack GPS Module +- 1x M5Stack Antenna + +## Application + +- Child positioning bracelet +- Logistics Tracking Management based on GPS + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[GPS Info](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) + +## Example + +## Schematic + + diff --git a/docs/en/module/lan.md b/docs/en/module/lan.md index 4ea3d6dd..32dcf1ee 100644 --- a/docs/en/module/lan.md +++ b/docs/en/module/lan.md @@ -1,44 +1,44 @@ -# M5Stack LAN Module - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** - -## Description - -The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports. - -When the speed of our wireless network is so slow that M5Stack Core can not normally connect to the wireless network. -So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem. - - -## Feature - -- W5500 - High-performance ethernet chip -- Less code and Hand-in-hand program experience - -## Include - -- 1x M5Stack LAN Module(including USER-DEFINE 6 PIN and 1 Grove port) -- 1x DIN-RAIL -- 1x STICKER - -## Applications - -- A mini portable Web server - + TCP/UDP Server - + HTTP Server -- A mini portable Web Clinet - + TCP/UDP Clinet - + HTTP Clinet -- SMTP/NTP Server - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - +# M5Stack LAN Module + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** + +## Description + +The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports. + +When the speed of our wireless network is so slow that M5Stack Core can not normally connect to the wireless network. +So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem. + + +## Feature + +- W5500 - High-performance ethernet chip +- Less code and Hand-in-hand program experience + +## Include + +- 1x M5Stack LAN Module(including USER-DEFINE 6 PIN and 1 Grove port) +- 1x DIN-RAIL +- 1x STICKER + +## Applications + +- A mini portable Web server + + TCP/UDP Server + + HTTP Server +- A mini portable Web Clinet + + TCP/UDP Clinet + + HTTP Clinet +- SMTP/NTP Server + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + - [LAN Info](https://www.u-blox.com/zh/product/neo-m8-series) (LAN) \ No newline at end of file diff --git a/docs/en/module/lora.md b/docs/en/module/lora.md index 1f387965..c2842a8a 100644 --- a/docs/en/module/lora.md +++ b/docs/en/module/lora.md @@ -1,56 +1,56 @@ -# M5Stack LORA Module - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-LoRa-Module-for-ESP32-DIY-Development-Kit-Wireless-433MHz-Built-in-Antenna/3226069_32839736315.html?spm=2114.12010615.8148356.22.25e96be7xE1y22.html)** - -## Description - -The LoRa Module is a module with small LoRa module named Ra-02. -You can program it after connected to any series of M5Stack Core through -Blockly, Arduino or MicroPython. - -M5Stack LoRa Module can be used for ultra-long distance spread spectrum -communication, and compatible FSK remote modulation and demodulation -quickly, to solve the traditional wireless design can not take into -account the distance, anti-interference and power consumption - -## Feature - -- LoRa Module named RA-02 supply by Ai-Thinker -- Supports FSK, GFSK, MSK, GMSK, LoRa ™ and OOK modulation modes -- Receive sensitivity as low as -141 dBm -- Programmable bit rate up to 300Kbps -- Build-in Antenna - -## Include - -- 1x M5Stack LoRa Module - -## Applications - -- Automatic meter reading -- Home building automation -- Remote irrigation system - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **[LoRa Info](http://wiki.ai-thinker.com/lora) (LoRa)** - -?> **Note** If your board LCD can't display or has some other problem, we suggest -you to add the two statements code followed by ``m5.begin();`` as shown -below -```cpp - pinMode(5,OUTPUT); - digitalWrite(5,HIGH); - m5.begin(); -``` -?> **Note** Because GPIO5 who has connected NSS pin of LoRa module need be pull-up -at the moment your board(or system) power on to prevent system's LCD -can't display. +# M5Stack LORA Module + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-LoRa-Module-for-ESP32-DIY-Development-Kit-Wireless-433MHz-Built-in-Antenna/3226069_32839736315.html?spm=2114.12010615.8148356.22.25e96be7xE1y22.html)** + +## Description + +The LoRa Module is a module with small LoRa module named Ra-02. +You can program it after connected to any series of M5Stack Core through +Blockly, Arduino or MicroPython. + +M5Stack LoRa Module can be used for ultra-long distance spread spectrum +communication, and compatible FSK remote modulation and demodulation +quickly, to solve the traditional wireless design can not take into +account the distance, anti-interference and power consumption + +## Feature + +- LoRa Module named RA-02 supply by Ai-Thinker +- Supports FSK, GFSK, MSK, GMSK, LoRa ™ and OOK modulation modes +- Receive sensitivity as low as -141 dBm +- Programmable bit rate up to 300Kbps +- Build-in Antenna + +## Include + +- 1x M5Stack LoRa Module + +## Applications + +- Automatic meter reading +- Home building automation +- Remote irrigation system + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[LoRa Info](http://wiki.ai-thinker.com/lora) (LoRa)** + +?> **Note** If your board LCD can't display or has some other problem, we suggest +you to add the two statements code followed by ``m5.begin();`` as shown +below +```cpp + pinMode(5,OUTPUT); + digitalWrite(5,HIGH); + m5.begin(); +``` +?> **Note** Because GPIO5 who has connected NSS pin of LoRa module need be pull-up +at the moment your board(or system) power on to prevent system's LCD +can't display. diff --git a/docs/en/module/lorawan.md b/docs/en/module/lorawan.md index 38ca9a20..f1c690fb 100644 --- a/docs/en/module/lorawan.md +++ b/docs/en/module/lorawan.md @@ -1,50 +1,50 @@ -# LoRaWAN - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-LoRaWAN-Module-433-470Mhz-868-915MHz-with-Internal-Antenna-and-MCX-External-Antenna-Port/3226069_32953098569.html?spm=a2g1y.12024536.productList_5885011.pic_2)** - -## Description - -LoRaWAN is a small LoRa terminal module built-in LoRa chip(SX1276) and ST MCU that means this module has been built with complete LoRa protocal stack. So you can develop a LoRaWAN module through UART or simple AT command with M5Core. - -By default, the UART configuration: "9600, 8, n, 1"(8 bits data, no parity, 1 stop bit) - -?> **Notice** The 5 holes which are under the silk screen "LoRaWAN" are designed for upgrading the firmware of LoRaWAN module. - -## Feature - -- Supports 433/470MHz and 868/915MHz -- Supports DataRate: 0.018-38.4kbps -- Output Power: 17 ± 0.5dbm -- Supports ADR(Adaptive Data Rate) -- Build-in Antenna - -## Include - -- 1x LoRa Module - -## Applications - -- Automatic meter reading -- Home building automation -- Remote irrigation system - -## PinMap - -| *RHF76-052_UART* | *ESP32 Chip* | -| :----------: |:------------: | -| RXD | GPIO17 | -| TXD | GPIO16 | - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **[LoRaWAN Info](http://wiki.ai-thinker.com/sx127x-052) (LoRaWAN)** - -- **[AT command for LoRaWAN](http://wiki.ai-thinker.com/_media/rhf-ps01509_lorawan_class_ac_at_command_specification_-_v4.4.pdf)** +# LoRaWAN + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-LoRaWAN-Module-433-470Mhz-868-915MHz-with-Internal-Antenna-and-MCX-External-Antenna-Port/3226069_32953098569.html?spm=a2g1y.12024536.productList_5885011.pic_2)** + +## Description + +LoRaWAN is a small LoRa terminal module built-in LoRa chip(SX1276) and ST MCU that means this module has been built with complete LoRa protocal stack. So you can develop a LoRaWAN module through UART or simple AT command with M5Core. + +By default, the UART configuration: "9600, 8, n, 1"(8 bits data, no parity, 1 stop bit) + +?> **Notice** The 5 holes which are under the silk screen "LoRaWAN" are designed for upgrading the firmware of LoRaWAN module. + +## Feature + +- Supports 433/470MHz and 868/915MHz +- Supports DataRate: 0.018-38.4kbps +- Output Power: 17 ± 0.5dbm +- Supports ADR(Adaptive Data Rate) +- Build-in Antenna + +## Include + +- 1x LoRa Module + +## Applications + +- Automatic meter reading +- Home building automation +- Remote irrigation system + +## PinMap + +| *RHF76-052_UART* | *ESP32 Chip* | +| :----------: |:------------: | +| RXD | GPIO17 | +| TXD | GPIO16 | + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[LoRaWAN Info](http://wiki.ai-thinker.com/sx127x-052) (LoRaWAN)** + +- **[AT command for LoRaWAN](http://wiki.ai-thinker.com/_media/rhf-ps01509_lorawan_class_ac_at_command_specification_-_v4.4.pdf)** diff --git a/docs/en/module/plc.md b/docs/en/module/plc.md index 95ef4cc6..92fbea37 100644 --- a/docs/en/module/plc.md +++ b/docs/en/module/plc.md @@ -1,48 +1,48 @@ -# M5Stack PLC Module - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-PLC-Proto-Industrial-Board-Module-Contains-RS485-ACS712-5B-Programmable-Logic-Controller-Relay-with-Magnet/3226069_32874916056.html?spm=2114.12010615.8148356.2.4c5b68a1WZ8sjd)** - -## Description - -The M5Stack PLC Module is a prototye industrial board, including RS484 -adapter and electricity meter module. - -With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin -relay output, digital input, communication interface etc. - -## Feature - -- Free DIY -- Programmable Logic Controller -- Individual package weight: 0.1kg (0.22lb.) -- Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) - -## Include - -- 1x PLC-Proto Broad -- 1x RS485 module -- 1x PLC Plastic Enclosure -- 1x Slide Guide -- 1x Magnet -- 1x 6 Pin 3.96 Pitch Terminal -- 1x 4 Pin 3.96 Pitch Terminal -- 3x Hex Key -- 7x Electrical Terminal -- 1x Sticker - -## Applications - -- Programmable Logic Controller -- Programmable Motion Controller -- Digital Operation Processor -- Strong Electric Controller - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** +# M5Stack PLC Module + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-PLC-Proto-Industrial-Board-Module-Contains-RS485-ACS712-5B-Programmable-Logic-Controller-Relay-with-Magnet/3226069_32874916056.html?spm=2114.12010615.8148356.2.4c5b68a1WZ8sjd)** + +## Description + +The M5Stack PLC Module is a prototye industrial board, including RS484 +adapter and electricity meter module. + +With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin +relay output, digital input, communication interface etc. + +## Feature + +- Free DIY +- Programmable Logic Controller +- Individual package weight: 0.1kg (0.22lb.) +- Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) + +## Include + +- 1x PLC-Proto Broad +- 1x RS485 module +- 1x PLC Plastic Enclosure +- 1x Slide Guide +- 1x Magnet +- 1x 6 Pin 3.96 Pitch Terminal +- 1x 4 Pin 3.96 Pitch Terminal +- 3x Hex Key +- 7x Electrical Terminal +- 1x Sticker + +## Applications + +- Programmable Logic Controller +- Programmable Motion Controller +- Digital Operation Processor +- Strong Electric Controller + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/module/plus.md b/docs/en/module/plus.md index 1abb8b5b..0432d3e8 100644 --- a/docs/en/module/plus.md +++ b/docs/en/module/plus.md @@ -1,28 +1,28 @@ -# M5Stack PLUS - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-PLUS-Module-Encoder-Module-with-MEGA328P-500mAh-Battery-ISP-IR-Transmitter-UART-GPIO/3226069_32949278724.html?spm=a2g1x.12024536.productList_5885013.pic_1)** - -## Description - -This a enhanced module including battery(500mAh), gear potentiometer, IR transmitter, PORT B(GPIO Port), PORT C(UART Port) and MicroPhone Pad. You can stack it with a M5Core for function enhancement. The module comunicates with M5Core with I2C. It's I2C address is 0x89. - -## Feature - -- 500mAh Battery -- Programmable gear potentiometer -- IR transmitter -- Including PORT B and PORT C - -## Include - -- 1x PLUS Module - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - +# M5Stack PLUS + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-PLUS-Module-Encoder-Module-with-MEGA328P-500mAh-Battery-ISP-IR-Transmitter-UART-GPIO/3226069_32949278724.html?spm=a2g1x.12024536.productList_5885013.pic_1)** + +## Description + +This a enhanced module including battery(500mAh), gear potentiometer, IR transmitter, PORT B(GPIO Port), PORT C(UART Port) and MicroPhone Pad. You can stack it with a M5Core for function enhancement. The module comunicates with M5Core with I2C. It's I2C address is 0x89. + +## Feature + +- 500mAh Battery +- Programmable gear potentiometer +- IR transmitter +- Including PORT B and PORT C + +## Include + +- 1x PLUS Module + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + - **[Forum](http://forum.m5stack.com/)** \ No newline at end of file diff --git a/docs/en/module/proto.md b/docs/en/module/proto.md index aabd528d..c31fb1ac 100644 --- a/docs/en/module/proto.md +++ b/docs/en/module/proto.md @@ -1,53 +1,53 @@ -# M5Stack PROTO Module - - - -*** - -:memo:**[Description](#Description)**     🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-Proto-Module-Proto-Board-with-Extension-Bus-Socket-for-Arduino-ESP32-Development/3226069_32843231933.html?spm=2114.12010610.8148356.4.7b26c4a1MZw8Xy.html)** - -## Description - -The M5Stack PROTO Module is a flexible blank circle with 30 pins which -could connect with all series of M5Stack Core. You can create any circle -that could controlled by any M5Stack Core on M5Stack PROTO Module as you -like. - -## Feature - -- Flexible extended blank circle -- Compatible with all series of M5Stack Core - -## Interface - -| LINE0 | LINE1 | -|:---:|:---:| -| GND | IO35(ADC1) | -| GND | IO36(ADC2) | -| GND | EN | -| IO23(MOSI) | IO25(DAC0) | -| IO19(MISO) | IO26(DAC1) | -| IO18(EXT\_SCK) | 3V3 | -| IO3(U1\_RX) | IO1(U1\_TX) | -| IO16(U1\_RX) | IO17(U2\_TX) | -| IO21(I2C\_SDA) | IO22(I2C\_SCL) | -| IO2 | IO5 | -| IO12(I2S\_SCLK) | IO13 | -| IO15(I2S\_OUT) | IO0 | -| HPOWR | IO34 | -| HPOWR | 5V | -| HPOWR | BAT | - -## Include - -- 1x M5Stack PROTO Module -- 1x Bus Socket -- 1x GROVE Cable -- 1x Packing Box -- User Manual - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** +# M5Stack PROTO Module + + + +*** + +:memo:**[Description](#Description)**     🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-Proto-Module-Proto-Board-with-Extension-Bus-Socket-for-Arduino-ESP32-Development/3226069_32843231933.html?spm=2114.12010610.8148356.4.7b26c4a1MZw8Xy.html)** + +## Description + +The M5Stack PROTO Module is a flexible blank circle with 30 pins which +could connect with all series of M5Stack Core. You can create any circle +that could controlled by any M5Stack Core on M5Stack PROTO Module as you +like. + +## Feature + +- Flexible extended blank circle +- Compatible with all series of M5Stack Core + +## Interface + +| LINE0 | LINE1 | +|:---:|:---:| +| GND | IO35(ADC1) | +| GND | IO36(ADC2) | +| GND | EN | +| IO23(MOSI) | IO25(DAC0) | +| IO19(MISO) | IO26(DAC1) | +| IO18(EXT\_SCK) | 3V3 | +| IO3(U1\_RX) | IO1(U1\_TX) | +| IO16(U1\_RX) | IO17(U2\_TX) | +| IO21(I2C\_SDA) | IO22(I2C\_SCL) | +| IO2 | IO5 | +| IO12(I2S\_SCLK) | IO13 | +| IO15(I2S\_OUT) | IO0 | +| HPOWR | IO34 | +| HPOWR | 5V | +| HPOWR | BAT | + +## Include + +- 1x M5Stack PROTO Module +- 1x Bus Socket +- 1x GROVE Cable +- 1x Packing Box +- User Manual + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/module/servo.md b/docs/en/module/servo.md index 952e08a1..b5a3cef1 100644 --- a/docs/en/module/servo.md +++ b/docs/en/module/servo.md @@ -1,66 +1,66 @@ -# SERVO - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-SERVO-Module-Board-12-Channels-Servo-Controller-with-MEGA328-Inside-Power-Adapter-6-24V/3226069_32951356502.html?spm=a2g1y.12024536.productList_5885011.pic_0)** - -## Description - -Servo is a servo-motor driver module which can drive 12-way servo motors simultaneously. But actually, in our experiment, because of the maximum current, the maximum number of servo motor it can drive is 9. So we will publish a upgraded version soon after. - -It's too easy to drive servo motors so that you can drive many servo motors after programmed 2-3 lines code in Arduino IDE or dragged 2-3 block in UiFlow. - -Servo is communicated with M5Core through GROVE interface(I2C communication). The I2C address is 0x53. - -## Feature - -- Drive multi-way servo motor simultaneously -- Support wide-voltage power input: 6-12V -- Support programming with Arduino IDE or UiFlow - -## Include - -- 1x M5Stack Servo Module -- 1x 6-12V Power Interface - -## Applications - -- Humanoid robot -- Bionic multi-joint robot -- 3-axis head for camera - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -### 1. Arduino IDE - -```c++ -#define SERVO_ADDR 0x53 //the IIC address of SERVO Module -/* - * control servo(CH channle) by us - */ -Wire.beginTransmission(SERVO_ADDR); -Wire.write(CH|0x00); -Wire.write(timeL); -Wire.write(timeH); -Wire.endTransmission(); - -/* - * control servo(CH channle) by angle - */ -Wire.beginTransmission(SERVO_ADDR); -Wire.write(CH|0x10); -Wire.write(angle);//0-180° -Wire.endTransmission(); -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/SERVO/Arduino) for specifical example. - +# SERVO + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-SERVO-Module-Board-12-Channels-Servo-Controller-with-MEGA328-Inside-Power-Adapter-6-24V/3226069_32951356502.html?spm=a2g1y.12024536.productList_5885011.pic_0)** + +## Description + +Servo is a servo-motor driver module which can drive 12-way servo motors simultaneously. But actually, in our experiment, because of the maximum current, the maximum number of servo motor it can drive is 9. So we will publish a upgraded version soon after. + +It's too easy to drive servo motors so that you can drive many servo motors after programmed 2-3 lines code in Arduino IDE or dragged 2-3 block in UiFlow. + +Servo is communicated with M5Core through GROVE interface(I2C communication). The I2C address is 0x53. + +## Feature + +- Drive multi-way servo motor simultaneously +- Support wide-voltage power input: 6-12V +- Support programming with Arduino IDE or UiFlow + +## Include + +- 1x M5Stack Servo Module +- 1x 6-12V Power Interface + +## Applications + +- Humanoid robot +- Bionic multi-joint robot +- 3-axis head for camera + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +#define SERVO_ADDR 0x53 //the IIC address of SERVO Module +/* + * control servo(CH channle) by us + */ +Wire.beginTransmission(SERVO_ADDR); +Wire.write(CH|0x00); +Wire.write(timeL); +Wire.write(timeH); +Wire.endTransmission(); + +/* + * control servo(CH channle) by angle + */ +Wire.beginTransmission(SERVO_ADDR); +Wire.write(CH|0x10); +Wire.write(angle);//0-180° +Wire.endTransmission(); +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/SERVO/Arduino) for specifical example. + ## Schematic \ No newline at end of file diff --git a/docs/en/module/sim800.md b/docs/en/module/sim800.md index 9023f65b..a59e68eb 100644 --- a/docs/en/module/sim800.md +++ b/docs/en/module/sim800.md @@ -1,84 +1,84 @@ -# M5Stack SIM800L Module - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-GSM-Module-SIM800L-Stackable-IoT-Development-Board-for-Arduino-ESP32-with-MIC/3226069_32843211923.html?spm=2114.12010615.8148356.20.25e96be7xE1y22.html)** - -## Description - -The M5Stack SIM800L Module is a module with small SIM800L GSM/GPRS -module. You can program it after connected to any series of M5Stack Core -through Blockly, Arduino or MicroPython. - -SIM800L is a complete Quad-band GSM/GPRS solution. SIM800L moudle could -be connected with M5Stack Core via a serial port named USART2. -Absolutely, you also can change the serial port number with jumper by -your own. - -## Feature - -- SIM800L Module -- Build-in Antenna -- 3.5 mm phone audio jack and MIC(MIC is disable. If you want to enable it, you need to weld a 0 ohm resistor for enabling.) -- Microphone -- Parameter: -- GSM/GPRS -- support Quad-band 850/900/1800/1900MHz -- transmit Voice, SMS and data information with low power consumption -- Featur Bluetooth and Embedded AT - -## PinMap - -*After SIM800 was stacked with M5Core, they communicat through UART2* - -**SIM800** - -| SIM800 Pin | ESP32 Chip | -| :----------: |:------------: | -| TXD | U2RXD(GPIO16) | -| RXD | U2TXD(GPIO17) | -| RST | GPIO5 | - -## Include - -- 1x M5Stack SIM800L Module - -## Applications - -- Nitrogen dioxide alarm -- Automatic Web Spider SMS-notifier -- Remote meter reading system - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **[SIM800L Info](http://simcomm2m.com/En/module/detail.aspx?id=138)** - (SIM800L) - -## Example - -### 1. Arduino IDE - -Here's a example using SIM800 for sending SMS - -```c++ -/* -* Master.ino -*/ -Serial2.begin(9600, SERIAL_8N1, 16, 17); - -/* LoRaWAN Init */ -//entry test mode -Serial2.print("AT+Mode=Test"); -//Configure the modem,like Freq, SF, BW, Preamble length, TX output power -Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); -//send data as HEX format -Serial2.print("AT+TEST=TXLRPKT,"00 00 01 00 00 AF 80 07 02 00 00 39""); -``` - +# M5Stack SIM800L Module + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-GSM-Module-SIM800L-Stackable-IoT-Development-Board-for-Arduino-ESP32-with-MIC/3226069_32843211923.html?spm=2114.12010615.8148356.20.25e96be7xE1y22.html)** + +## Description + +The M5Stack SIM800L Module is a module with small SIM800L GSM/GPRS +module. You can program it after connected to any series of M5Stack Core +through Blockly, Arduino or MicroPython. + +SIM800L is a complete Quad-band GSM/GPRS solution. SIM800L moudle could +be connected with M5Stack Core via a serial port named USART2. +Absolutely, you also can change the serial port number with jumper by +your own. + +## Feature + +- SIM800L Module +- Build-in Antenna +- 3.5 mm phone audio jack and MIC(MIC is disable. If you want to enable it, you need to weld a 0 ohm resistor for enabling.) +- Microphone +- Parameter: +- GSM/GPRS +- support Quad-band 850/900/1800/1900MHz +- transmit Voice, SMS and data information with low power consumption +- Featur Bluetooth and Embedded AT + +## PinMap + +*After SIM800 was stacked with M5Core, they communicat through UART2* + +**SIM800** + +| SIM800 Pin | ESP32 Chip | +| :----------: |:------------: | +| TXD | U2RXD(GPIO16) | +| RXD | U2TXD(GPIO17) | +| RST | GPIO5 | + +## Include + +- 1x M5Stack SIM800L Module + +## Applications + +- Nitrogen dioxide alarm +- Automatic Web Spider SMS-notifier +- Remote meter reading system + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[SIM800L Info](http://simcomm2m.com/En/module/detail.aspx?id=138)** + (SIM800L) + +## Example + +### 1. Arduino IDE + +Here's a example using SIM800 for sending SMS + +```c++ +/* +* Master.ino +*/ +Serial2.begin(9600, SERIAL_8N1, 16, 17); + +/* LoRaWAN Init */ +//entry test mode +Serial2.print("AT+Mode=Test"); +//Configure the modem,like Freq, SF, BW, Preamble length, TX output power +Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); +//send data as HEX format +Serial2.print("AT+TEST=TXLRPKT,"00 00 01 00 00 AF 80 07 02 00 00 39""); +``` + ## Schematic \ No newline at end of file diff --git a/docs/en/module/stepmotor.md b/docs/en/module/stepmotor.md index 6d50d398..9603a342 100644 --- a/docs/en/module/stepmotor.md +++ b/docs/en/module/stepmotor.md @@ -1,40 +1,40 @@ -# Step Motor Module - - - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-Stepmotor-Module-for-Arduino-ESP32-GRBL-12C-Step-Motor-MEGA328P-similar-as-12V/3226069_32889109142.html?spm=2114.12010612.8148356.17.50511b9b5ViNuz)** - -## Description - -This is a StepMotor Driver Module built in MEGA328P MCU which has been burnt GRBL firmware used to control stepper motors. The module comunicates with M5Core via I2C. It's I2C address is 0x70. - -## Feature - -- 9-24V Power Input -- Driver 3-way stepper motors(X, Y, Z) -- Including a lithium battery interface - -## Include - -- 1x Step Motor Module -- 12V Power -- 1x 5V FAN Module for heat dissipation - -## Applications - -- DIY 3D Printer -- Simple Robot Arm - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - +# Step Motor Module + + + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-Stepmotor-Module-for-Arduino-ESP32-GRBL-12C-Step-Motor-MEGA328P-similar-as-12V/3226069_32889109142.html?spm=2114.12010612.8148356.17.50511b9b5ViNuz)** + +## Description + +This is a StepMotor Driver Module built in MEGA328P MCU which has been burnt GRBL firmware used to control stepper motors. The module comunicates with M5Core via I2C. It's I2C address is 0x70. + +## Feature + +- 9-24V Power Input +- Driver 3-way stepper motors(X, Y, Z) +- Including a lithium battery interface + +## Include + +- 1x Step Motor Module +- 12V Power +- 1x 5V FAN Module for heat dissipation + +## Applications + +- DIY 3D Printer +- Simple Robot Arm + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + ## Schematic \ No newline at end of file diff --git a/docs/en/qs.md b/docs/en/qs.md index c03e6591..36277e21 100644 --- a/docs/en/qs.md +++ b/docs/en/qs.md @@ -1,17 +1,17 @@ -# Quick Start - - - -*This document is intended to help you set up the software environment(Arudino, MicroPython) for development of M5Stack. Through a simple example we would like to illustrate how to develop M5Stack boards, firmware(Arduino) or source files(MicroPython) download to M5Stack boards.* - - | ----|--- -[M5StackCore](/en/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/en/quick_start/m5camera/m5camera_quick_start) - - +# Quick Start + + + +*This document is intended to help you set up the software environment(Arudino, MicroPython) for development of M5Stack. Through a simple example we would like to illustrate how to develop M5Stack boards, firmware(Arduino) or source files(MicroPython) download to M5Stack boards.* + + | +---|--- +[M5StackCore](/en/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/en/quick_start/m5camera/m5camera_quick_start) + + diff --git a/docs/en/quick_start/bala/bala_quick_start.md b/docs/en/quick_start/bala/bala_quick_start.md index ba578d81..ec7270bd 100644 --- a/docs/en/quick_start/bala/bala_quick_start.md +++ b/docs/en/quick_start/bala/bala_quick_start.md @@ -1,3 +1,3 @@ -# BALA Get Started - +# BALA Get Started + ## (coming soon...) \ No newline at end of file diff --git a/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md index 27a73969..49863d77 100644 --- a/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md @@ -1,45 +1,45 @@ -# Burn A NES Game - -*This document will help you for burning a gameboy game(NES file) so that you can play a game with GameBoy Keyboard.* - -## CONTENT - -1. [Download firmware](#1-download-firmware) - -2. [Burn Game file](#2-burn-Game-file) - -3. [Reset you device](#3-reset-you-device) - -## 1. Download firmware - -Download the gameboy simulator firmware named `firmware.zip` from [Github](https://github.com/m5stack/M5Stack-nesemu). And unpack `firmware.zip`. - -
- -
- -
- -
- -## 2. Burn Game file - -Open Flash Download Tools[点击下载](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar) apply by Espressif, choose `ESP32 DownloadTool` option, choose 4 files, and execute **step 2-4** ( *choose firmware file, your serial port, erase and program flash* ) - -
- -
- -
- -
- -## 3. Reset you device - -After reset FACES, enjoy your game now. - -
- -
- -?> Tip **If you want another game, please change the `Game file`(.nes)** +# Burn A NES Game + +*This document will help you for burning a gameboy game(NES file) so that you can play a game with GameBoy Keyboard.* + +## CONTENT + +1. [Download firmware](#1-download-firmware) + +2. [Burn Game file](#2-burn-Game-file) + +3. [Reset you device](#3-reset-you-device) + +## 1. Download firmware + +Download the gameboy simulator firmware named `firmware.zip` from [Github](https://github.com/m5stack/M5Stack-nesemu). And unpack `firmware.zip`. + +
+ +
+ +
+ +
+ +## 2. Burn Game file + +Open Flash Download Tools[点击下载](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar) apply by Espressif, choose `ESP32 DownloadTool` option, choose 4 files, and execute **step 2-4** ( *choose firmware file, your serial port, erase and program flash* ) + +
+ +
+ +
+ +
+ +## 3. Reset you device + +After reset FACES, enjoy your game now. + +
+ +
+ +?> Tip **If you want another game, please change the `Game file`(.nes)** diff --git a/docs/en/quick_start/m5camera/m5camera_quick_start.md b/docs/en/quick_start/m5camera/m5camera_quick_start.md index b2a9c348..11c27d76 100644 --- a/docs/en/quick_start/m5camera/m5camera_quick_start.md +++ b/docs/en/quick_start/m5camera/m5camera_quick_start.md @@ -1,31 +1,31 @@ -# ESP32Cam/M5Camera Quick Start - -## 1. Out-of-the-box Demo - -It is really really out of the box. Your ESP32Cam/M5Camera will immediately run without any code after you power it. - -1. plug usb cable into ESP32Cam/M5Camera and open the serial terminal on your computer. - -
- -
- - -2. Then waitting a few seconds, you connect to a AP named "`M5CAM`" with your computer(or mobile phone). - -
- -
- - -3. And you open the browser on the computer(or mobile phone), enter a URL `http://192.168.4.1`. At the moment, your can see the real-time transmission of video by ESP32Cam/M5Camera on the browser. - -
- -
- -Now, A WebCam you achieved successfully ! - -*Note:* - -ESP32CAM AP only can connect with one device at a time. +# ESP32Cam/M5Camera Quick Start + +## 1. Out-of-the-box Demo + +It is really really out of the box. Your ESP32Cam/M5Camera will immediately run without any code after you power it. + +1. plug usb cable into ESP32Cam/M5Camera and open the serial terminal on your computer. + +
+ +
+ + +2. Then waitting a few seconds, you connect to a AP named "`M5CAM`" with your computer(or mobile phone). + +
+ +
+ + +3. And you open the browser on the computer(or mobile phone), enter a URL `http://192.168.4.1`. At the moment, your can see the real-time transmission of video by ESP32Cam/M5Camera on the browser. + +
+ +
+ +Now, A WebCam you achieved successfully ! + +*Note:* + +ESP32CAM AP only can connect with one device at a time. diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index a575b4af..77cebb14 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,133 +1,133 @@ -# M5Core Quick Start(macOS, Arudino) - -?> If your OS is Windows, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows). - -!> Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection). - -## CONTENT - -1. [Setting Environment](#setting-environment) - - - [Step1. Install Arduino IDE](#step1-install-arduino-ide) - - - [Step2. ESP32 Board Support](#step2-esp32-board-support) - - - [Step3. Install M5Stack Lib](#step3-install-m5stack-lib) - -2. [Example](#example) - -## Setting Environment - -### Step1. Install `Arduino IDE` - -First, if Arudino IDE is not installed, install it. It's *download address* is https://www.arduino.cc/en/Main/Software - -
- -
- -### Step2. ESP32 Board Support - -Open Terminal and execute the following command (copy->paste and hit enter): - -``` - -mkdir -p ~/Documents/Arduino/hardware/espressif && \ -cd ~/Documents/Arduino/hardware/espressif && \ -git clone https://github.com/espressif/arduino-esp32.git esp32 && \ -cd esp32 && \ -git submodule update --init --recursive && \ -cd tools && \ -python get.py - -``` - -Where ~/Documents/Arduino represents your sketch book location as per "Arduino" > "Preferences" > "Sketchbook location" (in the IDE once started). Adjust the command above accordingly if necessary! - -Where ~/Documents/Arduino represents your default sketch book location. If you encounter any problems it could be that your Arduino sketchbook folder is in a different location. This can be found by running arduino and navigating through the menu to "Arduino" > "Preferences" > "Sketchbook location". Adjust the command above accordingly if necessary! - -?> **Tip** If you get the error below: `xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),` -`missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, install the command line dev tools by typing `xcode-select --install` into the terminal and hit enter. once installed try the command above again and restart the Arduino IDE. - -?> **Tip** If you get the error: `IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol` `version (_ssl.c:590) when running python get.py`, try `python3` instead of `python` and restart the Arduino IDE. - - - -### Step3. Install M5Stack Lib - -Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` - -Type `M5Stack` into the search box, search it and install. - -
- -
- - -
- -
- - - -## Example - -The USB cable connects to M5Stack Core, then select your serial port which is connected M5Stack Core. -Select a demo example, compile and upload - -### 1. Select your board and the serial port - -Start up Arduino IDE, and click `Tools -> Boards -> M5Stack-Core-ESP32` to select your board - -
- -
- - -Click `Tools -> Ports ->` to select the serial port which is connected with M5Stack Core - -
- -
- - -### 2. Select an example - -Click `File-> Examples`. Here are some test programs in `M5Stack->` - -Try to open a sketch called `HelloWorld` inside Basics. - - -
- -
- - - -Compile it and upload, the M5Stack screen will show "Hello World!" - -
- -
- - - -## Note - -Although most versions of MacOS have no problem with detecting the COM port, on some newer versions of High Sierra sometimes Slab\_USBtoUART does not appear. If this is the case, after you connect the M5 open `security and privacy` in the system preferences and set it to `permit`. - -
- -
- - -
- -
- - -
- -
- +# M5Core Quick Start(macOS, Arudino) + +?> If your OS is Windows, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows). + +!> Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection). + +## CONTENT + +1. [Setting Environment](#setting-environment) + + - [Step1. Install Arduino IDE](#step1-install-arduino-ide) + + - [Step2. ESP32 Board Support](#step2-esp32-board-support) + + - [Step3. Install M5Stack Lib](#step3-install-m5stack-lib) + +2. [Example](#example) + +## Setting Environment + +### Step1. Install `Arduino IDE` + +First, if Arudino IDE is not installed, install it. It's *download address* is https://www.arduino.cc/en/Main/Software + +
+ +
+ +### Step2. ESP32 Board Support + +Open Terminal and execute the following command (copy->paste and hit enter): + +``` + +mkdir -p ~/Documents/Arduino/hardware/espressif && \ +cd ~/Documents/Arduino/hardware/espressif && \ +git clone https://github.com/espressif/arduino-esp32.git esp32 && \ +cd esp32 && \ +git submodule update --init --recursive && \ +cd tools && \ +python get.py + +``` + +Where ~/Documents/Arduino represents your sketch book location as per "Arduino" > "Preferences" > "Sketchbook location" (in the IDE once started). Adjust the command above accordingly if necessary! + +Where ~/Documents/Arduino represents your default sketch book location. If you encounter any problems it could be that your Arduino sketchbook folder is in a different location. This can be found by running arduino and navigating through the menu to "Arduino" > "Preferences" > "Sketchbook location". Adjust the command above accordingly if necessary! + +?> **Tip** If you get the error below: `xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),` +`missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, install the command line dev tools by typing `xcode-select --install` into the terminal and hit enter. once installed try the command above again and restart the Arduino IDE. + +?> **Tip** If you get the error: `IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol` `version (_ssl.c:590) when running python get.py`, try `python3` instead of `python` and restart the Arduino IDE. + + + +### Step3. Install M5Stack Lib + +Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` + +Type `M5Stack` into the search box, search it and install. + +
+ +
+ + +
+ +
+ + + +## Example + +The USB cable connects to M5Stack Core, then select your serial port which is connected M5Stack Core. +Select a demo example, compile and upload + +### 1. Select your board and the serial port + +Start up Arduino IDE, and click `Tools -> Boards -> M5Stack-Core-ESP32` to select your board + +
+ +
+ + +Click `Tools -> Ports ->` to select the serial port which is connected with M5Stack Core + +
+ +
+ + +### 2. Select an example + +Click `File-> Examples`. Here are some test programs in `M5Stack->` + +Try to open a sketch called `HelloWorld` inside Basics. + + +
+ +
+ + + +Compile it and upload, the M5Stack screen will show "Hello World!" + +
+ +
+ + + +## Note + +Although most versions of MacOS have no problem with detecting the COM port, on some newer versions of High Sierra sometimes Slab\_USBtoUART does not appear. If this is the case, after you connect the M5 open `security and privacy` in the system preferences and set it to `permit`. + +
+ +
+ + +
+ +
+ + +
+ +
+ ?> **If you want to read more the permission about the CP2104 USB driver, visit the below link please.** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html \ No newline at end of file diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index 552f39e6..b598b05a 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,102 +1,102 @@ -# M5Core Quick Start(Windows, Arudino) - -?> If your OS is MacOS, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS). - -!> We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). - -## CONTENT - -1. [Setting Environment](#setting-environment) - - - [Step1. Download Arduino-ESP32 Support](#step1-download-arduino-esp32-support) - - - [Step2. Download the M5Stack Lib](#step2-download-the-m5stack-lib) - -2. [Example](#example) - -## 1. Setting Environment - -*(Only two steps to complete setting)* - -### Step1. Download Arduino-ESP32 Support - -
- -
- - -Then please waiting for cloning... - -### Step2. Download the M5Stack Lib - -Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` -Search `M5Stack` and install it - -
- -
- -!> **Note:** *As shown below, it means you need update* - -
- -
- - -## Example - -This section for verifying whether you can program with Arduino or not. Now, The USB cable connects to M5Stack Core, then select your serial port which is connected M5Stack Core. - -Select a demo example, compile and upload - -### 1. Execute a example likes `FactoryTest.ino` - -Select your board name, baudrate, the specified serial port: M5Stack-Core-ESP32, 921600, COM4(Now, my serial port which is connected with PC is `COM4`) - -
- -
- - -Then select an example likes `FactoryTest.ino` - -
- -
- -Upload it - -
- -
- - -### 2. New a M5Stack program - -Open Arduino IDE, then new a `.ino` file, rename it as `my_test.ino` - -Copy the below code to my_test.ino - -```cpp -#include - -// the setup routine runs once when M5Stack starts up -void setup(){ - - // Initialize the M5Stack object - M5.begin(); - - // LCD display - M5.Lcd.print("Hello World!"); - M5.Lcd.print("M5Stack is running successfully!"); -} - -// the loop routine runs over and over again forever -void loop() { - -} -``` - -compile it and upload, the M5Stack screen will show "Hello World!" "M5Stack is running successfully!" - +# M5Core Quick Start(Windows, Arudino) + +?> If your OS is MacOS, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS). + +!> We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). + +## CONTENT + +1. [Setting Environment](#setting-environment) + + - [Step1. Download Arduino-ESP32 Support](#step1-download-arduino-esp32-support) + + - [Step2. Download the M5Stack Lib](#step2-download-the-m5stack-lib) + +2. [Example](#example) + +## 1. Setting Environment + +*(Only two steps to complete setting)* + +### Step1. Download Arduino-ESP32 Support + +
+ +
+ + +Then please waiting for cloning... + +### Step2. Download the M5Stack Lib + +Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` +Search `M5Stack` and install it + +
+ +
+ +!> **Note:** *As shown below, it means you need update* + +
+ +
+ + +## Example + +This section for verifying whether you can program with Arduino or not. Now, The USB cable connects to M5Stack Core, then select your serial port which is connected M5Stack Core. + +Select a demo example, compile and upload + +### 1. Execute a example likes `FactoryTest.ino` + +Select your board name, baudrate, the specified serial port: M5Stack-Core-ESP32, 921600, COM4(Now, my serial port which is connected with PC is `COM4`) + +
+ +
+ + +Then select an example likes `FactoryTest.ino` + +
+ +
+ +Upload it + +
+ +
+ + +### 2. New a M5Stack program + +Open Arduino IDE, then new a `.ino` file, rename it as `my_test.ino` + +Copy the below code to my_test.ino + +```cpp +#include + +// the setup routine runs once when M5Stack starts up +void setup(){ + + // Initialize the M5Stack object + M5.begin(); + + // LCD display + M5.Lcd.print("Hello World!"); + M5.Lcd.print("M5Stack is running successfully!"); +} + +// the loop routine runs over and over again forever +void loop() { + +} +``` + +compile it and upload, the M5Stack screen will show "Hello World!" "M5Stack is running successfully!" + ?> *If you want to upgrade the M5Stack Lib, please view this article [upgrade M5Stack Lib](/en/related_documents/upgrade_m5stack_lib).* \ No newline at end of file diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md index 301ca122..eb2c1b02 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -1,103 +1,103 @@ -# UiFlow Quick Start(Blockly/MicroPython) - -?> a. If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning). b. If it's first time to use M5Stack Core or you want to change the networkable AP that means the Core can't access [flow.m5stack.com](http://flow.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core](/en/related_documents/how_to_connect_wifi_using_core). - -By default, we account your M5Core has been connected with the networkable AP. And the screen shows like this figure below after you pressed the `UPLOAD` button on the left. After a few seconds if nothing is pressed the M5 will automatically run the code that was previously uploaded. If we want to upload new code we have to make sure we press the `upload` button on this menu before the M5 boots the code in it’s memory. - -
- -
- - - -## **CONTENT** - -1. [Connect to UiFlow](#connect-to-uiflow) - -2. [Program with Core](#program-with-core) - -3. [Play a song now](#play-a-song-now) - - -## **1. Connect to UiFlow** - -1. Now you scan the QR code with your phone or tablet to start programming on your mobile device. If you want to program the M5 from your computer, enter the url shown at the top of the screen `flow.m5stack.com`. It will show as following figure. - -
- -
- -2. Whenever we want to upload code to the M5 from UI flow we need to make sure the device is paired. So press the little gear in the top right corner of the screen and enter the `APIKEY` which shows on the screen of M5(Now, my APIKEY is `9C6469`) and click `SAVE`. - -
- -
- -Then UiFlow will connect with this Core. - -At the moment, you can draw a UI or program it through Blockly(or Python) as shown below. - -## **2. Program with Core** - -### a. Draw a UI - -Drag 4 kinds of elements into `M5Stack Core` UI and click `Run` buttom on M5UI.Flow - -
- -
- - -### b. Program with Blockly - -Drag a block named `Set emoji map in0` from `Emoji` class and click `Run` buttom on M5UI.Flow - -
- -
- -*The source code of this demostration: https://tower.im/projects/65b1c6743d194d22a801ed916832eb2b/uploads/fd59d8000b541c346d6c6d18291c29bb?version=1* - -### c. Program with MicroPython - -Copy the following codes, and paste them to `Python coding area`, and click `Run` button. - -```Python -from m5stack import * -from m5ui import * -clear_bg(0x111111) - - -btnA = M5Button(name='ButtonA', text='ButtonA', visibility=False) -btnB = M5Button(name='ButtonB', text='ButtonB', visibility=False) -btnC = M5Button(name='ButtonC', text='ButtonC', visibility=False) - - -lcd.print("Hello M5Stack") -``` - -
- -
- -At that moment, the screen of M5Core will display `Hello M5Stack`. - -## **3. Play a song now** - -Now, let's make a music player and play a song in a few minutes using M5Stack Core. - -Drag a `loop`, `music` and `timer` block into the coding area from the components section. - -Then set parameters of `music block` and `timer block` as shown belown. - -
- -
- -Now, run it and enjoy your musical work! - -*The source code of this demostration: https://tower.im/projects/65b1c6743d194d22a801ed916832eb2b/uploads/9062b4bc81b3dc9be74f92be510a81d0?version=1* - -## **Complete** - -?> *Also, For being more familiar with M5, you can contact us for a WorkShop * +# UiFlow Quick Start(Blockly/MicroPython) + +?> a. If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning). b. If it's first time to use M5Stack Core or you want to change the networkable AP that means the Core can't access [flow.m5stack.com](http://flow.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core](/en/related_documents/how_to_connect_wifi_using_core). + +By default, we account your M5Core has been connected with the networkable AP. And the screen shows like this figure below after you pressed the `UPLOAD` button on the left. After a few seconds if nothing is pressed the M5 will automatically run the code that was previously uploaded. If we want to upload new code we have to make sure we press the `upload` button on this menu before the M5 boots the code in it’s memory. + +
+ +
+ + + +## **CONTENT** + +1. [Connect to UiFlow](#connect-to-uiflow) + +2. [Program with Core](#program-with-core) + +3. [Play a song now](#play-a-song-now) + + +## **1. Connect to UiFlow** + +1. Now you scan the QR code with your phone or tablet to start programming on your mobile device. If you want to program the M5 from your computer, enter the url shown at the top of the screen `flow.m5stack.com`. It will show as following figure. + +
+ +
+ +2. Whenever we want to upload code to the M5 from UI flow we need to make sure the device is paired. So press the little gear in the top right corner of the screen and enter the `APIKEY` which shows on the screen of M5(Now, my APIKEY is `9C6469`) and click `SAVE`. + +
+ +
+ +Then UiFlow will connect with this Core. + +At the moment, you can draw a UI or program it through Blockly(or Python) as shown below. + +## **2. Program with Core** + +### a. Draw a UI + +Drag 4 kinds of elements into `M5Stack Core` UI and click `Run` buttom on M5UI.Flow + +
+ +
+ + +### b. Program with Blockly + +Drag a block named `Set emoji map in0` from `Emoji` class and click `Run` buttom on M5UI.Flow + +
+ +
+ +*The source code of this demostration: https://tower.im/projects/65b1c6743d194d22a801ed916832eb2b/uploads/fd59d8000b541c346d6c6d18291c29bb?version=1* + +### c. Program with MicroPython + +Copy the following codes, and paste them to `Python coding area`, and click `Run` button. + +```Python +from m5stack import * +from m5ui import * +clear_bg(0x111111) + + +btnA = M5Button(name='ButtonA', text='ButtonA', visibility=False) +btnB = M5Button(name='ButtonB', text='ButtonB', visibility=False) +btnC = M5Button(name='ButtonC', text='ButtonC', visibility=False) + + +lcd.print("Hello M5Stack") +``` + +
+ +
+ +At that moment, the screen of M5Core will display `Hello M5Stack`. + +## **3. Play a song now** + +Now, let's make a music player and play a song in a few minutes using M5Stack Core. + +Drag a `loop`, `music` and `timer` block into the coding area from the components section. + +Then set parameters of `music block` and `timer block` as shown belown. + +
+ +
+ +Now, run it and enjoy your musical work! + +*The source code of this demostration: https://tower.im/projects/65b1c6743d194d22a801ed916832eb2b/uploads/9062b4bc81b3dc9be74f92be510a81d0?version=1* + +## **Complete** + +?> *Also, For being more familiar with M5, you can contact us for a WorkShop * diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index 9e1597fa..28b3fa4b 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -1,154 +1,154 @@ -# M5Cloud Quick Start(MicroPython) - -?> If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud). - -By default, we consider your M5Core has been connected with the networkable AP successfully. And the screen shows like this figure below. - -
- -
- -## CONTENT - -1. [Connect to M5Cloud](#connect-to-m5cloud) - -2. [Binding device](#binding-device) - -3. [Program with Core](#program-with-Core) - - -## 1. Connect to M5Cloud - -Now If you want to program the M5 from your computer, enter the url shown at the top of the screen `cloud.m5stack.com` - -It will show as following figure. - -
- -
- -Now, register a account. - -## 2. Binding device - -Press `Device`->`Add` buttom on M5Cloud IDE for binding M5Stack board to your account.(Now, my check code is `052879`) - -
- -
- -
- -
- -At the moment, you can program it through Python as shown below. - -## 3. Program with Core - -### a. New a Project - -
- -
- -### a. Code it - -*Now, let's get started with FACES Kit.* - -After creating a new project, add a file named `faces.py` as a python module. - -
- -
- -
- -
- -Then copy following code into faces.py and main.py, and save they. - -```Python -""" -File name: faces.py - -M5Stack MicroPython FACES keyboard I2C driver -""" - -class Faces: - def __init__(self, i2c=None): - if i2c == None: - from machine import I2C, Pin - self.i2c = I2C(sda=21, scl=22) - else: - self.i2c = i2c - self.addr = 0x08 - self.cb = None - - def read(self): - return self.i2c.readfrom(self.addr, 1) - - def _callback(self, pin): - from machine import Pin - if pin == Pin(5): - self.cb(self.read()) - - def callback(self, cb): - from machine import Pin - self.pin = Pin(5) - self.pin.init(Pin.IN) - self.pin.irq(trigger=Pin.IRQ_FALLING, handler=self._callback) - self.cb = cb -``` - -
- -
- - -```Python -""" -File name: main.py -""" - -from m5stack import * -from faces import Faces - -keyboard = Faces() - -# read once -print("Key value:", end='') -print(keyboard.read()) - -# callback -def keyboard_cb(value): - print("Key value:", end='') - print(value) - lcd.print(value) - -keyboard.callback(keyboard_cb) -``` - -
- -
- -
- -
- - -Now, upload and run it! - -
- -
- -## Complete - -The function of This demostration is that screen and serial terminal will display the value of the key you pressed. - -Now, I press the first line of QWERTY Keyboard. ("q", "w", "e", "r", "t", "y", "u", "i", "o", "p") - -
- +# M5Cloud Quick Start(MicroPython) + +?> If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud). + +By default, we consider your M5Core has been connected with the networkable AP successfully. And the screen shows like this figure below. + +
+ +
+ +## CONTENT + +1. [Connect to M5Cloud](#connect-to-m5cloud) + +2. [Binding device](#binding-device) + +3. [Program with Core](#program-with-Core) + + +## 1. Connect to M5Cloud + +Now If you want to program the M5 from your computer, enter the url shown at the top of the screen `cloud.m5stack.com` + +It will show as following figure. + +
+ +
+ +Now, register a account. + +## 2. Binding device + +Press `Device`->`Add` buttom on M5Cloud IDE for binding M5Stack board to your account.(Now, my check code is `052879`) + +
+ +
+ +
+ +
+ +At the moment, you can program it through Python as shown below. + +## 3. Program with Core + +### a. New a Project + +
+ +
+ +### a. Code it + +*Now, let's get started with FACES Kit.* + +After creating a new project, add a file named `faces.py` as a python module. + +
+ +
+ +
+ +
+ +Then copy following code into faces.py and main.py, and save they. + +```Python +""" +File name: faces.py + +M5Stack MicroPython FACES keyboard I2C driver +""" + +class Faces: + def __init__(self, i2c=None): + if i2c == None: + from machine import I2C, Pin + self.i2c = I2C(sda=21, scl=22) + else: + self.i2c = i2c + self.addr = 0x08 + self.cb = None + + def read(self): + return self.i2c.readfrom(self.addr, 1) + + def _callback(self, pin): + from machine import Pin + if pin == Pin(5): + self.cb(self.read()) + + def callback(self, cb): + from machine import Pin + self.pin = Pin(5) + self.pin.init(Pin.IN) + self.pin.irq(trigger=Pin.IRQ_FALLING, handler=self._callback) + self.cb = cb +``` + +
+ +
+ + +```Python +""" +File name: main.py +""" + +from m5stack import * +from faces import Faces + +keyboard = Faces() + +# read once +print("Key value:", end='') +print(keyboard.read()) + +# callback +def keyboard_cb(value): + print("Key value:", end='') + print(value) + lcd.print(value) + +keyboard.callback(keyboard_cb) +``` + +
+ +
+ +
+ +
+ + +Now, upload and run it! + +
+ +
+ +## Complete + +The function of This demostration is that screen and serial terminal will display the value of the key you pressed. + +Now, I press the first line of QWERTY Keyboard. ("q", "w", "e", "r", "t", "y", "u", "i", "o", "p") + +
+
\ No newline at end of file diff --git a/docs/en/quick_start/m5core/m5stack_core_quick_start.md b/docs/en/quick_start/m5core/m5stack_core_quick_start.md index cf2b1d87..9b9efec6 100644 --- a/docs/en/quick_start/m5core/m5stack_core_quick_start.md +++ b/docs/en/quick_start/m5core/m5stack_core_quick_start.md @@ -1,7 +1,7 @@ -# M5Stack Core Get Started - -*Pick up your programming mode below for getting started* - - | ----|--- -[Arduino](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [UIFlow(Blockly/MicroPython)](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) +# M5Stack Core Get Started + +*Pick up your programming mode below for getting started* + + | +---|--- +[Arduino](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [UIFlow(Blockly/MicroPython)](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) diff --git a/docs/en/quick_start/m5core/m5stick_get_started_arduino.md b/docs/en/quick_start/m5core/m5stick_get_started_arduino.md index 15966630..2c334ecf 100644 --- a/docs/en/quick_start/m5core/m5stick_get_started_arduino.md +++ b/docs/en/quick_start/m5core/m5stick_get_started_arduino.md @@ -1,12 +1,12 @@ -# M5Stick Quick Start(Arduino) - -## 1. Install `U8g2` library - -If you have installed `U8g2`, then just run and upload your m5stick's poject. -If not, then open Arduino IDE, and click `Sketch`->`Include Library`->`Manage Libraries...` for installing `U8g2` library - -
- -
- -## 2. Upload your project +# M5Stick Quick Start(Arduino) + +## 1. Install `U8g2` library + +If you have installed `U8g2`, then just run and upload your m5stick's poject. +If not, then open Arduino IDE, and click `Sketch`->`Include Library`->`Manage Libraries...` for installing `U8g2` library + +
+ +
+ +## 2. Upload your project diff --git a/docs/en/related_documents.md b/docs/en/related_documents.md index 8f0b35ff..775cd429 100644 --- a/docs/en/related_documents.md +++ b/docs/en/related_documents.md @@ -1,13 +1,13 @@ -# Related Documents - - - -1. [Establish Serial Connection](en/related_documents/establish_serial_connection) - -2. [How to Install Git and Arduino](en/related_documents/how_to_install_git_and_arduino) - -3. [Upgrade M5Stack Lib](en/related_documents/upgrade_m5stack_lib) - -4. [How to Burn Firmware](en/related_documents/how_to_burn_firmware) - -5. [How to Connect WiFi Using Core](en/related_documents/how_to_connect_wifi_using_core) +# Related Documents + + + +1. [Establish Serial Connection](en/related_documents/establish_serial_connection) + +2. [How to Install Git and Arduino](en/related_documents/how_to_install_git_and_arduino) + +3. [Upgrade M5Stack Lib](en/related_documents/upgrade_m5stack_lib) + +4. [How to Burn Firmware](en/related_documents/how_to_burn_firmware) + +5. [How to Connect WiFi Using Core](en/related_documents/how_to_connect_wifi_using_core) diff --git a/docs/en/related_documents/establish_serial_connection.md b/docs/en/related_documents/establish_serial_connection.md index 646a5ae0..90b2a9e3 100644 --- a/docs/en/related_documents/establish_serial_connection.md +++ b/docs/en/related_documents/establish_serial_connection.md @@ -1,97 +1,97 @@ -# Establish Serial Connection - -**This section provides guidance how to establish serial connection between your board and PC.** - -## For MacOS - -### 1. Install the USB driver - -**[Download the SiLabs CP2104 Driver](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)** - -**As the disk image SiLabsUSBDriverDisk.dmg is downloaded, mount it. Proceed according to the instructions OK.** - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -### 2. Check port on MacOS - -**To check the device name for the serial port of your your board board (or external converter dongle), open terminal and run this command two times, first with the board / dongle unplugged, then with plugged in. The port which appears the second time is the one you need:** - -**MacOS** - - ls /dev/cu.* - - - -## For Windows - -### 1.Install the USB driver - -**Download the [SiLabs CP2104 Driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)** - -**Choice the version of USB driver according to your windows version(Windows7/8/10).** - -
- -
- -**Choice the right version installer(x64/x86), and install it.** - -
- -
- -
- -
- -
- -
- -### 2. Check port on Windows - -**Check the list of identified COM ports in the Windows Device Manager. Disconnect your board and connect it back, to verify which port disappears from the list and then shows back again.** - -**Figures below show serial port for M5Stack Core board** - -
- -
+# Establish Serial Connection + +**This section provides guidance how to establish serial connection between your board and PC.** + +## For MacOS + +### 1. Install the USB driver + +**[Download the SiLabs CP2104 Driver](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)** + +**As the disk image SiLabsUSBDriverDisk.dmg is downloaded, mount it. Proceed according to the instructions OK.** + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +### 2. Check port on MacOS + +**To check the device name for the serial port of your your board board (or external converter dongle), open terminal and run this command two times, first with the board / dongle unplugged, then with plugged in. The port which appears the second time is the one you need:** + +**MacOS** + + ls /dev/cu.* + + + +## For Windows + +### 1.Install the USB driver + +**Download the [SiLabs CP2104 Driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)** + +**Choice the version of USB driver according to your windows version(Windows7/8/10).** + +
+ +
+ +**Choice the right version installer(x64/x86), and install it.** + +
+ +
+ +
+ +
+ +
+ +
+ +### 2. Check port on Windows + +**Check the list of identified COM ports in the Windows Device Manager. Disconnect your board and connect it back, to verify which port disappears from the list and then shows back again.** + +**Figures below show serial port for M5Stack Core board** + +
+ +
diff --git a/docs/en/related_documents/how_to_burn_firmware.md b/docs/en/related_documents/how_to_burn_firmware.md index df2d0e3a..56e83a96 100644 --- a/docs/en/related_documents/how_to_burn_firmware.md +++ b/docs/en/related_documents/how_to_burn_firmware.md @@ -1,62 +1,62 @@ -# How to Burn Firmware - -**This article will guide you how to burn a right firmware to your board via M5Burner.** - -## For MacOS - -***(Coming soon...)*** - -## For Windows - -### 1. Download M5Burner - -For downloading M5Burner, visit the [M5Stack Website](http://www.m5stack.com) please. - -
- -
- -### 2. Burn the firmware - -Unzip the M5Burner tool which you donwloaded for official website just now, then double click `M5Burner.exe`. - -**Then choice the `serial port` which is connected with your board and the `Baud` which is 921600 following below steps. Choice a right firmware, click `Erase` and then click `Burn`.** - -?> **Tip** **a.** If you want to program with [UiFlow](http://flow.m5stack.com)(/[M5Cloud](http://cloud.m5stack.com)), select `M5Flow-vx.x`(/`M5Cloud-vx.x.x`) option(the lastest version). **b.** If you own a ESP32CAM (/ M5CAMERA), select `M5Cam-vx.x (/M5Cam-psram)` option - -
- -
- -!> **Notice** If it does not display any ``COMx`` port or only ``COM1`` exists at the option, you need to visit this article [establish_serial_connection](/en/related_documents/establish_serial_connection) and reinstall the USB driver. - -**a. Choice a right firmware** - -a. select `M5Flow-vx.x` option(the lastest version), if you want to program with [UiFlow](http://flow.m5stack.com) - -b. select `M5Cam-vx.x (/M5Cam-psram)` option, if you own a ESP32CAM (/ M5CAMERA) - -**b. Click `Erase`** - -
- Screenshot of coverpage -
- -*If M5Burner shows the information `Hard resetting via RTS pin...` below, it means chip has been erased successfully.* - -
- Screenshot of coverpage -
- -*If M5Burner shows the information `Leaving... Staying in bootloader.` below, it means chip has been burnt successfully.* - -
- Screenshot of coverpage -
- -### 3. Then reset your board - -?> **Tip** -If M5Burner means be busy after clicking `Burn`, please wait for a few minutes. It'll be normal after the firmware has been burnt successfully. - +# How to Burn Firmware + +**This article will guide you how to burn a right firmware to your board via M5Burner.** + +## For MacOS + +***(Coming soon...)*** + +## For Windows + +### 1. Download M5Burner + +For downloading M5Burner, visit the [M5Stack Website](http://www.m5stack.com) please. + +
+ +
+ +### 2. Burn the firmware + +Unzip the M5Burner tool which you donwloaded for official website just now, then double click `M5Burner.exe`. + +**Then choice the `serial port` which is connected with your board and the `Baud` which is 921600 following below steps. Choice a right firmware, click `Erase` and then click `Burn`.** + +?> **Tip** **a.** If you want to program with [UiFlow](http://flow.m5stack.com)(/[M5Cloud](http://cloud.m5stack.com)), select `M5Flow-vx.x`(/`M5Cloud-vx.x.x`) option(the lastest version). **b.** If you own a ESP32CAM (/ M5CAMERA), select `M5Cam-vx.x (/M5Cam-psram)` option + +
+ +
+ +!> **Notice** If it does not display any ``COMx`` port or only ``COM1`` exists at the option, you need to visit this article [establish_serial_connection](/en/related_documents/establish_serial_connection) and reinstall the USB driver. + +**a. Choice a right firmware** + +a. select `M5Flow-vx.x` option(the lastest version), if you want to program with [UiFlow](http://flow.m5stack.com) + +b. select `M5Cam-vx.x (/M5Cam-psram)` option, if you own a ESP32CAM (/ M5CAMERA) + +**b. Click `Erase`** + +
+ Screenshot of coverpage +
+ +*If M5Burner shows the information `Hard resetting via RTS pin...` below, it means chip has been erased successfully.* + +
+ Screenshot of coverpage +
+ +*If M5Burner shows the information `Leaving... Staying in bootloader.` below, it means chip has been burnt successfully.* + +
+ Screenshot of coverpage +
+ +### 3. Then reset your board + +?> **Tip** +If M5Burner means be busy after clicking `Burn`, please wait for a few minutes. It'll be normal after the firmware has been burnt successfully. + ?> **Tip** If the burning procedure has been interrupted(like `M5Burner has been closed suddenly...`), it's better to burn your board again. \ No newline at end of file diff --git a/docs/en/related_documents/how_to_connect_wifi_using_core.md b/docs/en/related_documents/how_to_connect_wifi_using_core.md index 473ea0ef..e047425c 100644 --- a/docs/en/related_documents/how_to_connect_wifi_using_core.md +++ b/docs/en/related_documents/how_to_connect_wifi_using_core.md @@ -1,56 +1,56 @@ -# How to Connect WIFI Using Core - -?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning)* - -**After powering on Core and pressing the red button on the left hand side of the M5，you will be greeted by this screen. Let's connect to networkable AP.** - -
- -
- -## CONTENT - -1. [Press UPLOAD Button](#press-upload-button) - -2. [Select Networkable AP](#select-networkable-ap) - -3. [Reset Your Device](#reset-your-device) - - -## 1. Press `UPLOAD` Button - -**Now, press the `upload` buttom. The screen will show this message.** - -
- -
- -## 2. Select Networkable AP - -**Use Mobile Phone or PC for connectting to M5Core AP(like `M5Stack-a67c`), and then open brower to login 192.168.4.1 for setting your networkable WIFI name and password. (Now, my networkable wifi is named `MasterHax_5G`)** - -
- -
- -## 3. Reset Your Device - -**After connected wifi successfully, reset your core according to the prompt on `192.168.4.1`** - -
- -
- -## Complete - -Once you've reset M5Stack Core, pressed the upload buttom, you will arrive at a screen with a QR code. Now, you can try to program with your core following this article [Quick Start with UiFlow](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) - -
- -
- -?> **Note** Similarly, if you want another networkable WIFI AP to connect with Core, press the SETUP buttom while core was power-up. - -
- +# How to Connect WIFI Using Core + +?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning)* + +**After powering on Core and pressing the red button on the left hand side of the M5，you will be greeted by this screen. Let's connect to networkable AP.** + +
+ +
+ +## CONTENT + +1. [Press UPLOAD Button](#press-upload-button) + +2. [Select Networkable AP](#select-networkable-ap) + +3. [Reset Your Device](#reset-your-device) + + +## 1. Press `UPLOAD` Button + +**Now, press the `upload` buttom. The screen will show this message.** + +
+ +
+ +## 2. Select Networkable AP + +**Use Mobile Phone or PC for connectting to M5Core AP(like `M5Stack-a67c`), and then open brower to login 192.168.4.1 for setting your networkable WIFI name and password. (Now, my networkable wifi is named `MasterHax_5G`)** + +
+ +
+ +## 3. Reset Your Device + +**After connected wifi successfully, reset your core according to the prompt on `192.168.4.1`** + +
+ +
+ +## Complete + +Once you've reset M5Stack Core, pressed the upload buttom, you will arrive at a screen with a QR code. Now, you can try to program with your core following this article [Quick Start with UiFlow](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) + +
+ +
+ +?> **Note** Similarly, if you want another networkable WIFI AP to connect with Core, press the SETUP buttom while core was power-up. + +
+
\ No newline at end of file diff --git a/docs/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md b/docs/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md index f66abafa..2785e8fc 100644 --- a/docs/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md +++ b/docs/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md @@ -1,52 +1,52 @@ -# How to Connect WIFI (For M5Cloud) - -?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `M5Cloud` in advance, please visit this article [How to burn firmware](en/related_documents/how_to_burn_firmware) for burnning)* - -**After powering on Core，you will be greeted by this screen. Let's connect to networkable AP.** - -
- -
- -## CONTENT - -1. [Connect to M5Core AP](#connect-to-m5Core-AP) - -2. [Select Networkable AP](#select-networkable-ap) - -3. [Reset Your Device](#reset-your-device) - -## 1. Connect to M5Core AP - -**Use Mobile Phone or PC for connectting to M5Core AP(like `M5Stack-a67c`)** - -## 2. Select Networkable AP - -**Then open brower to login 192.168.4.1 for setting your networkable WIFI name and password. (Now, my networkable wifi is named `MasterHax_2.4G`)** - -
- -
- -
- -
- -?> **Note** If you connect wifi unsuccessfully, repeat it again please. - -## 3. Reset Your Device - -**After connected wifi successfully, reset your core according to the prompt on `192.168.4.1`** - -
- -
- -?> **Note** If your device has been bound to M5Cloud's account before(means you have entered the check code on [M5Cloud](http://cloud.m5stack.com)), the screen will display as below -
- -
- -## Complete - -Now, you can try to program with your core following this article [Quick Start with M5Cloud](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) +# How to Connect WIFI (For M5Cloud) + +?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `M5Cloud` in advance, please visit this article [How to burn firmware](en/related_documents/how_to_burn_firmware) for burnning)* + +**After powering on Core，you will be greeted by this screen. Let's connect to networkable AP.** + +
+ +
+ +## CONTENT + +1. [Connect to M5Core AP](#connect-to-m5Core-AP) + +2. [Select Networkable AP](#select-networkable-ap) + +3. [Reset Your Device](#reset-your-device) + +## 1. Connect to M5Core AP + +**Use Mobile Phone or PC for connectting to M5Core AP(like `M5Stack-a67c`)** + +## 2. Select Networkable AP + +**Then open brower to login 192.168.4.1 for setting your networkable WIFI name and password. (Now, my networkable wifi is named `MasterHax_2.4G`)** + +
+ +
+ +
+ +
+ +?> **Note** If you connect wifi unsuccessfully, repeat it again please. + +## 3. Reset Your Device + +**After connected wifi successfully, reset your core according to the prompt on `192.168.4.1`** + +
+ +
+ +?> **Note** If your device has been bound to M5Cloud's account before(means you have entered the check code on [M5Cloud](http://cloud.m5stack.com)), the screen will display as below +
+ +
+ +## Complete + +Now, you can try to program with your core following this article [Quick Start with M5Cloud](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) diff --git a/docs/en/related_documents/how_to_install_git_and_arduino.md b/docs/en/related_documents/how_to_install_git_and_arduino.md index ebdf5e4e..7f657dfd 100644 --- a/docs/en/related_documents/how_to_install_git_and_arduino.md +++ b/docs/en/related_documents/how_to_install_git_and_arduino.md @@ -1,23 +1,23 @@ -# How to install Git and Arduino IDE (Windows) - -## 1. Install `Git` -If you has installed `Git`, please following next setp 2 straight.Otherwise, download the client of [Git](https://git-scm.com/download/win) and install it. - -## 2. Install `Arduino IDE` - -*download address* -https://www.arduino.cc/en/Main/Software - -
- -
- -Double click to install Arduino IDE - -
- -
- -
- +# How to install Git and Arduino IDE (Windows) + +## 1. Install `Git` +If you has installed `Git`, please following next setp 2 straight.Otherwise, download the client of [Git](https://git-scm.com/download/win) and install it. + +## 2. Install `Arduino IDE` + +*download address* +https://www.arduino.cc/en/Main/Software + +
+ +
+ +Double click to install Arduino IDE + +
+ +
+ +
+
\ No newline at end of file diff --git a/docs/en/related_documents/upgrade_m5stack_lib.md b/docs/en/related_documents/upgrade_m5stack_lib.md index 6da8c7a1..4fff0c41 100644 --- a/docs/en/related_documents/upgrade_m5stack_lib.md +++ b/docs/en/related_documents/upgrade_m5stack_lib.md @@ -1,17 +1,17 @@ -# Upgrade M5Stack Lib - -### 1. Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` - -### 2. Type `M5Stack` into the search box, search it. - -
- Screenshot of coverpage -
- -### 3. If it shows as below figure, click `Update`. - -**But if it shows `Install`, it means you has not installed M5Stack Lib. So, you need click `Install` for installing lib.** - -
- Screenshot of coverpage -
+# Upgrade M5Stack Lib + +### 1. Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` + +### 2. Type `M5Stack` into the search box, search it. + +
+ Screenshot of coverpage +
+ +### 3. If it shows as below figure, click `Update`. + +**But if it shows `Install`, it means you has not installed M5Stack Lib. So, you need click `Install` for installing lib.** + +
+ Screenshot of coverpage +
diff --git a/docs/en/tool/usb_downloader.md b/docs/en/tool/usb_downloader.md index 0663246b..b7bd9e3e 100644 --- a/docs/en/tool/usb_downloader.md +++ b/docs/en/tool/usb_downloader.md @@ -1,35 +1,35 @@ -# M5Stack USB Downloader - -## Description - -A tool built-in USB-to-UART bridge chip(CP2104) can be connected with UART port for automatically burning firmware. - -TXD led, RXD led, Power led and 6pin @ 2.54mm bus sockets. - -## PARAMETER - -| PinNumber | PinName | -| :-------------------: |:------------------------: | -| 1 | GND | -| 2 | GPIO0 | -| 3 | EN | -| 4 | TXD | -| 5 | RXD | -| 6 | 3.3V | - -### NOTE - -There are two reserved pins(RTS, DTR) on M5Stack USB Downloader for other applications. - -## Include - -- 1x M5Stack USB Downloader - -## Related Link - -- [Schematic](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/USBtool.pdf) -- [UserGuide](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/M5Stack-USB-Downloader-UserGuide.md) - - +# M5Stack USB Downloader + +## Description + +A tool built-in USB-to-UART bridge chip(CP2104) can be connected with UART port for automatically burning firmware. + +TXD led, RXD led, Power led and 6pin @ 2.54mm bus sockets. + +## PARAMETER + +| PinNumber | PinName | +| :-------------------: |:------------------------: | +| 1 | GND | +| 2 | GPIO0 | +| 3 | EN | +| 4 | TXD | +| 5 | RXD | +| 6 | 3.3V | + +### NOTE + +There are two reserved pins(RTS, DTR) on M5Stack USB Downloader for other applications. + +## Include + +- 1x M5Stack USB Downloader + +## Related Link + +- [Schematic](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/USBtool.pdf) +- [UserGuide](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/M5Stack-USB-Downloader-UserGuide.md) + + diff --git a/docs/en/unit/396port.md b/docs/en/unit/396port.md index 94cc044e..05ecde9c 100644 --- a/docs/en/unit/396port.md +++ b/docs/en/unit/396port.md @@ -1,24 +1,24 @@ -# Unit 396PORT - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-3-96-4Pin-Transfer-Module-Grove-Compatible-with-M5GO-FIRE-ESP32-Development-Kit/3226069_32922623759.html?spm=2114.12010612.8148356.26.57e2724dWGWCCC)** - -## Description - -3.96port is a unit that aim to transfer GROVE interface to VH3.96-4Pin. - -## Feature - -- VH3.96 interface -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - +# Unit 396PORT + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-3-96-4Pin-Transfer-Module-Grove-Compatible-with-M5GO-FIRE-ESP32-Development-Kit/3226069_32922623759.html?spm=2114.12010612.8148356.26.57e2724dWGWCCC)** + +## Description + +3.96port is a unit that aim to transfer GROVE interface to VH3.96-4Pin. + +## Feature + +- VH3.96 interface +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + diff --git a/docs/en/unit/adc.md b/docs/en/unit/adc.md index 49e2c713..1844d37c 100644 --- a/docs/en/unit/adc.md +++ b/docs/en/unit/adc.md @@ -1,59 +1,59 @@ -# Unit ADC - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ADC-Unit-16-Bit-I2C-GROVE-ADS1100-Module-0V-to-12V-analog-to-digital/3226069_32946953374.html?spm=a2g1x.12024536.productList_5885013.pic_7)** - -## Description - -This is a unit having self-calibrating function and 16bit analog-to-digitial coverter. The resolution is double than insided ADC of esp32, that means you can detect smaller amplitude voltage. The unit communicates with M5Core with I2C. It has provided two modes: continuously conversion and single conversion. - -## Feature - -- Up to 16 bits of resolution and perform conversions at rates of 8, 16, 32, or 128 samples per second -- Programmable gain amplifier - - Gain = 1, 2, 4, OR 8 -- Detect 0~12V voltage Input -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## APPLICATION - -- ECG signal acquisition -- Blood pressure measurement -- Dynamometer - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **Datasheet** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) - -## Example - -```c++ -ADS1100 ads;//new a object -ads.getAddr_ADS1100(0x48);//ADS1100_DEFAULT_ADDRESS: 0x48 - -ads.setOSMode(OSMODE_SINGLE);// Set to start a single-conversion -result = ads.Measure_Differential();//Reads the conversion results -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ADC/Arduino)for Specific example. - -### 2. UIFlow - -## Schematic - - - -### PinMap - - - - +# Unit ADC + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ADC-Unit-16-Bit-I2C-GROVE-ADS1100-Module-0V-to-12V-analog-to-digital/3226069_32946953374.html?spm=a2g1x.12024536.productList_5885013.pic_7)** + +## Description + +This is a unit having self-calibrating function and 16bit analog-to-digitial coverter. The resolution is double than insided ADC of esp32, that means you can detect smaller amplitude voltage. The unit communicates with M5Core with I2C. It has provided two modes: continuously conversion and single conversion. + +## Feature + +- Up to 16 bits of resolution and perform conversions at rates of 8, 16, 32, or 128 samples per second +- Programmable gain amplifier + - Gain = 1, 2, 4, OR 8 +- Detect 0~12V voltage Input +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## APPLICATION + +- ECG signal acquisition +- Blood pressure measurement +- Dynamometer + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **Datasheet** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) + +## Example + +```c++ +ADS1100 ads;//new a object +ads.getAddr_ADS1100(0x48);//ADS1100_DEFAULT_ADDRESS: 0x48 + +ads.setOSMode(OSMODE_SINGLE);// Set to start a single-conversion +result = ads.Measure_Differential();//Reads the conversion results +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ADC/Arduino)for Specific example. + +### 2. UIFlow + +## Schematic + + + +### PinMap + +
M5Core(GROVE A)GPIO22GPIO215VGND
ADC UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
ADC UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/angle.md b/docs/en/unit/angle.md index 2fc74917..5b6d5b7f 100644 --- a/docs/en/unit/angle.md +++ b/docs/en/unit/angle.md @@ -1,76 +1,76 @@ -# Unit ANGLE - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Angle-Unit-Potentiometer-Inside-Resistance-Adjustable-GPIO-GROVE-Co-n-nec-to-r/3226069_32931834705.html?spm=a2g1y.12024536.productList_5885013.subject_18)** - -## Description - -The Unit ANGLE is a potentiometer sensor that can detect rotary -angle. - -## Feature - -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -### 1. Arduino IDE - -```c++ -#include -// select the input pin for the potentiometer -int sensorPin = 36; -// last variable to store the value coming from the sensor -int last_sensorValue = 0; -// current variable to store the value coming from the sensor -int cur_sensorValue = 0; - -void setup() { - M5.begin(); - pinMode(sensorPin, INPUT); - M5.Lcd.setTextSize(2); - M5.Lcd.setCursor(0, 0); - M5.Lcd.print("the value of ANGLE: "); -} - -void loop() { - // read the value from the sensor: - cur_sensorValue = analogRead(sensorPin); - M5.Lcd.setCursor(0, 25); - if(abs(cur_sensorValue - last_sensorValue) > 10){//debaunce - M5.Lcd.fillRect(0, 25, 100, 25, BLACK); - M5.Lcd.print(cur_sensorValue); - last_sensorValue = cur_sensorValue; - } - delay(50); -} -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/Arduino)for `potentiometer_read.ino` example. - -### 2. UIFlow - - - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/UIFlow)for specifical example. - -## Schematic - - - -### PinMap - - - - +# Unit ANGLE + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Angle-Unit-Potentiometer-Inside-Resistance-Adjustable-GPIO-GROVE-Co-n-nec-to-r/3226069_32931834705.html?spm=a2g1y.12024536.productList_5885013.subject_18)** + +## Description + +The Unit ANGLE is a potentiometer sensor that can detect rotary +angle. + +## Feature + +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +#include +// select the input pin for the potentiometer +int sensorPin = 36; +// last variable to store the value coming from the sensor +int last_sensorValue = 0; +// current variable to store the value coming from the sensor +int cur_sensorValue = 0; + +void setup() { + M5.begin(); + pinMode(sensorPin, INPUT); + M5.Lcd.setTextSize(2); + M5.Lcd.setCursor(0, 0); + M5.Lcd.print("the value of ANGLE: "); +} + +void loop() { + // read the value from the sensor: + cur_sensorValue = analogRead(sensorPin); + M5.Lcd.setCursor(0, 25); + if(abs(cur_sensorValue - last_sensorValue) > 10){//debaunce + M5.Lcd.fillRect(0, 25, 100, 25, BLACK); + M5.Lcd.print(cur_sensorValue); + last_sensorValue = cur_sensorValue; + } + delay(50); +} +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/Arduino)for `potentiometer_read.ino` example. + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/UIFlow)for specifical example. + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
ANGLE UnitANGLE Pin 5VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
ANGLE UnitANGLE Pin 5VGND
\ No newline at end of file diff --git a/docs/en/unit/button.md b/docs/en/unit/button.md index 25086fa3..23bb2e8f 100644 --- a/docs/en/unit/button.md +++ b/docs/en/unit/button.md @@ -1,43 +1,43 @@ -# Unit BUTTON - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Button-Unit-for-ESP32-Arduino-Micropython-Development-Kit-with-GROVE-GPIO-Port-Blockly/3226069_32921805637.html?spm=a2g1x.12024536.productList_2187621.8)** - -## Description - -The Unit BUTTON is a sigle-button unit that can be detected whether the button pressed or not - -## Feature - -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -```c++ -float tmp = dht12.readTemperature();//temperature -float hum = dht12.readHumidity();//humidity -float pressure = bme.readPressure();//pressure -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTON/Arduino)for Specific example. - -## Schematic - - - -### PinMap - - - - +# Unit BUTTON + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Button-Unit-for-ESP32-Arduino-Micropython-Development-Kit-with-GROVE-GPIO-Port-Blockly/3226069_32921805637.html?spm=a2g1x.12024536.productList_2187621.8)** + +## Description + +The Unit BUTTON is a sigle-button unit that can be detected whether the button pressed or not + +## Feature + +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + +```c++ +float tmp = dht12.readTemperature();//temperature +float hum = dht12.readHumidity();//humidity +float pressure = bme.readPressure();//pressure +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTON/Arduino)for Specific example. + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
BUTTON UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
BUTTON UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/color.md b/docs/en/unit/color.md index ab6f1bde..bda79392 100644 --- a/docs/en/unit/color.md +++ b/docs/en/unit/color.md @@ -1,57 +1,57 @@ -# Unit COLOR - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Color-Unit-TCS34725-Color-Sensor-RGB-Color-Sensor-Development-Board-Module-GROVE-I2C-Compatible/3226069_32946957647.html?spm=a2g1x.12024536.productList_5885013.pic_5)** - -## Description - -This is a unit can detecte the color of object surface which integrates TCS3472 (a color sensor). The unit comunicates with M5Core with I2C. - -## Feature - -- High precision -- Detection range: -70℃~382.2℃ -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## APPLICATION - -- RGB LED Backlight Control -- Product Color Verification - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **Datasheet** - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) - -## Example -### 1. Arduino IDE - -```c++ -Adafruit_TCS34725 tcs; - -tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS, TCS34725_GAIN_4X); - -tcs.getRawData(&red, &green, &blue, &clear);//get rgb value -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/Arduino)for Specific example. - - - -## Schematic - - - -### PinMap - - - - +# Unit COLOR + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Color-Unit-TCS34725-Color-Sensor-RGB-Color-Sensor-Development-Board-Module-GROVE-I2C-Compatible/3226069_32946957647.html?spm=a2g1x.12024536.productList_5885013.pic_5)** + +## Description + +This is a unit can detecte the color of object surface which integrates TCS3472 (a color sensor). The unit comunicates with M5Core with I2C. + +## Feature + +- High precision +- Detection range: -70℃~382.2℃ +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## APPLICATION + +- RGB LED Backlight Control +- Product Color Verification + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **Datasheet** - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) + +## Example +### 1. Arduino IDE + +```c++ +Adafruit_TCS34725 tcs; + +tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS, TCS34725_GAIN_4X); + +tcs.getRawData(&red, &green, &blue, &clear);//get rgb value +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/Arduino)for Specific example. + + + +## Schematic + + + +### PinMap + +
M5Core(GROVE A)GPIO22GPIO215VGND
COLOR UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
COLOR UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/dac.md b/docs/en/unit/dac.md index 70f7c821..1b672b0f 100644 --- a/docs/en/unit/dac.md +++ b/docs/en/unit/dac.md @@ -1,82 +1,82 @@ -# Unit DAC - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-DAC-Unit-MCP4725-I2C-DAC-Converter-Breakout-Module-Digital-to-Analog-12-Bits-0V/3226069_32947696641.html?spm=a2g1x.12024536.productList_5885013.pic_6)** - -## Description - -This is a unit can convert digital signal to analog signal like voltage waveform, audio waveform and so on. It integrates a 12-bit high resolution DAC chip named MCP4725 which integrates a on-board non-volatile memory (EEPROM). The unit comunicates with M5Core with I2C. The DAC input and configuration data can be programmed to the EEPROM. - -## Feature - -- Up to 12 bits of resolution -- Output 0~3.3V voltage -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## APPLICATION - -- MP3 Audio Player -- mini Oscilloscope - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **Datasheet** - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html) - -## Example -### 1. Arduino IDE - - -### PinMap - - - - +# Unit DUAL_BUTTON + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Mini-Dual-Button-Unit-Mini-with-GROVE-Port-Cable-Connector-Compatible-with-FIRE/3226069_32923126250.html?spm=a2g1x.12024536.productList_2187621.9)** + +## Description + +This Unit is a dual-button unit that can be detected whether a single button pressed or two buttons pressed + +## Feature + +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
DUAL_BUTTON UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
DUAL_BUTTON UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/earth.md b/docs/en/unit/earth.md index 86328e1a..c920c6bb 100644 --- a/docs/en/unit/earth.md +++ b/docs/en/unit/earth.md @@ -1,49 +1,49 @@ -# Unit EARTH - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Earth-Module-Grove-Compatible-Soil-monitoring-Analog-and-Digital-Output/3226069_32922643696.html?spm=2114.12010615.8148356.2.45434ff2lDdyLQ)** - -## Description - -EARTH is a moisture detective unit for measuring the moisture in soil. The soil moisture sensor is pretty straight forward to use. The two large exp osed pads function as probes for the sensor, together acting as a variable resistor. The more water that is in the soil means the better the conductivity between the pads will be and will result in a lower resistance, and a higher SIG out. -You can read the moisture in soil staright or get a digital signal(0/1) that means the high(or low) humidity. - -## Feature - -- Adjustable threshold, including 10K adjustable resistor -- Analog & Digital output -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example -### 1. Arduino IDE - -```c++ -//disable the speak noise -dacWrite(25, 0); - -analogRead_value = analogRead(36); -digitalRead_value = digitalRead(26); -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/Arduino)for Specific example. - -## Schematic - - - -### PinMap - - - - +# Unit EARTH + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Earth-Module-Grove-Compatible-Soil-monitoring-Analog-and-Digital-Output/3226069_32922643696.html?spm=2114.12010615.8148356.2.45434ff2lDdyLQ)** + +## Description + +EARTH is a moisture detective unit for measuring the moisture in soil. The soil moisture sensor is pretty straight forward to use. The two large exp osed pads function as probes for the sensor, together acting as a variable resistor. The more water that is in the soil means the better the conductivity between the pads will be and will result in a lower resistance, and a higher SIG out. +You can read the moisture in soil staright or get a digital signal(0/1) that means the high(or low) humidity. + +## Feature + +- Adjustable threshold, including 10K adjustable resistor +- Analog & Digital output +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example +### 1. Arduino IDE + +```c++ +//disable the speak noise +dacWrite(25, 0); + +analogRead_value = analogRead(36); +digitalRead_value = digitalRead(26); +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/Arduino)for Specific example. + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
EARTH UnitAinDin5VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
EARTH UnitAinDin5VGND
\ No newline at end of file diff --git a/docs/en/unit/env.md b/docs/en/unit/env.md index 89dfe032..5566bd45 100644 --- a/docs/en/unit/env.md +++ b/docs/en/unit/env.md @@ -1,55 +1,55 @@ -# Unit ENV - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-ENV-Unit-with-DHT12-BMP280-Digital-DHT-12-Temperature-Humidity-Aire-Pressure-Sensor/3226069_32933115893.html?spm=2114.12010615.8148356.2.758c5bcbURtQtR)** - - -## Description - -ENV is a environment sensor for M5GO that can easily detect -temperature, humidity and air pressure with M5GO Core, including -temperature and humidity sensor and absolute barometric pressure sensor. Connect to GRVE A of M5Core. - -## Feature - -- Temperature: -- measuring range: 20 ~ 60℃ -- resolution: ±0.2℃ -- Humidity: -- measuring range: 20 ~ 95℃ -- resolution: 0.1% -- Air pressure -- measuring range: 300 ~ 1100hPa -- resolution: ±1hPa -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -```c++ -float tmp = dht12.readTemperature();//temperature -float hum = dht12.readHumidity();//humidity -float pressure = bme.readPressure();//pressure -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV)for Specific example. - -## Schematic - - - -### PinMap - - - - +# Unit ENV + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-ENV-Unit-with-DHT12-BMP280-Digital-DHT-12-Temperature-Humidity-Aire-Pressure-Sensor/3226069_32933115893.html?spm=2114.12010615.8148356.2.758c5bcbURtQtR)** + + +## Description + +ENV is a environment sensor for M5GO that can easily detect +temperature, humidity and air pressure with M5GO Core, including +temperature and humidity sensor and absolute barometric pressure sensor. Connect to GRVE A of M5Core. + +## Feature + +- Temperature: +- measuring range: 20 ~ 60℃ +- resolution: ±0.2℃ +- Humidity: +- measuring range: 20 ~ 95℃ +- resolution: 0.1% +- Air pressure +- measuring range: 300 ~ 1100hPa +- resolution: ±1hPa +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + +```c++ +float tmp = dht12.readTemperature();//temperature +float hum = dht12.readHumidity();//humidity +float pressure = bme.readPressure();//pressure +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV)for Specific example. + +## Schematic + + + +### PinMap + +
M5Core(GROVE A)GPIO22GPIO21
ENV UnitSCLSDA
+ +
M5Core(GROVE A)GPIO22GPIO21
ENV UnitSCLSDA
\ No newline at end of file diff --git a/docs/en/unit/esp32cam.md b/docs/en/unit/esp32cam.md index 7f16236e..830ce387 100644 --- a/docs/en/unit/esp32cam.md +++ b/docs/en/unit/esp32cam.md @@ -1,84 +1,84 @@ -# Unit ESP32CAM - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-Camera-Module-Development-Board-OV2640-Camera-Type-C-Grove-Port-3D-Wifi-Antenna/3226069_32881414545.html)** - -## Description - -The **ESP32Cam** is a tiny unit based on ESP32 chip and OV2640. You can even program it through ESP-IDF. - -The ESP32Cam equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger , so your ESP32Cam project can be battery-powered and truly wireless. Additionally, the board reserved the Welding positions of MPU6050,BME280 and an analog MIC. - - -## Include - -- 1x M5 Camera -- 1x Type-C USB Cable - - -## Feature - -- ESP32 specifications - + Dual-core Tensilica LX6 microprocessor - + Up to 240MHz clock frequency - + 512K internal SRAM - + 4MB Flash memory - + Integrated 802.11 BGN WiFi transceiver - + Integrated dual-mode Bluetooth (classic and BLE) - + Hardware accelerated encryption (AES, SHA2, ECC, RSA-4096) -- CP2104 USB TTL -- OV2640 sensor - - Output Formats(8-bit): - + YUV(422/420)/YCbCr422 - + RGB565/555 - + 8-bit compressed data - + 8-/10-bit Raw RGB data - - Maximum Image Transfer Rate - + UXGA/SXGA: 15fps - + SVGA: 30fps - + CIF: 60fps - - Scan Mode: Progressive -- Camera specifications - + CCD size : 1/4inch - + Field of View : 78 degree - + Maxmium Pixel: 200W -- Sensor best resolution: 1600 * 1200 -- Dimension: 25mm x 24mm -- Weight: 5g - - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **[Datasheet]** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - -- **[PinMap](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/hardware_diff_with_ESP32CAM_M5Camera.md)** - -- **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)** - -## Example - - - -## Schematic - - - -### PinMap - - + +## Schematic + + + +### PinMap + + \ No newline at end of file diff --git a/docs/en/unit/hub.md b/docs/en/unit/hub.md index 66bc9380..eb802ca5 100644 --- a/docs/en/unit/hub.md +++ b/docs/en/unit/hub.md @@ -1,29 +1,29 @@ -# Unit HUB - - - -*** - -:memo:**[Description](#Description)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-HUB-Unit-1-to-3-HUB-with-Universal-Connector-Grove-Port/3226069_32930928722.html?spm=a2g1y.12024536.productList_5885013.subject_17)** - -## Description - -HUB is a module for M5GO to expand GROVE port added three GROVE -ports for user. So you can control 3 GROVE devices with only one M5GO -Core at a time. - -## Feature - -- Instantly Add Three 4-Pins-GROVE ports to Any Compatible Device -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Schematic - - +# Unit HUB + + + +*** + +:memo:**[Description](#Description)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-HUB-Unit-1-to-3-HUB-with-Universal-Connector-Grove-Port/3226069_32930928722.html?spm=a2g1y.12024536.productList_5885013.subject_17)** + +## Description + +HUB is a module for M5GO to expand GROVE port added three GROVE +ports for user. So you can control 3 GROVE devices with only one M5GO +Core at a time. + +## Feature + +- Instantly Add Three 4-Pins-GROVE ports to Any Compatible Device +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Schematic + + diff --git a/docs/en/unit/ir.md b/docs/en/unit/ir.md index d15d70cf..ddb68d47 100644 --- a/docs/en/unit/ir.md +++ b/docs/en/unit/ir.md @@ -1,85 +1,85 @@ -# Unit IR - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Infrared-Unit-IR-Remote-Reflective-Sensor-with-Receiver-and-Transmitter-GPIO-GROVE-Connector/3226069_32933215001.html?spm=a2g1y.12024536.productList_5885013.subject_20)** - -## Description - -The Unit IR is a IR infrared obstacle avoidance sensor. It can -be widely used in robot obstacle avoidance, obstacle avoidance car, line -count, and black and white line tracking and so on. - -It has a pair of infrared transmitting and receiving tube, tube infrared -emit a certain frequency, when detecting direction meet with obstacles -(reflecting surface), reflected infrared receiving tube, after the -comparator circuit processing, green indicator will light up, at the -same time signal output interface to output digital signal. - -## Feature - -- A pair of infrared transmitting and receiving tube -- Detects the distance 2 ~ 5cm -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -### 1. Arduino IDE - -```c++ -#include -// select the input pin for the potentiometer -int ir_recv_pin = 36; -int ir_send_pin = 26; -int last_recv_value = 0; -int cur_recv_value = 0; - -void setup() { - M5.begin(); - pinMode(ir_recv_pin, INPUT); - pinMode(ir_send_pin, OUTPUT); - //send infrared light - //now, you can see the infrared light through mobile phone camera - digitalWrite(ir_send_pin, 1); - M5.Lcd.setTextSize(2); - M5.Lcd.setCursor(0, 0); - M5.Lcd.print("Test for IR receiver: "); -} - -void loop() { - //now, once you press the button on a remote controller to send infrared light - //the screen will display "detected!" - cur_recv_value = digitalRead(ir_recv_pin); - if(last_recv_value != cur_recv_value){ - M5.Lcd.setCursor(0, 25); - M5.Lcd.fillRect(0, 25, 150, 25, BLACK); - if(cur_recv_value == 0){//0: detected 1: not detected - M5.Lcd.print("detected!"); - } - last_recv_value = cur_recv_value; - } - delay(100); -} -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/Arduino)for `ir_dectect.ino` example. - -## Schematic - - - -### PinMap - - - - +# Unit IR + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Infrared-Unit-IR-Remote-Reflective-Sensor-with-Receiver-and-Transmitter-GPIO-GROVE-Connector/3226069_32933215001.html?spm=a2g1y.12024536.productList_5885013.subject_20)** + +## Description + +The Unit IR is a IR infrared obstacle avoidance sensor. It can +be widely used in robot obstacle avoidance, obstacle avoidance car, line +count, and black and white line tracking and so on. + +It has a pair of infrared transmitting and receiving tube, tube infrared +emit a certain frequency, when detecting direction meet with obstacles +(reflecting surface), reflected infrared receiving tube, after the +comparator circuit processing, green indicator will light up, at the +same time signal output interface to output digital signal. + +## Feature + +- A pair of infrared transmitting and receiving tube +- Detects the distance 2 ~ 5cm +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +#include +// select the input pin for the potentiometer +int ir_recv_pin = 36; +int ir_send_pin = 26; +int last_recv_value = 0; +int cur_recv_value = 0; + +void setup() { + M5.begin(); + pinMode(ir_recv_pin, INPUT); + pinMode(ir_send_pin, OUTPUT); + //send infrared light + //now, you can see the infrared light through mobile phone camera + digitalWrite(ir_send_pin, 1); + M5.Lcd.setTextSize(2); + M5.Lcd.setCursor(0, 0); + M5.Lcd.print("Test for IR receiver: "); +} + +void loop() { + //now, once you press the button on a remote controller to send infrared light + //the screen will display "detected!" + cur_recv_value = digitalRead(ir_recv_pin); + if(last_recv_value != cur_recv_value){ + M5.Lcd.setCursor(0, 25); + M5.Lcd.fillRect(0, 25, 150, 25, BLACK); + if(cur_recv_value == 0){//0: detected 1: not detected + M5.Lcd.print("detected!"); + } + last_recv_value = cur_recv_value; + } + delay(100); +} +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/Arduino)for `ir_dectect.ino` example. + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
IR UnitReceiver PinTransmitter Pin5VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
IR UnitReceiver PinTransmitter Pin5VGND
\ No newline at end of file diff --git a/docs/en/unit/joystick.md b/docs/en/unit/joystick.md index 86986e5d..734f414c 100644 --- a/docs/en/unit/joystick.md +++ b/docs/en/unit/joystick.md @@ -1,60 +1,60 @@ -# Unit JOYSTICK - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Joystick-Unit-MEGA328P-I2C-Grove-Connector-Compatible-X-Y-Axis-Button-for-ESP32/3226069_32921785624.html?spm=a2g1x.12024536.productList_2187621.10)** - -## Description - -This Unit is a joystick unit the same as game controller button that can be detected the X-Y axis offset and whether the joystick be pressed - -## Feature - -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -### 1. Arduino IDE - -```c++ -#define JOY_ADDR 0x52 - -//disable the speak noise -dacWrite(25, 0); -Wire.begin(21, 22, 400000); -Wire.requestFrom(JOY_ADDR); -while(Wire.available()) -{ - x_data = Wire.read();//x - y_data = Wire.read();//x - button_data = Wire.read();//x -} -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/Arduino)for Specific example. - -### 2. UIFlow - - - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/UIFlow)for Specific example. - -## Schematic - - - -### PinMap - - - - +# Unit JOYSTICK + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Joystick-Unit-MEGA328P-I2C-Grove-Connector-Compatible-X-Y-Axis-Button-for-ESP32/3226069_32921785624.html?spm=a2g1x.12024536.productList_2187621.10)** + +## Description + +This Unit is a joystick unit the same as game controller button that can be detected the X-Y axis offset and whether the joystick be pressed + +## Feature + +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +#define JOY_ADDR 0x52 + +//disable the speak noise +dacWrite(25, 0); +Wire.begin(21, 22, 400000); +Wire.requestFrom(JOY_ADDR); +while(Wire.available()) +{ + x_data = Wire.read();//x + y_data = Wire.read();//x + button_data = Wire.read();//x +} +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/Arduino)for Specific example. + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/UIFlow)for Specific example. + +## Schematic + + + +### PinMap + +
M5Core(GROVE A)GPIO22GPIO215VGND
JOYSTICK UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
JOYSTICK UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/light.md b/docs/en/unit/light.md index 55c76930..786ed654 100644 --- a/docs/en/unit/light.md +++ b/docs/en/unit/light.md @@ -1,58 +1,58 @@ -# Unit LIGHT - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Light-Unit-with-Photoresistance-Grove-Port-Analog-Digital-Output-Compatible-with-M5GO-FIRE-ESP32/3226069_32920589923.html?spm=2114.12010615.8148356.4.1be27011RbDBo5)** - -## Description - -The Unit light is a light sensor unit with an adjustable resistor that can detect the lightironmental light intensity. -You can read analog signal(lightironmental light intensity) staright or get a digital signal(0/1) that means whether the light exists or not. - - -## Feature - -- Adjustable threshold, including 10K adjustable resistor -- Analog & Digital output -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -### 1. Arduino IDE - -```c++ -//disable the speak noise -dacWrite(25, 0); - -analogRead_value = analogRead(36);//get analog value of LIGHT(0-4095) -digitalRead_value = digitalRead(26);//0: sense the ligth 1: do not sense -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/Arduino) for Specific example. - -### 2. UIFlow - - - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/UIFlow) for Specific example. - - -## Schematic - - - -### PinMap - - - - +# Unit LIGHT + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Light-Unit-with-Photoresistance-Grove-Port-Analog-Digital-Output-Compatible-with-M5GO-FIRE-ESP32/3226069_32920589923.html?spm=2114.12010615.8148356.4.1be27011RbDBo5)** + +## Description + +The Unit light is a light sensor unit with an adjustable resistor that can detect the lightironmental light intensity. +You can read analog signal(lightironmental light intensity) staright or get a digital signal(0/1) that means whether the light exists or not. + + +## Feature + +- Adjustable threshold, including 10K adjustable resistor +- Analog & Digital output +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +//disable the speak noise +dacWrite(25, 0); + +analogRead_value = analogRead(36);//get analog value of LIGHT(0-4095) +digitalRead_value = digitalRead(26);//0: sense the ligth 1: do not sense +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/Arduino) for Specific example. + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/UIFlow) for Specific example. + + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
LIGHT UnitAinDin5VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
LIGHT UnitAinDin5VGND
\ No newline at end of file diff --git a/docs/en/unit/m5camera.md b/docs/en/unit/m5camera.md index 1d4b2cdf..1b480d8d 100644 --- a/docs/en/unit/m5camera.md +++ b/docs/en/unit/m5camera.md @@ -1,84 +1,84 @@ -# Unit M5CAMERA - -
- -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-WROVER-with-PSRAM-Camera-Module-OV2640-Type-C-Grove-Port-Mini-Camera-Development/3226069_32909972455.html?spm=2114.12010612.8148356.24.57e2724dWGWCCC)** - -## Description - -The **M5Camera** is a tiny unit based on ESP32 chip and OV2640 including PSRAM. You can even program it through ESP-IDF. - -The M5Camera equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger (IP5306) , so your M5Camera project can be battery-powered and truly wireless. Additionally, the board reserved the Welding positions of MPU6050,BME280 and an analog MIC. - - -## Include - -- 1x M5 Camera -- 1x Type-C USB Cable - - -## Feature - -- ESP32 specifications - + Dual-core Tensilica LX6 microprocessor - + Up to 240MHz clock frequency - + 4MB internal SRAM - + 4MB Flash memory - + Integrated 802.11 BGN WiFi transceiver - + Integrated dual-mode Bluetooth (classic and BLE) - + Hardware accelerated encryption (AES, SHA2, ECC, RSA-4096) -- CP2104 USB TTL -- OV2640 sensor - - Output Formats(8-bit): - + YUV(422/420)/YCbCr422 - + RGB565/555 - + 8-bit compressed data - + 8-/10-bit Raw RGB data - - Maximum Image Transfer Rate - + UXGA/SXGA: 15fps - + SVGA: 30fps - + CIF: 60fps - - Scan Mode: Progressive -- Camera specifications - + CCD size : 1/4inch - + Field of View : 78 degree - + Maxmium Pixel: 200W -- Sensor best resolution: 1600 * 1200 -- Dimension: 25mm x 24mm -- Weight: 5g - - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **[Datasheet]** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - -- **[PinMap](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/hardware_diff_with_ESP32CAM_M5Camera.md)** - -- **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)** - -## Example - - - -## Schematic - - - -### PinMap - - + +## Schematic + + + +### PinMap + + \ No newline at end of file diff --git a/docs/en/unit/makey.md b/docs/en/unit/makey.md index 25ec2bdc..9ece78b5 100644 --- a/docs/en/unit/makey.md +++ b/docs/en/unit/makey.md @@ -1,51 +1,51 @@ -# Unit MAKEY - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Makey-Unit-MEGA328P-Inside-16Key-Fruit-Paino-with-NEO-Pixel-and-BUZZER-for-ESP32/3226069_32924883456.html?spm=a2g1y.12024536.productList_5885013.subject_23)** - -## Description - -The Unit makey is a makey unit with 16 touchable pins.The Unit makey is based on Arduino Uno Mega328p chip.It communicates with M5Stack Core via GROVE(I2C).It's I2C address is 0x51. - -## Feature - -- Arduino Mega328p Controller -- 16 Keys Fruit Piano(PD0-7 & PB0-5), 1 NeoPixel pin(PC2) and 1 Buzzer pin(PC3) -- Buzzer inside -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## APPLICATION - -- Makey Application -- RGB Application with Adafruit Library - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - - - -## Schematic - - - -### PinMap - - - - +# Unit MAKEY + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Makey-Unit-MEGA328P-Inside-16Key-Fruit-Paino-with-NEO-Pixel-and-BUZZER-for-ESP32/3226069_32924883456.html?spm=a2g1y.12024536.productList_5885013.subject_23)** + +## Description + +The Unit makey is a makey unit with 16 touchable pins.The Unit makey is based on Arduino Uno Mega328p chip.It communicates with M5Stack Core via GROVE(I2C).It's I2C address is 0x51. + +## Feature + +- Arduino Mega328p Controller +- 16 Keys Fruit Piano(PD0-7 & PB0-5), 1 NeoPixel pin(PC2) and 1 Buzzer pin(PC3) +- Buzzer inside +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## APPLICATION + +- Makey Application +- RGB Application with Adafruit Library + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + + + +## Schematic + + + +### PinMap + +
M5Core(GROVE A)GPIO22GPIO215VGND
MAKEY UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
MAKEY UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/ncir.md b/docs/en/unit/ncir.md index 6d856ab6..096cb563 100644 --- a/docs/en/unit/ncir.md +++ b/docs/en/unit/ncir.md @@ -1,52 +1,52 @@ -# Unit NCIR - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NCIR-Unit-MLX90614-Contactless-Temperature-Sensor-Module-70C-382-2C-GROVE-I2C-Development-Board/3226069_32947772098.html?spm=a2g1x.12024536.productList_5885013.pic_4)** - -## Description - -This is a unit can measure body temperature or be applicated for movement detection which integrates MLX90641 (an infrared thermometer designed for non-contact temperature sensing). The unit comunicates with M5Core with I2C. - -## Feature - -- High precision -- Detection range: -70℃~382.2℃ -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## APPLICATION - -- body temperature measurement -- movement detection - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **Datasheet** - [MLX90614](https://pdf1.alldatasheet.com/datasheet-pdf/view/218977/ETC2/MLX90614.html) - -## Example - - - -## Schematic - - - -### PinMap - - - - +# Unit NCIR + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NCIR-Unit-MLX90614-Contactless-Temperature-Sensor-Module-70C-382-2C-GROVE-I2C-Development-Board/3226069_32947772098.html?spm=a2g1x.12024536.productList_5885013.pic_4)** + +## Description + +This is a unit can measure body temperature or be applicated for movement detection which integrates MLX90641 (an infrared thermometer designed for non-contact temperature sensing). The unit comunicates with M5Core with I2C. + +## Feature + +- High precision +- Detection range: -70℃~382.2℃ +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## APPLICATION + +- body temperature measurement +- movement detection + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **Datasheet** - [MLX90614](https://pdf1.alldatasheet.com/datasheet-pdf/view/218977/ETC2/MLX90614.html) + +## Example + + + +## Schematic + + + +### PinMap + +
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/neopixel.md b/docs/en/unit/neopixel.md index 8abc93e1..13622cb4 100644 --- a/docs/en/unit/neopixel.md +++ b/docs/en/unit/neopixel.md @@ -1,52 +1,52 @@ -# Unit NEOPIXEL - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NeoPixel-RGB-LEDs-Cable-SK6812-with-GROVE-Port-2m-1m-50cm-20cm-10cm/3226069_32950831315.html?spm=a2g1x.12024536.productList_5885013.pic_0)** - -## Description - -This is a RGB LED Cable unit. You can program it using NeoPixel Lib supported by Adafruit or using UiFlow that will be easier. The unit comunicates with M5Core with GROVE Interface. - -## Feature - -- the length: 10cm/20cm/0.5m/1m/2m -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -### 1. Arduino IDE - - - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow)。 - - - - - - - - + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow)。 + + + + + + + + \ No newline at end of file diff --git a/docs/en/unit/pir.md b/docs/en/unit/pir.md index aefc6bb2..aecf659d 100644 --- a/docs/en/unit/pir.md +++ b/docs/en/unit/pir.md @@ -1,51 +1,51 @@ -# Unit PIR - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-PIR-Sensor-Human-Body-Infrared-PIR-Motion-Sensor-Detector-Module-GPIO-GROVE-Connector/3226069_32931794651.html?spm=a2g1y.12024536.productList_5885013.subject_19)** - -## Description - -The Unit PIR is a human infrared sensor for M5GO that can easily detect -whether someone appears in front of it with M5GO Core. - -## Feature - -- Detects the distance 150cm -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - - - -### 2. UIFlow - - - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow) for Specific example. - -## Schematic - - - -### PinMap - - - - +# Unit PIR + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-PIR-Sensor-Human-Body-Infrared-PIR-Motion-Sensor-Detector-Module-GPIO-GROVE-Connector/3226069_32931794651.html?spm=a2g1y.12024536.productList_5885013.subject_19)** + +## Description + +The Unit PIR is a human infrared sensor for M5GO that can easily detect +whether someone appears in front of it with M5GO Core. + +## Feature + +- Detects the distance 150cm +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + + + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow) for Specific example. + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
PIR UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
PIR UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/proto.md b/docs/en/unit/proto.md index 05d1c27b..b20112ab 100644 --- a/docs/en/unit/proto.md +++ b/docs/en/unit/proto.md @@ -1,37 +1,37 @@ -# Unit PROTO - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Proto-Board-Unit-Universal-Double-Side-Prototype-2-54mm-PCB-Grove-Port-Compatible/3226069_32920617495.html?spm=2114.12010615.8148356.4.6735f4943FDruP)** - -## Description - -The M5Stack proto unit is a flexible blank circle with 100mil pitch of holes. You can create any circle -that could controlled by M5GO Core as you like. - -## Feature - -- Flexible extended blank circle -- 70 holes(pitch of holes: 100mil) -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - - -## Schematic - - - -### PinMap - - - - +# Unit PROTO + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Proto-Board-Unit-Universal-Double-Side-Prototype-2-54mm-PCB-Grove-Port-Compatible/3226069_32920617495.html?spm=2114.12010615.8148356.4.6735f4943FDruP)** + +## Description + +The M5Stack proto unit is a flexible blank circle with 100mil pitch of holes. You can create any circle +that could controlled by M5GO Core as you like. + +## Feature + +- Flexible extended blank circle +- 70 holes(pitch of holes: 100mil) +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
PROTO UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
PROTO UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/relay.md b/docs/en/unit/relay.md index 0c75028f..112eb693 100644 --- a/docs/en/unit/relay.md +++ b/docs/en/unit/relay.md @@ -1,69 +1,67 @@ -# Unit RELAY - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Relay-Unit-DC-3A-30V-AC-3A-220V-with-Triode-Driven-GROVE-Port/3226069_32922856211.html?spm=a2g1y.12024536.productList_5885013.subject_24)** - -## Description - -The Unit relay is a unit that allows you to control large power loads with a light-current, safe, reliable power control system. the large power loads you can safely control is up to 24 VDC or 120 VAC. -Only a low electrial level is sent to this unit, the relay will be close and the large power loads you want to control will be working. - - -## Feature -- A single input -- Up to 3A @ 24 VDC or 120 VAC -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## APPLICATION - -- Be perfect for large inductive loads(like DC motors electrocircuit, intelligent interpolation...) -- Control a standard wall outlet device - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - -### 1. Arduino IDE - -```c++ -// RELAY is connected to GROVE B -pinMode(26, OUTPUT); - -digitalWrite(26, 0);//relay opened -delay(1000); -digitalWrite(26, 1);//relay closed -delay(1000); -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/Arduino) for Specific example. - -### 2. UIFlow - - - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/UIFlow) for Specific example. - -## Schematic - - - -### PinMap - - - - -
M5Core(GROVE B)GPIO36GPIO265VGND
RELAY Unit RELAY Pin5VGND
- -## Related Video - -- **m5stack introduction** - - +# Unit RELAY + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Relay-Unit-DC-3A-30V-AC-3A-220V-with-Triode-Driven-GROVE-Port/3226069_32922856211.html?spm=a2g1y.12024536.productList_5885013.subject_24)**   :clapper:**[Related Video](#Related-Video)** + +## Description + +The Unit relay is a unit that allows you to control large power loads with a light-current, safe, reliable power control system. the large power loads you can safely control is up to 24 VDC or 120 VAC. +Only a low electrial level is sent to this unit, the relay will be close and the large power loads you want to control will be working. + + +## Feature +- A single input +- Up to 3A @ 24 VDC or 120 VAC +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## APPLICATION + +- Be perfect for large inductive loads(like DC motors electrocircuit, intelligent interpolation...) +- Control a standard wall outlet device + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +// RELAY is connected to GROVE B +pinMode(26, OUTPUT); + +digitalWrite(26, 0);//relay opened +delay(1000); +digitalWrite(26, 1);//relay closed +delay(1000); +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/Arduino) for Specific example. + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/UIFlow) for Specific example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
RELAY Unit RELAY Pin5VGND
+ +## Related Video + + diff --git a/docs/en/unit/rgb.md b/docs/en/unit/rgb.md index 2935f982..098ff4e0 100644 --- a/docs/en/unit/rgb.md +++ b/docs/en/unit/rgb.md @@ -1,45 +1,45 @@ -# Unit RGB - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-RGB-Unit-with-NeoPixel-RGB-LED-Light-x3-GPIO-GROVE-Connector/3226069_32929809133.html?spm=a2g1y.12024536.productList_5885013.subject_21)** - -## Description - -The Unit RGB is a sensor including three RGB LED lights and two GROVE -ports.You can display specified color using M5GO Core through Blockly, -Arduino or MicroPython. - -## Feature - -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -## Example - - - -## Schematic - - - -### PinMap - - - - +# Unit RGB + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-RGB-Unit-with-NeoPixel-RGB-LED-Light-x3-GPIO-GROVE-Connector/3226069_32929809133.html?spm=a2g1y.12024536.productList_5885013.subject_21)** + +## Description + +The Unit RGB is a sensor including three RGB LED lights and two GROVE +ports.You can display specified color using M5GO Core through Blockly, +Arduino or MicroPython. + +## Feature + +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +## Example + + + +## Schematic + + + +### PinMap + +
M5Core(GROVE B)GPIO36GPIO265VGND
RGB UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
RGB UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/thermal.md b/docs/en/unit/thermal.md index 2f4e8413..cfb0ab59 100644 --- a/docs/en/unit/thermal.md +++ b/docs/en/unit/thermal.md @@ -1,57 +1,57 @@ -# Unit THERMAL - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Thermal-Camera-MLX90640-with-GROVE-I2C-Compatible-M5GO-FIRE-ESP32-Kit-Mini-Development/3226069_32918177644.html?spm=2114.12010615.8148356.2.4ad0717733LM7H)** - -## Description - -The Unit thermal is a thermal camera module contains thermopile sensors named MLX90640. the MLX90640 contains a 32x64 piexls IR array. It communicates with M5GO Core via GROVE which actually is a I2C interfacel. -As the images show you can detect surface temperatures from many feet away with an accuracy of ±1.5°C (best case). -After burn the firmware of the module's demostatrion to M5GO Core via `M5Burner`, the module will be running. Then you can program it via Arduino IDE. - - -## Feature - -- 32x24 piexls -- Target temperature -40°C ÷ 300°C -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## APPLICATION - -- High precision non-contact temperature measurements -- Intrusion / Movement detection -- Visual IR thermometers -- Temperature sensing element for intelligent building air conditioning - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **Datasheet** - [MLX90640](https://www.melexis.com/-/media/files/documents/datasheets/mlx90640-datasheet-melexis.pdf) - -## Example - - - -## Schematic - - - -### PinMap - - - - +# Unit THERMAL + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Thermal-Camera-MLX90640-with-GROVE-I2C-Compatible-M5GO-FIRE-ESP32-Kit-Mini-Development/3226069_32918177644.html?spm=2114.12010615.8148356.2.4ad0717733LM7H)** + +## Description + +The Unit thermal is a thermal camera module contains thermopile sensors named MLX90640. the MLX90640 contains a 32x64 piexls IR array. It communicates with M5GO Core via GROVE which actually is a I2C interfacel. +As the images show you can detect surface temperatures from many feet away with an accuracy of ±1.5°C (best case). +After burn the firmware of the module's demostatrion to M5GO Core via `M5Burner`, the module will be running. Then you can program it via Arduino IDE. + + +## Feature + +- 32x24 piexls +- Target temperature -40°C ÷ 300°C +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## APPLICATION + +- High precision non-contact temperature measurements +- Intrusion / Movement detection +- Visual IR thermometers +- Temperature sensing element for intelligent building air conditioning + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **Datasheet** - [MLX90640](https://www.melexis.com/-/media/files/documents/datasheets/mlx90640-datasheet-melexis.pdf) + +## Example + + + +## Schematic + + + +### PinMap + +
M5Core(GROVE A)GPIO22GPIO215VGND
THERMAL UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
THERMAL UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/tof.md b/docs/en/unit/tof.md index 3859d7f0..3c99612f 100644 --- a/docs/en/unit/tof.md +++ b/docs/en/unit/tof.md @@ -1,57 +1,57 @@ -# Unit TOF - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ToF-Unit-VL53L0X-Time-of-Flight-ToF-Laser-Ranging-Sensor-Breakout-Laser-Distance-Sensor/3226069_32949310300.html?spm=a2g1x.12024536.productList_5885013.pic_3)** - -## Description - -This is a unit can detect distance using a newest "Time-to-Flight" sensor using laser light. It is higher precision than most distance sensors. The unit comunicates with M5Core with I2C. - -## Feature - -- High precision -- Measure absolute distances up to 2m -- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes - -## APPLICATION - -- 1D gesture recognition - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- **Datasheet** - [VL53L0X](https://pdf1.alldatasheet.com/datasheet-pdf/view/948120/STMICROELECTRONICS/VL53L0X.html) - -## Example - -### 1. Arduino IDE - -```c++ -#define SYSRANGE_START 0x00 -#define RESULT_RANGE_STATUS 0x14 -#define ToF_ADDR 0x29 //the IIC address of ToF - -write_byte_data_at(SYSRANGE_START, 0x01); //start measure -read_block_data_at(RESULT_RANGE_STATUS, 12); //read 12 bytes once -dist = makeuint16(gbuf[11], gbuf[10]); //split distance data and save at "dist" -``` - -Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TOF/Arduino) for Specific example. - -## Schematic - - - -### PinMap - - - - +# Unit TOF + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ToF-Unit-VL53L0X-Time-of-Flight-ToF-Laser-Ranging-Sensor-Breakout-Laser-Distance-Sensor/3226069_32949310300.html?spm=a2g1x.12024536.productList_5885013.pic_3)** + +## Description + +This is a unit can detect distance using a newest "Time-to-Flight" sensor using laser light. It is higher precision than most distance sensors. The unit comunicates with M5Core with I2C. + +## Feature + +- High precision +- Measure absolute distances up to 2m +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## APPLICATION + +- 1D gesture recognition + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **Datasheet** - [VL53L0X](https://pdf1.alldatasheet.com/datasheet-pdf/view/948120/STMICROELECTRONICS/VL53L0X.html) + +## Example + +### 1. Arduino IDE + +```c++ +#define SYSRANGE_START 0x00 +#define RESULT_RANGE_STATUS 0x14 +#define ToF_ADDR 0x29 //the IIC address of ToF + +write_byte_data_at(SYSRANGE_START, 0x01); //start measure +read_block_data_at(RESULT_RANGE_STATUS, 12); //read 12 bytes once +dist = makeuint16(gbuf[11], gbuf[10]); //split distance data and save at "dist" +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TOF/Arduino) for Specific example. + +## Schematic + + + +### PinMap + +
M5Core(GROVE A)GPIO22GPIO215VGND
TOF UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
TOF UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 5c6758b6..f2ea16fd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,106 +1,106 @@ - - - - - - - - - M5Stack - A series of modular stackable development devices - - - - - - - - -
loading...
- - - - - - - - - - - - - - - - - - - - + + + + + + + + + M5Stack - A series of modular stackable development devices + + + + + + + + +
loading...
+ + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.md b/docs/index.md index 64e1bd1c..11fd41a8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,92 +1,92 @@ -# Product Documents - -*** - - - -**M5Core** - -[![basic_01.jpg](https://i.loli.net/2018/12/13/5c121478df534.jpg)](en/core/basic)[![gray_01.jpg](https://i.loli.net/2018/12/13/5c1214ef29949.jpg)](en/core/gray)[![product_pic_fire.jpg](https://i.loli.net/2018/12/13/5c121562a65be.jpg)](en/core/fire) - -**MiniCore** - -[![m5stick_01.jpg](https://i.loli.net/2018/12/13/5c12158935965.jpg)](en/core/m5stick) - - - -**Kit** - -[![m5go_01.png](https://i.loli.net/2018/12/13/5c12159c9c2aa.png)](en/core/m5go_iot_starter_kit)[![face_kit_01.jpg](https://i.loli.net/2018/12/13/5c1215b26d803.jpg)](en/core/face_kit) - - - -*** - - - -**Communication Modules** - -[![gps_01.jpg](https://i.loli.net/2018/12/13/5c12160039059.jpg)](en/module/gps) [![lora_01.jpg](https://i.loli.net/2018/12/13/5c12161755792.jpg)](en/module/lora) [![lorawan_01.jpg](https://i.loli.net/2018/12/13/5c1216c437a6c.jpg)](en/module/lorawan) [![sim800_01.jpg](https://i.loli.net/2018/12/13/5c12165b1bc66.jpg)](en/module/sim800) - -[![commu_01.jpg](https://i.loli.net/2018/12/13/5c121675145ca.jpg)](en/module/commu) - - - - - -**Expansion Modules** - -[![battery_01.jpg](https://i.loli.net/2018/12/13/5c121754d1485.jpg)](en/module/battery)[![proto_01.jpg](https://i.loli.net/2018/12/13/5c12175690f25.jpg)](en/module/proto)[![plus_1.png](https://i.loli.net/2018/12/13/5c121789cd9f9.png)](en/module/plus) - - - -**Drive Modules** - -[![stepmotor_01.jpg](https://i.loli.net/2018/12/13/5c1217aa25a91.jpg)](en/module/stepmotor)[![servo_01.jpg](https://i.loli.net/2018/12/13/5c1217abb1cd9.jpg)](en/module/servo) - - - - - -*** - - - -[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](en/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](en/base/node_base) - - - -*** - - - -**Input/Sensing Unit** - -[![M5GO_Unit_env.png](https://i.loli.net/2018/12/13/5c12229aed8e7.png)](en/unit/env) [![M5GO_Unit_ir.png](https://i.loli.net/2018/12/13/5c1222c75a47c.png)](en/unit/ir) [![M5GO_Unit_pir.png](https://i.loli.net/2018/12/13/5c1222b138916.png)](en/unit/pir) [![M5GO_Unit_angle.png](https://i.loli.net/2018/12/13/5c1219eb78c21.png)](en/unit/angle) - -[![M5GO_Unit_adc.png](https://i.loli.net/2018/12/13/5c12192a6110d.png)](en/unit/adc)[![M5GO_Unit_dac.png](https://i.loli.net/2018/12/13/5c1219d495a9a.png)](en/unit/dac)[![M5GO_Unit_button.png](https://i.loli.net/2018/12/13/5c121a068c209.png)](en/unit/button)[![M5GO_Unit_dual_button.png](https://i.loli.net/2018/12/13/5c121a1adfedb.png)](en/unit/dual_button) - -[![M5GO_Unit_joystick_01.png](https://i.loli.net/2018/12/13/5c121a8c96259.png)](en/unit/joystick)[![M5GO_Unit_earth_01.png](https://i.loli.net/2018/12/13/5c121a6619dd1.png)](en/unit/earth)[![M5GO_Unit_color.png](https://i.loli.net/2018/12/13/5c121a2debd7c.png)](en/unit/color)[![m5camera_01.png](https://i.loli.net/2018/12/13/5c1218b4d4a50.png)](en/unit/m5camera) - -[![M5GO_Unit_light_01.png](https://i.loli.net/2018/12/13/5c121db73426d.png)](en/unit/light)[![M5GO_Unit_makey.png](https://i.loli.net/2018/12/13/5c121dd514166.png)](en/unit/makey)[![M5GO_Unit_ncir.png](https://i.loli.net/2018/12/13/5c121df24f746.png)](en/unit/ncir)[![M5GO_Unit_thermal.png](https://i.loli.net/2018/12/13/5c121e38b72c9.png)](en/unit/thermal) - -[![M5GO_Unit_tof.png](https://i.loli.net/2018/12/13/5c121e5cd47e1.png)](en/unit/tof) - - -**Output/Controlling Unit** - -[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](en/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](en/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](en/unit/neopixel) - -**Interface Unit** - -[![M5GO_Unit_hub_01.png](https://i.loli.net/2018/12/13/5c121f970bb1f.png)](en/unit/hub)[![M5GO_Unit_3.96_01.png](https://i.loli.net/2018/12/13/5c121fac3607e.png)](en/unit/396port) -[![M5GO_Unit_proto_01.png](https://i.loli.net/2018/12/13/5c121e125b2fe.png)](en/unit/proto) - -*** - - - -[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](en/app/bala) [![lidarbot_01.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](en/app/lidarbot) - - +# Product Documents + +*** + + + +**M5Core** + +[![basic_01.jpg](https://i.loli.net/2018/12/13/5c121478df534.jpg)](en/core/basic)[![gray_01.jpg](https://i.loli.net/2018/12/13/5c1214ef29949.jpg)](en/core/gray)[![product_pic_fire.jpg](https://i.loli.net/2018/12/13/5c121562a65be.jpg)](en/core/fire) + +**MiniCore** + +[![m5stick_01.jpg](https://i.loli.net/2018/12/13/5c12158935965.jpg)](en/core/m5stick) + + + +**Kit** + +[![m5go_01.png](https://i.loli.net/2018/12/13/5c12159c9c2aa.png)](en/core/m5go_iot_starter_kit)[![face_kit_01.jpg](https://i.loli.net/2018/12/13/5c1215b26d803.jpg)](en/core/face_kit) + + + +*** + + + +**Communication Modules** + +[![gps_01.jpg](https://i.loli.net/2018/12/13/5c12160039059.jpg)](en/module/gps) [![lora_01.jpg](https://i.loli.net/2018/12/13/5c12161755792.jpg)](en/module/lora) [![lorawan_01.jpg](https://i.loli.net/2018/12/13/5c1216c437a6c.jpg)](en/module/lorawan) [![sim800_01.jpg](https://i.loli.net/2018/12/13/5c12165b1bc66.jpg)](en/module/sim800) + +[![commu_01.jpg](https://i.loli.net/2018/12/13/5c121675145ca.jpg)](en/module/commu) + + + + + +**Expansion Modules** + +[![battery_01.jpg](https://i.loli.net/2018/12/13/5c121754d1485.jpg)](en/module/battery)[![proto_01.jpg](https://i.loli.net/2018/12/13/5c12175690f25.jpg)](en/module/proto)[![plus_1.png](https://i.loli.net/2018/12/13/5c121789cd9f9.png)](en/module/plus) + + + +**Drive Modules** + +[![stepmotor_01.jpg](https://i.loli.net/2018/12/13/5c1217aa25a91.jpg)](en/module/stepmotor)[![servo_01.jpg](https://i.loli.net/2018/12/13/5c1217abb1cd9.jpg)](en/module/servo) + + + + + +*** + + + +[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](en/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](en/base/node_base) + + + +*** + + + +**Input/Sensing Unit** + +[![M5GO_Unit_env.png](https://i.loli.net/2018/12/13/5c12229aed8e7.png)](en/unit/env) [![M5GO_Unit_ir.png](https://i.loli.net/2018/12/13/5c1222c75a47c.png)](en/unit/ir) [![M5GO_Unit_pir.png](https://i.loli.net/2018/12/13/5c1222b138916.png)](en/unit/pir) [![M5GO_Unit_angle.png](https://i.loli.net/2018/12/13/5c1219eb78c21.png)](en/unit/angle) + +[![M5GO_Unit_adc.png](https://i.loli.net/2018/12/13/5c12192a6110d.png)](en/unit/adc)[![M5GO_Unit_dac.png](https://i.loli.net/2018/12/13/5c1219d495a9a.png)](en/unit/dac)[![M5GO_Unit_button.png](https://i.loli.net/2018/12/13/5c121a068c209.png)](en/unit/button)[![M5GO_Unit_dual_button.png](https://i.loli.net/2018/12/13/5c121a1adfedb.png)](en/unit/dual_button) + +[![M5GO_Unit_joystick_01.png](https://i.loli.net/2018/12/13/5c121a8c96259.png)](en/unit/joystick)[![M5GO_Unit_earth_01.png](https://i.loli.net/2018/12/13/5c121a6619dd1.png)](en/unit/earth)[![M5GO_Unit_color.png](https://i.loli.net/2018/12/13/5c121a2debd7c.png)](en/unit/color)[![m5camera_01.png](https://i.loli.net/2018/12/13/5c1218b4d4a50.png)](en/unit/m5camera) + +[![M5GO_Unit_light_01.png](https://i.loli.net/2018/12/13/5c121db73426d.png)](en/unit/light)[![M5GO_Unit_makey.png](https://i.loli.net/2018/12/13/5c121dd514166.png)](en/unit/makey)[![M5GO_Unit_ncir.png](https://i.loli.net/2018/12/13/5c121df24f746.png)](en/unit/ncir)[![M5GO_Unit_thermal.png](https://i.loli.net/2018/12/13/5c121e38b72c9.png)](en/unit/thermal) + +[![M5GO_Unit_tof.png](https://i.loli.net/2018/12/13/5c121e5cd47e1.png)](en/unit/tof) + + +**Output/Controlling Unit** + +[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](en/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](en/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](en/unit/neopixel) + +**Interface Unit** + +[![M5GO_Unit_hub_01.png](https://i.loli.net/2018/12/13/5c121f970bb1f.png)](en/unit/hub)[![M5GO_Unit_3.96_01.png](https://i.loli.net/2018/12/13/5c121fac3607e.png)](en/unit/396port) +[![M5GO_Unit_proto_01.png](https://i.loli.net/2018/12/13/5c121e125b2fe.png)](en/unit/proto) + +*** + + + +[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](en/app/bala) [![lidarbot_01.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](en/app/lidarbot) + + \ No newline at end of file diff --git a/docs/ja/README.md b/docs/ja/README.md index e3f22e8c..2bdbdbce 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -1,88 +1,88 @@ -# 製品ドキュメント - -*** - - - -**M5コア** - -[![basic_01.jpg](https://i.loli.net/2018/12/13/5c121478df534.jpg)](ja/core/basic)[![gray_01.jpg](https://i.loli.net/2018/12/13/5c1214ef29949.jpg)](ja/core/gray)[![product_pic_fire.jpg](https://i.loli.net/2018/12/13/5c121562a65be.jpg)](ja/core/fire) - -**ミニコア** - -[![m5stick_01.jpg](https://i.loli.net/2018/12/13/5c12158935965.jpg)](ja/core/m5stick) - - - -**セット** - -[![m5go_01.png](https://i.loli.net/2018/12/13/5c12159c9c2aa.png)](ja/core/m5go_iot_starter_kit)[![face_kit_01.jpg](https://i.loli.net/2018/12/13/5c1215b26d803.jpg)](ja/core/face_kit) - - - -*** - - - -**通信モジュール** - -[![gps_01.jpg](https://i.loli.net/2018/12/13/5c12160039059.jpg)](ja/module/gps) [![lora_01.jpg](https://i.loli.net/2018/12/13/5c12161755792.jpg)](ja/module/lora) [![lorawan_01.jpg](https://i.loli.net/2018/12/13/5c1216c437a6c.jpg)](ja/module/lorawan) [![sim800_01.jpg](https://i.loli.net/2018/12/13/5c12165b1bc66.jpg)](ja/module/sim800) - -[![commu_01.jpg](https://i.loli.net/2018/12/13/5c121675145ca.jpg)](ja/module/commu) [![usb_01.jpg](https://i.loli.net/2018/12/13/5c1216928954a.jpg)](ja/module/usb) - - - -**拡張モジュール** - -[![battery_01.jpg](https://i.loli.net/2018/12/13/5c121754d1485.jpg)](ja/module/battery)[![proto_01.jpg](https://i.loli.net/2018/12/13/5c12175690f25.jpg)](ja/module/proto)[![plus_1.png](https://i.loli.net/2018/12/13/5c121789cd9f9.png)](ja/module/plus) - - - -**駆動モジュール** - -[![stepmotor_01.jpg](https://i.loli.net/2018/12/13/5c1217aa25a91.jpg)](ja/module/stepmotor)[![servo_01.jpg](https://i.loli.net/2018/12/13/5c1217abb1cd9.jpg)](ja/module/servo)[![lego+_01.jpg](https://i.loli.net/2018/12/13/5c1217c0e98b7.jpg)](ja/module/lego_plus) - - - -*** - - - -[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](ja/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](ja/base/node_base) - - - -*** - - - -**入力/センシングユニット** - -[![M5GO_Unit_env.png](https://i.loli.net/2018/12/13/5c12229aed8e7.png)](ja/unit/env) [![M5GO_Unit_ir.png](https://i.loli.net/2018/12/13/5c1222c75a47c.png)](ja/unit/ir) [![M5GO_Unit_pir.png](https://i.loli.net/2018/12/13/5c1222b138916.png)](ja/unit/pir) [![M5GO_Unit_angle.png](https://i.loli.net/2018/12/13/5c1219eb78c21.png)](ja/unit/angle) - -[![M5GO_Unit_adc.png](https://i.loli.net/2018/12/13/5c12192a6110d.png)](ja/unit/adc)[![M5GO_Unit_dac.png](https://i.loli.net/2018/12/13/5c1219d495a9a.png)](ja/unit/dac)[![M5GO_Unit_button.png](https://i.loli.net/2018/12/13/5c121a068c209.png)](ja/unit/button)[![M5GO_Unit_dual_button.png](https://i.loli.net/2018/12/13/5c121a1adfedb.png)](ja/unit/dual_button) - -[![M5GO_Unit_joystick_01.png](https://i.loli.net/2018/12/13/5c121a8c96259.png)](ja/unit/joystick)[![M5GO_Unit_earth_01.png](https://i.loli.net/2018/12/13/5c121a6619dd1.png)](ja/unit/earth)[![M5GO_Unit_color.png](https://i.loli.net/2018/12/13/5c121a2debd7c.png)](ja/unit/color)[![m5camera_01.png](https://i.loli.net/2018/12/13/5c1218b4d4a50.png)](ja/unit/m5camera) - -[![M5GO_Unit_light_01.png](https://i.loli.net/2018/12/13/5c121db73426d.png)](ja/unit/light)[![M5GO_Unit_makey.png](https://i.loli.net/2018/12/13/5c121dd514166.png)](ja/unit/makey)[![M5GO_Unit_ncir.png](https://i.loli.net/2018/12/13/5c121df24f746.png)](ja/unit/ncir)[![M5GO_Unit_thermal.png](https://i.loli.net/2018/12/13/5c121e38b72c9.png)](ja/unit/thermal) - -[![M5GO_Unit_tof.png](https://i.loli.net/2018/12/13/5c121e5cd47e1.png)](ja/unit/tof) - - -**出力/制御ユニット** - -[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](ja/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](ja/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](ja/unit/neopixel) - -**インターフェースユニット** - -[![M5GO_Unit_hub_01.png](https://i.loli.net/2018/12/13/5c121f970bb1f.png)](ja/unit/hub)[![M5GO_Unit_3.96_01.png](https://i.loli.net/2018/12/13/5c121fac3607e.png)](ja/unit/396port) -[![M5GO_Unit_proto_01.png](https://i.loli.net/2018/12/13/5c121e125b2fe.png)](ja/unit/proto) - -*** - - - -[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](ja/app/bala) [![lidarbot_01.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](ja/app/lidarbot) - - +# 製品ドキュメント + +*** + + + +**M5コア** + +[![basic_01.jpg](https://i.loli.net/2018/12/13/5c121478df534.jpg)](ja/core/basic)[![gray_01.jpg](https://i.loli.net/2018/12/13/5c1214ef29949.jpg)](ja/core/gray)[![product_pic_fire.jpg](https://i.loli.net/2018/12/13/5c121562a65be.jpg)](ja/core/fire) + +**ミニコア** + +[![m5stick_01.jpg](https://i.loli.net/2018/12/13/5c12158935965.jpg)](ja/core/m5stick) + + + +**セット** + +[![m5go_01.png](https://i.loli.net/2018/12/13/5c12159c9c2aa.png)](ja/core/m5go_iot_starter_kit)[![face_kit_01.jpg](https://i.loli.net/2018/12/13/5c1215b26d803.jpg)](ja/core/face_kit) + + + +*** + + + +**通信モジュール** + +[![gps_01.jpg](https://i.loli.net/2018/12/13/5c12160039059.jpg)](ja/module/gps) [![lora_01.jpg](https://i.loli.net/2018/12/13/5c12161755792.jpg)](ja/module/lora) [![lorawan_01.jpg](https://i.loli.net/2018/12/13/5c1216c437a6c.jpg)](ja/module/lorawan) [![sim800_01.jpg](https://i.loli.net/2018/12/13/5c12165b1bc66.jpg)](ja/module/sim800) + +[![commu_01.jpg](https://i.loli.net/2018/12/13/5c121675145ca.jpg)](ja/module/commu) [![usb_01.jpg](https://i.loli.net/2018/12/13/5c1216928954a.jpg)](ja/module/usb) + + + +**拡張モジュール** + +[![battery_01.jpg](https://i.loli.net/2018/12/13/5c121754d1485.jpg)](ja/module/battery)[![proto_01.jpg](https://i.loli.net/2018/12/13/5c12175690f25.jpg)](ja/module/proto)[![plus_1.png](https://i.loli.net/2018/12/13/5c121789cd9f9.png)](ja/module/plus) + + + +**駆動モジュール** + +[![stepmotor_01.jpg](https://i.loli.net/2018/12/13/5c1217aa25a91.jpg)](ja/module/stepmotor)[![servo_01.jpg](https://i.loli.net/2018/12/13/5c1217abb1cd9.jpg)](ja/module/servo)[![lego+_01.jpg](https://i.loli.net/2018/12/13/5c1217c0e98b7.jpg)](ja/module/lego_plus) + + + +*** + + + +[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](ja/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](ja/base/node_base) + + + +*** + + + +**入力/センシングユニット** + +[![M5GO_Unit_env.png](https://i.loli.net/2018/12/13/5c12229aed8e7.png)](ja/unit/env) [![M5GO_Unit_ir.png](https://i.loli.net/2018/12/13/5c1222c75a47c.png)](ja/unit/ir) [![M5GO_Unit_pir.png](https://i.loli.net/2018/12/13/5c1222b138916.png)](ja/unit/pir) [![M5GO_Unit_angle.png](https://i.loli.net/2018/12/13/5c1219eb78c21.png)](ja/unit/angle) + +[![M5GO_Unit_adc.png](https://i.loli.net/2018/12/13/5c12192a6110d.png)](ja/unit/adc)[![M5GO_Unit_dac.png](https://i.loli.net/2018/12/13/5c1219d495a9a.png)](ja/unit/dac)[![M5GO_Unit_button.png](https://i.loli.net/2018/12/13/5c121a068c209.png)](ja/unit/button)[![M5GO_Unit_dual_button.png](https://i.loli.net/2018/12/13/5c121a1adfedb.png)](ja/unit/dual_button) + +[![M5GO_Unit_joystick_01.png](https://i.loli.net/2018/12/13/5c121a8c96259.png)](ja/unit/joystick)[![M5GO_Unit_earth_01.png](https://i.loli.net/2018/12/13/5c121a6619dd1.png)](ja/unit/earth)[![M5GO_Unit_color.png](https://i.loli.net/2018/12/13/5c121a2debd7c.png)](ja/unit/color)[![m5camera_01.png](https://i.loli.net/2018/12/13/5c1218b4d4a50.png)](ja/unit/m5camera) + +[![M5GO_Unit_light_01.png](https://i.loli.net/2018/12/13/5c121db73426d.png)](ja/unit/light)[![M5GO_Unit_makey.png](https://i.loli.net/2018/12/13/5c121dd514166.png)](ja/unit/makey)[![M5GO_Unit_ncir.png](https://i.loli.net/2018/12/13/5c121df24f746.png)](ja/unit/ncir)[![M5GO_Unit_thermal.png](https://i.loli.net/2018/12/13/5c121e38b72c9.png)](ja/unit/thermal) + +[![M5GO_Unit_tof.png](https://i.loli.net/2018/12/13/5c121e5cd47e1.png)](ja/unit/tof) + + +**出力/制御ユニット** + +[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](ja/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](ja/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](ja/unit/neopixel) + +**インターフェースユニット** + +[![M5GO_Unit_hub_01.png](https://i.loli.net/2018/12/13/5c121f970bb1f.png)](ja/unit/hub)[![M5GO_Unit_3.96_01.png](https://i.loli.net/2018/12/13/5c121fac3607e.png)](ja/unit/396port) +[![M5GO_Unit_proto_01.png](https://i.loli.net/2018/12/13/5c121e125b2fe.png)](ja/unit/proto) + +*** + + + +[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](ja/app/bala) [![lidarbot_01.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](ja/app/lidarbot) + + \ No newline at end of file diff --git a/docs/ja/README_ja.md b/docs/ja/README_ja.md index 1e413d4c..fa8d6a54 100644 --- a/docs/ja/README_ja.md +++ b/docs/ja/README_ja.md @@ -1,53 +1,53 @@ -# M5Stack 公式ドキュメント - -[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) -[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fdocsify-themeable&hashtags=css,docsify,developers,frontend) -Star - -**M5Stackの世界へようこそ!** - -?> **ヒント** アンダーラインが引かれた部分はリンクになっています。 - - - -## 製品紹介 - -**M5Stackはモジュール積み重ねるタイプの開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。** - -**M5Stackは、開発の際の煩わしさやストレスを軽減し、あなたがあなた自身の新しい発明やアイデアを具現化することに集中出来るように設計されています。M5Stackはいくつかのセンサー、Wi-Fi、Bluetooth、スクリーン、電源を自身に備えており、従来のブレッドボードでの煩雑な配線作業を行わなくても、拡張モジュールを積み重ねたり、Groveコネクタを介して拡張ユニットを簡単に接続することが可能です。** - -M5Stack Coreモジュールは **ESP32** チップをベースに開発されています。 - -私たちの目標は "**Stackable Board is Product(積んで形に)**"です。オフィシャルサイトは [こちら](www.m5stack.com)です。 - - - - - -## コンタクト&サポート - -- :computer: 最新情報は[公式サイト](http://www.m5stack.com)(英語) -- :busts_in_silhouette: [フォーラム](http://forum.m5stack.com)にサインインしてM5Stackの情報交換をしよう -- :mailbox_with_mail: 質問・疑問は[Email](mailto:tech@m5stack.com) -- :convenience_store: 日本からの購入は[スイッチサイエンス](https://www.switch-science.com/catalog/list/770/)さんより - -## ライセンス - -このプロジェクトのライセンスは[MIT license](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE)です。 - -Copyright (c) 2018 M5Stack ([@M5Stack](https://twitter.com/M5Stack)) - - - +# M5Stack 公式ドキュメント + +[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) +[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fdocsify-themeable&hashtags=css,docsify,developers,frontend) +Star + +**M5Stackの世界へようこそ!** + +?> **ヒント** アンダーラインが引かれた部分はリンクになっています。 + + + +## 製品紹介 + +**M5Stackはモジュール積み重ねるタイプの開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。** + +**M5Stackは、開発の際の煩わしさやストレスを軽減し、あなたがあなた自身の新しい発明やアイデアを具現化することに集中出来るように設計されています。M5Stackはいくつかのセンサー、Wi-Fi、Bluetooth、スクリーン、電源を自身に備えており、従来のブレッドボードでの煩雑な配線作業を行わなくても、拡張モジュールを積み重ねたり、Groveコネクタを介して拡張ユニットを簡単に接続することが可能です。** + +M5Stack Coreモジュールは **ESP32** チップをベースに開発されています。 + +私たちの目標は "**Stackable Board is Product(積んで形に)**"です。オフィシャルサイトは [こちら](www.m5stack.com)です。 + + + + + +## コンタクト&サポート + +- :computer: 最新情報は[公式サイト](http://www.m5stack.com)(英語) +- :busts_in_silhouette: [フォーラム](http://forum.m5stack.com)にサインインしてM5Stackの情報交換をしよう +- :mailbox_with_mail: 質問・疑問は[Email](mailto:tech@m5stack.com) +- :convenience_store: 日本からの購入は[スイッチサイエンス](https://www.switch-science.com/catalog/list/770/)さんより + +## ライセンス + +このプロジェクトのライセンスは[MIT license](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE)です。 + +Copyright (c) 2018 M5Stack ([@M5Stack](https://twitter.com/M5Stack)) + + + diff --git a/docs/ja/accessory/cables/grove_cable.md b/docs/ja/accessory/cables/grove_cable.md index d68f76b0..2ab81747 100644 --- a/docs/ja/accessory/cables/grove_cable.md +++ b/docs/ja/accessory/cables/grove_cable.md @@ -1,17 +1,17 @@ -# GROVE ケーブル - -## 概要 - -(近日公開...) - -## 特徴 - -## ドキュメント - -
- grove_cable_01 -
- -## 関連情報 - +# GROVE ケーブル + +## 概要 + +(近日公開...) + +## 特徴 + +## ドキュメント + +
+ grove_cable_01 +
+ +## 関連情報 + - [GROVE-CABLE 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-4Pin-1-2-50-20-10/3226069_32949298454.html) \ No newline at end of file diff --git a/docs/ja/accessory/cables/lego_cable.md b/docs/ja/accessory/cables/lego_cable.md index 87b7a6cb..b4e6c2dc 100644 --- a/docs/ja/accessory/cables/lego_cable.md +++ b/docs/ja/accessory/cables/lego_cable.md @@ -1,21 +1,21 @@ -# LEGO-CABLE - - - -## 概要 - -LEGO-CABLEGROVEインターフェースでM5CoreとLEGOロボットコンポーネントが接続できるように設計されています。 - -## 特徴 - -- 3種類の長さ: 10cm, 20cm, 30cm - -## ドキュメント - -
- lego_cable_01 -
- -## 関連情報 - +# LEGO-CABLE + + + +## 概要 + +LEGO-CABLEGROVEインターフェースでM5CoreとLEGOロボットコンポーネントが接続できるように設計されています。 + +## 特徴 + +- 3種類の長さ: 10cm, 20cm, 30cm + +## ドキュメント + +
+ lego_cable_01 +
+ +## 関連情報 + - [LEGO-CABLE 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html) \ No newline at end of file diff --git a/docs/ja/accessory/frame.md b/docs/ja/accessory/frame.md index c9da984a..907258df 100644 --- a/docs/ja/accessory/frame.md +++ b/docs/ja/accessory/frame.md @@ -1,28 +1,28 @@ -# FRAME - - - -## 概要 - -FrameはM5Coreの固定フレームとして使用するために特別に設計されています。 - -## 特徴 - -## ドキュメント - -
- frame_01 -
-
- frame_02 -
-
- frame_03 -
-
- frame_04 -
- -## 関連情報 - +# FRAME + + + +## 概要 + +FrameはM5Coreの固定フレームとして使用するために特別に設計されています。 + +## 特徴 + +## ドキュメント + +
+ frame_01 +
+
+ frame_02 +
+
+ frame_03 +
+
+ frame_04 +
+ +## 関連情報 + - [FRAME 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) \ No newline at end of file diff --git a/docs/ja/accessory/headers_socket.md b/docs/ja/accessory/headers_socket.md index e30b2b64..a3c944f5 100644 --- a/docs/ja/accessory/headers_socket.md +++ b/docs/ja/accessory/headers_socket.md @@ -1,21 +1,21 @@ -# Headers Socket - -## 概要 - -(近日公開...) - -## 特徴 - -## ドキュメント - -
- headers_socket_01 -
-
- headers_socket_02 -
- -## 関連情報 - -- [Headers Socket 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3654/) -- [Headers Socket 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-2-15-2-54-4-M5Stack/3226069_32840923472.html) +# Headers Socket + +## 概要 + +(近日公開...) + +## 特徴 + +## ドキュメント + +
+ headers_socket_01 +
+
+ headers_socket_02 +
+ +## 関連情報 + +- [Headers Socket 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3654/) +- [Headers Socket 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-2-15-2-54-4-M5Stack/3226069_32840923472.html) diff --git a/docs/ja/accessory/usb_uart_adapter.md b/docs/ja/accessory/usb_uart_adapter.md index 2a84b4c7..16af745c 100644 --- a/docs/ja/accessory/usb_uart_adapter.md +++ b/docs/ja/accessory/usb_uart_adapter.md @@ -1,20 +1,20 @@ -# USB-TTL UART Serial Adapter - -## 概要 - -(近日公開...) - -## 特徴 - -## ドキュメント - -
- usb_ttl_01 -
-
- usb_ttl_02 -
- -## 関連情報 - +# USB-TTL UART Serial Adapter + +## 概要 + +(近日公開...) + +## 特徴 + +## ドキュメント + +
+ usb_ttl_01 +
+
+ usb_ttl_02 +
+ +## 関連情報 + - [USB-TTL UART Serial Adapter 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ttl-uart-6-c-usb/3226069_32874729163.html) \ No newline at end of file diff --git a/docs/ja/api.md b/docs/ja/api.md index 6b1ea7b4..31298055 100644 --- a/docs/ja/api.md +++ b/docs/ja/api.md @@ -1,7 +1,7 @@ -# API リファレンス - - - -| MicroPython | Arduino | -|:------------|:--------| +# API リファレンス + + + +| MicroPython | Arduino | +|:------------|:--------| |[LCD](ja/api_reference/micropython/api_lcd) | [LCD](ja/api_reference/arduino/api_lcd) | \ No newline at end of file diff --git a/docs/ja/api/gpio.md b/docs/ja/api/gpio.md index 2e579178..15691d25 100644 --- a/docs/ja/api/gpio.md +++ b/docs/ja/api/gpio.md @@ -1,23 +1,23 @@ -# GPIO - - - -*Refer to GPIO API of [Arduino](http://www.arduino.cc)* - -### digitalRead -> uint32 digitalRead(uint8 pin); - -Read the value of `pin` - -| Param | Type | Description | -| --- | --- | --- | -| pin | uint8 | the number of pin | - -Return: - digital level(0/1) - -**Example** -```c++ -uint32_t pin21_data; -pin21_data = digitalRead(21); +# GPIO + + + +*Refer to GPIO API of [Arduino](http://www.arduino.cc)* + +### digitalRead +> uint32 digitalRead(uint8 pin); + +Read the value of `pin` + +| Param | Type | Description | +| --- | --- | --- | +| pin | uint8 | the number of pin | + +Return: + digital level(0/1) + +**Example** +```c++ +uint32_t pin21_data; +pin21_data = digitalRead(21); ``` \ No newline at end of file diff --git a/docs/ja/api/lcd.md b/docs/ja/api/lcd.md index 35b5a0a9..0dd6d6a8 100644 --- a/docs/ja/api/lcd.md +++ b/docs/ja/api/lcd.md @@ -1,245 +1,245 @@ -# LCD - - - -### lcd.setRotation(degree) - -**画面全体の回転角度を設定します。** - -| パラメータ | 説明 | -|:---|:---| -| degree | 回転角度 | - -**使用例** - -```python -lcd.setRotation(90) -``` - ---- - -### lcd.setColor(color [, background_color]) - -**テキストの色と背景色を設定します。** - -| パラメータ | 説明 | -| :--- | :--- | -| color | テキストの色 | -| background_color| テキストの背景色 | - -**使用例** - -```python -lcd.setColor(lcd.RED) -lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) -``` - ---- - -### lcd.fillScreen(color) - -**画面全体を指定した色で塗りつぶします。** - -| パラメータ | 説明 | -|:--- | :--- | -| color | 塗りつぶしの色 | - -**使用例** - -```python -lcd.fillScreen(lcd.RED) -``` - ---- - -### lcd.drawPixel(x, y [,color]) - -**(x,y)の位置に点（ピクセル）を描画します。** - -*色の指定がない場合は、現在設定されている前景色が使用されます。* - -| パラメータ | 説明 | -| :--- | :--- | -| x | 点のx座標 | -| y | 点のy座標 | -| color | 点の色 | - -**使用例** - -```python -lcd.drawPixel(22, 22, lcd.RED) -``` - ---- - -### lcd.drawLine(x, y, x1, y1 [,color]) - -**点(x,y) から 点(x1,y1) へ直線を描画します。** - -*色の指定がない場合は、現在設定されている前景色が使用されます。* - -| パラメータ | 説明 | -| :--- | :--- | -| x | 線の始点のx座標 | -| y | 線の始点のy座標 | -| x1 | 線の終点のx1座標 | -| y1 | 線の終点のy1座標 | -| color | 線の色 | - -**使用例** - -```python -lcd.drawLine(0, 0, 12, 12, lcd.WHITE) -``` - ---- - -### lcd.drawTriangle(x, y, x1, y1, x2, y2 [,color]) - -**3つの頂点 (x,y), (x1,y1), (x2,y2) を持つ三角形を描画します。** - -*色の指定がない場合は、現在設定されている前景色が使用されます。* - -| パラメータ | 説明 | -| :--- | :--- | -| x | 三角形の頂点0のx座標 | -| y | 三角形の頂点0のy座標 | -| x1 | 三角形の頂点1のx座標 | -| y1 | 三角形の頂点1のy座標 | -| x2 | 三角形の頂点2のx座標 | -| y2 | 三角形の頂点2のy座標 | -| color | 三角形の線の色 | - -**使用例** - -```python -lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) -``` - ---- - -### lcd.fillTriangle(x, y, x1, y1, x2, y2 [,color]) - -**3つの頂点 (x,y), (x1,y1), (x2,y2) を持つ三角形を塗りつぶします。** - -*色の指定がない場合は、現在設定されている前景色が使用されます。* - -| パラメータ | 説明 | -| :--- | :--- | -| x | 三角形の頂点0のx座標 | -| y | 三角形の頂点0のy座標 | -| x1 | 三角形の頂点1のx座標 | -| y1 | 三角形の頂点1のy座標 | -| x2 | 三角形の頂点2のx座標 | -| y2 | 三角形の頂点2のy座標 | -| color | 三角形の色 | - -**使用例** - -```python -lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) -``` - ---- - -### lcd.drawRect(x, y, w, h, [,color]) - -**左上の点(x,y)と幅と高さを指定して、四角形を描画します。** - -*色の指定がない場合は、現在設定されている前景色が使用されます。* - -| パラメータ | 説明 | -| :--- | :--- | -| x | 四角形の左上の頂点のx座標 | -| y | 四角形の左上の頂点のy座標 | -| w | 四角形の幅 | -| h | 四角形の高さ | -| color | 四角形の線の色 | - -**使用例** - -```python -lcd.drawRect(180, 12, 122, 10, lcd.BLUE) -``` - ---- - -### lcd.drawRoundRect(x, y, w, h, r [,color]) - -**左上の点(x,y)と幅と高さを指定して、かど丸の四角形を描画します。** - -*色の指定がない場合は、現在設定されている前景色が使用されます。* - -| パラメータ | 説明 | -| :--- | :--- | -| x | 四角形の左上の頂点のx座標 | -| y | 四角形の左上の頂点のy座標 | -| w | 四角形の幅 | -| h | 四角形の高さ | -| r | コーナー半径 | -| color | 四角形の線の色 | - -**使用例** - -```python -lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) -``` - ---- - -### lcd.print(‘text’, [x, y]) - -**位置(x,y)にテキストを表示します。** - -| パラメータ | 説明 | -| :--- | :--- | -| text | 表示するテキスト | -| x | テキストを表示する位置のx座標 | -| y | テキストを表示する位置のy座標 | - -**使用例** - -```python -lcd.print('this is a print text function', 80, 80) -``` - ---- - -### lcd.clear([color]) - -**デフォルトの背景色、または指定の色で画面を塗りつぶします。** - -| パラメータ | 説明 | -| :--- | :--- | -| color | 塗りつぶしの色 | - -**使用例** - -```python -lcd.clear(lcd.WHITE) -``` - ---- - -### 使い方 - -```python -from machine import SPI, Pin -from display import LCD - -spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) - -lcd = LCD(spi = spi) # lcd 初期化 -lcd.fillScreen(lcd.BLACK) # デフォルトの背景色を設定 - -lcd.drawLine(0, 0, lcd.WHITE) -lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) -lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) -lcd.drawCircle(180, 180, 10, lcd.BLUE) -lcd.fillcircle(100, 100, 10, lcd.BLUE) -lcd.drawRect(180, 12, 122, 10, lcd.BLUE) -lcd.fillRect(180, 30, 122, 10, lcd.BLUE) -lcd.drawRoundRect(180, 50, 122, 10, 4, lcd.BLUE) -lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) -lcd.print('this is a print text function', 80, 80) -``` +# LCD + + + +### lcd.setRotation(degree) + +**画面全体の回転角度を設定します。** + +| パラメータ | 説明 | +|:---|:---| +| degree | 回転角度 | + +**使用例** + +```python +lcd.setRotation(90) +``` + +--- + +### lcd.setColor(color [, background_color]) + +**テキストの色と背景色を設定します。** + +| パラメータ | 説明 | +| :--- | :--- | +| color | テキストの色 | +| background_color| テキストの背景色 | + +**使用例** + +```python +lcd.setColor(lcd.RED) +lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) +``` + +--- + +### lcd.fillScreen(color) + +**画面全体を指定した色で塗りつぶします。** + +| パラメータ | 説明 | +|:--- | :--- | +| color | 塗りつぶしの色 | + +**使用例** + +```python +lcd.fillScreen(lcd.RED) +``` + +--- + +### lcd.drawPixel(x, y [,color]) + +**(x,y)の位置に点（ピクセル）を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 点のx座標 | +| y | 点のy座標 | +| color | 点の色 | + +**使用例** + +```python +lcd.drawPixel(22, 22, lcd.RED) +``` + +--- + +### lcd.drawLine(x, y, x1, y1 [,color]) + +**点(x,y) から 点(x1,y1) へ直線を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 線の始点のx座標 | +| y | 線の始点のy座標 | +| x1 | 線の終点のx1座標 | +| y1 | 線の終点のy1座標 | +| color | 線の色 | + +**使用例** + +```python +lcd.drawLine(0, 0, 12, 12, lcd.WHITE) +``` + +--- + +### lcd.drawTriangle(x, y, x1, y1, x2, y2 [,color]) + +**3つの頂点 (x,y), (x1,y1), (x2,y2) を持つ三角形を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 三角形の頂点0のx座標 | +| y | 三角形の頂点0のy座標 | +| x1 | 三角形の頂点1のx座標 | +| y1 | 三角形の頂点1のy座標 | +| x2 | 三角形の頂点2のx座標 | +| y2 | 三角形の頂点2のy座標 | +| color | 三角形の線の色 | + +**使用例** + +```python +lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) +``` + +--- + +### lcd.fillTriangle(x, y, x1, y1, x2, y2 [,color]) + +**3つの頂点 (x,y), (x1,y1), (x2,y2) を持つ三角形を塗りつぶします。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 三角形の頂点0のx座標 | +| y | 三角形の頂点0のy座標 | +| x1 | 三角形の頂点1のx座標 | +| y1 | 三角形の頂点1のy座標 | +| x2 | 三角形の頂点2のx座標 | +| y2 | 三角形の頂点2のy座標 | +| color | 三角形の色 | + +**使用例** + +```python +lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) +``` + +--- + +### lcd.drawRect(x, y, w, h, [,color]) + +**左上の点(x,y)と幅と高さを指定して、四角形を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 四角形の左上の頂点のx座標 | +| y | 四角形の左上の頂点のy座標 | +| w | 四角形の幅 | +| h | 四角形の高さ | +| color | 四角形の線の色 | + +**使用例** + +```python +lcd.drawRect(180, 12, 122, 10, lcd.BLUE) +``` + +--- + +### lcd.drawRoundRect(x, y, w, h, r [,color]) + +**左上の点(x,y)と幅と高さを指定して、かど丸の四角形を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 四角形の左上の頂点のx座標 | +| y | 四角形の左上の頂点のy座標 | +| w | 四角形の幅 | +| h | 四角形の高さ | +| r | コーナー半径 | +| color | 四角形の線の色 | + +**使用例** + +```python +lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) +``` + +--- + +### lcd.print(‘text’, [x, y]) + +**位置(x,y)にテキストを表示します。** + +| パラメータ | 説明 | +| :--- | :--- | +| text | 表示するテキスト | +| x | テキストを表示する位置のx座標 | +| y | テキストを表示する位置のy座標 | + +**使用例** + +```python +lcd.print('this is a print text function', 80, 80) +``` + +--- + +### lcd.clear([color]) + +**デフォルトの背景色、または指定の色で画面を塗りつぶします。** + +| パラメータ | 説明 | +| :--- | :--- | +| color | 塗りつぶしの色 | + +**使用例** + +```python +lcd.clear(lcd.WHITE) +``` + +--- + +### 使い方 + +```python +from machine import SPI, Pin +from display import LCD + +spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) + +lcd = LCD(spi = spi) # lcd 初期化 +lcd.fillScreen(lcd.BLACK) # デフォルトの背景色を設定 + +lcd.drawLine(0, 0, lcd.WHITE) +lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) +lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) +lcd.drawCircle(180, 180, 10, lcd.BLUE) +lcd.fillcircle(100, 100, 10, lcd.BLUE) +lcd.drawRect(180, 12, 122, 10, lcd.BLUE) +lcd.fillRect(180, 30, 122, 10, lcd.BLUE) +lcd.drawRoundRect(180, 50, 122, 10, 4, lcd.BLUE) +lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) +lcd.print('this is a print text function', 80, 80) +``` diff --git a/docs/ja/api/speaker.md b/docs/ja/api/speaker.md index 83b5a142..418fdf05 100644 --- a/docs/ja/api/speaker.md +++ b/docs/ja/api/speaker.md @@ -1,17 +1,17 @@ -# Speaker - - - -### tone -> M5.Speaker.tone(uint32_t freq); - -Set the pitch of speaker. - -| Param | Type | Description | -| --- | --- | --- | -| freq | uint32_t | frequency | - -**Example** -```c++ -M5.Speaker.tone(100); +# Speaker + + + +### tone +> M5.Speaker.tone(uint32_t freq); + +Set the pitch of speaker. + +| Param | Type | Description | +| --- | --- | --- | +| freq | uint32_t | frequency | + +**Example** +```c++ +M5.Speaker.tone(100); ``` \ No newline at end of file diff --git a/docs/ja/app/bala.md b/docs/ja/app/bala.md index 12a31d92..2781f36b 100644 --- a/docs/ja/app/bala.md +++ b/docs/ja/app/bala.md @@ -1,91 +1,91 @@ -# M5BALA - - - -## 概要 - -**M5BALA**はM5Stack Fireに対応したバランスカーモジュールです。Arduino UNOなどにも使われているATmega328PチップをベースにしたDCモータx2のドライバモジュールを備えています。 -**Arduino**や**MicroPython**を使用して、M5BALAをコントロールするプログラムを簡単に書くことが可能です。 - -このDCモータドライバモジュールとM5BALAは**I2C**で接続されており、M5Stack Fire側からコントロールすることができます。I2Cアドレスは**0x56**です。 - -## 特徴 - -- プログラミングサポート - - Arduino - - MicroPython -- LEGO 互換ホール -- POGO ピン -- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート - -## スペック - -|項目|詳細| -|:---|:---| -|対応 Core | M5Stack FIRE ※M5BALAには含まれません| -|ESP32| 240MHz x 2コア, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモード Bluetooth| -|Flash| 16MB Flash + 4MB pSRAM| -|電源入力 | 5V @ 500mA| -|インターフェース | USB Type-C x 1, Grove(I2C+I/0+UART), Pogoピン x 1| -|画面 | 2 inch, 320x240 Colorful TFT LCD, ILI9342| -|スピーカー | 1W-0928| -|マイク | MEMS Analog BSE3729 Microphone| -|LED | SK6812 3535 RGB LED x 10| -|MEMS | MPU9250 (MPU6500 + AK8963)| -|電池 | 550mAh @ 3.7V 内蔵| -|動作温度 | 32°F to 104°F ( 0°C to 40°C )| -|サイズ | 54 x 54 x 21 mm| -|ケース | プラスチック ( PC )| -|重量 | 56g| - -## パッケージ内容 - -- 1x M5BALA -- 1x モータドライバ -- 2x N20 DCギヤモータ(エンコーダ内蔵) -- USB Type-C ケーブル - -※動作に必要な**M5Stack FIRE**は本製品(M5BALA)には含まれません。別途お買い求めください。| - -## ドキュメント - -- **サンプルコード** - - [Arduino版](https://github.com/m5stack/M5Bala/tree/master/examples) - - [MicroPython版](https://github.com/m5stack/M5Bala/tree/master/mpy) - -- **GitHub** - - [M5Bala](https://github.com/m5stack/M5Bala) - -- **クイックスタート** - - [M5Balaクイックスタート](/ja/quick_start/bala/bala_quick_start) - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -## 関連情報 - -- [M5BALA 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3995/) -- [M5Stack FIRE 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3953/) -- [M5BALA 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Satck-BALA-ESP32-2DC-PSRAM-MPU9250-BLE/3226069_32904033658.html) -- [M5Stack FIRE 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-PSRAM-2-0-IoT-ESP32-16M-FLash-4M-PSRAM-BLE/3226069_32847906756.html) -- [LEGO-CABLE 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html) -- [MPU9250 データシート](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) -- [MPU9250 レジスタマップ](https://www.invensense.com/wp-content/uploads/2015/02/RM-MPU-9250A-00-v1.6.pdf) +# M5BALA + + + +## 概要 + +**M5BALA**はM5Stack Fireに対応したバランスカーモジュールです。Arduino UNOなどにも使われているATmega328PチップをベースにしたDCモータx2のドライバモジュールを備えています。 +**Arduino**や**MicroPython**を使用して、M5BALAをコントロールするプログラムを簡単に書くことが可能です。 + +このDCモータドライバモジュールとM5BALAは**I2C**で接続されており、M5Stack Fire側からコントロールすることができます。I2Cアドレスは**0x56**です。 + +## 特徴 + +- プログラミングサポート + - Arduino + - MicroPython +- LEGO 互換ホール +- POGO ピン +- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート + +## スペック + +|項目|詳細| +|:---|:---| +|対応 Core | M5Stack FIRE ※M5BALAには含まれません| +|ESP32| 240MHz x 2コア, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモード Bluetooth| +|Flash| 16MB Flash + 4MB pSRAM| +|電源入力 | 5V @ 500mA| +|インターフェース | USB Type-C x 1, Grove(I2C+I/0+UART), Pogoピン x 1| +|画面 | 2 inch, 320x240 Colorful TFT LCD, ILI9342| +|スピーカー | 1W-0928| +|マイク | MEMS Analog BSE3729 Microphone| +|LED | SK6812 3535 RGB LED x 10| +|MEMS | MPU9250 (MPU6500 + AK8963)| +|電池 | 550mAh @ 3.7V 内蔵| +|動作温度 | 32°F to 104°F ( 0°C to 40°C )| +|サイズ | 54 x 54 x 21 mm| +|ケース | プラスチック ( PC )| +|重量 | 56g| + +## パッケージ内容 + +- 1x M5BALA +- 1x モータドライバ +- 2x N20 DCギヤモータ(エンコーダ内蔵) +- USB Type-C ケーブル + +※動作に必要な**M5Stack FIRE**は本製品(M5BALA)には含まれません。別途お買い求めください。| + +## ドキュメント + +- **サンプルコード** + - [Arduino版](https://github.com/m5stack/M5Bala/tree/master/examples) + - [MicroPython版](https://github.com/m5stack/M5Bala/tree/master/mpy) + +- **GitHub** + - [M5Bala](https://github.com/m5stack/M5Bala) + +- **クイックスタート** + - [M5Balaクイックスタート](/ja/quick_start/bala/bala_quick_start) + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +## 関連情報 + +- [M5BALA 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3995/) +- [M5Stack FIRE 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3953/) +- [M5BALA 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Satck-BALA-ESP32-2DC-PSRAM-MPU9250-BLE/3226069_32904033658.html) +- [M5Stack FIRE 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-PSRAM-2-0-IoT-ESP32-16M-FLash-4M-PSRAM-BLE/3226069_32847906756.html) +- [LEGO-CABLE 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html) +- [MPU9250 データシート](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) +- [MPU9250 レジスタマップ](https://www.invensense.com/wp-content/uploads/2015/02/RM-MPU-9250A-00-v1.6.pdf) - [AK8963 データシート](https://strawberry-linux.com/pub/AK8963.pdf) \ No newline at end of file diff --git a/docs/ja/app/lidarbot.md b/docs/ja/app/lidarbot.md index 9eb2e498..20306014 100644 --- a/docs/ja/app/lidarbot.md +++ b/docs/ja/app/lidarbot.md @@ -1,99 +1,99 @@ -# LidarBOT - - - -## 概要 - -**LidarBOT** は室内ナビゲーション用の四輪車です。 本体にはライダーセンサー、4つのメカナムホイール、ATmega328pベースのボトムボード、２つのフルカラーLEDバー、LEGO互換ホール、そしてメインコントローラーとしてM5Stackが装備されています。 - -ESP-NOWを利用したリアルタイム通信により、リモコンでLidarBOTを操作することができます。制御信号を受信した後、指定のプロトコルで各ホイールとRGBバーを制御することができます。 - -またリモコンによる前後左右のコントロールだけでなく、搭載されているM5Coreのディスプレイに、ライダーセンサーで読み取った地形マップを表示することができます。 - -## 特徴 - -- ライダー性能: 8m @ 6Hz -- プログラミングサポート - - Arduino -- LEGO 互換ホール -- [メカナムホイール](https://en.wikipedia.org/wiki/Mecanum_wheel) - -## プロトコル - -*データフォーマット：データヘッダ(コマンドタイプ) + データパケット + データテール* - -| ターゲット | データフォーマット | -|:-------------------|:------------------------------------------| -| ホイール |0xAA, SpeedX, SpeedY, SpeedZ, SpeedA, 0x55 | -| 各LED |0xAB, LedIndex, R, G, B, 0x55 | -| フロントLEDバー |0xAC, R, G, B, 0x55 | -| バックLEDバー |0xAD, R,G,B, 0x55 | -| 全てのLED |0xAE, R,G,B, 0x55 | -| サーボモーター0 |0xAF, Angle, 0x55 | -| サーボモーター1 |0xB0, Angle, 0x55 | - -## シリアル通信パラメータ - -| ターゲット | ピン @ M5Stack | ボーレート | シリアルパラメータ | -|:-----------|:--------------|:----------|:----------------| -| Lidar | GPIO16 (RX) | 230,400 | SERIAL_8N1 (8 bits data / non parity / 1 stop bit) | -| ボトムボード | GPIO17 (TX) | 115,200 | SERIAL_8N1 (8 bits data / non parity / 1 stop bit) | - -## ピンマップ（ボトム） - -| 対象 | ピン @ ATmega328 | -|:--------------|:----------------| -| サーボモーター0 | A0 | -| サーボモーター1 | A1 | -| Neopixel | 11 | - -## パッケージ内容 - -- 1x LidarBot -- 1x リモコンハンドル -- 2x バッテリー(1300mAh @ 11.1V) -- 1x 充電器 -- 1x USB Type-Cケーブル - -## アプリケーション - -- 室内ナビゲーション -- 自動迷路探索 -- ルートプラン -- 自動操縦 - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example) - - MicroPython - -- **GitHub** - - [LidarBOT](https://github.com/m5stack/Applications-LidarBot) - -- **クイックスタート** - - 近日公開予定 - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -## 関連情報 - -- [LidarBOT 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-Lidar-Lidar-8m-6-McNamm-NeoPixel-LED-ESP32-arduino-Micropython/3226069_32951134988.html) +# LidarBOT + + + +## 概要 + +**LidarBOT** は室内ナビゲーション用の四輪車です。 本体にはライダーセンサー、4つのメカナムホイール、ATmega328pベースのボトムボード、２つのフルカラーLEDバー、LEGO互換ホール、そしてメインコントローラーとしてM5Stackが装備されています。 + +ESP-NOWを利用したリアルタイム通信により、リモコンでLidarBOTを操作することができます。制御信号を受信した後、指定のプロトコルで各ホイールとRGBバーを制御することができます。 + +またリモコンによる前後左右のコントロールだけでなく、搭載されているM5Coreのディスプレイに、ライダーセンサーで読み取った地形マップを表示することができます。 + +## 特徴 + +- ライダー性能: 8m @ 6Hz +- プログラミングサポート + - Arduino +- LEGO 互換ホール +- [メカナムホイール](https://en.wikipedia.org/wiki/Mecanum_wheel) + +## プロトコル + +*データフォーマット：データヘッダ(コマンドタイプ) + データパケット + データテール* + +| ターゲット | データフォーマット | +|:-------------------|:------------------------------------------| +| ホイール |0xAA, SpeedX, SpeedY, SpeedZ, SpeedA, 0x55 | +| 各LED |0xAB, LedIndex, R, G, B, 0x55 | +| フロントLEDバー |0xAC, R, G, B, 0x55 | +| バックLEDバー |0xAD, R,G,B, 0x55 | +| 全てのLED |0xAE, R,G,B, 0x55 | +| サーボモーター0 |0xAF, Angle, 0x55 | +| サーボモーター1 |0xB0, Angle, 0x55 | + +## シリアル通信パラメータ + +| ターゲット | ピン @ M5Stack | ボーレート | シリアルパラメータ | +|:-----------|:--------------|:----------|:----------------| +| Lidar | GPIO16 (RX) | 230,400 | SERIAL_8N1 (8 bits data / non parity / 1 stop bit) | +| ボトムボード | GPIO17 (TX) | 115,200 | SERIAL_8N1 (8 bits data / non parity / 1 stop bit) | + +## ピンマップ（ボトム） + +| 対象 | ピン @ ATmega328 | +|:--------------|:----------------| +| サーボモーター0 | A0 | +| サーボモーター1 | A1 | +| Neopixel | 11 | + +## パッケージ内容 + +- 1x LidarBot +- 1x リモコンハンドル +- 2x バッテリー(1300mAh @ 11.1V) +- 1x 充電器 +- 1x USB Type-Cケーブル + +## アプリケーション + +- 室内ナビゲーション +- 自動迷路探索 +- ルートプラン +- 自動操縦 + +## ドキュメント + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example) + - MicroPython + +- **GitHub** + - [LidarBOT](https://github.com/m5stack/Applications-LidarBot) + +- **クイックスタート** + - 近日公開予定 + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +## 関連情報 + +- [LidarBOT 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-Lidar-Lidar-8m-6-McNamm-NeoPixel-LED-ESP32-arduino-Micropython/3226069_32951134988.html) diff --git a/docs/ja/base/face_base.md b/docs/ja/base/face_base.md index d2a9ecd1..319f42a2 100644 --- a/docs/ja/base/face_base.md +++ b/docs/ja/base/face_base.md @@ -1,87 +1,87 @@ -# FACES ベース - - - -## 概要 - -**FACES**ベースはESP32互換の３つの異なるキーボードのセットです。(キーボード、ゲームパッド、電卓キー) - -**FACES**ベースを利用して、自作ゲームを作って遊んだり、リモコン電卓やリモートゲームコントローラーを作成することが可能です。 -また別売りの[JOYSTICK](https://www.aliexpress.com/store/product/M5Stack-M5-ESP32-X-Y-NeoPixel-LED/3226069_32949801245.html)を利用する事も可能です。 - -## 特徴 - -- プログラミングサポート - - Blockly - - Arduino - - MycroPython -- LEGO 互換ホール -- Nintendo エミュレータサポート -- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート - -## パッケージ内容 - -- 1x M5Stack GRAY -- 1x キーボード -- 1x ゲームパッド -- 1x 電卓キー -- 1x FACE ボトム -- 1x CHG ベース -- 1x USB Type-C ケーブル -- ユーザーマニュアル - -## アプリケーション - -- 自作ゲーム -- Nintendo エミュレータ -- テトリス -- 自作電卓 -- 自作ポケコン - -## ドキュメント - -- **回路図** - - [Schematic](https://github.com/m5stack/esp32-cam-demo/blob/m5cam/M5CAM-ESP32-A1-POWER.pdf) - -- **サンプルコード** - - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) - -- **データシート** - - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -- **GitHub** - - [Arduino](https://github.com/m5stack/M5Stack-nesemu) - -### FACES - -
- faces_01 -
-
- faces_02 -
-
- faces_03 -
-
- faces_04 -
-
- faces_05 -
- -### JOYSTICK - -
- faces_joystick_01 -
-
- faces_joystick_02 -
- -## 関連情報 - -- [FACES 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3649/) -- [FACES 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ESP32-micropython-arduino/3226069_32843973578.html) +# FACES ベース + + + +## 概要 + +**FACES**ベースはESP32互換の３つの異なるキーボードのセットです。(キーボード、ゲームパッド、電卓キー) + +**FACES**ベースを利用して、自作ゲームを作って遊んだり、リモコン電卓やリモートゲームコントローラーを作成することが可能です。 +また別売りの[JOYSTICK](https://www.aliexpress.com/store/product/M5Stack-M5-ESP32-X-Y-NeoPixel-LED/3226069_32949801245.html)を利用する事も可能です。 + +## 特徴 + +- プログラミングサポート + - Blockly + - Arduino + - MycroPython +- LEGO 互換ホール +- Nintendo エミュレータサポート +- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート + +## パッケージ内容 + +- 1x M5Stack GRAY +- 1x キーボード +- 1x ゲームパッド +- 1x 電卓キー +- 1x FACE ボトム +- 1x CHG ベース +- 1x USB Type-C ケーブル +- ユーザーマニュアル + +## アプリケーション + +- 自作ゲーム +- Nintendo エミュレータ +- テトリス +- 自作電卓 +- 自作ポケコン + +## ドキュメント + +- **回路図** + - [Schematic](https://github.com/m5stack/esp32-cam-demo/blob/m5cam/M5CAM-ESP32-A1-POWER.pdf) + +- **サンプルコード** + - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) + +- **データシート** + - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) + - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +- **GitHub** + - [Arduino](https://github.com/m5stack/M5Stack-nesemu) + +### FACES + +
+ faces_01 +
+
+ faces_02 +
+
+ faces_03 +
+
+ faces_04 +
+
+ faces_05 +
+ +### JOYSTICK + +
+ faces_joystick_01 +
+
+ faces_joystick_02 +
+ +## 関連情報 + +- [FACES 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3649/) +- [FACES 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ESP32-micropython-arduino/3226069_32843973578.html) - [FACES JOYSTICK 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-M5-ESP32-X-Y-NeoPixel-LED/3226069_32949801245.html) \ No newline at end of file diff --git a/docs/ja/base/lan_base.md b/docs/ja/base/lan_base.md index 90811d81..4d290564 100644 --- a/docs/ja/base/lan_base.md +++ b/docs/ja/base/lan_base.md @@ -1,58 +1,58 @@ -# LAN ベース - - - -## 概要 - -**LAN**ベースはI2Cとユーザ定義の6ピンポートによってイーサネット通信が可能なベースです。 - -M5Stackの無線通信が遅かったり、無線ネットワークに繋がらない時に、このLANベースを利用して、それらの厄介な問題を解決することができます。 - -## 特徴 - -- W5500 - 高性能イーサネットチップ - -## パッケージ内容 - -- 1x LAN ベース(ユーザ定義 6 PIN and 1 Groveポート) -- 1x DINレール -- 1x ステッカー - -## アプリケーション - -- ミニポータブルWEBサーバ - - TCP/UDP サーバ - - HTTP サーバ -- ミニポータブルWEBクライアント - - TCP/UDP クライアント - - HTTP クライアント -- SMTP/NTP サーバ - -## ドキュメント - -- **ウェブサイト** - - [M5Stack](https://m5stack.com) - -- **サンプルコード** - - [Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) - -- **データシート** - - [W5500](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Shields/W5500_datasheet_v1.0.2_1.pdf) - -- **GitHub** - - [M5Stack](https://github.com/m5stack/M5Stack) - -
- lan_01 -
-
- lan_02 -
-
- lan_03 -
- -## 関連情報 - -- [LAN ベース購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3994/) -- [LAN ベース購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-LAN-W5500-LanProto-Arduino/3226069_32904089417.html) +# LAN ベース + + + +## 概要 + +**LAN**ベースはI2Cとユーザ定義の6ピンポートによってイーサネット通信が可能なベースです。 + +M5Stackの無線通信が遅かったり、無線ネットワークに繋がらない時に、このLANベースを利用して、それらの厄介な問題を解決することができます。 + +## 特徴 + +- W5500 - 高性能イーサネットチップ + +## パッケージ内容 + +- 1x LAN ベース(ユーザ定義 6 PIN and 1 Groveポート) +- 1x DINレール +- 1x ステッカー + +## アプリケーション + +- ミニポータブルWEBサーバ + - TCP/UDP サーバ + - HTTP サーバ +- ミニポータブルWEBクライアント + - TCP/UDP クライアント + - HTTP クライアント +- SMTP/NTP サーバ + +## ドキュメント + +- **ウェブサイト** + - [M5Stack](https://m5stack.com) + +- **サンプルコード** + - [Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) + +- **データシート** + - [W5500](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Shields/W5500_datasheet_v1.0.2_1.pdf) + +- **GitHub** + - [M5Stack](https://github.com/m5stack/M5Stack) + +
+ lan_01 +
+
+ lan_02 +
+
+ lan_03 +
+ +## 関連情報 + +- [LAN ベース購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3994/) +- [LAN ベース購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-LAN-W5500-LanProto-Arduino/3226069_32904089417.html) diff --git a/docs/ja/base/m5go_base.md b/docs/ja/base/m5go_base.md index d58fff36..8b51e687 100644 --- a/docs/ja/base/m5go_base.md +++ b/docs/ja/base/m5go_base.md @@ -1,76 +1,76 @@ -# M5GO ベース - - - -## 概要 - -M5GOベースは、[M5GO IOT Starter Kit](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit)および[M5Fire](zh_CN/product_documents/m5stack-core/m5core_fire)キットのベースです - -M5GOベースは、600mAhバッテリ、Mバスバスインタフェース、マイク、赤色充電インジケータLED、2つのRGBストリップ（10）、PORT BおよびPORT Cで構成されています。 - -M5GOベースの充電処理中、赤いLEDが点滅し、バッテリが完全に点灯します。 - -## ピンマップ - -**POGO Pin** - -| POGO Pin | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LED Bar** - -*RGBライトは10本あり、左右に5本あります* - -| LED Pin | ESP32 Chip | -| :----------: |:------------: | -| LED Pin | GPIO15 | - -**MIC** - -| MIC Pin | ESP32 Chip | -| :----------: |:------------: | -| MIC Pin | GPIO34 | - -**GROVE** - -| PORT A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -| :----------: |:------------: | -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -| :----------: |:------------: | -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**M-Bus** - -
- M_BUS -
- -## 関連情報 - -- **[回路図](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** -- **[M5GO IOT Starter Kit リンクを購入する](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.2.52385ab04i7vIu)** - -
- -
- -
- -
+# M5GO ベース + + + +## 概要 + +M5GOベースは、[M5GO IOT Starter Kit](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit)および[M5Fire](zh_CN/product_documents/m5stack-core/m5core_fire)キットのベースです + +M5GOベースは、600mAhバッテリ、Mバスバスインタフェース、マイク、赤色充電インジケータLED、2つのRGBストリップ（10）、PORT BおよびPORT Cで構成されています。 + +M5GOベースの充電処理中、赤いLEDが点滅し、バッテリが完全に点灯します。 + +## ピンマップ + +**POGO Pin** + +| POGO Pin | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | + +**LED Bar** + +*RGBライトは10本あり、左右に5本あります* + +| LED Pin | ESP32 Chip | +| :----------: |:------------: | +| LED Pin | GPIO15 | + +**MIC** + +| MIC Pin | ESP32 Chip | +| :----------: |:------------: | +| MIC Pin | GPIO34 | + +**GROVE** + +| PORT A(I2C) | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +| PORT B(I/O) | ESP32 Chip | +| :----------: |:------------: | +| G36 | GPIO36 | +| G26 | GPIO26 | +| 5V | 5V | +| GND | GND | + +| PORT C(UART2) | ESP32 Chip | +| :----------: |:------------: | +| RXD | GPIO16 | +| TXD | GPIO17 | +| 5V | 5V | +| GND | GND | + +**M-Bus** + +
+ M_BUS +
+ +## 関連情報 + +- **[回路図](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** +- **[M5GO IOT Starter Kit リンクを購入する](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.2.52385ab04i7vIu)** + +
+ +
+ +
+ +
diff --git a/docs/ja/base/node_base.md b/docs/ja/base/node_base.md index 49fe4ead..337268c3 100644 --- a/docs/ja/base/node_base.md +++ b/docs/ja/base/node_base.md @@ -1,61 +1,61 @@ -# Node ベース - - - -## 概要 - -**M5Stack Node**ベースは12個のRGB LED(SK6812)、コーデックチップ(WM8978)、DHT12、IR送受信機(CHQ0038H)、2つのマイクを備えたサウンドボックスベースです。WM8978チップはHi-Fiスピーカーなどでよく使われています。 - -このベースを使えば、WEBラジオ、Bluetoothスピーカー、インテリジェントサウンドボックスなどを作ることが可能です。 - -## 特徴 - -- 12 x RGB LED -- 温湿度センサー DHT12 -- Hi-Fiステレオコーデックチップ(最大分解能24bitDAC) -- IR送受信機内蔵 -- マイク内蔵 -- 3.5mm マイクジャック -- 内蔵リチウムバッテリー(500mAh) - -## パッケージ内容 - -- 1x Node ベース -- 1x ウォールホルダー -- 2x M3x12ネジ -- 2x M3x18ネジ -- 1x USB Type-C ケーブル - -## アプリケーション - -- WEBラジオ -- Bluetoothスピーカー -- インテリジェントサウンドボックス - -## ドキュメント - -- **ウェブサイト** - - [M5Stack](https://m5stack.com) -- **データシート** - - [WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) -- **回路図** - - [Schematic](https://github.com/m5stack/M5StackModule-Node/tree/master/schematic) -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5StackModule-Node/tree/master/example) - -
- node_01 -
-
- node_02 -
-
- node_03 -
-
- node_04 -
- -## 関連情報 - +# Node ベース + + + +## 概要 + +**M5Stack Node**ベースは12個のRGB LED(SK6812)、コーデックチップ(WM8978)、DHT12、IR送受信機(CHQ0038H)、2つのマイクを備えたサウンドボックスベースです。WM8978チップはHi-Fiスピーカーなどでよく使われています。 + +このベースを使えば、WEBラジオ、Bluetoothスピーカー、インテリジェントサウンドボックスなどを作ることが可能です。 + +## 特徴 + +- 12 x RGB LED +- 温湿度センサー DHT12 +- Hi-Fiステレオコーデックチップ(最大分解能24bitDAC) +- IR送受信機内蔵 +- マイク内蔵 +- 3.5mm マイクジャック +- 内蔵リチウムバッテリー(500mAh) + +## パッケージ内容 + +- 1x Node ベース +- 1x ウォールホルダー +- 2x M3x12ネジ +- 2x M3x18ネジ +- 1x USB Type-C ケーブル + +## アプリケーション + +- WEBラジオ +- Bluetoothスピーカー +- インテリジェントサウンドボックス + +## ドキュメント + +- **ウェブサイト** + - [M5Stack](https://m5stack.com) +- **データシート** + - [WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) +- **回路図** + - [Schematic](https://github.com/m5stack/M5StackModule-Node/tree/master/schematic) +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5StackModule-Node/tree/master/example) + +
+ node_01 +
+
+ node_02 +
+
+ node_03 +
+
+ node_04 +
+ +## 関連情報 + - [Node ベース 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-Samrt-WM8978-I2S-DHT12-Ir-500/3226069_32949773234.html) \ No newline at end of file diff --git a/docs/ja/base/plc_base.md b/docs/ja/base/plc_base.md index 87796c79..aaa314cf 100644 --- a/docs/ja/base/plc_base.md +++ b/docs/ja/base/plc_base.md @@ -1,63 +1,63 @@ -# PLC ベース - - - -## 概要 - -**M5Stack PLC**ベースはRS-485アダプタを含む工業向けベースです。 -DC9V-24V入力、4ピンまたは6ピンのリレー出力、デジタル入力、通信インターフェースなどを備えます。 - -## 特徴 - -- 自由に自作可能 -- プログラマブルロジックコントローラ (PLC) -- 軽量: 0.1kg (0.22lb.) -- パッケージサイズ: 5\*5\*5cm (1.97\*1.97\*1.97in) - -## パッケージ内容 - -- 1x PLC-Protoボード -- 1x RS-485モジュール -- 1x PLCプラスチックエンクロージャ -- 1x スライドガイド -- 1x 磁石 -- 1x 6ピン3.96ピッチ端子 -- 1x 4ピン3.96ピッチ端子 -- 3x 六角レンチ -- 7x 端子ピン -- 1x ステッカー - -## アプリケーション - -- プログラマブルロジックコントローラ -- プログラマブルモーションコントローラ -- デジタルオペレーションプロセッサ -- 強電コントローラ - -## ドキュメント - -- **ウェブサイト** - - [M5Stack](https://m5stack.com) -- **GitHub** - - [M5Stack](https://github.com/m5stack/M5Stack) - -
- plc_01 -
-
- plc_02 -
-
- plc_03 -
-
- plc_04 -
-
- plc_05 -
- -## 関連情報 - -- [PLC ベース 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3992/) -- [PLC ベース 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-plc-rs485-ACS712-5B-dinrail/3226069_32874916056.html) +# PLC ベース + + + +## 概要 + +**M5Stack PLC**ベースはRS-485アダプタを含む工業向けベースです。 +DC9V-24V入力、4ピンまたは6ピンのリレー出力、デジタル入力、通信インターフェースなどを備えます。 + +## 特徴 + +- 自由に自作可能 +- プログラマブルロジックコントローラ (PLC) +- 軽量: 0.1kg (0.22lb.) +- パッケージサイズ: 5\*5\*5cm (1.97\*1.97\*1.97in) + +## パッケージ内容 + +- 1x PLC-Protoボード +- 1x RS-485モジュール +- 1x PLCプラスチックエンクロージャ +- 1x スライドガイド +- 1x 磁石 +- 1x 6ピン3.96ピッチ端子 +- 1x 4ピン3.96ピッチ端子 +- 3x 六角レンチ +- 7x 端子ピン +- 1x ステッカー + +## アプリケーション + +- プログラマブルロジックコントローラ +- プログラマブルモーションコントローラ +- デジタルオペレーションプロセッサ +- 強電コントローラ + +## ドキュメント + +- **ウェブサイト** + - [M5Stack](https://m5stack.com) +- **GitHub** + - [M5Stack](https://github.com/m5stack/M5Stack) + +
+ plc_01 +
+
+ plc_02 +
+
+ plc_03 +
+
+ plc_04 +
+
+ plc_05 +
+ +## 関連情報 + +- [PLC ベース 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3992/) +- [PLC ベース 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-plc-rs485-ACS712-5B-dinrail/3226069_32874916056.html) diff --git a/docs/ja/case.md b/docs/ja/case.md index 001695e3..091cfc8a 100644 --- a/docs/ja/case.md +++ b/docs/ja/case.md @@ -1,99 +1,99 @@ -# M5Stack アプリケーション - - - -## STEM 教育例 - -## M5Stack を利用した素晴らしいアプリケーション - -- [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - - M5Stack向けのカスタマイズ可能なメニューシステム - - メニューからマイクロSDカード内のアプリを読み込み - -- [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - - ESP8266/ESP32 向けのTFTライブラリ - - さまざななドライバICに対応 - -- [M5Widgets](https://github.com/Kongduino/M5Widgets) - - M5Stack向けウィジェット - -- [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - - M5Stack向けシンプルアプリケーションメニューライブラリ - -- [cfGUI](https://github.com/JF002/cfGUI) - - M5Stack向けシンプルGUIライブラリ - -- [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - - 組み込み向け軽量GUIフレームワーク - -- [M5ez](https://github.com/ropg/M5ez) - - M5Stack向けインターフェースビルダーライブラリ - -- [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - - 便利アプリコレクション - -- [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - - フル機能オシロスコープアプリ - -- [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) - - M5Stack向けアバターアプリ - -- [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - - M5Stackの画面が割れるアプリ・・・ - -- [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - - シャトルランアプリ - -- [nixietubeM5](https://github.com/drayde/nixietubeM5) - - ニキシー管アプリ - -- [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - - Coindesk APIを利用したBTCティッカーアプリ - -- [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - - MaicoinのETH価格表示アプリ - -- [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - - パケットモニタアプリ - -- [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - - グラフィックイコライザーアプリ - -- [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - - MP3ストリームプレイヤーアプリ - -- [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - - MP3プレイヤーアプリ - -- [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - - 写真バックアップアプリ - -- [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - - PCへ CTRL+ALT+DEL 送信アプリ - -- [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) - - SDカードからマークダウンとアイコンを読み込めるWebサーバアプリ - -- [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - - テトリスアプリ - https://macsbug.wordpress.com/ - -- [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - - フラッピーバードアプリ - -- [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - - スペースインベーダーアプリ - -- [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - - パックマンアプリ - -- [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - - AMG8833サーマルセンサカメラ用アプリ - -- [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) - - M5Stack向けの3Dプリントデータ - -- [truetype2gfx](https://github.com/ropg/truetype2gfx) - - TrueTypeフォントをAdafruit GFXへコンバートするアプリ - -- [m5stack-onscreen-keyboard](https://github.com/yellowelise/m5stack-onscreen-keyboard) +# M5Stack アプリケーション + + + +## STEM 教育例 + +## M5Stack を利用した素晴らしいアプリケーション + +- [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) + - M5Stack向けのカスタマイズ可能なメニューシステム + - メニューからマイクロSDカード内のアプリを読み込み + +- [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) + - ESP8266/ESP32 向けのTFTライブラリ + - さまざななドライバICに対応 + +- [M5Widgets](https://github.com/Kongduino/M5Widgets) + - M5Stack向けウィジェット + +- [M5StackSAM](https://github.com/tomsuch/M5StackSAM) + - M5Stack向けシンプルアプリケーションメニューライブラリ + +- [cfGUI](https://github.com/JF002/cfGUI) + - M5Stack向けシンプルGUIライブラリ + +- [GUIslice](https://github.com/ImpulseAdventure/GUIslice) + - 組み込み向け軽量GUIフレームワーク + +- [M5ez](https://github.com/ropg/M5ez) + - M5Stack向けインターフェースビルダーライブラリ + +- [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) + - 便利アプリコレクション + +- [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) + - フル機能オシロスコープアプリ + +- [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) + - M5Stack向けアバターアプリ + +- [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) + - M5Stackの画面が割れるアプリ・・・ + +- [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) + - シャトルランアプリ + +- [nixietubeM5](https://github.com/drayde/nixietubeM5) + - ニキシー管アプリ + +- [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) + - Coindesk APIを利用したBTCティッカーアプリ + +- [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) + - MaicoinのETH価格表示アプリ + +- [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) + - パケットモニタアプリ + +- [M5-FFT](https://github.com/ElectroMagus/M5-FFT) + - グラフィックイコライザーアプリ + +- [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) + - MP3ストリームプレイヤーアプリ + +- [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) + - MP3プレイヤーアプリ + +- [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) + - 写真バックアップアプリ + +- [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) + - PCへ CTRL+ALT+DEL 送信アプリ + +- [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) + - SDカードからマークダウンとアイコンを読み込めるWebサーバアプリ + +- [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) + - テトリスアプリ - https://macsbug.wordpress.com/ + +- [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) + - フラッピーバードアプリ + +- [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) + - スペースインベーダーアプリ + +- [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) + - パックマンアプリ + +- [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) + - AMG8833サーマルセンサカメラ用アプリ + +- [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) + - M5Stack向けの3Dプリントデータ + +- [truetype2gfx](https://github.com/ropg/truetype2gfx) + - TrueTypeフォントをAdafruit GFXへコンバートするアプリ + +- [m5stack-onscreen-keyboard](https://github.com/yellowelise/m5stack-onscreen-keyboard) - スクリーンQWERTYキーボードアプリ \ No newline at end of file diff --git a/docs/ja/core/basic.md b/docs/ja/core/basic.md index f411cfb4..aa820d63 100644 --- a/docs/ja/core/basic.md +++ b/docs/ja/core/basic.md @@ -1,112 +1,112 @@ -# M5Stack BASIC - -basic_02 basic_03 basic_04 - -* * * - -:memo:**[概要](#概要)**   :bulb:**[クイックスタート](ja/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[サンプルコード](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[回路図](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)**   :clapper:**[関連動画](#関連動画)** - -## 概要 - -**M5Stack BASIC**は**ESP32**チップがベースです。**Blockly**、**Arduino**、**MicroPython**などでプログラミングすることができます。 - -**M5Stack BASIC**にはESP32プログラミングに必要なものに加えて、TFT液晶も装備されています。簡易版"Leap Motion"のような3Dリモートジェスチャーコントローラなども短時間で作ることが出来るでしょう。 - -ボトムボードはDIY用のI2Sピン(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)の他に、M-Bus上のGPIOを拡張利用できるようにデザインされています。 - -?>M5Stack BASICにIMUは内蔵されていません。 - -## 特徴 - -- プログラミングサポート - - Arduino - - ESP-IDF - - MicroPython -- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート - -## スペック - -|項目|詳細| -|:---|:---| -|ESP32| 240MHz x 2コア, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモードBluetooth| -|Flash| 4MB | -|電源入力| 5V @ 500mA | -|インターフェース| USB Type-C x 1, Grove(I2C+I/0+UART) x 1| -|画面| 2 inch, 320x240 Colorful TFT LCD, ILI9342 | -|スピーカー| 1W-0928| -|電池| 150mAh @ 3.7V 内蔵| -|動作温度| 32°F to 104°F ( 0°C to 40°C ) | -|サイズ| 54 x 54 x 12.5 mm | -|ケース| プラスチック ( PC )| -|重量| 120g (ボトムモジュール含む）, 100g（コアのみ） | - -## ピンマップ - -**Speaker** - -| Speak Pin | ESP32 Chip | -|:----------|:-----------| -| Speak Pin | GPIO25 | - -**Button** - -| Button Pin | ESP32 Chip | -|:-----------|:-----------| -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**GROVE A** - -| GROVE A(I2C) | ESP32 Chip | -|:-------------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -**LCD** - -| ILI9341 | ESP32 Chip | -|:--------|:-----------| -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | - -**TFカード** - -| TFCard Pin | ESP32 Chip | -|:-----------|:-----------| -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | - -**M-Bus** - -
- M_BUS -
- -## パッケージ内容 - -- 1x M5Stack BASIC -- 1x M5Stack BASIC ボトムモジュール -- USB Type-C ケーブル -- ユーザーマニュアル - -## 関連リンク - -- **データシート** - - [ESP32(中国語)](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - - -## 関連動画 - -- **m5stackの紹介** - +# M5Stack BASIC + +basic_02 basic_03 basic_04 + +* * * + +:memo:**[概要](#概要)**   :bulb:**[クイックスタート](ja/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[サンプルコード](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[回路図](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)**   :clapper:**[関連動画](#関連動画)** + +## 概要 + +**M5Stack BASIC**は**ESP32**チップがベースです。**Blockly**、**Arduino**、**MicroPython**などでプログラミングすることができます。 + +**M5Stack BASIC**にはESP32プログラミングに必要なものに加えて、TFT液晶も装備されています。簡易版"Leap Motion"のような3Dリモートジェスチャーコントローラなども短時間で作ることが出来るでしょう。 + +ボトムボードはDIY用のI2Sピン(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)の他に、M-Bus上のGPIOを拡張利用できるようにデザインされています。 + +?>M5Stack BASICにIMUは内蔵されていません。 + +## 特徴 + +- プログラミングサポート + - Arduino + - ESP-IDF + - MicroPython +- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート + +## スペック + +|項目|詳細| +|:---|:---| +|ESP32| 240MHz x 2コア, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモードBluetooth| +|Flash| 4MB | +|電源入力| 5V @ 500mA | +|インターフェース| USB Type-C x 1, Grove(I2C+I/0+UART) x 1| +|画面| 2 inch, 320x240 Colorful TFT LCD, ILI9342 | +|スピーカー| 1W-0928| +|電池| 150mAh @ 3.7V 内蔵| +|動作温度| 32°F to 104°F ( 0°C to 40°C ) | +|サイズ| 54 x 54 x 12.5 mm | +|ケース| プラスチック ( PC )| +|重量| 120g (ボトムモジュール含む）, 100g（コアのみ） | + +## ピンマップ + +**Speaker** + +| Speak Pin | ESP32 Chip | +|:----------|:-----------| +| Speak Pin | GPIO25 | + +**Button** + +| Button Pin | ESP32 Chip | +|:-----------|:-----------| +| BUTTON A | GPIO39 | +| BUTTON B | GPIO38 | +| BUTTON C | GPIO37 | + +**GROVE A** + +| GROVE A(I2C) | ESP32 Chip | +|:-------------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +**LCD** + +| ILI9341 | ESP32 Chip | +|:--------|:-----------| +| MOSI | GPIO23 | +| MISO | / | +| CLK | GPIO18 | +| CS | GPIO14 | +| DC | GPIO27 | +| RST | GPIO33 | +| BL | GPIO32 | + +**TFカード** + +| TFCard Pin | ESP32 Chip | +|:-----------|:-----------| +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO4 | + +**M-Bus** + +
+ M_BUS +
+ +## パッケージ内容 + +- 1x M5Stack BASIC +- 1x M5Stack BASIC ボトムモジュール +- USB Type-C ケーブル +- ユーザーマニュアル + +## 関連リンク + +- **データシート** + - [ESP32(中国語)](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) + + +## 関連動画 + +- **m5stackの紹介** + \ No newline at end of file diff --git a/docs/ja/core/face_kit.md b/docs/ja/core/face_kit.md index 6e69fa66..058f9a1c 100644 --- a/docs/ja/core/face_kit.md +++ b/docs/ja/core/face_kit.md @@ -1,57 +1,57 @@ -# FACES Kit - - - -## 概要 - -**FACES Kit** は M5Core GRAY、ファンクショナルキーボード, FACESベース, FACESチャージャー、そしていくつかのアクセサリ（DuPont線、ストラップ、M3ネジなど）で構成されたキットです。 現在、ファンクショナルキーボードはGameBoy、 電卓、 QWERTYの3つがあります。今後、さらに別のキーボードがFACESキットに追加される予定です。Arduino IDEまたはMicroPythonを使用してプログラムすることができます。異なるアプリケーションに対し、それぞれ対応したキーボードをFACESベースにスタックして、利用することができます。[FACES Base](ja/base/face_base)のページで詳細を確認できます。 - -*それぞれのキーボードには、**MEGA328**チップが統合されており、ボタンを押した時に対応した値(**16進フォーマット**)がキーボードからM5Coreに送信されます。それぞれI2Cを使って通信しており、各キーボードのI2Cアドレスは**0x08**です。* - -## パッケージ内容 - -
- -
- -### 1. GameBoyキーボード - -ゲームを作りたい時は、GameBoyキーボードをFACES Baseにスタックします。そしてNESエミュレータを書き込んでみましょう。 - -エミュレータとゲームの書き込み方法はこのページを参照してください: [ゲームのプレイ方法](ja/quick_start/faces/gameboy_burn_a_nes_game) - -
- -
- -### 2. 電卓キーボード - -電卓を作りたい時は、電卓キーボードをスタックします。そして、M5Coreにファームウェアを書き込みます。ボタンが押されると、コールバックで特殊な関数を実行し、電卓が作成されます。 - -
- -
- -### 3. QWERTYキーボード - -フルキーボードが必要なときは、QWERTYキーボードをスタックします。 - -次のサンプルを書き込んでみましょう。(サンプルコードの機能: M5Coreとシリアルターミナルにterminal押したボタンの内容が表示されます。) - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) - - [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES)(for M5Cloud) - -- **M5Cloudの使い方** - [MicroPython(M5Cloud)](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) - -
- -
- -### 4. FACES チャージャー - -**FACES チャージャー**は磁石内蔵です。充電する時はFACESを充電器にくっつけてください。FACESとチャージャーはポゴピンで接続されます。 - -
- -
+# FACES Kit + + + +## 概要 + +**FACES Kit** は M5Core GRAY、ファンクショナルキーボード, FACESベース, FACESチャージャー、そしていくつかのアクセサリ（DuPont線、ストラップ、M3ネジなど）で構成されたキットです。 現在、ファンクショナルキーボードはGameBoy、 電卓、 QWERTYの3つがあります。今後、さらに別のキーボードがFACESキットに追加される予定です。Arduino IDEまたはMicroPythonを使用してプログラムすることができます。異なるアプリケーションに対し、それぞれ対応したキーボードをFACESベースにスタックして、利用することができます。[FACES Base](ja/base/face_base)のページで詳細を確認できます。 + +*それぞれのキーボードには、**MEGA328**チップが統合されており、ボタンを押した時に対応した値(**16進フォーマット**)がキーボードからM5Coreに送信されます。それぞれI2Cを使って通信しており、各キーボードのI2Cアドレスは**0x08**です。* + +## パッケージ内容 + +
+ +
+ +### 1. GameBoyキーボード + +ゲームを作りたい時は、GameBoyキーボードをFACES Baseにスタックします。そしてNESエミュレータを書き込んでみましょう。 + +エミュレータとゲームの書き込み方法はこのページを参照してください: [ゲームのプレイ方法](ja/quick_start/faces/gameboy_burn_a_nes_game) + +
+ +
+ +### 2. 電卓キーボード + +電卓を作りたい時は、電卓キーボードをスタックします。そして、M5Coreにファームウェアを書き込みます。ボタンが押されると、コールバックで特殊な関数を実行し、電卓が作成されます。 + +
+ +
+ +### 3. QWERTYキーボード + +フルキーボードが必要なときは、QWERTYキーボードをスタックします。 + +次のサンプルを書き込んでみましょう。(サンプルコードの機能: M5Coreとシリアルターミナルにterminal押したボタンの内容が表示されます。) + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) + - [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES)(for M5Cloud) + +- **M5Cloudの使い方** - [MicroPython(M5Cloud)](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) + +
+ +
+ +### 4. FACES チャージャー + +**FACES チャージャー**は磁石内蔵です。充電する時はFACESを充電器にくっつけてください。FACESとチャージャーはポゴピンで接続されます。 + +
+ +
diff --git a/docs/ja/core/fire.md b/docs/ja/core/fire.md index f13ab557..b4bd2466 100644 --- a/docs/ja/core/fire.md +++ b/docs/ja/core/fire.md @@ -1,197 +1,197 @@ -# M5Stack FIRE - - - -## 概要 - -**M5Stack FIRE**は**ESP32**チップがベースです。**Blockly**、**Arduino**、**MicroPython**などでプログラミングすることができます。 - -**M5Stack FIRE**は、ESP32プログラミングに必要なものに加えて、~~**MPU6050**MEMSセンサー（3軸ジャイロ + 3軸加速度）、**MAG3110**MEMSセンサー(3軸地磁気)、~~ **MPU9250**MEMSセンサー(3軸ジャイロ + 3軸加速度 + 3軸地磁気) 、TFT LCDなどを備えています。簡易版"Leap Motion"のような3Dリモートジェスチャーコントローラなどを短時間で作ることが出来るでしょう。 - -M5Go CHG.ベースはPOGOピン、M5GoベースはPORT B, PORT C, 2つのLEDバー(SK6812)で構成されています。 - -## 特徴 - -- プログラミングサポート - - Arduino - - Blockly - - ESP-IDF - - Python -- LEGO 互換ホール -- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート - -## スペック - -|項目|詳細| -|:---|:---| -|ESP32| 240MHz x 2コア, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモードBluetooth| -|Flash| 16MB Flash + 4MB pSRAM | -|電源入力| 5V @ 500mA | -|インターフェース | USB Type-C x 1, Grove(I2C+I/0+UART) x 1 | -|画面| 2 inch, 320x240 Colorful TFT LCD, ILI9342| -|スピーカー| 1W-0928 | -|マイク| MEMS Analog BSE3729 Microphone| -|LED| SK6812 3535 RGB LED x 10 | -|MEMS| ~~MPU6050, MAG3110~~ MPU9250 (MPU6500 + AK8963) | -|電池| 150mAh @ 3.7V 内蔵| -|動作温度| 32°F to 104°F ( 0°C to 40°C ) | -|サイズ| 54 x 54 x 12.5 mm | -|ケース| プラスチック ( PC ) | -|重量| 56g | - -## ピンマップ - -**POGOピン** - -| POGO Pin | ESP32 Chip | -|:---------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LEDバー** - -| LED Pin | ESP32 Chip | -|:--------|:-----------| -| LED Pin | GPIO15 | - -**MIC** - -| MIC Pin | ESP32 Chip | -|:--------|:-----------| -| MIC Pin | GPIO34 | - -**Speaker** - -| Speak Pin | ESP32 Chip | -|:----------|:-----------| -| Speak Pin | GPIO25 | - -**Button** - -| Button Pin | ESP32 Chip | -|:-----------|:-----------| -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**GROVE** - -| PORT A(I2C) | ESP32 Chip | -|:------------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -|:------------|:-----------| -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -|:--------------|:-----------| -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**IMUセンサー** - -~~*MPU6050 i2c address: 0x68*~~ - -~~*MAG3110 i2c address: 0x0E*~~ - -*MPU9250 i2c address: 0x68* - -| MPU9250 | ESP32 Chip | -|:--------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -**LCD** - -| ILI9341 | ESP32 Chip | -|:--------|:-----------| -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | - -**TFカード** - -| TFCard Pin | ESP32 Chip | -|:-----------|:-----------| -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | - -**M-Bus** - -
- M_BUS -
- -## パッケージ内容 - -- 1x M5Stack FIRE -- 1x M5GO ボトムモジュール -- 1x M5GO チャージベース -- USB Type-C ケーブル -- ユーザーマニュアル - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) - -- **データシート** - - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - - ~~[MPU6050](https://www.invensense.com/wp-content/uploads/2015/02/MPU-6000-Datasheet1.pdf)~~ - - ~~[MAG3110](https://www.nxp.com/docs/en/data-sheet/MAG3110.pdf)~~ - - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - - [MPU9250レジスタマップ](https://www.invensense.com/wp-content/uploads/2015/02/RM-MPU-9250A-00-v1.6.pdf) - - [AK8963 (日本語)](https://strawberry-linux.com/pub/AK8963.pdf) - - [AK8963 (英語)](https://www.akm.com/akm/en/file/datasheet/AK8963C.pdf) - -- **GitHub** - - [M5Stack](https://github.com/m5stack/M5Stack) - - [M5GO](https://github.com/m5stack/M5GO) - -- **クイックスタート (Arduino)** - - [macOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - - [Windows](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) - -
- fire_01 -
- -
- fire_02 -
- -
- fire_03 -
- -
- fire_03 -
- -
- fire_03 -
- -## 関連情報 - -- [M5Stack FIRE 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3953/) -- [M5Stack FIRE 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-PSRAM-2-0-IoT-ESP32-16M-FLash-4M-PSRAM-BLE/3226069_32847906756.html) +# M5Stack FIRE + + + +## 概要 + +**M5Stack FIRE**は**ESP32**チップがベースです。**Blockly**、**Arduino**、**MicroPython**などでプログラミングすることができます。 + +**M5Stack FIRE**は、ESP32プログラミングに必要なものに加えて、~~**MPU6050**MEMSセンサー（3軸ジャイロ + 3軸加速度）、**MAG3110**MEMSセンサー(3軸地磁気)、~~ **MPU9250**MEMSセンサー(3軸ジャイロ + 3軸加速度 + 3軸地磁気) 、TFT LCDなどを備えています。簡易版"Leap Motion"のような3Dリモートジェスチャーコントローラなどを短時間で作ることが出来るでしょう。 + +M5Go CHG.ベースはPOGOピン、M5GoベースはPORT B, PORT C, 2つのLEDバー(SK6812)で構成されています。 + +## 特徴 + +- プログラミングサポート + - Arduino + - Blockly + - ESP-IDF + - Python +- LEGO 互換ホール +- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート + +## スペック + +|項目|詳細| +|:---|:---| +|ESP32| 240MHz x 2コア, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモードBluetooth| +|Flash| 16MB Flash + 4MB pSRAM | +|電源入力| 5V @ 500mA | +|インターフェース | USB Type-C x 1, Grove(I2C+I/0+UART) x 1 | +|画面| 2 inch, 320x240 Colorful TFT LCD, ILI9342| +|スピーカー| 1W-0928 | +|マイク| MEMS Analog BSE3729 Microphone| +|LED| SK6812 3535 RGB LED x 10 | +|MEMS| ~~MPU6050, MAG3110~~ MPU9250 (MPU6500 + AK8963) | +|電池| 150mAh @ 3.7V 内蔵| +|動作温度| 32°F to 104°F ( 0°C to 40°C ) | +|サイズ| 54 x 54 x 12.5 mm | +|ケース| プラスチック ( PC ) | +|重量| 56g | + +## ピンマップ + +**POGOピン** + +| POGO Pin | ESP32 Chip | +|:---------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | + +**LEDバー** + +| LED Pin | ESP32 Chip | +|:--------|:-----------| +| LED Pin | GPIO15 | + +**MIC** + +| MIC Pin | ESP32 Chip | +|:--------|:-----------| +| MIC Pin | GPIO34 | + +**Speaker** + +| Speak Pin | ESP32 Chip | +|:----------|:-----------| +| Speak Pin | GPIO25 | + +**Button** + +| Button Pin | ESP32 Chip | +|:-----------|:-----------| +| BUTTON A | GPIO39 | +| BUTTON B | GPIO38 | +| BUTTON C | GPIO37 | + +**GROVE** + +| PORT A(I2C) | ESP32 Chip | +|:------------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +| PORT B(I/O) | ESP32 Chip | +|:------------|:-----------| +| G36 | GPIO36 | +| G26 | GPIO26 | +| 5V | 5V | +| GND | GND | + +| PORT C(UART2) | ESP32 Chip | +|:--------------|:-----------| +| RXD | GPIO16 | +| TXD | GPIO17 | +| 5V | 5V | +| GND | GND | + +**IMUセンサー** + +~~*MPU6050 i2c address: 0x68*~~ + +~~*MAG3110 i2c address: 0x0E*~~ + +*MPU9250 i2c address: 0x68* + +| MPU9250 | ESP32 Chip | +|:--------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +**LCD** + +| ILI9341 | ESP32 Chip | +|:--------|:-----------| +| MOSI | GPIO23 | +| MISO | / | +| CLK | GPIO18 | +| CS | GPIO14 | +| DC | GPIO27 | +| RST | GPIO33 | +| BL | GPIO32 | + +**TFカード** + +| TFCard Pin | ESP32 Chip | +|:-----------|:-----------| +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO4 | + +**M-Bus** + +
+ M_BUS +
+ +## パッケージ内容 + +- 1x M5Stack FIRE +- 1x M5GO ボトムモジュール +- 1x M5GO チャージベース +- USB Type-C ケーブル +- ユーザーマニュアル + +## ドキュメント + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) + - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) + +- **データシート** + - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) + - ~~[MPU6050](https://www.invensense.com/wp-content/uploads/2015/02/MPU-6000-Datasheet1.pdf)~~ + - ~~[MAG3110](https://www.nxp.com/docs/en/data-sheet/MAG3110.pdf)~~ + - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + - [MPU9250レジスタマップ](https://www.invensense.com/wp-content/uploads/2015/02/RM-MPU-9250A-00-v1.6.pdf) + - [AK8963 (日本語)](https://strawberry-linux.com/pub/AK8963.pdf) + - [AK8963 (英語)](https://www.akm.com/akm/en/file/datasheet/AK8963C.pdf) + +- **GitHub** + - [M5Stack](https://github.com/m5stack/M5Stack) + - [M5GO](https://github.com/m5stack/M5GO) + +- **クイックスタート (Arduino)** + - [macOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + - [Windows](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) + +
+ fire_01 +
+ +
+ fire_02 +
+ +
+ fire_03 +
+ +
+ fire_03 +
+ +
+ fire_03 +
+ +## 関連情報 + +- [M5Stack FIRE 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3953/) +- [M5Stack FIRE 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-PSRAM-2-0-IoT-ESP32-16M-FLash-4M-PSRAM-BLE/3226069_32847906756.html) diff --git a/docs/ja/core/gray.md b/docs/ja/core/gray.md index fd17d6f8..af3e4294 100644 --- a/docs/ja/core/gray.md +++ b/docs/ja/core/gray.md @@ -1,118 +1,118 @@ -# M5Stack GRAY - -gray_02 gray_02 gray_04 - -* * * - -:memo:**[概要](#概要)**   :bulb:**[クイックスタート](ja/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[サンプルコード](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[回路図](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)**   :clapper:**[関連動画](#関連動画)** - -## 概要 - -**M5Stack GRAY**は**ESP32**チップがベースです。**Blockly**、**Arduino**、**MicroPython**などでプログラミングすることができます。 - -**M5Stack GRAY**はESP32プログラミングに必要なものに加えて、**MPU9250**MEMSセンサー（3軸ジャイロ + 3軸加速度 + 3軸地磁気)、TFT LCDなどを備えています。簡易版"Leap Motion"のような3Dリモートジェスチャーコントローラなどを短時間で作ることが出来るでしょう。 - -ボトムボードはDIY用のI2Sピン(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)の他に、M-Bus上のGPIOを拡張利用できるようにデザインされています。 - -## 特徴 - -- プログラミングサポート - - Arduino - - ESP-IDF - - MicroPython -- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート - -## スペック - -|項目|詳細| -|:---|:---| -|ESP32| 240MHz x 2 コア, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモード Bluetooth| -|Flash| 4MB | -|電源入力| 5V @ 500mA| -|インターフェース| USB Type-C x 1, Grove(I2C+I/0+UART) x 1| -|画面| 2 inch, 320x240 Colorful TFT LCD, ILI9342 | -|スピーカー| 1W-0928 | -|MEMS| MPU9250 | -|電池| 150mAh @ 3.7V, inside 内蔵| -|動作温度| 32°F to 104°F ( 0°C to 40°C ) | -|サイズ| 54 x 54 x 12.5 mm | -|ケース| プラスチック ( PC ) | -|重量| 120g (ボトムモジュール含む), 100g (コアのみ)| - -## ピンマップ - -**Speaker** - -| Speak Pin | ESP32 Chip | -|:----------|:-----------| -| Speak Pin | GPIO25 | - -**Button** - -| Button Pin | ESP32 Chip | -|:-----------|:-----------| -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**IMUセンサー** - -| MPU9250 | ESP32 Chip | -|:--------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | - -**GROVE** - -| Port A(I2C) | ESP32 Chip | -|:------------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -**LCD** - -| ILI9341 | ESP32 Chip | -|:--------|:-----------| -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | - -**TFカード** - -| TFCard Pin | ESP32 Chip | -|:-----------|:-----------| -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | - -**M-Bus** - -
- M_BUS -
- -## パッケージ内容 - -- 1x M5Stack GRAY -- 1x M5Stack ボトムモジュール -- USB Type-C ケーブル -- ユーザーマニュアル - -## ドキュメント - -- **データシート** - - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -## 関連動画 - -- **m5stackの紹介** - +# M5Stack GRAY + +gray_02 gray_02 gray_04 + +* * * + +:memo:**[概要](#概要)**   :bulb:**[クイックスタート](ja/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[サンプルコード](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[回路図](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)**   :clapper:**[関連動画](#関連動画)** + +## 概要 + +**M5Stack GRAY**は**ESP32**チップがベースです。**Blockly**、**Arduino**、**MicroPython**などでプログラミングすることができます。 + +**M5Stack GRAY**はESP32プログラミングに必要なものに加えて、**MPU9250**MEMSセンサー（3軸ジャイロ + 3軸加速度 + 3軸地磁気)、TFT LCDなどを備えています。簡易版"Leap Motion"のような3Dリモートジェスチャーコントローラなどを短時間で作ることが出来るでしょう。 + +ボトムボードはDIY用のI2Sピン(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)の他に、M-Bus上のGPIOを拡張利用できるようにデザインされています。 + +## 特徴 + +- プログラミングサポート + - Arduino + - ESP-IDF + - MicroPython +- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート + +## スペック + +|項目|詳細| +|:---|:---| +|ESP32| 240MHz x 2 コア, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモード Bluetooth| +|Flash| 4MB | +|電源入力| 5V @ 500mA| +|インターフェース| USB Type-C x 1, Grove(I2C+I/0+UART) x 1| +|画面| 2 inch, 320x240 Colorful TFT LCD, ILI9342 | +|スピーカー| 1W-0928 | +|MEMS| MPU9250 | +|電池| 150mAh @ 3.7V, inside 内蔵| +|動作温度| 32°F to 104°F ( 0°C to 40°C ) | +|サイズ| 54 x 54 x 12.5 mm | +|ケース| プラスチック ( PC ) | +|重量| 120g (ボトムモジュール含む), 100g (コアのみ)| + +## ピンマップ + +**Speaker** + +| Speak Pin | ESP32 Chip | +|:----------|:-----------| +| Speak Pin | GPIO25 | + +**Button** + +| Button Pin | ESP32 Chip | +|:-----------|:-----------| +| BUTTON A | GPIO39 | +| BUTTON B | GPIO38 | +| BUTTON C | GPIO37 | + +**IMUセンサー** + +| MPU9250 | ESP32 Chip | +|:--------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | + +**GROVE** + +| Port A(I2C) | ESP32 Chip | +|:------------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +**LCD** + +| ILI9341 | ESP32 Chip | +|:--------|:-----------| +| MOSI | GPIO23 | +| MISO | / | +| CLK | GPIO18 | +| CS | GPIO14 | +| DC | GPIO27 | +| RST | GPIO33 | +| BL | GPIO32 | + +**TFカード** + +| TFCard Pin | ESP32 Chip | +|:-----------|:-----------| +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO4 | + +**M-Bus** + +
+ M_BUS +
+ +## パッケージ内容 + +- 1x M5Stack GRAY +- 1x M5Stack ボトムモジュール +- USB Type-C ケーブル +- ユーザーマニュアル + +## ドキュメント + +- **データシート** + - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) + - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +## 関連動画 + +- **m5stackの紹介** + \ No newline at end of file diff --git a/docs/ja/core/m5go_iot_starter_kit.md b/docs/ja/core/m5go_iot_starter_kit.md index e87ef17a..9c14b1f0 100644 --- a/docs/ja/core/m5go_iot_starter_kit.md +++ b/docs/ja/core/m5go_iot_starter_kit.md @@ -1,183 +1,183 @@ -# M5GO IoT Starter Kit - - - -## 概要 - -**M5GO IoT Starter Kit**は6つのユニット(ENV, IR, RGB, PIR, ANGLE, HUB)と1つの白いM5Core(ESP32ベース)からなる、IoTプログラミング学習キットです。 - -[UiFlow](http://flow.m5stack.com)や**Arduino IDE**を使用してプログラミングすることができます。 - -また私たちはIoTプログラミングトレーニングコースも提供しています。 興味がある方は、電子メールまでご連絡ください。 - -## 特徴 - -- プログラミングサポート - - Arduino - - ESP-IDF - - MicroPython -- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート - -## スペック - -| 項目 | 詳細 | -|:----|:-----| -| ESP32 | 240MHz x 2 cores, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモード Bluetooth | -| Flash | 16MB | -| 電源入力 | 5V @ 500mA | -| インターフェース | Type-C x 1, Grove(I2C+I/0+UART) x 1 | -| LCD | 2 inch, 320x240 フルカラーTFT LCD, ILI9342 | -| スピーカー | 1W-0928 | -| 電池 | 150mAh @ 3.7V 内蔵 | -| 動作温度 | 0°C to 40°C ( 32°F to 104°F ) | -| サイズ | 54 x 54 x 12.5 mm | -| ケース | プラスチック ( PC ) | -| 重量 | 300g ボトム含む | - -## ピンマップ - -**POGOピン** - -| POGO Pin | ESP32 Chip | -|:---------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LEDバー** - -| LED Pin | ESP32 Chip | -|:--------|:-----------| -| LED Pin | GPIO15 | - -**MIC** - -| MIC Pin | ESP32 Chip | -|:--------|:-----------| -| MIC Pin | GPIO34 | - -**Speaker** - -| Speak Pin | ESP32 Chip | -|:----------|:-----------| -| Speak Pin | GPIO25 | - -**Button** - -| Button Pin | ESP32 Chip | -|:-----------|:-----------| -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**GROVE** - -| PORT A(I2C) | ESP32 Chip | -|:------------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -|:------------|:-----------| -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -|:--------------|:-----------| -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**IMUセンサー** - -*MPU9250 i2c address: 0x68* - -| MPU9250 | ESP32 Chip | -|:--------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -**LCD** - -| ILI9341 | ESP32 Chip | -|:--------|:-----------| -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | - -**TFカード** - -| TFCard Pin | ESP32 Chip | -|:-----------|:-----------| -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | - -**M-Bus** - -
- M_BUS -
- -## パッケージ内容 - -- 1x M5Core（白） -- 6x 6種類のユニット(ENV, IR, RGB, PIR, ANGLE, HUB) -- 4x LEGO アクセサリ -- 3x Grove ケーブル -- 1x USB Type-C ケーブル -- 1x ユーザーマニュアル - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) - -- **GitHub** - - [Arduino](https://github.com/m5stack/M5Stack) - - [MicroPython](https://github.com/m5stack/M5GO) - -- **Quick Start** - - Arduino - - [MacOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - - [Windows_64](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) - -
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
- -## 関連情報 - -- [M5GO Starter Kit 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3875/) +# M5GO IoT Starter Kit + + + +## 概要 + +**M5GO IoT Starter Kit**は6つのユニット(ENV, IR, RGB, PIR, ANGLE, HUB)と1つの白いM5Core(ESP32ベース)からなる、IoTプログラミング学習キットです。 + +[UiFlow](http://flow.m5stack.com)や**Arduino IDE**を使用してプログラミングすることができます。 + +また私たちはIoTプログラミングトレーニングコースも提供しています。 興味がある方は、電子メールまでご連絡ください。 + +## 特徴 + +- プログラミングサポート + - Arduino + - ESP-IDF + - MicroPython +- [TFカード](https://ja.wikipedia.org/wiki/SD%E3%83%A1%E3%83%A2%E3%83%AA%E3%83%BC%E3%82%AB%E3%83%BC%E3%83%89)サポート + +## スペック + +| 項目 | 詳細 | +|:----|:-----| +| ESP32 | 240MHz x 2 cores, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモード Bluetooth | +| Flash | 16MB | +| 電源入力 | 5V @ 500mA | +| インターフェース | Type-C x 1, Grove(I2C+I/0+UART) x 1 | +| LCD | 2 inch, 320x240 フルカラーTFT LCD, ILI9342 | +| スピーカー | 1W-0928 | +| 電池 | 150mAh @ 3.7V 内蔵 | +| 動作温度 | 0°C to 40°C ( 32°F to 104°F ) | +| サイズ | 54 x 54 x 12.5 mm | +| ケース | プラスチック ( PC ) | +| 重量 | 300g ボトム含む | + +## ピンマップ + +**POGOピン** + +| POGO Pin | ESP32 Chip | +|:---------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | + +**LEDバー** + +| LED Pin | ESP32 Chip | +|:--------|:-----------| +| LED Pin | GPIO15 | + +**MIC** + +| MIC Pin | ESP32 Chip | +|:--------|:-----------| +| MIC Pin | GPIO34 | + +**Speaker** + +| Speak Pin | ESP32 Chip | +|:----------|:-----------| +| Speak Pin | GPIO25 | + +**Button** + +| Button Pin | ESP32 Chip | +|:-----------|:-----------| +| BUTTON A | GPIO39 | +| BUTTON B | GPIO38 | +| BUTTON C | GPIO37 | + +**GROVE** + +| PORT A(I2C) | ESP32 Chip | +|:------------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +| PORT B(I/O) | ESP32 Chip | +|:------------|:-----------| +| G36 | GPIO36 | +| G26 | GPIO26 | +| 5V | 5V | +| GND | GND | + +| PORT C(UART2) | ESP32 Chip | +|:--------------|:-----------| +| RXD | GPIO16 | +| TXD | GPIO17 | +| 5V | 5V | +| GND | GND | + +**IMUセンサー** + +*MPU9250 i2c address: 0x68* + +| MPU9250 | ESP32 Chip | +|:--------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +**LCD** + +| ILI9341 | ESP32 Chip | +|:--------|:-----------| +| MOSI | GPIO23 | +| MISO | / | +| CLK | GPIO18 | +| CS | GPIO14 | +| DC | GPIO27 | +| RST | GPIO33 | +| BL | GPIO32 | + +**TFカード** + +| TFCard Pin | ESP32 Chip | +|:-----------|:-----------| +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO4 | + +**M-Bus** + +
+ M_BUS +
+ +## パッケージ内容 + +- 1x M5Core（白） +- 6x 6種類のユニット(ENV, IR, RGB, PIR, ANGLE, HUB) +- 4x LEGO アクセサリ +- 3x Grove ケーブル +- 1x USB Type-C ケーブル +- 1x ユーザーマニュアル + +## ドキュメント + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) + - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) + +- **GitHub** + - [Arduino](https://github.com/m5stack/M5Stack) + - [MicroPython](https://github.com/m5stack/M5GO) + +- **Quick Start** + - Arduino + - [MacOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + - [Windows_64](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) + +
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+ +## 関連情報 + +- [M5GO Starter Kit 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3875/) - [M5GO Starter Kit 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-M5GO-IoT-arduino-ESP32-MicroPython-IR-550/3226069_32881911596.html) \ No newline at end of file diff --git a/docs/ja/core/m5stick.md b/docs/ja/core/m5stick.md index e914853d..ac32d8cc 100644 --- a/docs/ja/core/m5stick.md +++ b/docs/ja/core/m5stick.md @@ -1,97 +1,97 @@ -# M5Stick - - - -## 概要 - -**M5Stick**は1.3インチのOLEDスクリーン(64x128)、LED、ボタン、ブザー、IR送信機と80mAhの電池を内蔵した開発用ボードです。小型なのでウェアラブルデバイスとして使用したり、壁などに固定して利用することが可能です。 - -**M5Stick**は２種類のモデルがあります。通常版とMPU9250版です。MPU9250版には９軸のIMUが搭載され、さらに`WATCH BELT`、`WALL`、`BRICK`が付属します。 - -## 特徴 - -- サポートプログラミング - - Arduino - - UiFlow (Blockly / MicroPython) -- ウェアラブル -- MEMS IMU(MPU9250版のみ) - -## スペック - -| 項目 | 詳細 | -|:------|:--------------------------| -| Core | M5Stick | -| カラー | 白 (通常版) / 灰 (MPU9250版)| - -## ピンマップ - -| *BLUE_LED* | *ESP32* | -|:-----------|:--------| -| LED_Pin | GPIO19 | - -| *BUTTON* | *ESP32* | -|:-----------|:--------| -| Button_Pin | GPIO35 | - -| *BUZZER* | *ESP32* | -|:-----------|:--------| -| Buzzer_Pin | GPIO26 | - -| *IR* | *ESP32* | -|:-----------|:--------| -| Buzzer_Pin | GPIO17 | - -| *GROVE* | *ESP32* | -|:--------|:--------| -| SDA | GPIO25 | -| SCL | GPIO13 | - -**Optional:** - -| *MPU9250* | *ESP32* | -|:----------|:--------| -| SDA | GPIO22 | -| SCL | GPIO21 | - -## パッケージ内容 - -### 通常版・MPU9250版共通 - -- 1x M5Stick 内蔵 80mAh バッテリー -- 1x USB Type-C ケーブル - -### MPU9250版のみ - -- 付属品 - - `WATCH BELT` - - `WALL` - - `BRICK` - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Stick) - -- **データシート** - - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -- **クイックスタート　(Arduino)** - - 近日公開... - -
- m5stick_01 -
-
- m5stick_02 -
-
- m5stick_03 -
-
- m5stick_04 -
- -## 関連情報 - +# M5Stick + + + +## 概要 + +**M5Stick**は1.3インチのOLEDスクリーン(64x128)、LED、ボタン、ブザー、IR送信機と80mAhの電池を内蔵した開発用ボードです。小型なのでウェアラブルデバイスとして使用したり、壁などに固定して利用することが可能です。 + +**M5Stick**は２種類のモデルがあります。通常版とMPU9250版です。MPU9250版には９軸のIMUが搭載され、さらに`WATCH BELT`、`WALL`、`BRICK`が付属します。 + +## 特徴 + +- サポートプログラミング + - Arduino + - UiFlow (Blockly / MicroPython) +- ウェアラブル +- MEMS IMU(MPU9250版のみ) + +## スペック + +| 項目 | 詳細 | +|:------|:--------------------------| +| Core | M5Stick | +| カラー | 白 (通常版) / 灰 (MPU9250版)| + +## ピンマップ + +| *BLUE_LED* | *ESP32* | +|:-----------|:--------| +| LED_Pin | GPIO19 | + +| *BUTTON* | *ESP32* | +|:-----------|:--------| +| Button_Pin | GPIO35 | + +| *BUZZER* | *ESP32* | +|:-----------|:--------| +| Buzzer_Pin | GPIO26 | + +| *IR* | *ESP32* | +|:-----------|:--------| +| Buzzer_Pin | GPIO17 | + +| *GROVE* | *ESP32* | +|:--------|:--------| +| SDA | GPIO25 | +| SCL | GPIO13 | + +**Optional:** + +| *MPU9250* | *ESP32* | +|:----------|:--------| +| SDA | GPIO22 | +| SCL | GPIO21 | + +## パッケージ内容 + +### 通常版・MPU9250版共通 + +- 1x M5Stick 内蔵 80mAh バッテリー +- 1x USB Type-C ケーブル + +### MPU9250版のみ + +- 付属品 + - `WATCH BELT` + - `WALL` + - `BRICK` + +## ドキュメント + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Stick) + +- **データシート** + - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) + - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +- **クイックスタート　(Arduino)** + - 近日公開... + +
+ m5stick_01 +
+
+ m5stick_02 +
+
+ m5stick_03 +
+
+ m5stick_04 +
+ +## 関連情報 + - [M5Stick 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-M5Stick-ESP32-1-3-OLED-80-mah-Ir/3226069_32947692973.html) \ No newline at end of file diff --git a/docs/ja/core/white.md b/docs/ja/core/white.md index fd280541..d09fe1ae 100644 --- a/docs/ja/core/white.md +++ b/docs/ja/core/white.md @@ -1,167 +1,167 @@ -# M5Core WHITE - - - -## 概要 - -**この白いM5CoreはM5GO IOT Starter Kitのメインボードです。** M5Core Whiteは、M5Core GRAYに似たスペックです。しかしFlashの容量が16MBに増え、M5GOベースを備えている点が異なります。 - -ESP32を備えた素晴らしいボードです。MEMS Chip(**MPU9250**)やTFT液晶も備えており、3Dジェスチャコントローラや、簡単な "Leap Motion" のようなプロダクトを数週間で作ることも可能です。 - -M5Coreの下のボトムボードには、I2Sピン(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)の他にM-BusベースのDIY向け拡張用GPIOが用意されています。 - -## 特徴 - -- プログラミングサポート - - UiFlow - - MicroPython - - Arduino -- LEGO 互換ホール -- TFカードサポート - -## スペック - -| 項目 | 詳細 | -|:----|:-----| -| ESP32 | 240MHz x 2 core, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモード Bluetooth | -| Flash | 16MB | -| 電源入力 | 5V @ 500mA | -| インターフェース | USB Type-C x 1, Grove(I2C+I/0+UART) x 1 | -| LCD | 2 inch, 320x240 フルカラーTFT液晶, ILI9342 | -| スピーカー | 1W-0928 | -| **MEMS** | MPU9250 | -| 電池 | 150mAh @ 3.7V, inside vb | -| 動作温度 | 32°F to 104°F ( 0°C to 40°C ) | -| サイズ | 54 x 54 x 12.5 mm | -| ケース材質 | Plastic ( PC ) | -| 重量 | 120g（ボトム部含む）, 100g（コアのみ）| - -## ピンマップ - -**ポゴピン** - -| POGO Pin | ESP32 Chip | -|:--------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LEDバー** - -| LED Pin | ESP32 Chip | -|:--------|:-----------| -| LED Pin | GPIO15 | - -**マイク** - -| MIC Pin | ESP32 Chip | -|:--------|:-----------| -| MIC Pin | GPIO34 | - -**スピーカー** - -| Speak Pin | ESP32 Chip | -|:----------|:-----------| -| Speak Pin | GPIO25 | - -**ボタン** - -| Button Pin | ESP32 Chip | -|:-----------|:-----------| -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**Grove** - -| PORT A(I2C) | ESP32 Chip | -|:------------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -|:------------|:-----------| -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -|:--------------|:-----------| -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**MEMS Chip** - -*MPU9250 I2Cアドレス: 0x68* - -| MPU9250 | ESP32 Chip | -|:--------|:-----------| -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -**LCD** - -| ILI9341 | ESP32 Chip | -|:--------|:-----------| -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | - -**TFカード** - -| TFCard Pin | ESP32 Chip | -|:-----------|:-----------| -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | - -**M-Bus** - -
- M_BUS -
- -## パッケージ内容 - -- 1x M5Core WHITE -- 1x M5GO ベース -- 1x M5GO CHG ベース -- USB Type-C ケーブル -- ユーザーマニュアル - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) - -- **GitHub** - - [Arduino](https://github.com/m5stack/M5Stack) - - [MicroPython](https://github.com/m5stack/M5GO) - -- **クイックスタート** - - Arduino - - [MacOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - - [Windows_64](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) - -- **[M5Coreによる違い](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md)** - -
- -
- -## 関連資料 - +# M5Core WHITE + + + +## 概要 + +**この白いM5CoreはM5GO IOT Starter Kitのメインボードです。** M5Core Whiteは、M5Core GRAYに似たスペックです。しかしFlashの容量が16MBに増え、M5GOベースを備えている点が異なります。 + +ESP32を備えた素晴らしいボードです。MEMS Chip(**MPU9250**)やTFT液晶も備えており、3Dジェスチャコントローラや、簡単な "Leap Motion" のようなプロダクトを数週間で作ることも可能です。 + +M5Coreの下のボトムボードには、I2Sピン(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)の他にM-BusベースのDIY向け拡張用GPIOが用意されています。 + +## 特徴 + +- プログラミングサポート + - UiFlow + - MicroPython + - Arduino +- LEGO 互換ホール +- TFカードサポート + +## スペック + +| 項目 | 詳細 | +|:----|:-----| +| ESP32 | 240MHz x 2 core, 600 DMIPS, 520KB SRAM, Wi-Fi, デュアルモード Bluetooth | +| Flash | 16MB | +| 電源入力 | 5V @ 500mA | +| インターフェース | USB Type-C x 1, Grove(I2C+I/0+UART) x 1 | +| LCD | 2 inch, 320x240 フルカラーTFT液晶, ILI9342 | +| スピーカー | 1W-0928 | +| **MEMS** | MPU9250 | +| 電池 | 150mAh @ 3.7V, inside vb | +| 動作温度 | 32°F to 104°F ( 0°C to 40°C ) | +| サイズ | 54 x 54 x 12.5 mm | +| ケース材質 | Plastic ( PC ) | +| 重量 | 120g（ボトム部含む）, 100g（コアのみ）| + +## ピンマップ + +**ポゴピン** + +| POGO Pin | ESP32 Chip | +|:--------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | + +**LEDバー** + +| LED Pin | ESP32 Chip | +|:--------|:-----------| +| LED Pin | GPIO15 | + +**マイク** + +| MIC Pin | ESP32 Chip | +|:--------|:-----------| +| MIC Pin | GPIO34 | + +**スピーカー** + +| Speak Pin | ESP32 Chip | +|:----------|:-----------| +| Speak Pin | GPIO25 | + +**ボタン** + +| Button Pin | ESP32 Chip | +|:-----------|:-----------| +| BUTTON A | GPIO39 | +| BUTTON B | GPIO38 | +| BUTTON C | GPIO37 | + +**Grove** + +| PORT A(I2C) | ESP32 Chip | +|:------------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +| PORT B(I/O) | ESP32 Chip | +|:------------|:-----------| +| G36 | GPIO36 | +| G26 | GPIO26 | +| 5V | 5V | +| GND | GND | + +| PORT C(UART2) | ESP32 Chip | +|:--------------|:-----------| +| RXD | GPIO16 | +| TXD | GPIO17 | +| 5V | 5V | +| GND | GND | + +**MEMS Chip** + +*MPU9250 I2Cアドレス: 0x68* + +| MPU9250 | ESP32 Chip | +|:--------|:-----------| +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +**LCD** + +| ILI9341 | ESP32 Chip | +|:--------|:-----------| +| MOSI | GPIO23 | +| MISO | / | +| CLK | GPIO18 | +| CS | GPIO14 | +| DC | GPIO27 | +| RST | GPIO33 | +| BL | GPIO32 | + +**TFカード** + +| TFCard Pin | ESP32 Chip | +|:-----------|:-----------| +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO4 | + +**M-Bus** + +
+ M_BUS +
+ +## パッケージ内容 + +- 1x M5Core WHITE +- 1x M5GO ベース +- 1x M5GO CHG ベース +- USB Type-C ケーブル +- ユーザーマニュアル + +## ドキュメント + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) + - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) + +- **GitHub** + - [Arduino](https://github.com/m5stack/M5Stack) + - [MicroPython](https://github.com/m5stack/M5GO) + +- **クイックスタート** + - Arduino + - [MacOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + - [Windows_64](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) + +- **[M5Coreによる違い](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md)** + +
+ +
+ +## 関連資料 + - **[M5GO IoT Starter Kit 購入 (AliExpress)](https://www.aliexpress.com/store/product/M5Stack-M5GO-IoT-arduino-ESP32-MicroPython-IR-550/3226069_32881911596.html)** \ No newline at end of file diff --git a/docs/ja/faq.md b/docs/ja/faq.md index 69058a09..c1f1131e 100644 --- a/docs/ja/faq.md +++ b/docs/ja/faq.md @@ -1,28 +1,28 @@ -# よくある質問 - - - ---- - -- Q. USB Type-C ケーブルに上下はありますか？ - - A. ありません。上下どちらでも使用可能です。 - ---- - -- Q. ArduinoでI2Cがうまく動きません。 - - A. Arduino IDEのボードマネージャから最新のesp32ライブラリ(>=1.0.1)を導入してください。 - ---- - -- Q. UiFlowのソースは公開されていますか？ - - A. 現在公開はされていません。もしかしたら将来公開されるかもしれません。 - ---- - -- Q. XXX の使い方がわかりません。 - - A. Twitterで [@M5Stack](https://twitter.com/M5Stack) 宛てにメッセージをお送りください。 - ---- - -- Q. 買った時から XXX が壊れています。 +# よくある質問 + + + +--- + +- Q. USB Type-C ケーブルに上下はありますか？ + - A. ありません。上下どちらでも使用可能です。 + +--- + +- Q. ArduinoでI2Cがうまく動きません。 + - A. Arduino IDEのボードマネージャから最新のesp32ライブラリ(>=1.0.1)を導入してください。 + +--- + +- Q. UiFlowのソースは公開されていますか？ + - A. 現在公開はされていません。もしかしたら将来公開されるかもしれません。 + +--- + +- Q. XXX の使い方がわかりません。 + - A. Twitterで [@M5Stack](https://twitter.com/M5Stack) 宛てにメッセージをお送りください。 + +--- + +- Q. 買った時から XXX が壊れています。 - A. お買い求め担ったお店にお問い合わせいただくか、またはTwitterで [@M5Stack](https://twitter.com/M5Stack) 宛てにメッセージをお送りください。 \ No newline at end of file diff --git a/docs/ja/module/battery.md b/docs/ja/module/battery.md index cc2e7bb0..3768bfd9 100644 --- a/docs/ja/module/battery.md +++ b/docs/ja/module/battery.md @@ -1,34 +1,34 @@ -# BATTERY モジュール - - - -## 概要 - -**BATTERY**モジュールは850mAhの大容量バッテリを内蔵しています。 - -これによりM5Stack単独で動作するポータブルデバイスを開発する事が可能です。 - -## 特徴 - -- 850mAh 大容量バッテリ - -## パッケージ内容 - -- 1x BATTERY モジュール - -## ドキュメント - -- **ウェブサイト** - - [M5Stack](https://m5stack.com) - -
- module_battery_01 -
-
- module_battery_02 -
- -## 関連情報 - -- [BATTERY モジュール 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3653/) -- [BATTERY モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-arduino-ESP32-850-mah-iot/3226069_32839688875.html) +# BATTERY モジュール + + + +## 概要 + +**BATTERY**モジュールは850mAhの大容量バッテリを内蔵しています。 + +これによりM5Stack単独で動作するポータブルデバイスを開発する事が可能です。 + +## 特徴 + +- 850mAh 大容量バッテリ + +## パッケージ内容 + +- 1x BATTERY モジュール + +## ドキュメント + +- **ウェブサイト** + - [M5Stack](https://m5stack.com) + +
+ module_battery_01 +
+
+ module_battery_02 +
+ +## 関連情報 + +- [BATTERY モジュール 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3653/) +- [BATTERY モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-arduino-ESP32-850-mah-iot/3226069_32839688875.html) diff --git a/docs/ja/module/btc.md b/docs/ja/module/btc.md index eab35727..f367fb2b 100644 --- a/docs/ja/module/btc.md +++ b/docs/ja/module/btc.md @@ -1,60 +1,60 @@ -# BTC モジュール - - - -## 概要 - -**BTC**モジュールは温度と湿度を計測することができるDHT12センサーを内蔵しています。 -また充電スタンドとして利用できます。これにより小型温湿度計やBTCティッカーなどを作成する事が可能です。 - -## 特徴 - -- DHT12内蔵 -- 充電スタンド - -## パッケージ内容 - -- 1x BTC モジュール -- 1x USB Type-C ケーブル -- 2x M3x16ネジ -- 1x 六角レンチ - -## ピンマップ - -| DHT12 | ESP32 | -| :----------: |:------------:| -| SCL | G22 | -| GND | GND | -| SDA | G21 | -| 3V3 | 3V3 | - -
- -
- -## ドキュメント - -- **ウェブサイト** - -- [サンプルコード](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/DHT12) (for DHT12) - -
- module_btc_01 -
-
- module_btc_02 -
-
- module_btc_03 -
-
- module_btc_04 -
-
- module_btc_05 -
- -## 関連情報 - -- [BTC モジュール 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3993/) +# BTC モジュール + + + +## 概要 + +**BTC**モジュールは温度と湿度を計測することができるDHT12センサーを内蔵しています。 +また充電スタンドとして利用できます。これにより小型温湿度計やBTCティッカーなどを作成する事が可能です。 + +## 特徴 + +- DHT12内蔵 +- 充電スタンド + +## パッケージ内容 + +- 1x BTC モジュール +- 1x USB Type-C ケーブル +- 2x M3x16ネジ +- 1x 六角レンチ + +## ピンマップ + +| DHT12 | ESP32 | +| :----------: |:------------:| +| SCL | G22 | +| GND | GND | +| SDA | G21 | +| 3V3 | 3V3 | + +
+ +
+ +## ドキュメント + +- **ウェブサイト** + +- [サンプルコード](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/DHT12) (for DHT12) + +
+ module_btc_01 +
+
+ module_btc_02 +
+
+ module_btc_03 +
+
+ module_btc_04 +
+
+ module_btc_05 +
+ +## 関連情報 + +- [BTC モジュール 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3993/) - [BTC モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-btc-DHT12-ESP32-micropython-bitcoin/3226069_32852302770.html) \ No newline at end of file diff --git a/docs/ja/module/commu.md b/docs/ja/module/commu.md index 68760df9..807f1cec 100644 --- a/docs/ja/module/commu.md +++ b/docs/ja/module/commu.md @@ -1,54 +1,54 @@ -# COMMU モジュール - - - -## 概要 - -**COMMU**モジュールはアプリケーション設計の大部分を満たす事ができる通信インターフェースコンバータモジュールです。1つのRS-485インターフェース、１つのCANインターフェース、2つのI2Cインターフェースを備えています。M5Coreにスタックするだけで、RS-485デバイスやCANデバイスを制御する事が可能です。TTLインターフェースに注意してください。デフォルトではUARTですが、(J6, J7, J9, J10)のジャンパを変更する事でUART2に接続可能です。 - -## 特徴 - -- 2x I2C インタフェース -- 1x CAN インタフェース(コントローラ: MCP2515, トランシーバ: TJA1051) -- 1x RS-485 インタフェース(SP3485) -- 1x TTL インタフェース - -## パッケージ内容 - -- 1x COMMU モジュール - -## ピンマップ - -| CAN | ESP32 | -|:---:|:-----:| -| CAN_CS | GPIO12 | -| CAN_INT | GPIO15 | -| CAN_SCK | GPIO18 | -| CAN_MISO | GPIO19 | -| CAN_MOSI | GPIO23 | - -| I2C Interface | ESP32 | -|:-------------:|:-----:| -| IIC_SDA | GPIO21 | -| IIC_SCL | GPIO22 | - -## ドキュメント - -- **回路図** - - [Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Modules/module_commu_sch.pdf) - -- **データシート** - - [MCP2515](http://ww1.microchip.com/downloads/en/devicedoc/20001801h.pdf) - - [TJA1051](https://www.nxp.com/docs/en/data-sheet/TJA1051.pdf) - - [SP3485](https://www.exar.com/ds/sp3485.pdf) - -
- module_commu_01 -
-
- module_commu_02 -
- -## 関連情報 - +# COMMU モジュール + + + +## 概要 + +**COMMU**モジュールはアプリケーション設計の大部分を満たす事ができる通信インターフェースコンバータモジュールです。1つのRS-485インターフェース、１つのCANインターフェース、2つのI2Cインターフェースを備えています。M5Coreにスタックするだけで、RS-485デバイスやCANデバイスを制御する事が可能です。TTLインターフェースに注意してください。デフォルトではUARTですが、(J6, J7, J9, J10)のジャンパを変更する事でUART2に接続可能です。 + +## 特徴 + +- 2x I2C インタフェース +- 1x CAN インタフェース(コントローラ: MCP2515, トランシーバ: TJA1051) +- 1x RS-485 インタフェース(SP3485) +- 1x TTL インタフェース + +## パッケージ内容 + +- 1x COMMU モジュール + +## ピンマップ + +| CAN | ESP32 | +|:---:|:-----:| +| CAN_CS | GPIO12 | +| CAN_INT | GPIO15 | +| CAN_SCK | GPIO18 | +| CAN_MISO | GPIO19 | +| CAN_MOSI | GPIO23 | + +| I2C Interface | ESP32 | +|:-------------:|:-----:| +| IIC_SDA | GPIO21 | +| IIC_SCL | GPIO22 | + +## ドキュメント + +- **回路図** + - [Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Modules/module_commu_sch.pdf) + +- **データシート** + - [MCP2515](http://ww1.microchip.com/downloads/en/devicedoc/20001801h.pdf) + - [TJA1051](https://www.nxp.com/docs/en/data-sheet/TJA1051.pdf) + - [SP3485](https://www.exar.com/ds/sp3485.pdf) + +
+ module_commu_01 +
+
+ module_commu_02 +
+ +## 関連情報 + - [COMMU モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-RS485-TTL-I2C-MCP2515-TJA1051-SP3485/3226069_32954475633.html) \ No newline at end of file diff --git a/docs/ja/module/gps.md b/docs/ja/module/gps.md index e4bd86fa..4812d296 100644 --- a/docs/ja/module/gps.md +++ b/docs/ja/module/gps.md @@ -1,49 +1,49 @@ -# GPSモジュール - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**      :electric_plug:**[回路図](#回路図)**      🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-gps-mcx-iot-arduino-ESP32/3226069_32840757048.html)** - -## 概要 - -**GPS**モジュールはu-bloxのNEO-M8Nを採用した小型のGPSモジュールです。 - -**GPS**モジュールはu-bloxのM8 GNSSエンジンにより、高い性能と受信感度を発揮します。 - -## 特徴 - -- GPS NEO-M8Nモジュール -- 高性能 -- 高受信感度 (–167 dBm) -- 最大 3 GNSS 同時受信可能（GPS, Galileo, GLONASS, BeiDou/COMPASS) -- 内蔵または外付けアンテナを選択可能 - -## パッケージ内容 - -- 1x GPSモジュール -- 1x 外付けアンテナ - -## アプリケーション - -- 子供向けGPSブレスレット -- GPSによる物流トラッキングシステム - -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -- **[データシート](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) - -## サンプルコード - -### 1. Arduino IDE - -### 2. UIFlow - -## 回路図 - - +# GPSモジュール + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**      :electric_plug:**[回路図](#回路図)**      🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-gps-mcx-iot-arduino-ESP32/3226069_32840757048.html)** + +## 概要 + +**GPS**モジュールはu-bloxのNEO-M8Nを採用した小型のGPSモジュールです。 + +**GPS**モジュールはu-bloxのM8 GNSSエンジンにより、高い性能と受信感度を発揮します。 + +## 特徴 + +- GPS NEO-M8Nモジュール +- 高性能 +- 高受信感度 (–167 dBm) +- 最大 3 GNSS 同時受信可能（GPS, Galileo, GLONASS, BeiDou/COMPASS) +- 内蔵または外付けアンテナを選択可能 + +## パッケージ内容 + +- 1x GPSモジュール +- 1x 外付けアンテナ + +## アプリケーション + +- 子供向けGPSブレスレット +- GPSによる物流トラッキングシステム + +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +- **[データシート](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) + +## サンプルコード + +### 1. Arduino IDE + +### 2. UIFlow + +## 回路図 + + diff --git a/docs/ja/module/lan.md b/docs/ja/module/lan.md index ec763a64..9ba0cd32 100644 --- a/docs/ja/module/lan.md +++ b/docs/ja/module/lan.md @@ -1,45 +1,45 @@ -# LAN モジュール - - - -## 概要 - -The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports. - -When the speed of our wireless network is so slow that M5Stack Core can not normally connect to the wireless network. -So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem. - -## 特徴 - -- W5500 - High-performance ethernet chip -- Less code and Hand-in-hand program experience - -## パッケージ内容 - -- 1x M5Stack LAN Module(including USER-DEFINE 6 PIN and 1 Grove port) -- 1x DIN-RAIL -- 1x STICKER - -## アプリケーション - -- A mini portable Web server - - TCP/UDP Server - - HTTP Server -- A mini portable Web Clinet - - TCP/UDP Clinet - - HTTP Clinet -- SMTP/NTP Server - -## ドキュメント - -- [WebSite](https://m5stack.com) - -- Example - - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) - -- [LAN Info](https://www.u-blox.com/zh/product/neo-m8-series) (LAN) - -- GitHub - - [Arduino GitHub](https://github.com/m5stack/M5Stack) - -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html) +# LAN モジュール + + + +## 概要 + +The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports. + +When the speed of our wireless network is so slow that M5Stack Core can not normally connect to the wireless network. +So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem. + +## 特徴 + +- W5500 - High-performance ethernet chip +- Less code and Hand-in-hand program experience + +## パッケージ内容 + +- 1x M5Stack LAN Module(including USER-DEFINE 6 PIN and 1 Grove port) +- 1x DIN-RAIL +- 1x STICKER + +## アプリケーション + +- A mini portable Web server + - TCP/UDP Server + - HTTP Server +- A mini portable Web Clinet + - TCP/UDP Clinet + - HTTP Clinet +- SMTP/NTP Server + +## ドキュメント + +- [WebSite](https://m5stack.com) + +- Example + - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) + +- [LAN Info](https://www.u-blox.com/zh/product/neo-m8-series) (LAN) + +- GitHub + - [Arduino GitHub](https://github.com/m5stack/M5Stack) + +- [Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html) diff --git a/docs/ja/module/lego_plus.md b/docs/ja/module/lego_plus.md index a402434a..1aa11b11 100644 --- a/docs/ja/module/lego_plus.md +++ b/docs/ja/module/lego_plus.md @@ -1,31 +1,31 @@ -# LEGO+ モジュール - -## 概要 - -**LEGO+**モジュールは、ATmega328を内蔵したDCモーターコントロールモジュールです。LEGO+モジュールはI2Cを介してM5Coreと通信します。I2Cアドレスは**0x56**です。このモジュールには、高電圧入力ドライブのモーターが必要な場合に接続できるDC電源ジャックも装備されています。 -## 特徴 - -- DCコネクタ許容入力電圧範囲：6-12V - -## パッケージ内容 - -- 1x LEGO+モジュール -- 1x 10cm LEGOケーブル -- 1x DCジャック - -## ドキュメント - - - - -
- -
- - - -## 関連情報 - +# LEGO+ モジュール + +## 概要 + +**LEGO+**モジュールは、ATmega328を内蔵したDCモーターコントロールモジュールです。LEGO+モジュールはI2Cを介してM5Coreと通信します。I2Cアドレスは**0x56**です。このモジュールには、高電圧入力ドライブのモーターが必要な場合に接続できるDC電源ジャックも装備されています。 +## 特徴 + +- DCコネクタ許容入力電圧範囲：6-12V + +## パッケージ内容 + +- 1x LEGO+モジュール +- 1x 10cm LEGOケーブル +- 1x DCジャック + +## ドキュメント + + + + +
+ +
+ + + +## 関連情報 + - [LEGO+ モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-MEGA328-4-DC-10-DC-I2C/3226069_32961587834.html) \ No newline at end of file diff --git a/docs/ja/module/lora.md b/docs/ja/module/lora.md index 716c5f06..18d642c7 100644 --- a/docs/ja/module/lora.md +++ b/docs/ja/module/lora.md @@ -1,63 +1,63 @@ -# LORA モジュール - - - -## 概要 - -**LORA**モジュールはRa-02と呼ばれる小型のLoRa™モジュールを採用しています。 - -LoRa™は少ない消費電力で広いエリアをカバーする無線通信方式の一つです。 - -## 特徴 - -- Ai-Thinker製Ra-02採用 -- FSK, GFSK, MSK, GMSK, LoRa™, OOK 変調モードをサポート -- 受信感度 -141 dBm -- ビットレート可変 up to 300Kbps -- アンテナ内蔵 - -## パッケージ内容 - -- 1x LORA モジュール - -## アプリケーション - -- 自動検針器 -- スマートホーム -- リモート灌漑システム - -## ドキュメント - -- **ウェブサイト** - - [M5Stack](https://m5stack.com) -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Lora) -- **データシート** - - [LoRa](http://wiki.ai-thinker.com/lora) -- **GitHub** - - [M5Stack](https://github.com/m5stack/M5Stack) - -?> **メモ** もしあなたのLCD画面が表示されない場合は、以下のソースのように``m5.begin()``の前にGPIO5をプルアップする２行を追加してみてください。GPIO5がLoRaモジュールのNSSピンに接続されている為、GPIO５をプルアップする必要があります。 - -```cpp - pinMode(5,OUTPUT); - digitalWrite(5,HIGH); - m5.begin(); -``` - -
- module_lora_01 -
-
- module_lora_02 -
-
- module_lora_03 -
-
- module_lora_04 -
- -## 関連情報 - -- [LORA モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-lora-ESP32-diy-433-mhz-iot/3226069_32839736315.html) +# LORA モジュール + + + +## 概要 + +**LORA**モジュールはRa-02と呼ばれる小型のLoRa™モジュールを採用しています。 + +LoRa™は少ない消費電力で広いエリアをカバーする無線通信方式の一つです。 + +## 特徴 + +- Ai-Thinker製Ra-02採用 +- FSK, GFSK, MSK, GMSK, LoRa™, OOK 変調モードをサポート +- 受信感度 -141 dBm +- ビットレート可変 up to 300Kbps +- アンテナ内蔵 + +## パッケージ内容 + +- 1x LORA モジュール + +## アプリケーション + +- 自動検針器 +- スマートホーム +- リモート灌漑システム + +## ドキュメント + +- **ウェブサイト** + - [M5Stack](https://m5stack.com) +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Lora) +- **データシート** + - [LoRa](http://wiki.ai-thinker.com/lora) +- **GitHub** + - [M5Stack](https://github.com/m5stack/M5Stack) + +?> **メモ** もしあなたのLCD画面が表示されない場合は、以下のソースのように``m5.begin()``の前にGPIO5をプルアップする２行を追加してみてください。GPIO5がLoRaモジュールのNSSピンに接続されている為、GPIO５をプルアップする必要があります。 + +```cpp + pinMode(5,OUTPUT); + digitalWrite(5,HIGH); + m5.begin(); +``` + +
+ module_lora_01 +
+
+ module_lora_02 +
+
+ module_lora_03 +
+
+ module_lora_04 +
+ +## 関連情報 + +- [LORA モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-lora-ESP32-diy-433-mhz-iot/3226069_32839736315.html) diff --git a/docs/ja/module/lorawan.md b/docs/ja/module/lorawan.md index 3a20b17d..420e5360 100644 --- a/docs/ja/module/lorawan.md +++ b/docs/ja/module/lorawan.md @@ -1,53 +1,53 @@ -# LoRaWAN モジュール - - - -## 概要 - -**LoRaWAN**モジュールはLoRaチップ(SX1276)とMCU内蔵の小型LoRa端末モジュールです。完全なLoRaプロトコルスタックが組み込まれており、UARTまたはsimple ATコマンドを利用してLoRaWANモジュールを開発することができます。 - -デフォルトUART config: "9600, 8, n, 1" (8ビットデータ, ノーパリティ, 1ストップビット) - -?> "LoRaWAN"シルクスクリーンの隣の5つの穴はLoRaWANモジュールのファームウェアアップデート用です。 - -## 特徴 - -- サポートバンド: 433/470MHz , 868/915MHz -- データレート: 0.018-38.4kbps -- 出力: 17 ± 0.5dbm -- ADR(Adaptive Data Rate)サポート -- アンテナ内蔵 - -## パッケージ内容 - -- 1x LoRaWAN　モジュール - -## アプリケーション - -- オートメーターリーダー -- スマートホーム -- リモート灌漑システム - -## ピンマップ - -|RHF76-052_UART | ESP32 Chip | -|:--------------|:-----------| -|RXD | GPIO16 | -|TXD | GPIO17 | - -## ドキュメント - -- データシート - - [RHF76-052 wiki](http://wiki.ai-thinker.com/sx127x-052) - - [ATコマンド for LoRaWAN](http://wiki.ai-thinker.com/_media/rhf-ps01509_module_lorawan_class_ac_at_command_specification_-_v4.4.pdf) - -
- module_lorawan_01 -
-
- module_lorawan_02 -
- -## 関連情報 - +# LoRaWAN モジュール + + + +## 概要 + +**LoRaWAN**モジュールはLoRaチップ(SX1276)とMCU内蔵の小型LoRa端末モジュールです。完全なLoRaプロトコルスタックが組み込まれており、UARTまたはsimple ATコマンドを利用してLoRaWANモジュールを開発することができます。 + +デフォルトUART config: "9600, 8, n, 1" (8ビットデータ, ノーパリティ, 1ストップビット) + +?> "LoRaWAN"シルクスクリーンの隣の5つの穴はLoRaWANモジュールのファームウェアアップデート用です。 + +## 特徴 + +- サポートバンド: 433/470MHz , 868/915MHz +- データレート: 0.018-38.4kbps +- 出力: 17 ± 0.5dbm +- ADR(Adaptive Data Rate)サポート +- アンテナ内蔵 + +## パッケージ内容 + +- 1x LoRaWAN　モジュール + +## アプリケーション + +- オートメーターリーダー +- スマートホーム +- リモート灌漑システム + +## ピンマップ + +|RHF76-052_UART | ESP32 Chip | +|:--------------|:-----------| +|RXD | GPIO16 | +|TXD | GPIO17 | + +## ドキュメント + +- データシート + - [RHF76-052 wiki](http://wiki.ai-thinker.com/sx127x-052) + - [ATコマンド for LoRaWAN](http://wiki.ai-thinker.com/_media/rhf-ps01509_module_lorawan_class_ac_at_command_specification_-_v4.4.pdf) + +
+ module_lorawan_01 +
+
+ module_lorawan_02 +
+ +## 関連情報 + - [LoRaWAN モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-LoRaWAN-433-470-mhz-868-915-mhz-mcx/3226069_32953098569.html) \ No newline at end of file diff --git a/docs/ja/module/plc.md b/docs/ja/module/plc.md index 49d554a2..c24deccc 100644 --- a/docs/ja/module/plc.md +++ b/docs/ja/module/plc.md @@ -1,45 +1,45 @@ -# M5Stack PLC モジュール - - - -## 概要 - -The M5Stack PLC Module is a prototye industrial board, including RS484 -adapter and electricity meter module. - -With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin -relay output, digital input, communication interface etc. - -## 特徴 - -- Free DIY -- Programmable Logic Controller -- Individual package weight: 0.1kg (0.22lb.) -- Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) - -## パッケージ内容 - -- 1x PLC-Proto Broad -- 1x RS485 module -- 1x PLC Plastic Enclosure -- 1x Slide Guide -- 1x Magnet -- 1x 6 Pin 3.96 Pitch Terminal -- 1x 4 Pin 3.96 Pitch Terminal -- 3x Hex Key -- 7x Electrical Terminal -- 1x Sticker - -## アプリケーション - -- Programmable Logic Controller -- Programmable Motion Controller -- Digital Operation Processor -- Strong Electric Controller - -## ドキュメント - -- [WebSiteStart](https://m5stack.com) -- GitHub - - [Arduino](https://github.com/m5stack/M5Stack) - - [MicroPython]() +# M5Stack PLC モジュール + + + +## 概要 + +The M5Stack PLC Module is a prototye industrial board, including RS484 +adapter and electricity meter module. + +With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin +relay output, digital input, communication interface etc. + +## 特徴 + +- Free DIY +- Programmable Logic Controller +- Individual package weight: 0.1kg (0.22lb.) +- Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) + +## パッケージ内容 + +- 1x PLC-Proto Broad +- 1x RS485 module +- 1x PLC Plastic Enclosure +- 1x Slide Guide +- 1x Magnet +- 1x 6 Pin 3.96 Pitch Terminal +- 1x 4 Pin 3.96 Pitch Terminal +- 3x Hex Key +- 7x Electrical Terminal +- 1x Sticker + +## アプリケーション + +- Programmable Logic Controller +- Programmable Motion Controller +- Digital Operation Processor +- Strong Electric Controller + +## ドキュメント + +- [WebSiteStart](https://m5stack.com) +- GitHub + - [Arduino](https://github.com/m5stack/M5Stack) + - [MicroPython]() diff --git a/docs/ja/module/plus.md b/docs/ja/module/plus.md index 974bf5c2..c6e4b910 100644 --- a/docs/ja/module/plus.md +++ b/docs/ja/module/plus.md @@ -1,39 +1,39 @@ -# PLUS モジュール - - - -## 概要 - -**PLUS**モジュールは500mAhのバッテリ、ロータリエンコーダ、IR送信機、PORT B(GPIO)、PORT C(UART)そしてマイクジャックの為のパッドを備えています。M5Stackの下に重ねるだけで、機能を強化することが出来ます。M5Stackとの通信にはI2Cを使用します。I2Cアドレスは **0x89**です。 - -## 特徴 - -- 500mAh バッテリー -- プログラマブルロータリエンコーダ -- IR送信機 -- PORT B (GPIO) -- PORT C (UART) - -## パッケージ内容 - -- 1x PLUS モジュール - -## ドキュメント - -- **ウェブサイト** - - [M5Stack](https://m5stack.com) -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Plus) -- **GitHub** - - [M5Stack](https://github.com/m5stack/M5Stack) - -
- module_plus_01 -
-
- module_plus_01 -
- -## 関連情報 - +# PLUS モジュール + + + +## 概要 + +**PLUS**モジュールは500mAhのバッテリ、ロータリエンコーダ、IR送信機、PORT B(GPIO)、PORT C(UART)そしてマイクジャックの為のパッドを備えています。M5Stackの下に重ねるだけで、機能を強化することが出来ます。M5Stackとの通信にはI2Cを使用します。I2Cアドレスは **0x89**です。 + +## 特徴 + +- 500mAh バッテリー +- プログラマブルロータリエンコーダ +- IR送信機 +- PORT B (GPIO) +- PORT C (UART) + +## パッケージ内容 + +- 1x PLUS モジュール + +## ドキュメント + +- **ウェブサイト** + - [M5Stack](https://m5stack.com) +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Plus) +- **GitHub** + - [M5Stack](https://github.com/m5stack/M5Stack) + +
+ module_plus_01 +
+
+ module_plus_01 +
+ +## 関連情報 + - [PLUS モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-MEGA328P-500-mah-ISP-Ir-UART-GPIO/3226069_32949278724.html) \ No newline at end of file diff --git a/docs/ja/module/proto.md b/docs/ja/module/proto.md index 9e1ea49b..defd762c 100644 --- a/docs/ja/module/proto.md +++ b/docs/ja/module/proto.md @@ -1,107 +1,107 @@ -# PROTO モジュール - - - -## 概要 - -**PROTO**モジュールは、各M5Stack Coreと接続可能な30ピンソケットとユニバーサル基板が一体になった試作用モジュールです。あなたのアイデアを自由に試作することができます。 - -## 特徴 - -- フレキシブルなブランクホール -- M5Stack Coreと互換性のある30ピンソケット -- 温湿度センサー DHT12 付属 (キット購入時) - -## インターフェース - -| LINE0 | LINE1 | -|:---|:---| -| GND | IO35(ADC1) | -| GND | IO36(ADC2) | -| GND | EN | -| IO23(MOSI) | IO25(DAC0) | -| IO19(MISO) | IO26(DAC1) | -| IO18(EXT_SCK) | 3V3 | -| IO3(U1_RX) | IO1(U1_TX) | -| IO16(U1_RX) | IO17(U2_TX) | -| IO21(I2C_SDA) | IO22(I2C_SCL) | -| IO2 | IO5 | -| IO12(I2S_SCLK) | IO13 | -| IO15(I2S_OUT) | IO0 | -| HPOWR | IO34 | -| HPOWR | 5V | -| HPOWR | BAT | - -## パッケージ内容 - -### PROTO モジュール Kit - -- 1x PROTO モジュール -- 1x DHT12 温湿度センサー -- 1x バスソケット -- 1x Grove ケーブル -- 1x パッキングボックス -- ユーザーマニュアル - -### PROTOT モジュール - -- 1x PROTO モジュール - -### ボード - -- 3x PROTO ボード - -## ドキュメント - -- **ウェブサイト** - - [M5Stack](https://m5stack.com) - -- **GitHub** - - [M5Stack](https://github.com/m5stack/M5Stack) - -### Kit - -
- proto_kit_01 -
-
- proto_kit_02 -
-
- proto_kit_03 -
- -### モジュールのみ - -
- module_proto_01 -
-
- module_proto_02 -
-
- module_proto_03 -
- -### ボードのみ - -
- proto_board_01 -
-
- proto_board_02 -
-
- proto_board_03 -
-
- proto_board_04 -
- -## 関連情報 - -- [PROTO モジュール Kit 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3651/) -- [PROTO モジュール 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3650/) -- [PROTO モジュール Kit 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-DHT12-socke-ESP32-Mpu9250-arduino/3226069_32841004439.html) -- [PROTO モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-arduino-ESP32/3226069_32843231933.html) +# PROTO モジュール + + + +## 概要 + +**PROTO**モジュールは、各M5Stack Coreと接続可能な30ピンソケットとユニバーサル基板が一体になった試作用モジュールです。あなたのアイデアを自由に試作することができます。 + +## 特徴 + +- フレキシブルなブランクホール +- M5Stack Coreと互換性のある30ピンソケット +- 温湿度センサー DHT12 付属 (キット購入時) + +## インターフェース + +| LINE0 | LINE1 | +|:---|:---| +| GND | IO35(ADC1) | +| GND | IO36(ADC2) | +| GND | EN | +| IO23(MOSI) | IO25(DAC0) | +| IO19(MISO) | IO26(DAC1) | +| IO18(EXT_SCK) | 3V3 | +| IO3(U1_RX) | IO1(U1_TX) | +| IO16(U1_RX) | IO17(U2_TX) | +| IO21(I2C_SDA) | IO22(I2C_SCL) | +| IO2 | IO5 | +| IO12(I2S_SCLK) | IO13 | +| IO15(I2S_OUT) | IO0 | +| HPOWR | IO34 | +| HPOWR | 5V | +| HPOWR | BAT | + +## パッケージ内容 + +### PROTO モジュール Kit + +- 1x PROTO モジュール +- 1x DHT12 温湿度センサー +- 1x バスソケット +- 1x Grove ケーブル +- 1x パッキングボックス +- ユーザーマニュアル + +### PROTOT モジュール + +- 1x PROTO モジュール + +### ボード + +- 3x PROTO ボード + +## ドキュメント + +- **ウェブサイト** + - [M5Stack](https://m5stack.com) + +- **GitHub** + - [M5Stack](https://github.com/m5stack/M5Stack) + +### Kit + +
+ proto_kit_01 +
+
+ proto_kit_02 +
+
+ proto_kit_03 +
+ +### モジュールのみ + +
+ module_proto_01 +
+
+ module_proto_02 +
+
+ module_proto_03 +
+ +### ボードのみ + +
+ proto_board_01 +
+
+ proto_board_02 +
+
+ proto_board_03 +
+
+ proto_board_04 +
+ +## 関連情報 + +- [PROTO モジュール Kit 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3651/) +- [PROTO モジュール 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3650/) +- [PROTO モジュール Kit 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-DHT12-socke-ESP32-Mpu9250-arduino/3226069_32841004439.html) +- [PROTO モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-arduino-ESP32/3226069_32843231933.html) - [PROTO ボード 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ESP32-Mpu9250-arduino-3/3226069_32837180999.html) \ No newline at end of file diff --git a/docs/ja/module/servo.md b/docs/ja/module/servo.md index 1ea7bcb0..95552c13 100644 --- a/docs/ja/module/servo.md +++ b/docs/ja/module/servo.md @@ -1,54 +1,54 @@ -# SERVO モジュール - - - -## 概要 - -**SERVO**モジュールは、12ウェイサーボモータを同時に駆動できるサーボモータドライバモジュールです。(現在、最大電流の制限により、駆動できるサーボモータの最大数は9です。すぐにアップグレード版を公開します。） - -サーボモータをコントロールするのはとても簡単です。Arduino IDEで2〜3行のコードを書くか、UiFlowで2-3ブロックをドラッグ&ドロップするだけで、一度に多くのサーボモータを駆動できます。 - -サーボはGROVEインタフェース（I2C）を介してM5Coreと通信します。 I2Cアドレスは0x53です。 - -## 特徴 - -- 12サーボモータ同時駆動可能 -- 電源範囲：6-12V -- Arduino IDEサポート -- UiFlowサポート - -## パッケージ内容 - -- 1x SERVO モジュール -- 1x 6-12V 電源インターフェース - -## アプリケーション - -- ヒューマノイドロボット -- バイオニック多関節ロボット -- カメラ用3軸ヘッド - -## ドキュメント - -- **回路図** - - Schematic - -- **GitHub** - - [Arduino](https://github.com/m5stack/M5Stack) - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Servo) - -
- module_servo_01 -
-
- module_servo_02 -
-
- module_servo_03 -
- -## 関連情報 - +# SERVO モジュール + + + +## 概要 + +**SERVO**モジュールは、12ウェイサーボモータを同時に駆動できるサーボモータドライバモジュールです。(現在、最大電流の制限により、駆動できるサーボモータの最大数は9です。すぐにアップグレード版を公開します。） + +サーボモータをコントロールするのはとても簡単です。Arduino IDEで2〜3行のコードを書くか、UiFlowで2-3ブロックをドラッグ&ドロップするだけで、一度に多くのサーボモータを駆動できます。 + +サーボはGROVEインタフェース（I2C）を介してM5Coreと通信します。 I2Cアドレスは0x53です。 + +## 特徴 + +- 12サーボモータ同時駆動可能 +- 電源範囲：6-12V +- Arduino IDEサポート +- UiFlowサポート + +## パッケージ内容 + +- 1x SERVO モジュール +- 1x 6-12V 電源インターフェース + +## アプリケーション + +- ヒューマノイドロボット +- バイオニック多関節ロボット +- カメラ用3軸ヘッド + +## ドキュメント + +- **回路図** + - Schematic + +- **GitHub** + - [Arduino](https://github.com/m5stack/M5Stack) + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Servo) + +
+ module_servo_01 +
+
+ module_servo_02 +
+
+ module_servo_03 +
+ +## 関連情報 + - [SERVO モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-12-MEGA328-6-24/3226069_32951356502.html) \ No newline at end of file diff --git a/docs/ja/module/sim800.md b/docs/ja/module/sim800.md index 2bc70070..711a8920 100644 --- a/docs/ja/module/sim800.md +++ b/docs/ja/module/sim800.md @@ -1,62 +1,62 @@ -# SIM800L モジュール - - - -## 概要 - -**SIM800L**モジュールは小型のSIM800Lを用いたGSM/GPRS通信用モジュールです。 -M5Stackシリーズのコアを使用し、Blockly、Arduino、MicroPythonでプログラムすることが可能です。 - -**SIM800L**モジュールはクアッドバンドのGSM/GPRS通信ソリューションを提供します。SIM800LとM5StackはUSART2と呼ばれるシリアルポートで接続されます。もちろん、あなた自身でシリアルポート番号を変更することも可能です。 - -## 特徴 - -- SIM800L モジュール -- アンテナ内蔵 -- 3.5 mm オーディオジャック, マイク(ユーザーは、マイクを有効にするためにO ohm抵抗を半田付けする必要があります) -- マイク -- パラメータ -- GSM/GPRS -- クアッドバンド 850/900/1800/1900MHz をサポート -- 低消費電力で通話、SMS、データ通信が可能 -- Bluetooth と Embedded AT - -## ピンマッピング - -*After SIM800 was stacked with M5Core, they communicat through UART2* - -**SIM800** - -| SIM800 Pin | ESP32 Chip | -| :----------: |:------------: | -| TXD | GPIO16 | -| RXD | GPIO17 | -| RST | GPIO5 | - -## パッケージ内容 - -- 1x SIM800L モジュール - -## アプリケーション - -- 二酸化窒素アラーム -- 自動WebクローラーSMS通知 -- リモート検針システム - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) -- **データシート** - - [SIM800L](http://simcomm2m.com/En/module/detail.aspx?id=138)(SIM800L) - -
- module_sim800_01 -
-
- module_sim800_02 -
- -## 関連情報 - -- [SIM800L モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-gsm-SIM800L-iot-arduino-ESP32-3-5/3226069_32843211923.html) +# SIM800L モジュール + + + +## 概要 + +**SIM800L**モジュールは小型のSIM800Lを用いたGSM/GPRS通信用モジュールです。 +M5Stackシリーズのコアを使用し、Blockly、Arduino、MicroPythonでプログラムすることが可能です。 + +**SIM800L**モジュールはクアッドバンドのGSM/GPRS通信ソリューションを提供します。SIM800LとM5StackはUSART2と呼ばれるシリアルポートで接続されます。もちろん、あなた自身でシリアルポート番号を変更することも可能です。 + +## 特徴 + +- SIM800L モジュール +- アンテナ内蔵 +- 3.5 mm オーディオジャック, マイク(ユーザーは、マイクを有効にするためにO ohm抵抗を半田付けする必要があります) +- マイク +- パラメータ +- GSM/GPRS +- クアッドバンド 850/900/1800/1900MHz をサポート +- 低消費電力で通話、SMS、データ通信が可能 +- Bluetooth と Embedded AT + +## ピンマッピング + +*After SIM800 was stacked with M5Core, they communicat through UART2* + +**SIM800** + +| SIM800 Pin | ESP32 Chip | +| :----------: |:------------: | +| TXD | GPIO16 | +| RXD | GPIO17 | +| RST | GPIO5 | + +## パッケージ内容 + +- 1x SIM800L モジュール + +## アプリケーション + +- 二酸化窒素アラーム +- 自動WebクローラーSMS通知 +- リモート検針システム + +## ドキュメント + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) +- **データシート** + - [SIM800L](http://simcomm2m.com/En/module/detail.aspx?id=138)(SIM800L) + +
+ module_sim800_01 +
+
+ module_sim800_02 +
+ +## 関連情報 + +- [SIM800L モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-gsm-SIM800L-iot-arduino-ESP32-3-5/3226069_32843211923.html) diff --git a/docs/ja/module/stepmotor.md b/docs/ja/module/stepmotor.md index 373f1a5b..197c7776 100644 --- a/docs/ja/module/stepmotor.md +++ b/docs/ja/module/stepmotor.md @@ -1,52 +1,52 @@ -# STEPMOTOR モジュール - - - -## 概要 - -**STEPMOTOR**モジュールはATmega328Pを内蔵しており、GRBLファームウェアによってモータをコントロールすることが可能です。M5StackのCoreとの通信にはI2Cを利用しています。I2Cアドレスは**0x70**です。 - -## 特徴 - -- 電源入力 9-24V -- 3-Way STEPMOTOR(X, Y, Z) -- リチウムバッテリー用インターフェース内蔵 - -## パッケージ内容 - -- 1x STEPMOTOR モジュール -- 1x 12V 電源 -- 1x 5V ファンモジュール - -## アプリケーション - -- 自作3Dプリンタ -- シンプルロボットアーム - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/stepmotor_module/tree/master/Example/StepMotor_M5test) - -- **クイックスタート** - - 近日公開... - -
- module_stepmotor_01 -
-
- module_stepmotor_02 -
-
- module_stepmotor_03 -
-
- module_stepmotor_04 -
-
- module_stepmotor_05 -
- -## 関連情報 - +# STEPMOTOR モジュール + + + +## 概要 + +**STEPMOTOR**モジュールはATmega328Pを内蔵しており、GRBLファームウェアによってモータをコントロールすることが可能です。M5StackのCoreとの通信にはI2Cを利用しています。I2Cアドレスは**0x70**です。 + +## 特徴 + +- 電源入力 9-24V +- 3-Way STEPMOTOR(X, Y, Z) +- リチウムバッテリー用インターフェース内蔵 + +## パッケージ内容 + +- 1x STEPMOTOR モジュール +- 1x 12V 電源 +- 1x 5V ファンモジュール + +## アプリケーション + +- 自作3Dプリンタ +- シンプルロボットアーム + +## ドキュメント + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/stepmotor_module/tree/master/Example/StepMotor_M5test) + +- **クイックスタート** + - 近日公開... + +
+ module_stepmotor_01 +
+
+ module_stepmotor_02 +
+
+ module_stepmotor_03 +
+
+ module_stepmotor_04 +
+
+ module_stepmotor_05 +
+ +## 関連情報 + - [STEPMOTOR モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-Stepmotor-arduino-ESP32-GRBL-12C-MEGA328P-12-DC/3226069_32889109142.html) \ No newline at end of file diff --git a/docs/ja/module/usb.md b/docs/ja/module/usb.md index 9daa29e8..1cb19a9b 100644 --- a/docs/ja/module/usb.md +++ b/docs/ja/module/usb.md @@ -1,40 +1,40 @@ -# USB モジュール - -## 概要 - -**USB**モジュールはMAX3421Eを内蔵したUSBコントローラです。このモジュールはM5Coreと最大通信速度26MHzのSPIインターフェースで接続され、USBホストやUSBペリフェラルとして使用できます。 - -## 特徴 - -- 最大通信速度26MHz SPIインターフェース -- 8x GPIO入出力 -- 内蔵リチウム電池コネクタ - -## パッケージ内容 - -- 1x USBモジュール - -## アプリケーション - -- USBキーロガー -- USBメモリのリードライト - -## ドキュメント - - - - -- データシート - - [MAX3421E](https://www.sparkfun.com/datasheets/DevTools/Arduino/MAX3421E.pdf) - -
- -
- -
- -
- -## 関連情報 - -- [USB モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-USB-USB-hid-MAX3421E-SPI-5-5-m5Stack/3226069_32961627365.html) +# USB モジュール + +## 概要 + +**USB**モジュールはMAX3421Eを内蔵したUSBコントローラです。このモジュールはM5Coreと最大通信速度26MHzのSPIインターフェースで接続され、USBホストやUSBペリフェラルとして使用できます。 + +## 特徴 + +- 最大通信速度26MHz SPIインターフェース +- 8x GPIO入出力 +- 内蔵リチウム電池コネクタ + +## パッケージ内容 + +- 1x USBモジュール + +## アプリケーション + +- USBキーロガー +- USBメモリのリードライト + +## ドキュメント + + + + +- データシート + - [MAX3421E](https://www.sparkfun.com/datasheets/DevTools/Arduino/MAX3421E.pdf) + +
+ +
+ +
+ +
+ +## 関連情報 + +- [USB モジュール 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-USB-USB-hid-MAX3421E-SPI-5-5-m5Stack/3226069_32961627365.html) diff --git a/docs/ja/qs.md b/docs/ja/qs.md index 24aa19c9..b7fdc22e 100644 --- a/docs/ja/qs.md +++ b/docs/ja/qs.md @@ -1,50 +1,50 @@ -# クイックスタート - - - -*このページはM5Stack開発のためのソフトウェア環境（Arduino/MicroPython）構築支援のページです。開発方法や、ファームウェアやソースファイルをM5Stackに書き込む方法を簡単な例を通して説明していきます。* - - - - | ----|--- -[M5StackCore](/ja/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/ja/quick_start/m5camera/m5camera_quick_start) - - - - - + + | +---|--- +[M5StackCore](/ja/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/ja/quick_start/m5camera/m5camera_quick_start) + + + + + \ No newline at end of file diff --git a/docs/ja/quick_start/bala/bala_quick_start.md b/docs/ja/quick_start/bala/bala_quick_start.md index 064fb7e4..74c43778 100644 --- a/docs/ja/quick_start/bala/bala_quick_start.md +++ b/docs/ja/quick_start/bala/bala_quick_start.md @@ -1,142 +1,142 @@ -# BALA クイックスタート - - - -!>M5Balaを使用するためには、M5Stack FIREまたはM5GO(WHITE)のいずれかが別途必要になります。 - -## 準備 - -- シリアルドライバをインストールします。- [シリアル接続の確立方法](/ja/related_documents/establish_serial_connection) - -## 開発環境選択 - -1. [UiFlow編](#UiFlow編) -2. [Arduino IDE編](#Arduino-IDE編) - -## UIFlow編 - -1. UiFlow向けのファームウェアを書込みます。- [ファームウェアの更新方法](/ja/related_documents/how_to_burn_firmware) -2. Wi-Fi接続設定を行います。- [M5StackのWi-Fi接続方法](/ja/related_documents/how_to_connect_wifi_using_core) -3. ポゴピンの位置を確認して、M5BalaにM5Stackコアを重ねます。 -
- -
- -4. M5Stackの横の赤いスイッチを押して、起動します。(２回連続でクリックすると電源OFF) -
- -
- -5. M5Balaのスイッチを押して起動します。(２回連続でクリックすると電源OFF) -
- -
-
- -
- -6. [UiFlow](http://flow.m5stack.com/)にアクセスし、モードをBlocklyからPythonに切り替えます。 -
- -
- -7. 以下のコードを貼り付けて実行すると、バランスを取ります。 - -```python -from m5stack import * -from m5ui import * -from m5bala import M5Bala -import i2c_bus -clear_bg(0x111111) - -m5bala = M5Bala(i2c_bus.get(i2c_bus.M_BUS)) -btnA = M5Button(name="ButtonA", text="ButtonA", visibility=False) -btnB = M5Button(name="ButtonB", text="ButtonB", visibility=False) -btnC = M5Button(name="ButtonC", text="ButtonC", visibility=False) -title0 = M5Title(title="Title", fgcolor=0xFFFFFF, bgcolor=0x0000FF) - -title0.setTitle('calirate start') -wait(2) -sampleCount = 2000 -gyroXSum = 0 -gyroYSum = 0 -gyroZSum = 0 - -for _ in range(sampleCount): - gyroXYZ = m5bala.imu.gyro - gyroXSum += gyroXYZ[0] # X - gyroYSum += gyroXYZ[1] # Y - gyroZSum += gyroXYZ[2] # Z - -gyroXMean = gyroXSum / sampleCount -gyroYMean = gyroYSum / sampleCount -gyroZMean = gyroZSum / sampleCount - -m5bala.imu.setGyroOffsets(gyroXMean, gyroYMean, gyroZMean) - -title0.setTitle('balance start') -while True: - m5bala.balance() - wait(0.001) -``` - -## Arduino IDE編 - -1. Arduino IDEをインストールします。 -2. Arduino IDEの設定から追加のボードマネージャのURLに`https://dl.espressif.com/dl/package_esp32_index.json`を追加します。 -
- -
-
- -
- -3. Arduino IDEにボードマネージャから`esp32`をインストールします。 -
- -
- -1. Arduino IDEにライブラリマネージャから`m5stack`ライブラリをインストールします。 -
- -
- -5. Arduino IDEにライブラリマネージャから`NeoPixelBus`ライブラリをインストールします。 -
- -
- -6. Arduino IDEにライブラリマネージャから`MPU6050_tockn`ライブラリをインストールします。 -
- -
- -7. M5Stackがパソコンに接続されていることを確認してから、`ツール -> シリアルポート`から適切なシリアルポートを選択します。 -8. 同様にボードも`M5Stack-Core-ESP32`または`M5Stack-Fire`を選択します。 -9. [M5Bala](https://github.com/m5stack/M5Bala.git)のソースをダウンロードします。Gitが使えない方は、[こちら](https://git-scm.com/download/win)からインストールしてください。 -```shell -git clone --recursive https://github.com/m5stack/M5Bala.git -``` -10. Arduino IDE上で新規ファイルを作成し、`M5Bala/src/Default_firmware.ino`の中身をコピーして貼り付けます。 -
- -
- -11. `Default_firmware.ino`の89行目の`M5.setPowerBoostKeepOn(false);`をコメントアウトします。 -
- -
- -12. 新規タブを作成し、同様に`M5Bala/src/M5Bala.cpp`の中身をコピーして貼り付けます。 -
- -
-
- -
- -13. 新規タブを作成し、同様に`M5Bala/src/M5Bala.h`の中身をコピーして貼り付けます。 -14. 最後に書込みを実行します。 -
- +# BALA クイックスタート + + + +!>M5Balaを使用するためには、M5Stack FIREまたはM5GO(WHITE)のいずれかが別途必要になります。 + +## 準備 + +- シリアルドライバをインストールします。- [シリアル接続の確立方法](/ja/related_documents/establish_serial_connection) + +## 開発環境選択 + +1. [UiFlow編](#UiFlow編) +2. [Arduino IDE編](#Arduino-IDE編) + +## UIFlow編 + +1. UiFlow向けのファームウェアを書込みます。- [ファームウェアの更新方法](/ja/related_documents/how_to_burn_firmware) +2. Wi-Fi接続設定を行います。- [M5StackのWi-Fi接続方法](/ja/related_documents/how_to_connect_wifi_using_core) +3. ポゴピンの位置を確認して、M5BalaにM5Stackコアを重ねます。 +
+ +
+ +4. M5Stackの横の赤いスイッチを押して、起動します。(２回連続でクリックすると電源OFF) +
+ +
+ +5. M5Balaのスイッチを押して起動します。(２回連続でクリックすると電源OFF) +
+ +
+
+ +
+ +6. [UiFlow](http://flow.m5stack.com/)にアクセスし、モードをBlocklyからPythonに切り替えます。 +
+ +
+ +7. 以下のコードを貼り付けて実行すると、バランスを取ります。 + +```python +from m5stack import * +from m5ui import * +from m5bala import M5Bala +import i2c_bus +clear_bg(0x111111) + +m5bala = M5Bala(i2c_bus.get(i2c_bus.M_BUS)) +btnA = M5Button(name="ButtonA", text="ButtonA", visibility=False) +btnB = M5Button(name="ButtonB", text="ButtonB", visibility=False) +btnC = M5Button(name="ButtonC", text="ButtonC", visibility=False) +title0 = M5Title(title="Title", fgcolor=0xFFFFFF, bgcolor=0x0000FF) + +title0.setTitle('calirate start') +wait(2) +sampleCount = 2000 +gyroXSum = 0 +gyroYSum = 0 +gyroZSum = 0 + +for _ in range(sampleCount): + gyroXYZ = m5bala.imu.gyro + gyroXSum += gyroXYZ[0] # X + gyroYSum += gyroXYZ[1] # Y + gyroZSum += gyroXYZ[2] # Z + +gyroXMean = gyroXSum / sampleCount +gyroYMean = gyroYSum / sampleCount +gyroZMean = gyroZSum / sampleCount + +m5bala.imu.setGyroOffsets(gyroXMean, gyroYMean, gyroZMean) + +title0.setTitle('balance start') +while True: + m5bala.balance() + wait(0.001) +``` + +## Arduino IDE編 + +1. Arduino IDEをインストールします。 +2. Arduino IDEの設定から追加のボードマネージャのURLに`https://dl.espressif.com/dl/package_esp32_index.json`を追加します。 +
+ +
+
+ +
+ +3. Arduino IDEにボードマネージャから`esp32`をインストールします。 +
+ +
+ +1. Arduino IDEにライブラリマネージャから`m5stack`ライブラリをインストールします。 +
+ +
+ +5. Arduino IDEにライブラリマネージャから`NeoPixelBus`ライブラリをインストールします。 +
+ +
+ +6. Arduino IDEにライブラリマネージャから`MPU6050_tockn`ライブラリをインストールします。 +
+ +
+ +7. M5Stackがパソコンに接続されていることを確認してから、`ツール -> シリアルポート`から適切なシリアルポートを選択します。 +8. 同様にボードも`M5Stack-Core-ESP32`または`M5Stack-Fire`を選択します。 +9. [M5Bala](https://github.com/m5stack/M5Bala.git)のソースをダウンロードします。Gitが使えない方は、[こちら](https://git-scm.com/download/win)からインストールしてください。 +```shell +git clone --recursive https://github.com/m5stack/M5Bala.git +``` +10. Arduino IDE上で新規ファイルを作成し、`M5Bala/src/Default_firmware.ino`の中身をコピーして貼り付けます。 +
+ +
+ +11. `Default_firmware.ino`の89行目の`M5.setPowerBoostKeepOn(false);`をコメントアウトします。 +
+ +
+ +12. 新規タブを作成し、同様に`M5Bala/src/M5Bala.cpp`の中身をコピーして貼り付けます。 +
+ +
+
+ +
+ +13. 新規タブを作成し、同様に`M5Bala/src/M5Bala.h`の中身をコピーして貼り付けます。 +14. 最後に書込みを実行します。 +
+
\ No newline at end of file diff --git a/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md index bffe27d4..9c024482 100644 --- a/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md @@ -1,47 +1,47 @@ -# NESゲーム クイックスタート (Windows向け) - - - -*このページでは、NESゲームを遊ぶために必要なソフトウェアの書き込み方法を紹介します。* - -## コンテンツ - -1. [ファームウェアのダウンロード](#1-ファームウェアのダウンロード) - -2. [ゲームファイルの書き込み](#2-ゲームファイルの書き込み) - -3. [デバイスのリセット](#3-デバイスのリセット) - -## 1. Dァームウェアのダウンロード - -ゲームボーイエミュレータのファイル `firmware.zip` を [Github](https://github.com/m5stack/M5Stack-nesemu) からダウンロードして解凍します。 - -
- -
- -
- -
- -## 2. ゲームファイルの書き込み - -[ここ](https://www.espressif.com/en/support/download/other-tools)からフラッシュ書き込みツール（Flash Download Tools (ESP8266 & ESP32) v3.6.5）をダウンロード、実行し、`ESP32 DownloadTool` を選択、書き込む4つのファイルを指定します。そして、図の（Step2 シリアルポート選択）、（Step3 Erase消去）、（Step4 書き込み）を実行します。 - -
- -
- -
- -
- -## 3. デバイスのリセット - -FACESをリセットして再起動したら、赤い帽子のヒゲおじさんがきのこを食べたり、土管に入ったりするゲームをプレイできます。 - -
- -
- -?> Tip **もし他のゲームで遊びたい場合は、`ゲームファイル`(.nes)を書き換えてください。** +# NESゲーム クイックスタート (Windows向け) + + + +*このページでは、NESゲームを遊ぶために必要なソフトウェアの書き込み方法を紹介します。* + +## コンテンツ + +1. [ファームウェアのダウンロード](#1-ファームウェアのダウンロード) + +2. [ゲームファイルの書き込み](#2-ゲームファイルの書き込み) + +3. [デバイスのリセット](#3-デバイスのリセット) + +## 1. Dァームウェアのダウンロード + +ゲームボーイエミュレータのファイル `firmware.zip` を [Github](https://github.com/m5stack/M5Stack-nesemu) からダウンロードして解凍します。 + +
+ +
+ +
+ +
+ +## 2. ゲームファイルの書き込み + +[ここ](https://www.espressif.com/en/support/download/other-tools)からフラッシュ書き込みツール（Flash Download Tools (ESP8266 & ESP32) v3.6.5）をダウンロード、実行し、`ESP32 DownloadTool` を選択、書き込む4つのファイルを指定します。そして、図の（Step2 シリアルポート選択）、（Step3 Erase消去）、（Step4 書き込み）を実行します。 + +
+ +
+ +
+ +
+ +## 3. デバイスのリセット + +FACESをリセットして再起動したら、赤い帽子のヒゲおじさんがきのこを食べたり、土管に入ったりするゲームをプレイできます。 + +
+ +
+ +?> Tip **もし他のゲームで遊びたい場合は、`ゲームファイル`(.nes)を書き換えてください。** diff --git a/docs/ja/quick_start/m5camera/m5camera_quick_start.md b/docs/ja/quick_start/m5camera/m5camera_quick_start.md index f91db064..66bb7e85 100644 --- a/docs/ja/quick_start/m5camera/m5camera_quick_start.md +++ b/docs/ja/quick_start/m5camera/m5camera_quick_start.md @@ -1,29 +1,29 @@ -# ESP32Cam/M5Camera クイックスタート - - - -## 1. デモ - -プログラムなどは不要で、箱から取り出してすぐに利用することができます！ - -1. ESP32Cam/M5Camera とPCをUSBケーブルで接続し、シリアルターミナルを開きます。 - -
- -
- -2. 接続してから数秒後、`M5CAM`というWi-FiのAP(アクセスポイント)が見つかるので、PCまたはスマートフォンで接続します。 - -
- -
- -1. PCまたはスマートフォンのブラウザを開き、次のURLを入力します。`http://192.168.4.1` - -
- -
- -ESP32Cam/M5Cameraの映像がブラウザにリアルタイムに表示されましたか？ - -?> メモ: ESP32CAMのAPには一度にひとつのデバイスしか接続できません。 +# ESP32Cam/M5Camera クイックスタート + + + +## 1. デモ + +プログラムなどは不要で、箱から取り出してすぐに利用することができます！ + +1. ESP32Cam/M5Camera とPCをUSBケーブルで接続し、シリアルターミナルを開きます。 + +
+ +
+ +2. 接続してから数秒後、`M5CAM`というWi-FiのAP(アクセスポイント)が見つかるので、PCまたはスマートフォンで接続します。 + +
+ +
+ +1. PCまたはスマートフォンのブラウザを開き、次のURLを入力します。`http://192.168.4.1` + +
+ +
+ +ESP32Cam/M5Cameraの映像がブラウザにリアルタイムに表示されましたか？ + +?> メモ: ESP32CAMのAPには一度にひとつのデバイスしか接続できません。 diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index 2dd276e5..04bed6ea 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,113 +1,113 @@ -# M5Core クイックスタート(macOS, Arudino) - - - -?> **Tip** もしWindowsを使っているなら[こちらへ](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - -## コンテンツ - -1. [環境設定](#環境設定) - - - Step1. [Arduino IDEインストール](#step1-arduino-ideインストール) - - - Step2. [ESP32ボードサポート](#step2-esp32ボードサポート) - - - Step3. [M5Stack Libインストール](#step3-m5stack-libインストール) - -2. [例題](#例題) - -?> **Note** *環境設定の前に、シリアルドライバがインストールされているか確認いてください。もしまだの場合は[シリアル接続の確立方法](/en/related_documents/establish_serial_connection)を参照してください。* - -## 環境設定 - -### Step1. `Arduino IDE`インストール - -最初にArduino IDEをインストールします。ダウンロードアドレスは https://www.arduino.cc/en/Main/Software です。 - -
- -
- -### Step2. ESP32ボードサポート - -ターミナルを開いて次のコマンドを実行します。（全文コピーして、ターミナルに貼り付けてッターン！） - -```shell -mkdir -p ~/Documents/Arduino/hardware/espressif && \ -cd ~/Documents/Arduino/hardware/espressif && \ -git clone https://github.com/espressif/arduino-esp32.git esp32 && \ -cd esp32 && \ -git submodule update --init --recursive && \ -cd tools && \ -python get.py -``` - -デフォルトでスケッチが保存される場所は ~/Documents/Arduino です。もしArduino IDEの設定でスケッチブックの位置を変更している場合や、何か問題が発生したときは必要に応じて上記のコマンドを調整してください。 - -?> **Tip** もし下記のエラーが発生したら: `xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),` -`missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, ターミナルで`xcode-select --install`を実行し、Arduino IDEを再起動してみてください。 - -?> **Tip** もし下記のエラーが発生したら: `IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol` `version (_ssl.c:590) when running python get.py`, 上記のコマンドの`python get.py`の行を`python3 get.py`に置き換えて実行し、Arduino IDEを再起動します。 - -### Step3. M5Stack Libインストール - -Arduino IDEを起動し、メニューから`スケッチ`->`ライブラリをインクルード`->`ライブラリを管理...`を選択します。 - -検索ボックスに`m5stack`と入力して検索し、M5Stackのライブラリをインストールします。 - -
- -
- -
- -
- -## 例題 - -USBケーブルをM5Stackに接続し、ボードとシリアルポートを選択します。そしてサンプルプログラムをコンパイルし、アップロードしてみましょう。 - -### 1. ボードとシリアルポートを選択 - -Arduino IDEを起動し、メニューから`ツール -> ボード -> M5Stack-Core-ESP32`とボードを選択します。 - -
- -
- -次に、メニューから`ツール -> シリアルポート -> /dev/cu.SLAB_USBtoUART` とシリアルポートを選択します。 -
- -
- -### 2. サンプルスケッチ - -サンプルスケッチを利用して、定番のHelloWorldを表示してみましょう。メニューから`ファイル -> スケッチ例 -> M5Stack -> Basics -> HelloWorld`と選択します。 - -
- -
- -コンパイルしてアップロード実行すると、M5Stackの画面に `Hello World!` と表示されます。 - -
- -
- -## ノート - -もしシリアルポートが見つからない場合は、Macの`システム環境設定 -> セキュリティとプライバシー`を開いてブロックされているアプリを許可してください。それでもダメな場合は、再度シリアルドライバをインストールしてください。 - -
- -
- -
- -
- -
- -
- +# M5Core クイックスタート(macOS, Arudino) + + + +?> **Tip** もしWindowsを使っているなら[こちらへ](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + +## コンテンツ + +1. [環境設定](#環境設定) + + - Step1. [Arduino IDEインストール](#step1-arduino-ideインストール) + + - Step2. [ESP32ボードサポート](#step2-esp32ボードサポート) + + - Step3. [M5Stack Libインストール](#step3-m5stack-libインストール) + +2. [例題](#例題) + +?> **Note** *環境設定の前に、シリアルドライバがインストールされているか確認いてください。もしまだの場合は[シリアル接続の確立方法](/en/related_documents/establish_serial_connection)を参照してください。* + +## 環境設定 + +### Step1. `Arduino IDE`インストール + +最初にArduino IDEをインストールします。ダウンロードアドレスは https://www.arduino.cc/en/Main/Software です。 + +
+ +
+ +### Step2. ESP32ボードサポート + +ターミナルを開いて次のコマンドを実行します。（全文コピーして、ターミナルに貼り付けてッターン！） + +```shell +mkdir -p ~/Documents/Arduino/hardware/espressif && \ +cd ~/Documents/Arduino/hardware/espressif && \ +git clone https://github.com/espressif/arduino-esp32.git esp32 && \ +cd esp32 && \ +git submodule update --init --recursive && \ +cd tools && \ +python get.py +``` + +デフォルトでスケッチが保存される場所は ~/Documents/Arduino です。もしArduino IDEの設定でスケッチブックの位置を変更している場合や、何か問題が発生したときは必要に応じて上記のコマンドを調整してください。 + +?> **Tip** もし下記のエラーが発生したら: `xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),` +`missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, ターミナルで`xcode-select --install`を実行し、Arduino IDEを再起動してみてください。 + +?> **Tip** もし下記のエラーが発生したら: `IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol` `version (_ssl.c:590) when running python get.py`, 上記のコマンドの`python get.py`の行を`python3 get.py`に置き換えて実行し、Arduino IDEを再起動します。 + +### Step3. M5Stack Libインストール + +Arduino IDEを起動し、メニューから`スケッチ`->`ライブラリをインクルード`->`ライブラリを管理...`を選択します。 + +検索ボックスに`m5stack`と入力して検索し、M5Stackのライブラリをインストールします。 + +
+ +
+ +
+ +
+ +## 例題 + +USBケーブルをM5Stackに接続し、ボードとシリアルポートを選択します。そしてサンプルプログラムをコンパイルし、アップロードしてみましょう。 + +### 1. ボードとシリアルポートを選択 + +Arduino IDEを起動し、メニューから`ツール -> ボード -> M5Stack-Core-ESP32`とボードを選択します。 + +
+ +
+ +次に、メニューから`ツール -> シリアルポート -> /dev/cu.SLAB_USBtoUART` とシリアルポートを選択します。 +
+ +
+ +### 2. サンプルスケッチ + +サンプルスケッチを利用して、定番のHelloWorldを表示してみましょう。メニューから`ファイル -> スケッチ例 -> M5Stack -> Basics -> HelloWorld`と選択します。 + +
+ +
+ +コンパイルしてアップロード実行すると、M5Stackの画面に `Hello World!` と表示されます。 + +
+ +
+ +## ノート + +もしシリアルポートが見つからない場合は、Macの`システム環境設定 -> セキュリティとプライバシー`を開いてブロックされているアプリを許可してください。それでもダメな場合は、再度シリアルドライバをインストールしてください。 + +
+ +
+ +
+ +
+ +
+ +
+ ?> **Tip** **もしmacOSのパーミッションについてもっと詳しい情報が知りたい方は、次のリンクを参照してください。** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html \ No newline at end of file diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index 54e44423..3b612c69 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,108 +1,108 @@ -# M5Core クイックスタート(Windows, Arudino) - - - -?> **Tip** もしMacをお使いの方は[こちら](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)を参照してください。 - -## コンテンツ - -1. [環境設定](#環境設定) - - - [Step1. arduino-ESP32サポートのダウンロード](#step1-arduino-esp32サポートのダウンロード) - - - [Step2. M5Stackライブラリのダウンロード](#step2-m5stackライブラリのダウンロード) - -2. [例題](#例題) - -?> **Tip** *もしM5Stack Libを更新したい場合はこちらの記事を参照してください。[Arduino IDEのM5Stackライブラリ更新方法](/ja/related_documents/upgrade_m5stack_lib).* - -?> **Note** *`USB driver`、`Git`、`Arduino IDE(Installation path: C:\Program Files\Arduino)` をインストールしているか確認してください。 もしまだの場合は、 [シリアル接続の確立方法](/ja/related_documents/establish_serial_connection) と [GitとArduino IDEのインストール方法](/ja/related_documents/how_to_install_git_and_arduino)を参照してください。もしあなたがすでにArduino IDEをデフォルトの`C:\Program Files\Arduino`以外にインストールしている場合は、デフォルトパスに再インストールしてください。* - -## 環境設定 - -### Step1. arduino-ESP32サポートのダウンロード - -次のバッチファイルをダウンロードして、実行してください。[download_arduino_esp32_support.bat](https://github.com/m5stack/m5-docs/tree/master/docs/assets/scripts/download_arduino_esp32_support.bat) -
- -
- -以下のようにGitHubからリポジトリを取得します。（少し時間がかかります） - -
- -
- -
- -
- - -### Step2. M5Stackライブラリのダウンロード - -Arduino IDEを開いて`スケッチ -> ライブラリをインクルード -> ライブラリを管理...`と選択します。開いたウィンドウの検索ボックスに`m5stack`と検索し、出てきたライブラリをインストールします。 - -
- -
- -
- -
- -!> **Note:** *以下のように表示された場合は、アップデートです。* - -
- -
- -## 例題 - -このセクションではArduinoでプログラムができるかを確認します。最初にM5StackとPCをUSBケーブルで接続してください。そしてM5Stackが接続されているシリアルポートを選択し、サンプルプログラムを実行してみましょう。 - -### 1. `FactoryTest.ino`サンプルスケッチ実行 - -Arduino IDEのメニューから`ツール`を選択し、ボードとボーレート、シリアルポートを次のように選択します。M5Stack-Core-ESP32、921600、COMx（シリアルポートの番号はお使いの環境によって変わります。) - -
- -
- -メニューから`ファイル -> スケッチ例 -> M5Stack -> Basics -> FactoryTest`を選択します。 - -
- -
- -コンパイル＆アップロード実行します。 - -
- -
- -### 2. 新しいM5Stackのプログラム - -Arduino IDEで新しいファイルを開いて`my_test`という名前をつけます。 -次に以下のコードをコピーし、`my_test`に貼り付けます。 - -```cpp -#include - -// M5Stackがスタートする時に一度だけ実行されます。 -void setup(){ - - // M5Stackの初期化 - M5.begin(); - - // LCDの画面に表示 - M5.Lcd.print("Hello World!"); - M5.Lcd.print("M5Stack is running successfully!"); -} - -// この中の処理は無限に繰り返し実行されます。 -void loop() { - // このプログラムでは何もしない -} -``` - -コンパイルしてアップロードすると、M5Stackの画面に"Hello World! M5Stack is running successfully!"とメッセージが表示されます。 +# M5Core クイックスタート(Windows, Arudino) + + + +?> **Tip** もしMacをお使いの方は[こちら](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)を参照してください。 + +## コンテンツ + +1. [環境設定](#環境設定) + + - [Step1. arduino-ESP32サポートのダウンロード](#step1-arduino-esp32サポートのダウンロード) + + - [Step2. M5Stackライブラリのダウンロード](#step2-m5stackライブラリのダウンロード) + +2. [例題](#例題) + +?> **Tip** *もしM5Stack Libを更新したい場合はこちらの記事を参照してください。[Arduino IDEのM5Stackライブラリ更新方法](/ja/related_documents/upgrade_m5stack_lib).* + +?> **Note** *`USB driver`、`Git`、`Arduino IDE(Installation path: C:\Program Files\Arduino)` をインストールしているか確認してください。 もしまだの場合は、 [シリアル接続の確立方法](/ja/related_documents/establish_serial_connection) と [GitとArduino IDEのインストール方法](/ja/related_documents/how_to_install_git_and_arduino)を参照してください。もしあなたがすでにArduino IDEをデフォルトの`C:\Program Files\Arduino`以外にインストールしている場合は、デフォルトパスに再インストールしてください。* + +## 環境設定 + +### Step1. arduino-ESP32サポートのダウンロード + +次のバッチファイルをダウンロードして、実行してください。[download_arduino_esp32_support.bat](https://github.com/m5stack/m5-docs/tree/master/docs/assets/scripts/download_arduino_esp32_support.bat) +
+ +
+ +以下のようにGitHubからリポジトリを取得します。（少し時間がかかります） + +
+ +
+ +
+ +
+ + +### Step2. M5Stackライブラリのダウンロード + +Arduino IDEを開いて`スケッチ -> ライブラリをインクルード -> ライブラリを管理...`と選択します。開いたウィンドウの検索ボックスに`m5stack`と検索し、出てきたライブラリをインストールします。 + +
+ +
+ +
+ +
+ +!> **Note:** *以下のように表示された場合は、アップデートです。* + +
+ +
+ +## 例題 + +このセクションではArduinoでプログラムができるかを確認します。最初にM5StackとPCをUSBケーブルで接続してください。そしてM5Stackが接続されているシリアルポートを選択し、サンプルプログラムを実行してみましょう。 + +### 1. `FactoryTest.ino`サンプルスケッチ実行 + +Arduino IDEのメニューから`ツール`を選択し、ボードとボーレート、シリアルポートを次のように選択します。M5Stack-Core-ESP32、921600、COMx（シリアルポートの番号はお使いの環境によって変わります。) + +
+ +
+ +メニューから`ファイル -> スケッチ例 -> M5Stack -> Basics -> FactoryTest`を選択します。 + +
+ +
+ +コンパイル＆アップロード実行します。 + +
+ +
+ +### 2. 新しいM5Stackのプログラム + +Arduino IDEで新しいファイルを開いて`my_test`という名前をつけます。 +次に以下のコードをコピーし、`my_test`に貼り付けます。 + +```cpp +#include + +// M5Stackがスタートする時に一度だけ実行されます。 +void setup(){ + + // M5Stackの初期化 + M5.begin(); + + // LCDの画面に表示 + M5.Lcd.print("Hello World!"); + M5.Lcd.print("M5Stack is running successfully!"); +} + +// この中の処理は無限に繰り返し実行されます。 +void loop() { + // このプログラムでは何もしない +} +``` + +コンパイルしてアップロードすると、M5Stackの画面に"Hello World! M5Stack is running successfully!"とメッセージが表示されます。 diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md index daaaad20..afcb5e86 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -1,125 +1,125 @@ -# UiFlow クイックスタート(Blockly/MicroPython) - - - -?> **Note** *初めてM5Stackを使う場合、あらかじめ指定のファームウェアを書き込む必要があります。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)を参照してください。また、Wi-Fi接続先を変更したい場合は、このページを参照してください。 [M5StackのWi-Fi接続方法 (M5Cloud向け)](/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud)* - -M5Stackを起動したらすぐに `UPLOAD` ボタンを連打します。以下の画面に遷移しなかった場合は、M5Stack本体横の赤いリセットスイッチを押して、再起動してやり直してください。 - -
- -
- -?> **Note** *最初の起動では何もしないと、デモプログラムに遷移します。Wi-Fiの設定が完了していると自動的にWi-FiのAPに接続しにいきます。Wi-Fiを再設定したい場合は、`SETUP`ボタンを押してください。* - -## コンテンツ - -1. [UiFlowに接続](#_1-uiflowに接続) - -2. [プログラム作成](#_2-プログラム作成) - -3. [音楽演奏デモ](#_3-音楽演奏デモ) - -## 1. UiFlowに接続 - -1. M5Stackに表示されている二次元コードをあなたのスマートフォンやタブレットPCで読み取ってプログラムを始めることができます。もしPCでプログラムをする場合は、ブラウザで次のURLを入力してください。 `flow.m5stack.com` - -
- -
- -1. UiFlowを利用するためには、お持ちのM5Stackをペアリングする必要があります。 - -最初にUiFlowの画面の右上にある歯車の設定を開きます。`APIKEY` の欄にM5Stack本体に表示されているAPIKEYを入力します。(写真の場合は `9C6469`) 入力が終わったら`SAVE`をクリックします。 - -
- -
- -
- -
- -正しいAPIKEYが入力されるとUiFlowはあなたのM5Stackと接続します。 - -しばらくすると下図のように、Blockly(や Python)を用いてプログラムが可能になります。 - -## 2. プログラム作成 - -### a. UIデザイン - -4種類のUI要素が用意されており、UiFlow内のUIエディタにドラッグすることで利用できます。試しにいくつかUIオブジェクトを配置して`実行(Run)`をクリックしてみましょう。 - -
- -
- -
- -
- -### b. Blocklyでプログラミング - -`Emoji`クラスの中にある`Set emoji map in0`ブロックをドラッグしてブロックエディタに配置し、`実行(Run)`をクリックしてみましょう。 - -
- -
- -
- -
- -### c. MicroPythonでプログラミング - -Blockly/MicroPython切り替えボタンを使って、MicroPythonに切り替えます。そして次のコードをコピーして`Python エディタ`に貼り付け、`実行(Run)`をクリックしてみましょう。 - -```Python -from m5stack import * -from m5ui import * -clear_bg(0x111111) - - -btnA = M5Button(name='ButtonA', text='ButtonA', visibility=False) -btnB = M5Button(name='ButtonB', text='ButtonB', visibility=False) -btnC = M5Button(name='ButtonC', text='ButtonC', visibility=False) - - -lcd.print("Hello M5Stack") -``` - -
- -
- -M5Stackの画面に`Hello M5Stack`と表示されます。 - -## 3. 音楽演奏デモ - -M5Stackを用いればたった数分でミュージックプレイヤーを作成して、音楽を演奏することができます。 - -`loop`、`music`、`timer`から下図のブロックをブロックエディタに配置します。 - -
- -
- -
- -
- -
- -
- -それから下図に示すように各ブロックのパラメータを調整します。 - -
- -
- -完成したら、鳴らしてみましょう！！ - -## 完成 - -?> **Note** *M5StackへのWorkShop等のお問い合わせはこちらまで→ * +# UiFlow クイックスタート(Blockly/MicroPython) + + + +?> **Note** *初めてM5Stackを使う場合、あらかじめ指定のファームウェアを書き込む必要があります。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)を参照してください。また、Wi-Fi接続先を変更したい場合は、このページを参照してください。 [M5StackのWi-Fi接続方法 (M5Cloud向け)](/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud)* + +M5Stackを起動したらすぐに `UPLOAD` ボタンを連打します。以下の画面に遷移しなかった場合は、M5Stack本体横の赤いリセットスイッチを押して、再起動してやり直してください。 + +
+ +
+ +?> **Note** *最初の起動では何もしないと、デモプログラムに遷移します。Wi-Fiの設定が完了していると自動的にWi-FiのAPに接続しにいきます。Wi-Fiを再設定したい場合は、`SETUP`ボタンを押してください。* + +## コンテンツ + +1. [UiFlowに接続](#_1-uiflowに接続) + +2. [プログラム作成](#_2-プログラム作成) + +3. [音楽演奏デモ](#_3-音楽演奏デモ) + +## 1. UiFlowに接続 + +1. M5Stackに表示されている二次元コードをあなたのスマートフォンやタブレットPCで読み取ってプログラムを始めることができます。もしPCでプログラムをする場合は、ブラウザで次のURLを入力してください。 `flow.m5stack.com` + +
+ +
+ +1. UiFlowを利用するためには、お持ちのM5Stackをペアリングする必要があります。 + +最初にUiFlowの画面の右上にある歯車の設定を開きます。`APIKEY` の欄にM5Stack本体に表示されているAPIKEYを入力します。(写真の場合は `9C6469`) 入力が終わったら`SAVE`をクリックします。 + +
+ +
+ +
+ +
+ +正しいAPIKEYが入力されるとUiFlowはあなたのM5Stackと接続します。 + +しばらくすると下図のように、Blockly(や Python)を用いてプログラムが可能になります。 + +## 2. プログラム作成 + +### a. UIデザイン + +4種類のUI要素が用意されており、UiFlow内のUIエディタにドラッグすることで利用できます。試しにいくつかUIオブジェクトを配置して`実行(Run)`をクリックしてみましょう。 + +
+ +
+ +
+ +
+ +### b. Blocklyでプログラミング + +`Emoji`クラスの中にある`Set emoji map in0`ブロックをドラッグしてブロックエディタに配置し、`実行(Run)`をクリックしてみましょう。 + +
+ +
+ +
+ +
+ +### c. MicroPythonでプログラミング + +Blockly/MicroPython切り替えボタンを使って、MicroPythonに切り替えます。そして次のコードをコピーして`Python エディタ`に貼り付け、`実行(Run)`をクリックしてみましょう。 + +```Python +from m5stack import * +from m5ui import * +clear_bg(0x111111) + + +btnA = M5Button(name='ButtonA', text='ButtonA', visibility=False) +btnB = M5Button(name='ButtonB', text='ButtonB', visibility=False) +btnC = M5Button(name='ButtonC', text='ButtonC', visibility=False) + + +lcd.print("Hello M5Stack") +``` + +
+ +
+ +M5Stackの画面に`Hello M5Stack`と表示されます。 + +## 3. 音楽演奏デモ + +M5Stackを用いればたった数分でミュージックプレイヤーを作成して、音楽を演奏することができます。 + +`loop`、`music`、`timer`から下図のブロックをブロックエディタに配置します。 + +
+ +
+ +
+ +
+ +
+ +
+ +それから下図に示すように各ブロックのパラメータを調整します。 + +
+ +
+ +完成したら、鳴らしてみましょう！！ + +## 完成 + +?> **Note** *M5StackへのWorkShop等のお問い合わせはこちらまで→ * diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index c22f40bb..603e588a 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -1,153 +1,153 @@ -# M5Cloud クイックスタート(MicroPython) - - - -?> **Note** *初めてM5Stackを使う場合、あらかじめ指定のファームウェアを書き込む必要があります。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)を参照してください。また、Wi-Fi接続先を変更したい場合は、このページを参照してください。 [M5StackのWi-Fi接続方法 (M5Cloud向け)](/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud)* - -*デフォルトではM5CoreがWi-Fi接続に成功した場合、以下のような画面が表示されるはずです。* - -
- -
- -## コンテンツ - -1. [M5Cloudへ接続](#M5Cloudへ接続) - -2. [デバイスのバインド](#デバイスのバインド) - -3. [プログラムする](#プログラムする) - -## 1. M5Cloudへ接続 - -PCからM5Cloudでプログミングしたい場合は `cloud.m5stack.com` へブラウザでアクセスします。 - -次のように表示されるのでアカウントの登録を行います。 - -
- -
- -## 2. デバイスのバインド - -`Device`->`Add` とクリックし、 チェックコードを入力して、M5StackをM5Cloud IDEのあなたのアカウントに紐付けます。(写真の場合はチェックコードが`052879`です) - -
- -
- -
- -
- -うまくいけば、プログラムができるようになるはずです。次のステップへ進みましょう。 - -## 3. プログラムする - -### a. 新しいプロジェクトを作成する - -
- -
- -### b. 新しいファイルを作成する - -*FACES Kit向けのプログラムを書いてみましょう* - -プロジェクトを作成したら、`faces.py`という名前のファイルを追加します。 - -
- -
- -
- -
- -それから次のコードを`faces.py`に貼り付けて保存します。 - -```Python -""" -File name: faces.py - -M5Stack MicroPython FACES keyboard I2C driver -""" - -class Faces: - def __init__(self, i2c=None): - if i2c == None: - from machine import I2C, Pin - self.i2c = I2C(sda=21, scl=22) - else: - self.i2c = i2c - self.addr = 0x08 - self.cb = None - - def read(self): - return self.i2c.readfrom(self.addr, 1) - - def _callback(self, pin): - from machine import Pin - if pin == Pin(5): - self.cb(self.read()) - - def callback(self, cb): - from machine import Pin - self.pin = Pin(5) - self.pin.init(Pin.IN) - self.pin.irq(trigger=Pin.IRQ_FALLING, handler=self._callback) - self.cb = cb -``` - -
- -
- -さらに以下のファイルを`main.py`に貼り付けて保存します。 - -```Python -""" -File name: main.py -""" - -from m5stack import * -from faces import Faces - -keyboard = Faces() - -# read once -print("Key value:", end='') -print(keyboard.read()) - -# callback -def keyboard_cb(value): - print("Key value:", end='') - print(value) - lcd.print(value) - -keyboard.callback(keyboard_cb) -``` - -
- -
- -
- -
- -実行してみましょう！ - -
- -
- -## 完成 - -このデモプログラムは、FACESキーボードで押された文字をM5Stackの画面に表示します。 - -下図は、QWERTY キーボードで ("q", "w", "e", "r", "t", "y", "u", "i", "o", "p") と押した様子です。 - -
- +# M5Cloud クイックスタート(MicroPython) + + + +?> **Note** *初めてM5Stackを使う場合、あらかじめ指定のファームウェアを書き込む必要があります。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)を参照してください。また、Wi-Fi接続先を変更したい場合は、このページを参照してください。 [M5StackのWi-Fi接続方法 (M5Cloud向け)](/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud)* + +*デフォルトではM5CoreがWi-Fi接続に成功した場合、以下のような画面が表示されるはずです。* + +
+ +
+ +## コンテンツ + +1. [M5Cloudへ接続](#M5Cloudへ接続) + +2. [デバイスのバインド](#デバイスのバインド) + +3. [プログラムする](#プログラムする) + +## 1. M5Cloudへ接続 + +PCからM5Cloudでプログミングしたい場合は `cloud.m5stack.com` へブラウザでアクセスします。 + +次のように表示されるのでアカウントの登録を行います。 + +
+ +
+ +## 2. デバイスのバインド + +`Device`->`Add` とクリックし、 チェックコードを入力して、M5StackをM5Cloud IDEのあなたのアカウントに紐付けます。(写真の場合はチェックコードが`052879`です) + +
+ +
+ +
+ +
+ +うまくいけば、プログラムができるようになるはずです。次のステップへ進みましょう。 + +## 3. プログラムする + +### a. 新しいプロジェクトを作成する + +
+ +
+ +### b. 新しいファイルを作成する + +*FACES Kit向けのプログラムを書いてみましょう* + +プロジェクトを作成したら、`faces.py`という名前のファイルを追加します。 + +
+ +
+ +
+ +
+ +それから次のコードを`faces.py`に貼り付けて保存します。 + +```Python +""" +File name: faces.py + +M5Stack MicroPython FACES keyboard I2C driver +""" + +class Faces: + def __init__(self, i2c=None): + if i2c == None: + from machine import I2C, Pin + self.i2c = I2C(sda=21, scl=22) + else: + self.i2c = i2c + self.addr = 0x08 + self.cb = None + + def read(self): + return self.i2c.readfrom(self.addr, 1) + + def _callback(self, pin): + from machine import Pin + if pin == Pin(5): + self.cb(self.read()) + + def callback(self, cb): + from machine import Pin + self.pin = Pin(5) + self.pin.init(Pin.IN) + self.pin.irq(trigger=Pin.IRQ_FALLING, handler=self._callback) + self.cb = cb +``` + +
+ +
+ +さらに以下のファイルを`main.py`に貼り付けて保存します。 + +```Python +""" +File name: main.py +""" + +from m5stack import * +from faces import Faces + +keyboard = Faces() + +# read once +print("Key value:", end='') +print(keyboard.read()) + +# callback +def keyboard_cb(value): + print("Key value:", end='') + print(value) + lcd.print(value) + +keyboard.callback(keyboard_cb) +``` + +
+ +
+ +
+ +
+ +実行してみましょう！ + +
+ +
+ +## 完成 + +このデモプログラムは、FACESキーボードで押された文字をM5Stackの画面に表示します。 + +下図は、QWERTY キーボードで ("q", "w", "e", "r", "t", "y", "u", "i", "o", "p") と押した様子です。 + +
+
\ No newline at end of file diff --git a/docs/ja/quick_start/m5core/m5stack_core_quick_start.md b/docs/ja/quick_start/m5core/m5stack_core_quick_start.md index 982b8c1a..cbdecc5f 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_quick_start.md +++ b/docs/ja/quick_start/m5core/m5stack_core_quick_start.md @@ -1,9 +1,9 @@ -# 今すぐ始めるM5Stack - - - -## 好きなプログラミング言語を以下から選んでください。 - - | ----|--- -[Arduino](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Blockly/MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) +# 今すぐ始めるM5Stack + + + +## 好きなプログラミング言語を以下から選んでください。 + + | +---|--- +[Arduino](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Blockly/MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) diff --git a/docs/ja/quick_start/m5core/m5stick_get_started_arduino.md b/docs/ja/quick_start/m5core/m5stick_get_started_arduino.md index f8df65a8..f5247023 100644 --- a/docs/ja/quick_start/m5core/m5stick_get_started_arduino.md +++ b/docs/ja/quick_start/m5core/m5stick_get_started_arduino.md @@ -1,16 +1,16 @@ -# M5Stick クイックスタート(Arduino) - - - -## 1. `U8g2` ライブラリをインストール - -もしすでに `U8g2` がインストールされている場合は、M5Stickにプログラムを書き込んで、実行するだけです。 -まだの場合は、Arduino IDEのメニューから`スケッチ -> ライブラリをインクルード -> ライブラリを管理...` を選択し、`U8g2` ライブラリを検索しインストールします。 - -
- -
- -## 2. プログラムをアップロード - +# M5Stick クイックスタート(Arduino) + + + +## 1. `U8g2` ライブラリをインストール + +もしすでに `U8g2` がインストールされている場合は、M5Stickにプログラムを書き込んで、実行するだけです。 +まだの場合は、Arduino IDEのメニューから`スケッチ -> ライブラリをインクルード -> ライブラリを管理...` を選択し、`U8g2` ライブラリを検索しインストールします。 + +
+ +
+ +## 2. プログラムをアップロード + プログラムをコンパイルし、M5StickとPCがUSBケーブルで接続されていることを確認し、アップロードします。もしうまく行かない場合は、シリアルポートの設定を確認してください。 \ No newline at end of file diff --git a/docs/ja/related_documents.md b/docs/ja/related_documents.md index b736ceaa..a4e903fe 100644 --- a/docs/ja/related_documents.md +++ b/docs/ja/related_documents.md @@ -1,9 +1,9 @@ -# その他のドキュメント - - - -1. [シリアル接続の確立方法](ja/related_documents/establish_serial_connection) -2. [GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino) -3. [Arduino IDEのM5Stackライブラリ更新方法](ja/related_documents/upgrade_m5stack_lib) -4. [ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware) -5. [M5StackのWi-Fi接続方法](ja/related_documents/how_to_connect_wifi_using_core) +# その他のドキュメント + + + +1. [シリアル接続の確立方法](ja/related_documents/establish_serial_connection) +2. [GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino) +3. [Arduino IDEのM5Stackライブラリ更新方法](ja/related_documents/upgrade_m5stack_lib) +4. [ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware) +5. [M5StackのWi-Fi接続方法](ja/related_documents/how_to_connect_wifi_using_core) diff --git a/docs/ja/related_documents/establish_serial_connection.md b/docs/ja/related_documents/establish_serial_connection.md index 331cd8c1..17477529 100644 --- a/docs/ja/related_documents/establish_serial_connection.md +++ b/docs/ja/related_documents/establish_serial_connection.md @@ -1,97 +1,97 @@ -# シリアル接続の確立方法 - - - -**このページでは、M5StackとPCとの間でシリアル接続を確立するための方法を説明します。** - -## MacOS - -### 1. USBドライバをインストール - -**[SiLabs CP2104 ドライバ ダウンロード](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)** - -**ダウンロードした SiLabsUSBDriverDisk.dmg ディスクイメージをクリックし、マウントします。そして、指示に従い、OKをクリックします。** - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -### 2. ポート確認 - -**あなたのPC（の外部コンバータドングル）のシリアルポートのデバイス名を確認するには、ターミナルを開き、M5Stackを取り外した状態で2回、次に接続した状態で2回ずつ実行します。** - -**MacOS** - - ls /dev/cu.* - -## Windows - -### 1. USBドライバをインストール - -**ダウンロード [SiLabs CP2104 ドライバ ダウンロード](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)** - -**あなたのWindowsのバージョンに合わせて(Windows7/8/10)ドライバをダウンロードしてください。** - -
- -
- -**自分の使用しているOSに合わせて64bit(x64)/32bit(x86)を選択し、インストーラをクリックします。** - -
- -
- -
- -
- -
- -
- -### 2. ポート確認 - -**Windowsのデバイスマネージャからポートを確認することができます。まずデバイスマネージャを開きます。そしてM5Stackを接続すると、デバイスマネージャのリストが更新され、ポートが現れます。** - -**図のようにシリアルポートが見えるようになります。** - -
- -
+# シリアル接続の確立方法 + + + +**このページでは、M5StackとPCとの間でシリアル接続を確立するための方法を説明します。** + +## MacOS + +### 1. USBドライバをインストール + +**[SiLabs CP2104 ドライバ ダウンロード](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)** + +**ダウンロードした SiLabsUSBDriverDisk.dmg ディスクイメージをクリックし、マウントします。そして、指示に従い、OKをクリックします。** + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +### 2. ポート確認 + +**あなたのPC（の外部コンバータドングル）のシリアルポートのデバイス名を確認するには、ターミナルを開き、M5Stackを取り外した状態で2回、次に接続した状態で2回ずつ実行します。** + +**MacOS** + + ls /dev/cu.* + +## Windows + +### 1. USBドライバをインストール + +**ダウンロード [SiLabs CP2104 ドライバ ダウンロード](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)** + +**あなたのWindowsのバージョンに合わせて(Windows7/8/10)ドライバをダウンロードしてください。** + +
+ +
+ +**自分の使用しているOSに合わせて64bit(x64)/32bit(x86)を選択し、インストーラをクリックします。** + +
+ +
+ +
+ +
+ +
+ +
+ +### 2. ポート確認 + +**Windowsのデバイスマネージャからポートを確認することができます。まずデバイスマネージャを開きます。そしてM5Stackを接続すると、デバイスマネージャのリストが更新され、ポートが現れます。** + +**図のようにシリアルポートが見えるようになります。** + +
+ +
diff --git a/docs/ja/related_documents/how_to_burn_firmware.md b/docs/ja/related_documents/how_to_burn_firmware.md index 2b7112d8..0dac999b 100644 --- a/docs/ja/related_documents/how_to_burn_firmware.md +++ b/docs/ja/related_documents/how_to_burn_firmware.md @@ -1,126 +1,126 @@ -# ファームウェアの更新方法 - - - -**このページではM5Stackのファームウェアの更新方法を説明します。** - -## MacOS - -ターミナルを開き、以下のコマンドをコピペして実行していきます。 - -1. 初めに**pip**をインストールします。（２回目以降はこの作業は不要です） - -```shell -sudo easy_install pip -``` - -2. 次に**esptool**をインストールします。（２回目以降はこの作業は不要です） - -```shell -pip install esptool -``` - -3. 次にファームウェアをダウンロードし、解凍します。 - - - UiFlow以外 -```shell -mkdir m5burner && \ -cd m5burner && \ -curl -O http://res.m5stack.com/M5Burner/M5Burner.zip && \ -unzip M5Burner.zip -``` - - - UiFlowのみ -```shell -mkdir m5burner && \ -cd m5burner && \ -curl -O http://flow.m5stack.com/download/M5Burner-flow-only.zip && \ -unzip M5Burner-flow-only.zip -``` - -1. 解凍が終わったら、リストを表示します。 - -```shell -ls firmwares/ -``` - -
- firmware_list -
- -5. そして書き込みたいファームウェアを選び、ディレクトリを移動します。 - -```shell - cd path/to/firmware/version/ - ls -``` - -6. flash.sh という名前のファイルがあるところまで移動したら、M5Stackとパソコンの接続を確認し、以下のコマンドを入力します。 - -```shell - sh flash.sh -``` - -7. 書き込みが完了したら、M5Stackのリセットボタンを押して、ファームウェアの更新の完了です。 - -## Windows - -### 1. M5Burnerツールのダウンロード - -M5Stackの公式サイトへアクセスし、**M5Burner**をダウンロードします。[offical website](http://www.m5stack.com) - -
- Screenshot of coverpage -
- -### 2. ファームウェアの書き込み - -ダウンロードが完了したら、Zipファイルを解凍し、 `M5Burner.exe` をダブルクリックします。 - -
- Screenshot of coverpage -
- -**適切な`シリアルポート`を選択し、`Baud`を*921600*に設定します。** - -
- Screenshot of coverpage -
- -!> **注意** もし `COMx` が表示されず、`COM1` だけしかない場合は、[シリアル接続の確立方法](ja/related_documents/establish_serial_connection)を参照し、USBドライバを再インストールしてください。 - -**a. ファームウェアを選択** - -例えば、もし[UiFlow](http://flow.m5stack.com)を試したい場合は、`M5Flow-vx.x`オプションを選択してください。 -もしESP32CAM(またはM5CAMERA)を試したい場合は、`M5Cam-vx.x (/M5Cam-psram)`オプションを選択してください。 - -**b. `Erase`をクリック** - -
- Screenshot of coverpage -
- -*もしM5Burnerに `Hard resetting via RTS pin...` と表示されたら、`Erase(削除)`成功です！* - -
- Screenshot of coverpage -
- -**c. `Burn`をクリック** - -
- Screenshot of coverpage -
- -*もしM5Burnerに `Leaving... Staying in bootloader.` と表示されたら、書き込み成功です！* - -
- Screenshot of coverpage -
- -### 3. M5Stackをリセット - -?> **Tip** -もしM5Burner `Burn`ビジー状態になる場合は、少し時間をおいてください。 ファームウェアの書き込みが終了すると正常に戻ります。 - +# ファームウェアの更新方法 + + + +**このページではM5Stackのファームウェアの更新方法を説明します。** + +## MacOS + +ターミナルを開き、以下のコマンドをコピペして実行していきます。 + +1. 初めに**pip**をインストールします。（２回目以降はこの作業は不要です） + +```shell +sudo easy_install pip +``` + +2. 次に**esptool**をインストールします。（２回目以降はこの作業は不要です） + +```shell +pip install esptool +``` + +3. 次にファームウェアをダウンロードし、解凍します。 + + - UiFlow以外 +```shell +mkdir m5burner && \ +cd m5burner && \ +curl -O http://res.m5stack.com/M5Burner/M5Burner.zip && \ +unzip M5Burner.zip +``` + + - UiFlowのみ +```shell +mkdir m5burner && \ +cd m5burner && \ +curl -O http://flow.m5stack.com/download/M5Burner-flow-only.zip && \ +unzip M5Burner-flow-only.zip +``` + +1. 解凍が終わったら、リストを表示します。 + +```shell +ls firmwares/ +``` + +
+ firmware_list +
+ +5. そして書き込みたいファームウェアを選び、ディレクトリを移動します。 + +```shell + cd path/to/firmware/version/ + ls +``` + +6. flash.sh という名前のファイルがあるところまで移動したら、M5Stackとパソコンの接続を確認し、以下のコマンドを入力します。 + +```shell + sh flash.sh +``` + +7. 書き込みが完了したら、M5Stackのリセットボタンを押して、ファームウェアの更新の完了です。 + +## Windows + +### 1. M5Burnerツールのダウンロード + +M5Stackの公式サイトへアクセスし、**M5Burner**をダウンロードします。[offical website](http://www.m5stack.com) + +
+ Screenshot of coverpage +
+ +### 2. ファームウェアの書き込み + +ダウンロードが完了したら、Zipファイルを解凍し、 `M5Burner.exe` をダブルクリックします。 + +
+ Screenshot of coverpage +
+ +**適切な`シリアルポート`を選択し、`Baud`を*921600*に設定します。** + +
+ Screenshot of coverpage +
+ +!> **注意** もし `COMx` が表示されず、`COM1` だけしかない場合は、[シリアル接続の確立方法](ja/related_documents/establish_serial_connection)を参照し、USBドライバを再インストールしてください。 + +**a. ファームウェアを選択** + +例えば、もし[UiFlow](http://flow.m5stack.com)を試したい場合は、`M5Flow-vx.x`オプションを選択してください。 +もしESP32CAM(またはM5CAMERA)を試したい場合は、`M5Cam-vx.x (/M5Cam-psram)`オプションを選択してください。 + +**b. `Erase`をクリック** + +
+ Screenshot of coverpage +
+ +*もしM5Burnerに `Hard resetting via RTS pin...` と表示されたら、`Erase(削除)`成功です！* + +
+ Screenshot of coverpage +
+ +**c. `Burn`をクリック** + +
+ Screenshot of coverpage +
+ +*もしM5Burnerに `Leaving... Staying in bootloader.` と表示されたら、書き込み成功です！* + +
+ Screenshot of coverpage +
+ +### 3. M5Stackをリセット + +?> **Tip** +もしM5Burner `Burn`ビジー状態になる場合は、少し時間をおいてください。 ファームウェアの書き込みが終了すると正常に戻ります。 + ?> **Tip** もし途中で書き込みが中断された場合、書き込みをやり直してください。(`M5Burner has been closed suddenly...` などと表示された場合) \ No newline at end of file diff --git a/docs/ja/related_documents/how_to_connect_wifi_using_core.md b/docs/ja/related_documents/how_to_connect_wifi_using_core.md index 66d200e3..8b8edd66 100644 --- a/docs/ja/related_documents/how_to_connect_wifi_using_core.md +++ b/docs/ja/related_documents/how_to_connect_wifi_using_core.md @@ -1,57 +1,57 @@ -# M5StackのWi-Fi接続方法 - - - -?> **Tip** *もしあなたのM5Stackに`UiFlow`向けのファームウェアが書き込まれていない場合は、あらかじめ、こちらを参考にファームウェアを書き込んでください。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)* - -**M5Stackの左側にある赤いボタンを押して電源をオンにすると、この画面に遷移します。さぁ、アクセスポイントに接続しましょう！** - -
- -
- -## 接続の流れ - -1. [UPLOADボタンを押す](#press-upload-button) - -2. [アクセスポイントの選択](#select-networkable-ap) - -3. [デバイスのリセット](#reset-your-device) - -## 1. `UPLOAD`ボタンを押す - -**`UPLOAD`ボタンを押すと、以下のようなメッセージが表示されます。** - -
- -
- -## 2. アクセスポイントの選択 - -**スマートフォンかPCを使用して、M5Core AP(like `M5Stack-03fc`)に接続します。 それからブラウザを開き、192.168.4.1 にアクセスし、あなたの使用しているネットワークのSSIDとパスワードを入力して`Configure`ボタンをクリックします。 (図の例ではネットワークのSSIDは `MasterHax_5G`です)** - -
- -
- -## 3. デバイスのリセット - -**Wi-Fiの接続に成功したら、ブラウザの表示に従い、自動的にM5Stackが再起動します。** - -
- -
- -## 完了 - -一度M5Stackをリセットして再起動したら、UPLOADボタンを押します。二次元コードが表示される画面に遷移するので、次の記事を参考にして、プログラムをしてみましょう！ [Quick Start with UiFlow](ja/quick_start/m5core/m5stack_core_get_started_MicroPython) - -
- -
- -?> **Note** もし別のネットワークに接続したい場合は、リセットボタンで再起動をしてから`SETUP`ボタンを押して、再度Wi-Fiの接続設定を行なってください。 - -
- +# M5StackのWi-Fi接続方法 + + + +?> **Tip** *もしあなたのM5Stackに`UiFlow`向けのファームウェアが書き込まれていない場合は、あらかじめ、こちらを参考にファームウェアを書き込んでください。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)* + +**M5Stackの左側にある赤いボタンを押して電源をオンにすると、この画面に遷移します。さぁ、アクセスポイントに接続しましょう！** + +
+ +
+ +## 接続の流れ + +1. [UPLOADボタンを押す](#press-upload-button) + +2. [アクセスポイントの選択](#select-networkable-ap) + +3. [デバイスのリセット](#reset-your-device) + +## 1. `UPLOAD`ボタンを押す + +**`UPLOAD`ボタンを押すと、以下のようなメッセージが表示されます。** + +
+ +
+ +## 2. アクセスポイントの選択 + +**スマートフォンかPCを使用して、M5Core AP(like `M5Stack-03fc`)に接続します。 それからブラウザを開き、192.168.4.1 にアクセスし、あなたの使用しているネットワークのSSIDとパスワードを入力して`Configure`ボタンをクリックします。 (図の例ではネットワークのSSIDは `MasterHax_5G`です)** + +
+ +
+ +## 3. デバイスのリセット + +**Wi-Fiの接続に成功したら、ブラウザの表示に従い、自動的にM5Stackが再起動します。** + +
+ +
+ +## 完了 + +一度M5Stackをリセットして再起動したら、UPLOADボタンを押します。二次元コードが表示される画面に遷移するので、次の記事を参考にして、プログラムをしてみましょう！ [Quick Start with UiFlow](ja/quick_start/m5core/m5stack_core_get_started_MicroPython) + +
+ +
+ +?> **Note** もし別のネットワークに接続したい場合は、リセットボタンで再起動をしてから`SETUP`ボタンを押して、再度Wi-Fiの接続設定を行なってください。 + +
+
\ No newline at end of file diff --git a/docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md b/docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md index 028ee7a3..d2dd6c6e 100644 --- a/docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md +++ b/docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md @@ -1,55 +1,55 @@ -# M5StackのWi-Fi接続方法 (M5Cloud向け) - - - -?> **Tip** *もしあなたのM5Stackにあらかじめ`M5Cloud`向けのファームウェアが書き込まれていない場合は、こちらを参考にファームウェアを書き込んでください。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)* - -**電源を入れて下図の画面に遷移したら、M5StackのWi-FiのAPにアクセスすることができます。** - -
- -
- -## コンテンツ - -1. [APに接続](#_1-apに接続) - -2. [Wi-Fiネットワーク選択](#_2-Wi-Fiネットワーク選択) - -3. [M5Stackをリセット](#_3-m5stackをリセット) - -## 1. APに接続 - -**Use Mobile Phone or PC for connectting to M5Core AP(like `M5Stack-a67c`)** - -## 2. Wi-Fiネットワーク選択 - -**ブラウザから`192.168.4.1`にアクセスし、使用するWi-FiのSSIDとパスワードを入力します。(図ではWi-FiのSSIDは`MasterHax_2.4G`)** - -
- -
- -
- -
- -?> **Note** もしWi-Fi接続が失敗した場合は、再度接続をやり直してみてください。 - -## 3. M5Stackをリセット - -**Wi-Fiの設定がうまくいったら、M5Stackは自動的に再起動します。** - -
- -
- -?> **Note** もし以前に[M5Cloud](http://cloud.m5stack.com)でチェックコードを入力したことがある場合、以下の図のように表示されます。 - -
- -
- -## 完成 - -次のステップとして実際にプログラムを作成してみましょう。[M5Cloud クイックスタート(MicroPython)](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud)を参照してください。 +# M5StackのWi-Fi接続方法 (M5Cloud向け) + + + +?> **Tip** *もしあなたのM5Stackにあらかじめ`M5Cloud`向けのファームウェアが書き込まれていない場合は、こちらを参考にファームウェアを書き込んでください。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)* + +**電源を入れて下図の画面に遷移したら、M5StackのWi-FiのAPにアクセスすることができます。** + +
+ +
+ +## コンテンツ + +1. [APに接続](#_1-apに接続) + +2. [Wi-Fiネットワーク選択](#_2-Wi-Fiネットワーク選択) + +3. [M5Stackをリセット](#_3-m5stackをリセット) + +## 1. APに接続 + +**Use Mobile Phone or PC for connectting to M5Core AP(like `M5Stack-a67c`)** + +## 2. Wi-Fiネットワーク選択 + +**ブラウザから`192.168.4.1`にアクセスし、使用するWi-FiのSSIDとパスワードを入力します。(図ではWi-FiのSSIDは`MasterHax_2.4G`)** + +
+ +
+ +
+ +
+ +?> **Note** もしWi-Fi接続が失敗した場合は、再度接続をやり直してみてください。 + +## 3. M5Stackをリセット + +**Wi-Fiの設定がうまくいったら、M5Stackは自動的に再起動します。** + +
+ +
+ +?> **Note** もし以前に[M5Cloud](http://cloud.m5stack.com)でチェックコードを入力したことがある場合、以下の図のように表示されます。 + +
+ +
+ +## 完成 + +次のステップとして実際にプログラムを作成してみましょう。[M5Cloud クイックスタート(MicroPython)](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud)を参照してください。 diff --git a/docs/ja/related_documents/how_to_install_git_and_arduino.md b/docs/ja/related_documents/how_to_install_git_and_arduino.md index a26f263b..664f053b 100644 --- a/docs/ja/related_documents/how_to_install_git_and_arduino.md +++ b/docs/ja/related_documents/how_to_install_git_and_arduino.md @@ -1,27 +1,27 @@ -# GitとArduino IDEのインストール方法 - - - -## Windows - -## 1. `Git`のインストール -もし既に `Git` がインストールされている場合は、次のステップへ進んでください。そうでなければ [Git](https://git-scm.com/download/win) をダウンロードし、インストールしてください。 - -## 2. `Arduino IDE`のインストール - -*Arduino IDEのダウンロードリンク* -https://www.arduino.cc/en/Main/Software - -
- -
- -Arduino IDE をダウンロードしたら、インストーラをダブルクリックしてインストールします。 - -
- -
- -
- +# GitとArduino IDEのインストール方法 + + + +## Windows + +## 1. `Git`のインストール +もし既に `Git` がインストールされている場合は、次のステップへ進んでください。そうでなければ [Git](https://git-scm.com/download/win) をダウンロードし、インストールしてください。 + +## 2. `Arduino IDE`のインストール + +*Arduino IDEのダウンロードリンク* +https://www.arduino.cc/en/Main/Software + +
+ +
+ +Arduino IDE をダウンロードしたら、インストーラをダブルクリックしてインストールします。 + +
+ +
+ +
+
\ No newline at end of file diff --git a/docs/ja/related_documents/upgrade_m5stack_lib.md b/docs/ja/related_documents/upgrade_m5stack_lib.md index 90ffb6b3..61ee86df 100644 --- a/docs/ja/related_documents/upgrade_m5stack_lib.md +++ b/docs/ja/related_documents/upgrade_m5stack_lib.md @@ -1,19 +1,19 @@ -# Arduino IDEのM5Stackライブラリ更新方法 - - - -### 1. Arduino IDEを起動し、`スケッチ`->`ライブラリをインクルード`->`ライブラリを管理...` - -### 2. 検索ボックスに`M5Stack`と入力し、検索 - -
- Screenshot of coverpage -
- -### 3. もし以下のように表示されたら`アップデート`をクリック - -**もし`インストール`と表示された場合は、まだあなたがM5Stackライブラリをインストールしていない事を意味します。** - -
- Screenshot of coverpage -
+# Arduino IDEのM5Stackライブラリ更新方法 + + + +### 1. Arduino IDEを起動し、`スケッチ`->`ライブラリをインクルード`->`ライブラリを管理...` + +### 2. 検索ボックスに`M5Stack`と入力し、検索 + +
+ Screenshot of coverpage +
+ +### 3. もし以下のように表示されたら`アップデート`をクリック + +**もし`インストール`と表示された場合は、まだあなたがM5Stackライブラリをインストールしていない事を意味します。** + +
+ Screenshot of coverpage +
diff --git a/docs/ja/sidebar.md b/docs/ja/sidebar.md index 1a58a9e7..757f8af1 100644 --- a/docs/ja/sidebar.md +++ b/docs/ja/sidebar.md @@ -1,10 +1,10 @@ -- [製品ドキュメント](ja/) -- [API リファレンス](ja/api) -- [M5Stack アプリケーション](ja/case) -- [その他のドキュメント](ja/related_documents) -- [よくある質問](ja/faq) - - -- **Links** -- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/m5stack) -- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) +- [製品ドキュメント](ja/) +- [API リファレンス](ja/api) +- [M5Stack アプリケーション](ja/case) +- [その他のドキュメント](ja/related_documents) +- [よくある質問](ja/faq) + + +- **Links** +- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/m5stack) +- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) diff --git a/docs/ja/tool/usb_downloader.md b/docs/ja/tool/usb_downloader.md index 18710d4f..99647213 100644 --- a/docs/ja/tool/usb_downloader.md +++ b/docs/ja/tool/usb_downloader.md @@ -1,32 +1,32 @@ -# M5Stack USB Downloader - - - -## 概要 - -1. USB/UART変換チップCP2104によるESP32/ESP8266のファームウェア書き込みをサポートします。 -2. ６ピン@2.54mmバスソケットです。 - -## ピンマップ - -| Pin# | Name | -|:-----|:------| -| 1 | GND | -| 2 | GPIO0 | -| 3 | EN | -| 4 | TXD | -| 5 | RXD | -| 6 | 3.3V | - -?>メモ M5Stack USB Downloaderには、他のアプリケーション用に2つの予約済みピン（RTS、DTR）があります。 - -## パッケージ内容 - -- 1x M5Stack USB Downloader - -## ドキュメント - -- 回路図 - - [Schematic](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/USBtool.pdf) -- ユーザガイド(英語) +# M5Stack USB Downloader + + + +## 概要 + +1. USB/UART変換チップCP2104によるESP32/ESP8266のファームウェア書き込みをサポートします。 +2. ６ピン@2.54mmバスソケットです。 + +## ピンマップ + +| Pin# | Name | +|:-----|:------| +| 1 | GND | +| 2 | GPIO0 | +| 3 | EN | +| 4 | TXD | +| 5 | RXD | +| 6 | 3.3V | + +?>メモ M5Stack USB Downloaderには、他のアプリケーション用に2つの予約済みピン（RTS、DTR）があります。 + +## パッケージ内容 + +- 1x M5Stack USB Downloader + +## ドキュメント + +- 回路図 + - [Schematic](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/USBtool.pdf) +- ユーザガイド(英語) - [UserGuide](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/M5Stack-USB-Downloader-UserGuide.md) \ No newline at end of file diff --git a/docs/ja/unit/396port.md b/docs/ja/unit/396port.md index 267413c1..63c90717 100644 --- a/docs/ja/unit/396port.md +++ b/docs/ja/unit/396port.md @@ -1,27 +1,27 @@ -# 3.96port ユニット - - - -* * * - -:memo:**[概要](#概要)**   :octocat:**[サンプルコード](#サンプルコード)**   :electric_plug:**[回路図](#回路図)**   🛒**[購入リンク](#購入リンク)** - -## 概要 - -**3.96port**ユニットはGroveからVH3.96-4ピンコネクタに変換するためのユニットです。 - -## 特徴 - -- VH3.96 インターフェース -- LEGO 互換ホール - -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -## 購入リンク - -- [3.96port ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4055/) +# 3.96port ユニット + + + +* * * + +:memo:**[概要](#概要)**   :octocat:**[サンプルコード](#サンプルコード)**   :electric_plug:**[回路図](#回路図)**   🛒**[購入リンク](#購入リンク)** + +## 概要 + +**3.96port**ユニットはGroveからVH3.96-4ピンコネクタに変換するためのユニットです。 + +## 特徴 + +- VH3.96 インターフェース +- LEGO 互換ホール + +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## 購入リンク + +- [3.96port ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4055/) - [3.96port ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-3-96-4Pin-M5GO-ESP32/3226069_32922623759.html) \ No newline at end of file diff --git a/docs/ja/unit/adc.md b/docs/ja/unit/adc.md index 247c38e1..d8919329 100644 --- a/docs/ja/unit/adc.md +++ b/docs/ja/unit/adc.md @@ -1,57 +1,57 @@ -# ADC ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** - -## 概要 - -**ADC**ユニットは自己校正機能を備えた16bit ADコンバータユニットです。ESP32内蔵ADコンバータの2倍の分解能をほこり、より精細なデータを取得する事ができるようになります。変換モードは連続モードとワンショットモードの２つがあります。I2Cを使用してADCユニットからデータの取得を行う事ができます。I2Cアドレスは **0x48**です。 - -## 特徴 - -- 最大分解能 16bit -- サンプリングレート変更可能 - サンプルレート 8, 16, 32, 128Hz -- 増幅率変更可能 - 利得 1, 2, 4, 8 dB -- 0〜12Vの電圧入力を検出可能 -- ２種類の変換モード - 連続モード、ワンショットモード -- LEGO 互換ホール - -## アプリケーション - -- 心電図 -- 血圧計 -- ダイナモメーター - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### PinMap - - - - -
M5Core(GROVE A)GPIO22GPIO215VGND
ADC UnitSCLSDA5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -- **データシート** - - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) - -## 購入リンク - +# ADC ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** + +## 概要 + +**ADC**ユニットは自己校正機能を備えた16bit ADコンバータユニットです。ESP32内蔵ADコンバータの2倍の分解能をほこり、より精細なデータを取得する事ができるようになります。変換モードは連続モードとワンショットモードの２つがあります。I2Cを使用してADCユニットからデータの取得を行う事ができます。I2Cアドレスは **0x48**です。 + +## 特徴 + +- 最大分解能 16bit +- サンプリングレート変更可能 - サンプルレート 8, 16, 32, 128Hz +- 増幅率変更可能 - 利得 1, 2, 4, 8 dB +- 0〜12Vの電圧入力を検出可能 +- ２種類の変換モード - 連続モード、ワンショットモード +- LEGO 互換ホール + +## アプリケーション + +- 心電図 +- 血圧計 +- ダイナモメーター + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
ADC UnitSCLSDA5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +- **データシート** + - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) + +## 購入リンク + - [ADC ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ADC-16-I2C-ADS1100-0-12/3226069_32946953374.html) \ No newline at end of file diff --git a/docs/ja/unit/angle.md b/docs/ja/unit/angle.md index 36cea499..124f922c 100644 --- a/docs/ja/unit/angle.md +++ b/docs/ja/unit/angle.md @@ -1,44 +1,44 @@ -# ANGLE ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** - -## 概要 - -**ANGLE**ユニットは可変抵抗器です。回転角度検出や音量調節などに利用できます。 - -## 特徴 - -- LEGO 互換ホール - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### PinMap - - -
- - -
M5Core(GROVE B)GPIO36GPIO265VGND
ANGLE UnitANGLE Pin 5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -## 関連情報 - +# ANGLE ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** + +## 概要 + +**ANGLE**ユニットは可変抵抗器です。回転角度検出や音量調節などに利用できます。 + +## 特徴 + +- LEGO 互換ホール + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### PinMap + + +
+ + +
M5Core(GROVE B)GPIO36GPIO265VGND
ANGLE UnitANGLE Pin 5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## 関連情報 + - [ANGLE ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-GPIO-Co-n-nec-to-r/3226069_32931834705.html) \ No newline at end of file diff --git a/docs/ja/unit/button.md b/docs/ja/unit/button.md index be2513a4..c42b29db 100644 --- a/docs/ja/unit/button.md +++ b/docs/ja/unit/button.md @@ -1,45 +1,45 @@ -# BUTTON ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** - -## 概要 - -**BUTTON**ユニットは一つのボタンを備えたユニットです。 - -## 特徴 - -- LEGO 互換ホール -- Grove インターフェース - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### PinMap - - - - -
M5Core(GROVE B)GPIO36GPIO265VGND
BUTTON UnitGPIO36GPIO265VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -## 購入リンク - -- [BUTTON ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4047/) +# BUTTON ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** + +## 概要 + +**BUTTON**ユニットは一つのボタンを備えたユニットです。 + +## 特徴 + +- LEGO 互換ホール +- Grove インターフェース + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
BUTTON UnitGPIO36GPIO265VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## 購入リンク + +- [BUTTON ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4047/) - [BUTTON ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ESP32-Arduino-Micropython-GPIO-Blockly/3226069_32921805637.html) \ No newline at end of file diff --git a/docs/ja/unit/color.md b/docs/ja/unit/color.md index 6fb9882f..a9854100 100644 --- a/docs/ja/unit/color.md +++ b/docs/ja/unit/color.md @@ -1,39 +1,43 @@ -# COLOR SENSOR ユニット - - - -## 概要 - -**COLOR SENSOR**ユニットは内蔵されたTCS3472により、対象物表面の色を検出する事ができます。M5StackはI2Cで値を取得可能です。 - -## 特徴 - -- 高精度 -- LEGO 互換ホール - -## アプリケーション - -- RGB LED バックライトコントロール -- 色校正 - -## ドキュメント - -- **GitHub** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Color) - -- **データシート** - - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) - -- **回路図** - - [Schematic](https://github.com/m5stack/M5Stack) - -
- M5GO_Unit_color -
-
- M5GO_Unit_color_02 -
- -## 関連情報 - +# COLOR SENSOR ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Color-Unit-TCS34725-Color-Sensor-RGB-Color-Sensor-Development-Board-Module-GROVE-I2C-Compatible/3226069_32946957647.html?spm=a2g1x.12024536.productList_5885013.pic_5)** + +## 概要 + +**COLOR SENSOR**ユニットは内蔵されたTCS3472により、対象物表面の色を検出する事ができます。M5StackはI2Cで値を取得可能です。 + +## 特徴 + +- 高精度 +- LEGO 互換ホール + +## アプリケーション + +- RGB LED バックライトコントロール +- 色校正 + +## ドキュメント + +- **GitHub** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Color) + +- **データシート** + - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) + +- **回路図** + - [回路図](https://github.com/m5stack/M5Stack) + +
+ M5GO_Unit_color +
+
+ M5GO_Unit_color_02 +
+ +## 関連情報 + - [COLOR SENSOR ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-TCS34725-RGB-I2C/3226069_32946957647.html) \ No newline at end of file diff --git a/docs/ja/unit/dac.md b/docs/ja/unit/dac.md index 80ff226c..91e7bc5d 100644 --- a/docs/ja/unit/dac.md +++ b/docs/ja/unit/dac.md @@ -1,38 +1,38 @@ -# DAC ユニット - - - -## 概要 - -**DAC**ユニットは電圧や音などのデジタル信号をアナログ信号に変換する機能を提供します。12 bitの分解能を持つMCP4725チップを採用しており、入力値やコンフィグレーションデータは内蔵する不揮発性メモリ(EEPROM)に書き込む事が可能です。 - -## 特徴 - -- 最大12bit 分解能 -- 出力電圧 0 ~ 3.3V -- LEGO 互換ホール -- EEPROM - -## アプリケーション - -- MP3 オーディオプレイヤー -- ミニオシロスコープ - -## ドキュメント - -- **GitHub** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/DAC_MCP4725) - -- **データシート** - - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html) - -
- M5GO_Unit_dac -
-
- M5GO_Unit_dac_02 -
- -## 関連情報 - +# DAC ユニット + + + +## 概要 + +**DAC**ユニットは電圧や音などのデジタル信号をアナログ信号に変換する機能を提供します。12 bitの分解能を持つMCP4725チップを採用しており、入力値やコンフィグレーションデータは内蔵する不揮発性メモリ(EEPROM)に書き込む事が可能です。 + +## 特徴 + +- 最大12bit 分解能 +- 出力電圧 0 ~ 3.3V +- LEGO 互換ホール +- EEPROM + +## アプリケーション + +- MP3 オーディオプレイヤー +- ミニオシロスコープ + +## ドキュメント + +- **GitHub** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/DAC_MCP4725) + +- **データシート** + - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html) + +
+ M5GO_Unit_dac +
+
+ M5GO_Unit_dac_02 +
+ +## 関連情報 + - [DAC ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-DAC-MCP4725-I2C-Dac-12-0/3226069_32947696641.html) \ No newline at end of file diff --git a/docs/ja/unit/dual_button.md b/docs/ja/unit/dual_button.md index f1123897..2d0a7e25 100644 --- a/docs/ja/unit/dual_button.md +++ b/docs/ja/unit/dual_button.md @@ -1,45 +1,45 @@ -# Dual BUTTON ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** - -## 概要 - -**Dual BUTTON**ユニットは2つのボタンが搭載されたユニットです。 - -## 特徴 - -- LEGO 互換ホール -- Grove インターフェース - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### PinMap - - - - -
M5Core(GROVE B)GPIO36GPIO265VGND
DUAL_BUTTON UnitGPIO36GPIO265VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -## 購入リンク - -- [Dual BUTTON ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4048/) +# Dual BUTTON ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** + +## 概要 + +**Dual BUTTON**ユニットは2つのボタンが搭載されたユニットです。 + +## 特徴 + +- LEGO 互換ホール +- Grove インターフェース + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
DUAL_BUTTON UnitGPIO36GPIO265VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## 購入リンク + +- [Dual BUTTON ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4048/) - [Dual BUTTON ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-M5GO-ESP32-Micropython/3226069_32923126250.html) \ No newline at end of file diff --git a/docs/ja/unit/earth.md b/docs/ja/unit/earth.md index a9a1598a..fa04ba0b 100644 --- a/docs/ja/unit/earth.md +++ b/docs/ja/unit/earth.md @@ -1,47 +1,47 @@ -# EARTH ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** - -## 概要 - -**EARTH**ユニットは土壌に含まれる水分量を検出する事ができるユニットです。土壌中の水分量をアナログ値として取得できるほか、水分量が一定値を超えているかどうかをデジタル値(0/1)として取得可能です。 - -## 特徴 - -- 10KΩ調整抵抗による閾値調整可能 -- アナログ & デジタル出力 -- Grove インターフェース -- LEGO 互換ホール - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### PinMap - - - - -
M5Core(GROVE B)GPIO36GPIO265VGND
EARTH UnitAinDin5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -## 購入リンク - -- [EARTH ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4049/) +# EARTH ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** + +## 概要 + +**EARTH**ユニットは土壌に含まれる水分量を検出する事ができるユニットです。土壌中の水分量をアナログ値として取得できるほか、水分量が一定値を超えているかどうかをデジタル値(0/1)として取得可能です。 + +## 特徴 + +- 10KΩ調整抵抗による閾値調整可能 +- アナログ & デジタル出力 +- Grove インターフェース +- LEGO 互換ホール + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
EARTH UnitAinDin5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## 購入リンク + +- [EARTH ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4049/) - [EARTH ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack/3226069_32922643696.html) \ No newline at end of file diff --git a/docs/ja/unit/env.md b/docs/ja/unit/env.md index ba57ed2b..e7acac3b 100644 --- a/docs/ja/unit/env.md +++ b/docs/ja/unit/env.md @@ -1,52 +1,52 @@ -# ENV ユニット - - - -* * * - -:memo:**[概要](#概要)**   :octocat:**[サンプルコード](#サンプルコード)**   :electric_plug:**[回路図](#回路図)**   🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)** - -## 概要 - -**ENV**ユニットは周辺の温度・湿度・気圧を取得する事ができます。 - -## 特徴 - -- 温度: - - 計測範囲: 20 ~ 60℃ - - 精度: ±0.2℃ -- 湿度: - - 計測範囲: 20 ~ 95℃ - - 精度: 0.1% -- 気圧: - - 計測範囲: 300 ~ 1100hPa - - 精度: ±1hPa -- LEGO 互換ホール - -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - - -## 回路図 - - - -### ピンマッピング - -M5Core(GROVE A)GPIO22GPIO215VGND - ENV UnitSCLSDA5VGND - - - - - +# ENV ユニット + + + +* * * + +:memo:**[概要](#概要)**   :octocat:**[サンプルコード](#サンプルコード)**   :electric_plug:**[回路図](#回路図)**   🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)** + +## 概要 + +**ENV**ユニットは周辺の温度・湿度・気圧を取得する事ができます。 + +## 特徴 + +- 温度: + - 計測範囲: 20 ~ 60℃ + - 精度: ±0.2℃ +- 湿度: + - 計測範囲: 20 ~ 95℃ + - 精度: 0.1% +- 気圧: + - 計測範囲: 300 ~ 1100hPa + - 精度: ±1hPa +- LEGO 互換ホール + +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + + +## 回路図 + + + +### ピンマッピング + +M5Core(GROVE A)GPIO22GPIO215VGND + ENV UnitSCLSDA5VGND + + + + + diff --git a/docs/ja/unit/esp32cam.md b/docs/ja/unit/esp32cam.md index 989da4a6..dc422c7a 100644 --- a/docs/ja/unit/esp32cam.md +++ b/docs/ja/unit/esp32cam.md @@ -1,58 +1,58 @@ -# ESP32Cam ユニット - - - -*** - -:memo:**[概要](#概要)**   :bulb:**[クイックスタート](ja/quick_start/m5core/m5stack_core_quick_start)**      :octocat::electric_plug:**[回路図](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-Camera-Module-Development-Board-OV2640-Camera-Type-C-Grove-Port-3D-Wifi-Antenna/3226069_32881414545.html)** - -## 概要 - -**ESP32Cam**ユニットは**ESP32**、**OV2640**、**LiPoチャージャー(IP5306)**を内蔵しています。リチウムバッテリ、MPU6050（ジャイロ＋加速度センサー）、BME280（温湿度＋気圧センサー）、マイクなどと組み合わせることでバッテリ駆動の監視システムを構築することも可能です。 - -## 特徴 - -- ESP32 スペック - - デュアルコア Tensilica LX6 マイクロプロセッサ - - 最大クロック 240MHz - - 520KB SRAM - - 4MB Flash メモリ - - 802.11 b/g/n Wi-Fi - - デュアルモード Bluetooth (classic and BLE) - - ハードウェアアクセラレーションによる暗号化 (AES, SHA2, ECC, RSA-4096) -- CP2104 USB TTL -- OV2640 センサー - - 出力フォーマット(8-bit): - - YUV(422/420)/YCbCr422 - - RGB565/555 - - 8-bit 圧縮データ - - 8/10-bit RAW RGB データ - - 最大画像転送レート - - UXGA/SXGA: 15fps - - SVGA: 30fps - - CIF: 60fps - - スキャンモード: プログレッシブ -- カメラ スペック - - CCD サイズ : 1/4inch - - 視野 : 78 度 - - 最大ピクセル: 200W -- 最大解像度: 1600 * 1200 -- サイズ: 25mm x 24mm -- 重量: 5g - -## パッケージ内容 - -- 1x ESP32Cam -- 1x USB Type-C ケーブル - -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -- **データシート** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - -## 関連情報 - +# ESP32Cam ユニット + + + +*** + +:memo:**[概要](#概要)**   :bulb:**[クイックスタート](ja/quick_start/m5core/m5stack_core_quick_start)**      :octocat::electric_plug:**[回路図](https://github.com/m5stack/M5-回路図/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-Camera-Module-Development-Board-OV2640-Camera-Type-C-Grove-Port-3D-Wifi-Antenna/3226069_32881414545.html)** + +## 概要 + +**ESP32Cam**ユニットは**ESP32**、**OV2640**、**LiPoチャージャー(IP5306)**を内蔵しています。リチウムバッテリ、MPU6050（ジャイロ＋加速度センサー）、BME280（温湿度＋気圧センサー）、マイクなどと組み合わせることでバッテリ駆動の監視システムを構築することも可能です。 + +## 特徴 + +- ESP32 スペック + - デュアルコア Tensilica LX6 マイクロプロセッサ + - 最大クロック 240MHz + - 520KB SRAM + - 4MB Flash メモリ + - 802.11 b/g/n Wi-Fi + - デュアルモード Bluetooth (classic and BLE) + - ハードウェアアクセラレーションによる暗号化 (AES, SHA2, ECC, RSA-4096) +- CP2104 USB TTL +- OV2640 センサー + - 出力フォーマット(8-bit): + - YUV(422/420)/YCbCr422 + - RGB565/555 + - 8-bit 圧縮データ + - 8/10-bit RAW RGB データ + - 最大画像転送レート + - UXGA/SXGA: 15fps + - SVGA: 30fps + - CIF: 60fps + - スキャンモード: プログレッシブ +- カメラ スペック + - CCD サイズ : 1/4inch + - 視野 : 78 度 + - 最大ピクセル: 200W +- 最大解像度: 1600 * 1200 +- サイズ: 25mm x 24mm +- 重量: 5g + +## パッケージ内容 + +- 1x ESP32Cam +- 1x USB Type-C ケーブル + +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +- **データシート** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) + +## 関連情報 + - [ESP32Cam ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ESP32-OV2640-C-3D-Wifi/3226069_32881414545.html) \ No newline at end of file diff --git a/docs/ja/unit/hub.md b/docs/ja/unit/hub.md index c09beb8f..5ca63c04 100644 --- a/docs/ja/unit/hub.md +++ b/docs/ja/unit/hub.md @@ -1,30 +1,30 @@ -# HUB ユニット - - - -*** - -:memo:**[概要](#概要)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** - -## 概要 - -**HUB**ユニットは3つのGroveコネクタ備えたハブユニットです。ユーザは任意のユニットを3つまで追加する事ができます。 - -## 特徴 - -- 3つの4ピンGroveコネクタ -- LEGO 互換ホール - -## 回路図 - - - -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -## 購入リンク - +# HUB ユニット + + + +*** + +:memo:**[概要](#概要)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** + +## 概要 + +**HUB**ユニットは3つのGroveコネクタ備えたハブユニットです。ユーザは任意のユニットを3つまで追加する事ができます。 + +## 特徴 + +- 3つの4ピンGroveコネクタ +- LEGO 互換ホール + +## 回路図 + + + +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## 購入リンク + - [HUB ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-1-3/3226069_32930928722.html) \ No newline at end of file diff --git a/docs/ja/unit/ir.md b/docs/ja/unit/ir.md index ad412ef0..92ad04e0 100644 --- a/docs/ja/unit/ir.md +++ b/docs/ja/unit/ir.md @@ -1,45 +1,45 @@ -# IR ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** - -## 概要 - -**IR**ユニットは赤外線送受信機能をもったユニットです。障害物回避ロボット、ライントレーサーなどを作る事が可能です。 - -## 特徴 - -- IR送受信機 -- 検出距離 2 ~ 5cm -- LEGO 互換ホ - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### ピンマッピング - - - - -
M5Core(GROVE B)GPIO36GPIO265VGND
IR UnitReceiver PinTransmitter Pin5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -## 購入リンク - +# IR ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](#購入リンク)** + +## 概要 + +**IR**ユニットは赤外線送受信機能をもったユニットです。障害物回避ロボット、ライントレーサーなどを作る事が可能です。 + +## 特徴 + +- IR送受信機 +- 検出距離 2 ~ 5cm +- LEGO 互換ホ + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
IR UnitReceiver PinTransmitter Pin5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## 購入リンク + - [IR ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-Ir-GPIO/3226069_32933215001.html) \ No newline at end of file diff --git a/docs/ja/unit/joystick.md b/docs/ja/unit/joystick.md index 3d449ff0..97b1f918 100644 --- a/docs/ja/unit/joystick.md +++ b/docs/ja/unit/joystick.md @@ -1,39 +1,39 @@ -# JOYSTICK ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-New-Joystick-Unit-MEGA328P-I2C-Grove-Connector-Compatible-X-Y-Axis-Button-for-ESP32/3226069_32921785624.html?spm=a2g1x.12024536.productList_2187621.10)** - -## 概要 - -**JOYSTICK**ユニットはゲームコントローラーと同じジョイスティックです。X-Y軸オフセットとボタンクリックの入力を取得できます。 - -## 特徴 - -- LEGO 互換ホール -- Grove インターフェース - -## サンプルコード - -### 1. Arduino IDE - -### 2. UIFlow - -## 回路図 - - - -### ピンマッピング - - - - -
M5Core(GROVE A)GPIO22GPIO215VGND
JOYSTICK UnitSCLSDA5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - +# JOYSTICK ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-New-Joystick-Unit-MEGA328P-I2C-Grove-Connector-Compatible-X-Y-Axis-Button-for-ESP32/3226069_32921785624.html?spm=a2g1x.12024536.productList_2187621.10)** + +## 概要 + +**JOYSTICK**ユニットはゲームコントローラーと同じジョイスティックです。X-Y軸オフセットとボタンクリックの入力を取得できます。 + +## 特徴 + +- LEGO 互換ホール +- Grove インターフェース + +## サンプルコード + +### 1. Arduino IDE + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
JOYSTICK UnitSCLSDA5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + - **[フォーラム](http://forum.m5stack.com/)** \ No newline at end of file diff --git a/docs/ja/unit/light.md b/docs/ja/unit/light.md index 859c1447..cb7b0302 100644 --- a/docs/ja/unit/light.md +++ b/docs/ja/unit/light.md @@ -1,42 +1,42 @@ -# LIGHT ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Light-Unit-with-Photoresistance-Grove-Port-Analog-Digital-Output-Compatible-with-M5GO-FIRE-ESP32/3226069_32920589923.html?spm=2114.12010615.8148356.4.1be27011RbDBo5)** - -## 概要 - -**LIGHT**ユニットは調整抵抗付き明るさセンサーです。明るさをアナログ値として、光のオンオフをデジタル値(0/1)として取得できます。 - -## 特徴 - -- 10KΩ調整抵抗による閾値調整可能 -- アナログ & デジタル出力 -- Grove インターフェース -- LEGO 互換ホール - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### ピンマッピング - - - - -
M5Core(GROVE B)GPIO36GPIO265VGND
LIGHT UnitAinDin5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - +# LIGHT ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Light-Unit-with-Photoresistance-Grove-Port-Analog-Digital-Output-Compatible-with-M5GO-FIRE-ESP32/3226069_32920589923.html?spm=2114.12010615.8148356.4.1be27011RbDBo5)** + +## 概要 + +**LIGHT**ユニットは調整抵抗付き明るさセンサーです。明るさをアナログ値として、光のオンオフをデジタル値(0/1)として取得できます。 + +## 特徴 + +- 10KΩ調整抵抗による閾値調整可能 +- アナログ & デジタル出力 +- Grove インターフェース +- LEGO 互換ホール + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
LIGHT UnitAinDin5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + - **[フォーラム](http://forum.m5stack.com/)** \ No newline at end of file diff --git a/docs/ja/unit/m5camera.md b/docs/ja/unit/m5camera.md index aeb71359..410313df 100644 --- a/docs/ja/unit/m5camera.md +++ b/docs/ja/unit/m5camera.md @@ -1,57 +1,57 @@ -# M5Camera ユニット - -
- -*** - -:memo:**[概要](#概要)**   :bulb:**[クイックスタート](ja/quick_start/m5core/m5stack_core_quick_start)**      :octocat::electric_plug:**[回路図](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-Camera-Module-Development-Board-OV2640-Camera-Type-C-Grove-Port-3D-Wifi-Antenna/3226069_32881414545.html)** - -## 概要 - -**M5Camera**は**ESP32**、**OV2640**、4MBの**pSRAM**、**LiPoチャージャー(IP5306)**などが内蔵されています。リチウムバッテリ、MPU6050（ジャイロ＋加速度センサー）、BME280（温湿度＋気圧センサー）、マイクなどと組み合わせることでバッテリ駆動の監視システムを構築することも可能です。 - -## 特徴 - -- ESP32 スペック - - デュアルコア Tensilica LX6 マイクロプロセッサ - - 最大クロック 240MHz - - 520KB SRAM - - 4MB pSRAM - - 4MB Flash メモリ - - 802.11 b/g/n Wi-Fi - - デュアルモード Bluetooth (classic and BLE) - - ハードウェアアクセラレーションによる暗号化 (AES, SHA2, ECC, RSA-4096) -- CP2104 USB TTL -- OV2640 センサー - - 出力フォーマット(8-bit): - - YUV(422/420)/YCbCr422 - - RGB565/555 - - 8-bit 圧縮データ - - 8/10-bit RAW RGB データ - - 最大画像転送レート - - UXGA/SXGA: 15fps - - SVGA: 30fps - - CIF: 60fps - - スキャンモード: プログレッシブ -- カメラ スペック - - CCD サイズ : 1/4inch - - 視野 : 78 度 - - 最大ピクセル: 200W -- 最大解像度: 1600 * 1200 -- サイズ: 25mm x 24mm -- 重量: 5g - -## パッケージ内容 - -- 1x M5Camera -- 1x USB Type-C ケーブル - -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -- **データシート** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - - +# M5Camera ユニット + +
+ +*** + +:memo:**[概要](#概要)**   :bulb:**[クイックスタート](ja/quick_start/m5core/m5stack_core_quick_start)**      :octocat::electric_plug:**[回路図](https://github.com/m5stack/M5-回路図/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-Camera-Module-Development-Board-OV2640-Camera-Type-C-Grove-Port-3D-Wifi-Antenna/3226069_32881414545.html)** + +## 概要 + +**M5Camera**は**ESP32**、**OV2640**、4MBの**pSRAM**、**LiPoチャージャー(IP5306)**などが内蔵されています。リチウムバッテリ、MPU6050（ジャイロ＋加速度センサー）、BME280（温湿度＋気圧センサー）、マイクなどと組み合わせることでバッテリ駆動の監視システムを構築することも可能です。 + +## 特徴 + +- ESP32 スペック + - デュアルコア Tensilica LX6 マイクロプロセッサ + - 最大クロック 240MHz + - 520KB SRAM + - 4MB pSRAM + - 4MB Flash メモリ + - 802.11 b/g/n Wi-Fi + - デュアルモード Bluetooth (classic and BLE) + - ハードウェアアクセラレーションによる暗号化 (AES, SHA2, ECC, RSA-4096) +- CP2104 USB TTL +- OV2640 センサー + - 出力フォーマット(8-bit): + - YUV(422/420)/YCbCr422 + - RGB565/555 + - 8-bit 圧縮データ + - 8/10-bit RAW RGB データ + - 最大画像転送レート + - UXGA/SXGA: 15fps + - SVGA: 30fps + - CIF: 60fps + - スキャンモード: プログレッシブ +- カメラ スペック + - CCD サイズ : 1/4inch + - 視野 : 78 度 + - 最大ピクセル: 200W +- 最大解像度: 1600 * 1200 +- サイズ: 25mm x 24mm +- 重量: 5g + +## パッケージ内容 + +- 1x M5Camera +- 1x USB Type-C ケーブル + +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +- **データシート** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) + + diff --git a/docs/ja/unit/makey.md b/docs/ja/unit/makey.md index 5ec8684c..ff0e81cb 100644 --- a/docs/ja/unit/makey.md +++ b/docs/ja/unit/makey.md @@ -1,50 +1,50 @@ -# MAKEY ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Makey-Unit-MEGA328P-Inside-16Key-Fruit-Paino-with-NEO-Pixel-and-BUZZER-for-ESP32/3226069_32924883456.html?spm=a2g1y.12024536.productList_5885013.subject_23)** - -## 概要 - -**MAKEY**ユニットはATmega328Pを内蔵し、自由に使用可能な16のIOピンを備えています。I2Cでコントロール可能です。I2Cアドレスは**0x51**です。 - -## 特徴 - -- ATmega328P 内蔵 -- 16 Keys Fruit Piano(PD0-7 & PB0-5) -- 1x NeoPixel pin(PC2) -- 1x Buzzer pin(PC3) -- ブザー内蔵 -- Grove インターフェース -- LEGO 互換ホール - -## アプリケーション - -- Makeyアプリケーション -- Adafruitのライブラリを用いたRGB アプリケーション - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### ピンマッピング - - - - -
M5Core(GROVE A)GPIO22GPIO215VGND
MAKEY UnitSCLSDA5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - +# MAKEY ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Makey-Unit-MEGA328P-Inside-16Key-Fruit-Paino-with-NEO-Pixel-and-BUZZER-for-ESP32/3226069_32924883456.html?spm=a2g1y.12024536.productList_5885013.subject_23)** + +## 概要 + +**MAKEY**ユニットはATmega328Pを内蔵し、自由に使用可能な16のIOピンを備えています。I2Cでコントロール可能です。I2Cアドレスは**0x51**です。 + +## 特徴 + +- ATmega328P 内蔵 +- 16 Keys Fruit Piano(PD0-7 & PB0-5) +- 1x NeoPixel pin(PC2) +- 1x Buzzer pin(PC3) +- ブザー内蔵 +- Grove インターフェース +- LEGO 互換ホール + +## アプリケーション + +- Makeyアプリケーション +- Adafruitのライブラリを用いたRGB アプリケーション + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
MAKEY UnitSCLSDA5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + - **[フォーラム](http://forum.m5stack.com/)** \ No newline at end of file diff --git a/docs/ja/unit/ncir.md b/docs/ja/unit/ncir.md index 00223382..25984796 100644 --- a/docs/ja/unit/ncir.md +++ b/docs/ja/unit/ncir.md @@ -1,48 +1,48 @@ -# NCIR ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-NCIR-Unit-MLX90614-Contactless-Temperature-Sensor-Module-70C-382-2C-GROVE-I2C-Development-Board/3226069_32947772098.html?spm=a2g1x.12024536.productList_5885013.pic_4)** - -## 概要 - -**NCIR**ユニットは内蔵されている**MLX90641**により赤外線を測定する事で、体温測定や動きを検出する事が可能です。I2C通信により値の取得が可能です。 - -## 特徴 - -- 高精度 -- 検出範囲: -70℃~382.2℃ -- LEGO 互換ホール - -## アプリケーション - -- 体温測定 -- 動き検出 - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### ピンマッピング - - - - -
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - +# NCIR ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-NCIR-Unit-MLX90614-Contactless-Temperature-Sensor-Module-70C-382-2C-GROVE-I2C-Development-Board/3226069_32947772098.html?spm=a2g1x.12024536.productList_5885013.pic_4)** + +## 概要 + +**NCIR**ユニットは内蔵されている**MLX90641**により赤外線を測定する事で、体温測定や動きを検出する事が可能です。I2C通信により値の取得が可能です。 + +## 特徴 + +- 高精度 +- 検出範囲: -70℃~382.2℃ +- LEGO 互換ホール + +## アプリケーション + +- 体温測定 +- 動き検出 + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + - **データシート** - [MLX90614](https://pdf1.alldatasheet.com/datasheet-pdf/view/218977/ETC2/MLX90614.html) \ No newline at end of file diff --git a/docs/ja/unit/neopixel.md b/docs/ja/unit/neopixel.md index 237c7184..b9eac79a 100644 --- a/docs/ja/unit/neopixel.md +++ b/docs/ja/unit/neopixel.md @@ -1,41 +1,41 @@ -# NeoPixel ユニット - - - -*** - -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**      🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-NeoPixel-RGB-LEDs-Cable-SK6812-with-GROVE-Port-2m-1m-50cm-20cm-10cm/3226069_32950831315.html?spm=a2g1x.12024536.productList_5885013.pic_0)** - -## 概要 - -**NeoPixel**ユニットは帯状にフルカラーLEDが連なったケーブルです。プログラマブルに色や点灯・点滅などをコントロールする事が可能です。Grove インターフェースで接続します。 - -## 特徴 - -- 測定可能距離: 10cm/20cm/0.5m/1m/2m -- Grove インターフェース -- LEGO 互換ホール - -## サンプルコード - -### 1. Arduino IDE - - -### 2. UIFlow - -## 回路図 - - - -### ピンマッピング - - - - -
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
- -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - +# NeoPixel ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**      🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-NeoPixel-RGB-LEDs-Cable-SK6812-with-GROVE-Port-2m-1m-50cm-20cm-10cm/3226069_32950831315.html?spm=a2g1x.12024536.productList_5885013.pic_0)** + +## 概要 + +**NeoPixel**ユニットは帯状にフルカラーLEDが連なったケーブルです。プログラマブルに色や点灯・点滅などをコントロールする事が可能です。Grove インターフェースで接続します。 + +## 特徴 + +- 測定可能距離: 10cm/20cm/0.5m/1m/2m +- Grove インターフェース +- LEGO 互換ホール + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + - **[フォーラム](http://forum.m5stack.com/)** \ No newline at end of file diff --git a/docs/ja/unit/pir.md b/docs/ja/unit/pir.md index 75b3193e..452164f2 100644 --- a/docs/ja/unit/pir.md +++ b/docs/ja/unit/pir.md @@ -1,25 +1,40 @@ -# PIR ユニット - - - -## 概要 - -**PIR**ユニットは人間の動き（モーション）を検出する事が可能です。 - -## 特徴 - -- 測定可能距離 150cm -- LEGO 互換ホール - -## ドキュメント - -- **GitHub** - - [M5GO](https://github.com/m5stack/M5GO) - -
- unit_pir -
- -## 関連情報 - -- [PIR ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-PIR-Pir-GPIO/3226069_32931794651.html) \ No newline at end of file +# PIR ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-PIR-Sensor-Human-Body-Infrared-PIR-Motion-Sensor-Detector-Module-GPIO-GROVE-Connector/3226069_32931794651.html?spm=a2g1y.12024536.productList_5885013.subject_19)** + +## 概要 + +**PIR**ユニットは人間の動き（モーション）を検出する事が可能です。 + +## 特徴 + +- 測定可能距離 150cm +- LEGO 互換ホール + +## サンプルコード + +### 1. Arduino IDE + + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
PIR UnitGPIO36GPIO265VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** \ No newline at end of file diff --git a/docs/ja/unit/proto.md b/docs/ja/unit/proto.md index f79dd6c5..68bdec1a 100644 --- a/docs/ja/unit/proto.md +++ b/docs/ja/unit/proto.md @@ -1,28 +1,18 @@ -# PROTO ユニット - - - -## 概要 - -**PROTO**ユニットは2.54mmピッチのブランクホールが70個用意されています。 - -## 特徴 - -- フレキシブルなブランクホール -- 70 ホール (ピッチ: 2.54mm) -- Grove インターフェース -- LEGO 互換ホール - -## ドキュメント - -- **GitHub** - - [M5GO](https://github.com/m5stack/M5GO) - -
- M5GO_Unit_proto_01 -
- -## 関連情報 - -- [PROTO ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4053/) -- [PROTO ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-2-54-PCB-ESP32/3226069_32920617495.html) \ No newline at end of file +# PROTO ユニット + + + +*** + +:memo:**[概要](#概要)**      🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Proto-Board-Unit-Universal-Double-Side-Prototype-2-54mm-PCB-Grove-Port-Compatible/3226069_32920617495.html?spm=2114.12010615.8148356.4.6735f4943FDruP)** + +## 概要 + +**PROTO**ユニットは2.54mmピッチのブランクホールが70個用意されています。 + +## 特徴 + +- フレキシブルなブランクホール +- 70 ホール (ピッチ: 2.54mm) +- Grove インターフェース +- LEGO 互換ホール diff --git a/docs/ja/unit/relay.md b/docs/ja/unit/relay.md index 7317cb90..6051f609 100644 --- a/docs/ja/unit/relay.md +++ b/docs/ja/unit/relay.md @@ -1,33 +1,50 @@ -# RELAY ユニット - - - -## 概要 - -**RELAY**ユニットは大きな電力負荷を高い信頼性で安全にコントロールする事が可能です。最大 3A @ 24 VDC または 120 VACまでの負荷に対して対応しています。 - -## 特徴 - -- シングル入力 -- 最大 3A @ 24 VDC または 120 VAC -- Grove インターフェース -- LEGO 互換ホール - -## アプリケーション - -- 大きな負荷の制御 -- IoTアウトレット(壁のコンセント) - -## ドキュメント - -- **GitHub** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Relay) - -
- M5GO_Unit_relay -
- -## 関連情報 - -- [RELAY ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4054/) -- [RELAY ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-DC-3A-30-AC-3A-220-ESP32/3226069_32922856211.html) \ No newline at end of file +# RELAY ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Relay-Unit-DC-3A-30V-AC-3A-220V-with-Triode-Driven-GROVE-Port/3226069_32922856211.html?spm=a2g1y.12024536.productList_5885013.subject_24)**   :clapper:**[関連動画](#関連動画)** + +## 概要 + +**RELAY**ユニットは大きな電力負荷を高い信頼性で安全にコントロールする事が可能です。最大 3A @ 24 VDC または 120 VACまでの負荷に対して対応しています。 + +## 特徴 + +- シングル入力 +- 最大 3A @ 24 VDC または 120 VAC +- Grove インターフェース +- LEGO 互換ホール + +## アプリケーション + +- 大きな負荷の制御 +- IoTアウトレット(壁のコンセント) + +## サンプルコード + +### 1. Arduino IDE + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
RELAY Unit RELAY Pin5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +## 関連動画 + + \ No newline at end of file diff --git a/docs/ja/unit/rgb.md b/docs/ja/unit/rgb.md index a7f63da9..c309417f 100644 --- a/docs/ja/unit/rgb.md +++ b/docs/ja/unit/rgb.md @@ -1,22 +1,39 @@ -# RGB ユニット - - - -## 概要 - -**RGB**ユニットは3つのフルカラーLEDを備えており、指定した色を表示させる事が可能です。2つのGroveインターフェースを備えています。 - -## 特徴 - -- 3x フルカラーLED -- LEGO 互換ホール - -## ドキュメント - -
- -
- -## 関連情報 - -- [RGB ユニット購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-RGB-NeoPixel-RGB-Led-x3-GPIO/3226069_32929809133.html) \ No newline at end of file +# RGB ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-RGB-Unit-with-NeoPixel-RGB-LED-Light-x3-GPIO-GROVE-Connector/3226069_32929809133.html?spm=a2g1y.12024536.productList_5885013.subject_21)** + +## 概要 + +**RGB**ユニットは3つのフルカラーLEDを備えており、指定した色を表示させる事が可能です。2つのGroveインターフェースを備えています。 + +## 特徴 + +- 3x フルカラーLED +- LEGO 互換ホール + +## サンプルコード + +### 1. Arduino IDE + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
RGB UnitGPIO36GPIO265VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** \ No newline at end of file diff --git a/docs/ja/unit/thermal.md b/docs/ja/unit/thermal.md index 69f85e7a..d5f2e725 100644 --- a/docs/ja/unit/thermal.md +++ b/docs/ja/unit/thermal.md @@ -1,48 +1,52 @@ -# THERMAL ユニット - - - -## 概要 - -**THERMAL**ユニットはサーモパイルセンサー**MLX90640**を備えたサーモグラフィックカメラユニットです。解像度は32x64ピクセルです。遠くの物体の表面温度を±1.5°Cの精度で計測する事が可能です。I2Cで値を取得できます。 - -## 特徴 - -- 解像度: 32x24 pixels -- 測定可能範囲: -40°C ÷ 300°C -- Grove インターフェース -- LEGO 互換ホール - -## アプリケーション - -- 高精度非接触温度測定器 -- 侵入 / 移動検知 -- サーモグラフィ -- ビルのスマート空調システム - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/MLX90640) - - [Arduino MLX90640 制御](https://github.com/melexis/mlx90640-library) - -- **データシート** - - [MLX90640](https://www.melexis.com/-/media/files/documents/datasheets/mlx90640-datasheet-melexis.pdf) - -
- M5GO_Unit_thermal -
-
- M5GO_Unit_thermal_02 -
-
- M5GO_Unit_thermal_03 -
-
- M5GO_Unit_thermal_04 -
- -## 関連情報 - -- [THERMAL ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/4056/) -- [THERMAL ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-MLX90640-I2C-M5GO-ESP32/3226069_32918177644.html) \ No newline at end of file +# THERMAL ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-New-Thermal-Camera-MLX90640-with-GROVE-I2C-Compatible-M5GO-FIRE-ESP32-Kit-Mini-Development/3226069_32918177644.html?spm=2114.12010615.8148356.2.4ad0717733LM7H)** + +## 概要 + +**THERMAL**ユニットはサーモパイルセンサー**MLX90640**を備えたサーモグラフィックカメラユニットです。解像度は32x64ピクセルです。遠くの物体の表面温度を±1.5°Cの精度で計測する事が可能です。I2Cで値を取得できます。 + +## 特徴 + +- 解像度: 32x24 pixels +- 測定可能範囲: -40°C ÷ 300°C +- Grove インターフェース +- LEGO 互換ホール + +## アプリケーション + +- 高精度非接触温度測定器 +- 侵入 / 移動検知 +- サーモグラフィ +- ビルのスマート空調システム + +## サンプルコード + +### 1. Arduino IDE + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
JOYSTICK UnitSCLSDA5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +- **[Arduino MLX90640 制御](https://github.com/melexis/mlx90640-library)** + +- **データシート** - [MLX90640](https://www.melexis.com/-/media/files/documents/datasheets/mlx90640-datasheet-melexis.pdf) \ No newline at end of file diff --git a/docs/ja/unit/tof.md b/docs/ja/unit/tof.md index 2a504647..be901e9f 100644 --- a/docs/ja/unit/tof.md +++ b/docs/ja/unit/tof.md @@ -1,35 +1,52 @@ -# ToF ユニット - - - -## 概要 - -**ToF**ユニットはレーザー光を使った最新の「Time-to-Flight」センサーを使用して距離を検出できるユニットです。 ほとんどの距離センサーよりも高い精度で計測可能です。I2Cで値を取得可能です。 - -## 特徴 - -- 高精度 -- 測定可能距離 2m -- LEGO 互換ホール - -## アプリケーション - -- 1次元ジェスチャー認識 - -## ドキュメント - -- **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/TOF_VL53L0X) -- **データシート** - - [VL53L0X](https://pdf1.alldatasheet.com/datasheet-pdf/view/948120/STMICROELECTRONICS/VL53L0X.html) - -
- M5GO_Unit_tof -
-
- M5GO_Unit_tof_02 -
- -## 関連情報 - -- [ToF ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ToF-VL53L0X-ToF-I2C/3226069_32949310300.html) \ No newline at end of file +# ToF ユニット + + + +*** + +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-ToF-Unit-VL53L0X-Time-of-Flight-ToF-Laser-Ranging-Sensor-Breakout-Laser-Distance-Sensor/3226069_32949310300.html?spm=a2g1x.12024536.productList_5885013.pic_3)** + +## 概要 + +**ToF**ユニットはレーザー光を使った最新の「Time-to-Flight」センサーを使用して距離を検出できるユニットです。 ほとんどの距離センサーよりも高い精度で計測可能です。I2Cで値を取得可能です。 + +## 特徴 + +- 高精度 +- 測定可能距離 2m +- LEGO 互換ホール + +## アプリケーション + +- 1次元ジェスチャー認識 + +## ドキュメント + +- **サンプルコード** + - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/TOF_VL53L0X) + + +## サンプルコード + +### 1. Arduino IDE + +### 2. UIFlow + +## 回路図 + + + +### ピンマッピング + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
TOF UnitSCLSDA5VGND
+ +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +- **データシート** - [VL53L0X](https://pdf1.alldatasheet.com/datasheet-pdf/view/948120/STMICROELECTRONICS/VL53L0X.html) \ No newline at end of file diff --git a/docs/ja/unit/unit_color.md b/docs/ja/unit/unit_color.md deleted file mode 100644 index 6fb9882f..00000000 --- a/docs/ja/unit/unit_color.md +++ /dev/null @@ -1,39 +0,0 @@ -# COLOR SENSOR ユニット - - - -## 概要 - -**COLOR SENSOR**ユニットは内蔵されたTCS3472により、対象物表面の色を検出する事ができます。M5StackはI2Cで値を取得可能です。 - -## 特徴 - -- 高精度 -- LEGO 互換ホール - -## アプリケーション - -- RGB LED バックライトコントロール -- 色校正 - -## ドキュメント - -- **GitHub** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Color) - -- **データシート** - - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) - -- **回路図** - - [Schematic](https://github.com/m5stack/M5Stack) - -
- M5GO_Unit_color -
-
- M5GO_Unit_color_02 -
- -## 関連情報 - -- [COLOR SENSOR ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-TCS34725-RGB-I2C/3226069_32946957647.html) \ No newline at end of file diff --git a/docs/navbar.md b/docs/navbar.md index a52e6beb..a78da074 100644 --- a/docs/navbar.md +++ b/docs/navbar.md @@ -1,7 +1,7 @@ -- Language - - [:uk: English](/) - - [:cn: 中文](/zh_CN/) - - [:jp: 日本語](/ja/) - - +- Language + - [:uk: English](/) + - [:cn: 中文](/zh_CN/) + - [:jp: 日本語](/ja/) + + \ No newline at end of file diff --git a/docs/sidebar.md b/docs/sidebar.md index 1af02ce7..7bd8d33f 100644 --- a/docs/sidebar.md +++ b/docs/sidebar.md @@ -1,10 +1,10 @@ -- [Product Documents](en/) -- [API Reference](en/api) -- [M5Stack Cases](en/case) -- [Related Documents](en/related_documents) -- [FAQ](en/faq) - - -- **Links** -- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/m5stack) -- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) +- [Product Documents](en/) +- [API Reference](en/api) +- [M5Stack Cases](en/case) +- [Related Documents](en/related_documents) +- [FAQ](en/faq) + + +- **Links** +- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/m5stack) +- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index d4e90782..0a6db77a 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -1,112 +1,112 @@ -# 产品列表 - -*** - - - -**主控M5Core** - -[![basic_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/cores/core_basic.png)](zh_CN/core/basic)[![gray_01.jpg](https://i.loli.net/2018/12/13/5c1214ef29949.jpg)](zh_CN/core/gray)[![product_pic_fire.jpg](https://i.loli.net/2018/12/13/5c121562a65be.jpg)](zh_CN/core/fire) - - - -**MiniCore** - -[![m5stick_01.jpg](https://i.loli.net/2018/12/13/5c12158935965.jpg)](zh_CN/core/m5stick) - - - -**套件** - -[![m5go_01.png](https://i.loli.net/2018/12/13/5c12159c9c2aa.png)](zh_CN/core/m5go_iot_starter_kit)[![face_kit_01.jpg](https://i.loli.net/2018/12/13/5c1215b26d803.jpg)](zh_CN/core/face_kit) - - - -*** - - - -**通讯模块** - -[![gps_01.jpg](https://i.loli.net/2018/12/13/5c12160039059.jpg)](zh_CN/module/gps) [![lora_01.jpg](https://i.loli.net/2018/12/13/5c12161755792.jpg)](zh_CN/module/lora) [![lorawan_01.jpg](https://i.loli.net/2018/12/13/5c1216c437a6c.jpg)](zh_CN/module/lorawan) [![sim800_01.jpg](https://i.loli.net/2018/12/13/5c12165b1bc66.jpg)](zh_CN/module/sim800) - - - -[![module_commu.jpg](https://i.loli.net/2018/12/13/5c121675145ca.jpg)](zh_CN/module/commu)[![module_usb.jpg](https://i.loli.net/2018/12/13/5c1216928954a.jpg)](zh_CN/module/usb) - -**拓展模块** - -[![battery_01.jpg](https://i.loli.net/2018/12/13/5c121754d1485.jpg)](zh_CN/module/battery)[![proto_01.jpg](https://i.loli.net/2018/12/13/5c12175690f25.jpg)](zh_CN/module/proto)[![plus_1.png](https://i.loli.net/2018/12/13/5c121789cd9f9.png)](zh_CN/module/plus) - -**驱动模块** - -[![stepmotor_01.jpg](https://i.loli.net/2018/12/13/5c1217aa25a91.jpg)](zh_CN/module/stepmotor)[![servo_01.jpg](https://i.loli.net/2018/12/13/5c1217abb1cd9.jpg)](zh_CN/module/servo)[![lego+_01.jpg](https://i.loli.net/2018/12/13/5c1217c0e98b7.jpg)](zh_CN/module/lego_plus) - -*** - - - -[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](zh_CN/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](zh_CN/base/node_base) - - - -*** - - - -**通讯类Unit** - -[![unit_gps.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/unit_gps.png)](zh_CN/unit/gps) - -**输入/传感类Unit** - -[![M5GO_Unit_env.png](https://i.loli.net/2018/12/13/5c12229aed8e7.png)](zh_CN/unit/env) [![M5GO_Unit_ir.png](https://i.loli.net/2018/12/13/5c1222c75a47c.png)](zh_CN/unit/ir) [![M5GO_Unit_pir.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/M5GO_Unit_pir.png)](zh_CN/unit/pir) [![M5GO_Unit_angle.png](https://i.loli.net/2018/12/13/5c1219eb78c21.png)](zh_CN/unit/angle) - -[![M5GO_Unit_adc.png](https://i.loli.net/2018/12/13/5c12192a6110d.png)](zh_CN/unit/adc)[![M5GO_Unit_dac.png](https://i.loli.net/2018/12/13/5c1219d495a9a.png)](zh_CN/unit/dac)[![M5GO_Unit_button.png](https://i.loli.net/2018/12/13/5c121a068c209.png)](zh_CN/unit/button)[![M5GO_Unit_dual_button.png](https://i.loli.net/2018/12/13/5c121a1adfedb.png)](zh_CN/unit/dual_button) - -[![M5GO_Unit_joystick_01.png](https://i.loli.net/2018/12/13/5c121a8c96259.png)](zh_CN/unit/joystick)[![M5GO_Unit_earth_01.png](https://i.loli.net/2018/12/13/5c121a6619dd1.png)](zh_CN/unit/earth)[![M5GO_Unit_color.png](https://i.loli.net/2018/12/13/5c121a2debd7c.png)](zh_CN/unit/color)[![m5camera_01.png](https://i.loli.net/2018/12/13/5c1218b4d4a50.png)](zh_CN/unit/m5camera) - -[![M5GO_Unit_light_01.png](https://i.loli.net/2018/12/13/5c121db73426d.png)](zh_CN/unit/light)[![M5GO_Unit_makey.png](https://i.loli.net/2018/12/13/5c121dd514166.png)](zh_CN/unit/makey)[![M5GO_Unit_ncir.png](https://i.loli.net/2018/12/13/5c121df24f746.png)](zh_CN/unit/ncir)[![M5GO_Unit_thermal.png](https://i.loli.net/2018/12/13/5c121e38b72c9.png)](zh_CN/unit/thermal) - -[![M5GO_Unit_tof.png](https://i.loli.net/2018/12/13/5c121e5cd47e1.png)](zh_CN/unit/tof) - - - - - - - -**输出/控制类Unit** - -[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](zh_CN/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](zh_CN/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](zh_CN/unit/neopixel) - - - - - -**接口类Unit** - -[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](zh_CN/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](zh_CN/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](zh_CN/unit/neopixel) - - - -*** - - - -[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](zh_CN/app/bala) [![lidarbot.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](zh_CN/app/lidarbot) - - - - - - +# 产品列表 + +*** + + + +**主控M5Core** + +[![basic_01.jpg](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/cores/core_basic.png)](zh_CN/core/basic)[![gray_01.jpg](https://i.loli.net/2018/12/13/5c1214ef29949.jpg)](zh_CN/core/gray)[![product_pic_fire.jpg](https://i.loli.net/2018/12/13/5c121562a65be.jpg)](zh_CN/core/fire) + + + +**MiniCore** + +[![m5stick_01.jpg](https://i.loli.net/2018/12/13/5c12158935965.jpg)](zh_CN/core/m5stick) + + + +**套件** + +[![m5go_01.png](https://i.loli.net/2018/12/13/5c12159c9c2aa.png)](zh_CN/core/m5go_iot_starter_kit)[![face_kit_01.jpg](https://i.loli.net/2018/12/13/5c1215b26d803.jpg)](zh_CN/core/face_kit) + + + +*** + + + +**通讯模块** + +[![gps_01.jpg](https://i.loli.net/2018/12/13/5c12160039059.jpg)](zh_CN/module/gps) [![lora_01.jpg](https://i.loli.net/2018/12/13/5c12161755792.jpg)](zh_CN/module/lora) [![lorawan_01.jpg](https://i.loli.net/2018/12/13/5c1216c437a6c.jpg)](zh_CN/module/lorawan) [![sim800_01.jpg](https://i.loli.net/2018/12/13/5c12165b1bc66.jpg)](zh_CN/module/sim800) + + + +[![module_commu.jpg](https://i.loli.net/2018/12/13/5c121675145ca.jpg)](zh_CN/module/commu)[![module_usb.jpg](https://i.loli.net/2018/12/13/5c1216928954a.jpg)](zh_CN/module/usb) + +**拓展模块** + +[![battery_01.jpg](https://i.loli.net/2018/12/13/5c121754d1485.jpg)](zh_CN/module/battery)[![proto_01.jpg](https://i.loli.net/2018/12/13/5c12175690f25.jpg)](zh_CN/module/proto)[![plus_1.png](https://i.loli.net/2018/12/13/5c121789cd9f9.png)](zh_CN/module/plus) + +**驱动模块** + +[![stepmotor_01.jpg](https://i.loli.net/2018/12/13/5c1217aa25a91.jpg)](zh_CN/module/stepmotor)[![servo_01.jpg](https://i.loli.net/2018/12/13/5c1217abb1cd9.jpg)](zh_CN/module/servo)[![lego+_01.jpg](https://i.loli.net/2018/12/13/5c1217c0e98b7.jpg)](zh_CN/module/lego_plus) + +*** + + + +[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](zh_CN/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](zh_CN/base/node_base) + + + +*** + + + +**通讯类Unit** + +[![unit_gps.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/unit_gps.png)](zh_CN/unit/gps) + +**输入/传感类Unit** + +[![M5GO_Unit_env.png](https://i.loli.net/2018/12/13/5c12229aed8e7.png)](zh_CN/unit/env) [![M5GO_Unit_ir.png](https://i.loli.net/2018/12/13/5c1222c75a47c.png)](zh_CN/unit/ir) [![M5GO_Unit_pir.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/docs/assets/img/product_pics/pictures_for_homepage/units/M5GO_Unit_pir.png)](zh_CN/unit/pir) [![M5GO_Unit_angle.png](https://i.loli.net/2018/12/13/5c1219eb78c21.png)](zh_CN/unit/angle) + +[![M5GO_Unit_adc.png](https://i.loli.net/2018/12/13/5c12192a6110d.png)](zh_CN/unit/adc)[![M5GO_Unit_dac.png](https://i.loli.net/2018/12/13/5c1219d495a9a.png)](zh_CN/unit/dac)[![M5GO_Unit_button.png](https://i.loli.net/2018/12/13/5c121a068c209.png)](zh_CN/unit/button)[![M5GO_Unit_dual_button.png](https://i.loli.net/2018/12/13/5c121a1adfedb.png)](zh_CN/unit/dual_button) + +[![M5GO_Unit_joystick_01.png](https://i.loli.net/2018/12/13/5c121a8c96259.png)](zh_CN/unit/joystick)[![M5GO_Unit_earth_01.png](https://i.loli.net/2018/12/13/5c121a6619dd1.png)](zh_CN/unit/earth)[![M5GO_Unit_color.png](https://i.loli.net/2018/12/13/5c121a2debd7c.png)](zh_CN/unit/color)[![m5camera_01.png](https://i.loli.net/2018/12/13/5c1218b4d4a50.png)](zh_CN/unit/m5camera) + +[![M5GO_Unit_light_01.png](https://i.loli.net/2018/12/13/5c121db73426d.png)](zh_CN/unit/light)[![M5GO_Unit_makey.png](https://i.loli.net/2018/12/13/5c121dd514166.png)](zh_CN/unit/makey)[![M5GO_Unit_ncir.png](https://i.loli.net/2018/12/13/5c121df24f746.png)](zh_CN/unit/ncir)[![M5GO_Unit_thermal.png](https://i.loli.net/2018/12/13/5c121e38b72c9.png)](zh_CN/unit/thermal) + +[![M5GO_Unit_tof.png](https://i.loli.net/2018/12/13/5c121e5cd47e1.png)](zh_CN/unit/tof) + + + + + + + +**输出/控制类Unit** + +[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](zh_CN/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](zh_CN/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](zh_CN/unit/neopixel) + + + + + +**接口类Unit** + +[![M5GO_Unit_rgb.png](https://i.loli.net/2018/12/13/5c121f5c98542.png)](zh_CN/unit/rgb)[![M5GO_Unit_relay.png](https://i.loli.net/2018/12/13/5c121f6e9a185.png)](zh_CN/unit/relay)[![M5GO_Unit_neopixel.png](https://i.loli.net/2018/12/13/5c121f8457fcb.png)](zh_CN/unit/neopixel) + + + +*** + + + +[![bala_1.png](https://i.loli.net/2018/12/13/5c1224ba208bc.png)](zh_CN/app/bala) [![lidarbot.png](https://i.loli.net/2018/12/13/5c1224dbe9609.png)](zh_CN/app/lidarbot) + + + + + + diff --git a/docs/zh_CN/README_zh_CN.md b/docs/zh_CN/README_zh_CN.md index 140beb7d..b3b1814f 100644 --- a/docs/zh_CN/README_zh_CN.md +++ b/docs/zh_CN/README_zh_CN.md @@ -1,54 +1,54 @@ -# M5Stack - -**Welcome to M5Stack Documents!** - -[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) -[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fdocsify-themeable&hashtags=css,docsify,developers,frontend) -Star - -?> **提示** 点击下划线的蓝色字体可以跳转到对应链接。 - - - -## 介绍(Introduction) - -**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** - -**M5Stack的理念就是为了摆脱新发明开发过程复杂的痛苦，希望让用户的创意更容易实现。M5Stack主控内置wifi、蓝牙、多种传感器和一个小屏幕，还有电源模块和其他拓展传感器模块，每个产品都是单独模块，从而避免了结合面包板在设计产品原型时需要很多杂乱导线相连的情况，所以在设计一个新功能的时候，仅仅需要在各种我们提供的拓展模块之上堆叠一个M5Stack主控或者用M5Stack主控通过GROVE导线外接相应unit传感器就能实现一个完整的产品。** - -我们的全系列产品基本是以ESP芯片为主芯片。 - -我们希望"**堆叠即是产品**"。 这是我们的[官网](www.m5stack.com)。 - - - - - - -## 联系方式(Contact & Support) - -- :computer: 访问[官网](www.m5stack.com)了解最新的产品 -- :busts_in_silhouette: 登录我们的[论坛](http://forum.m5stack.com)了解更多基于M5产品的创意设计 -- :mailbox_with_mail: 如果你有对产品有任何疑问或有更好的建议，请联系我们的[邮箱](tech@m5stack.com) -- :convenience_store: 如果你想继续购买我们的产品，请访问我们的[官方旗舰店](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) - -## License - -This project is licensed under the [MIT license](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE). - -Copyright (c) 2018 M5Stack ([@M5Stack](https://twitter.com/M5Stack)) - - - +# M5Stack + +**Welcome to M5Stack Documents!** + +[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) +[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fdocsify-themeable&hashtags=css,docsify,developers,frontend) +Star + +?> **提示** 点击下划线的蓝色字体可以跳转到对应链接。 + + + +## 介绍(Introduction) + +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** + +**M5Stack的理念就是为了摆脱新发明开发过程复杂的痛苦，希望让用户的创意更容易实现。M5Stack主控内置wifi、蓝牙、多种传感器和一个小屏幕，还有电源模块和其他拓展传感器模块，每个产品都是单独模块，从而避免了结合面包板在设计产品原型时需要很多杂乱导线相连的情况，所以在设计一个新功能的时候，仅仅需要在各种我们提供的拓展模块之上堆叠一个M5Stack主控或者用M5Stack主控通过GROVE导线外接相应unit传感器就能实现一个完整的产品。** + +我们的全系列产品基本是以ESP芯片为主芯片。 + +我们希望"**堆叠即是产品**"。 这是我们的[官网](www.m5stack.com)。 + + + + + + +## 联系方式(Contact & Support) + +- :computer: 访问[官网](www.m5stack.com)了解最新的产品 +- :busts_in_silhouette: 登录我们的[论坛](http://forum.m5stack.com)了解更多基于M5产品的创意设计 +- :mailbox_with_mail: 如果你有对产品有任何疑问或有更好的建议，请联系我们的[邮箱](tech@m5stack.com) +- :convenience_store: 如果你想继续购买我们的产品，请访问我们的[官方旗舰店](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) + +## License + +This project is licensed under the [MIT license](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE). + +Copyright (c) 2018 M5Stack ([@M5Stack](https://twitter.com/M5Stack)) + + + diff --git a/docs/zh_CN/accessory/cables/lego_cable.md b/docs/zh_CN/accessory/cables/lego_cable.md index 11cf74d4..9e3ea3d9 100644 --- a/docs/zh_CN/accessory/cables/lego_cable.md +++ b/docs/zh_CN/accessory/cables/lego_cable.md @@ -1,20 +1,20 @@ -# LEGO Cable - -中文 | [English](en/product_documents/accessories/cables/lego_cable) | [日本語](ja/product_documents/accessories/cables/lego_cable) - -## 描述 - -LEGO Cable专门设计用来连接GROVE接口和乐高机器人组件，特别是用来连接M5Core与乐高机器人组件。 - -## 特性 - -- 3种规格: 10cm, 20cm, 30cm - -## 相关链接 - - -- **[购买链接](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** - -
- lego_cable_01 +# LEGO Cable + +中文 | [English](en/product_documents/accessories/cables/lego_cable) | [日本語](ja/product_documents/accessories/cables/lego_cable) + +## 描述 + +LEGO Cable专门设计用来连接GROVE接口和乐高机器人组件，特别是用来连接M5Core与乐高机器人组件。 + +## 特性 + +- 3种规格: 10cm, 20cm, 30cm + +## 相关链接 + + +- **[购买链接](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** + +
+ lego_cable_01
\ No newline at end of file diff --git a/docs/zh_CN/accessory/frame.md b/docs/zh_CN/accessory/frame.md index 177a6485..0ee4b7e3 100644 --- a/docs/zh_CN/accessory/frame.md +++ b/docs/zh_CN/accessory/frame.md @@ -1,24 +1,24 @@ -# Frame - 5x5的M5外框 - -中文 | [English](en/product_documents/accessories/frame) | [日本語](ja/product_documents/accessories/frame) - -## 描述 - -Frame专门设计用来做M5Core的固定框架。 - -## 相关链接 - -- [购买链接](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) - -
- frame_01 -
-
- frame_02 -
-
- frame_03 -
-
- frame_04 +# Frame - 5x5的M5外框 + +中文 | [English](en/product_documents/accessories/frame) | [日本語](ja/product_documents/accessories/frame) + +## 描述 + +Frame专门设计用来做M5Core的固定框架。 + +## 相关链接 + +- [购买链接](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) + +
+ frame_01 +
+
+ frame_02 +
+
+ frame_03 +
+
+ frame_04
\ No newline at end of file diff --git a/docs/zh_CN/accessory/headers_socket.md b/docs/zh_CN/accessory/headers_socket.md index aec4acf4..554a1185 100644 --- a/docs/zh_CN/accessory/headers_socket.md +++ b/docs/zh_CN/accessory/headers_socket.md @@ -1,4 +1,4 @@ -# Headers Socket - -## (敬请期待...) - +# Headers Socket + +## (敬请期待...) + diff --git a/docs/zh_CN/api.md b/docs/zh_CN/api.md index 98b5694d..1cd86b42 100644 --- a/docs/zh_CN/api.md +++ b/docs/zh_CN/api.md @@ -1,13 +1,13 @@ -# API Reference - -| MicroPython | Arduino | -|:------------|:--------| -|[LCD](zh_CN/api_reference/micropython/api_lcd) | [LCD](zh_CN/api_reference/arduino/api_lcd) | - - - - - +# API Reference + +| MicroPython | Arduino | +|:------------|:--------| +|[LCD](zh_CN/api_reference/micropython/api_lcd) | [LCD](zh_CN/api_reference/arduino/api_lcd) | + + + + + diff --git a/docs/zh_CN/api/gpio.md b/docs/zh_CN/api/gpio.md index 58d1966d..0031c1a6 100644 --- a/docs/zh_CN/api/gpio.md +++ b/docs/zh_CN/api/gpio.md @@ -1,23 +1,23 @@ -# GPIO - -中文 | [English](/en/api_reference/micropython/peripherals/api_gpio) | [日本語](/ja/api_reference/micropython/peripherals/api_gpio) - -*使用Arduino库的GPIO API* - -### digitalRead -> uint32 digitalRead(uint8 pin); - -读取数字引脚电平值 - -| Param | Type | Description | -| --- | --- | --- | -| pin | uint8 | 引脚编号 | - -Return: - 电平值(0/1) - -**例程** -```c++ -uint32_t pin21_data; -pin21_data = digitalRead(21); +# GPIO + +中文 | [English](/en/api_reference/micropython/peripherals/api_gpio) | [日本語](/ja/api_reference/micropython/peripherals/api_gpio) + +*使用Arduino库的GPIO API* + +### digitalRead +> uint32 digitalRead(uint8 pin); + +读取数字引脚电平值 + +| Param | Type | Description | +| --- | --- | --- | +| pin | uint8 | 引脚编号 | + +Return: + 电平值(0/1) + +**例程** +```c++ +uint32_t pin21_data; +pin21_data = digitalRead(21); ``` \ No newline at end of file diff --git a/docs/zh_CN/api/lcd.md b/docs/zh_CN/api/lcd.md index e0fc0a08..e7c6f7a7 100644 --- a/docs/zh_CN/api/lcd.md +++ b/docs/zh_CN/api/lcd.md @@ -1,209 +1,209 @@ -# LCD - -中文 | [English](/en/api_reference/micropython/api_lcd) | [日本語](/ja/api_reference/micropython/api_lcd) - -*屏幕像素为320x240，以屏幕左上角为原点(0,0)* - -### lcd.setRotation(degree) - -**例程** -```python -lcd.setRotation(90) -``` - -**设置整个屏幕显示的旋转角度。** - -| 参数 | 描述 | -| --- | --- | -| degree | 旋转的角度 | - - - -* * * - - -### lcd.setColor(color [, background_color]) -**例程** -```python -lcd.setColor(lcd.RED) -lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) -``` - -**设置显示文本的前景颜色和背景颜色。** - -| 参数 | 描述 | -| --- | --- | -| color | 文本的前景颜色 | -| background_color| 文本的背景颜色 | - -* * * - -### lcd.fillScreen(color) -**例程** -```python -lcd.fillScreen(lcd.RED) -``` -**以指定的颜色填充整个屏幕。** - -| 参数 | 描述 | -| --- | --- | -| color | 颜色值 | - - - -* * * - -### lcd.drawPixel(x, y [,color]) -**例程** -```python -lcd.drawPixel(22,22,lcd.RED) -``` -**在位置(x,y)处画点。** - -*如果函数的color值没给出，则使用当前的背景颜色。* - -| 参数 | 描述 | -| --- | --- | -| color | 颜色值 | - - - -* * * - -### lcd.drawLine(x, y, x1, y1 [,color]) -**例程** -```python -lcd.drawLine(0,0,12,12,lcd.WHITE) -``` -**以指定的颜色从点(x,y)到点(x1,y1)画直线。** - -*如果函数的color值没给出，则使用当前的背景颜色。* - -| 参数 | 描述 | -| --- | --- | -| color | 颜色值 | - - -* * * - -### lcd.drawTriangle(x, y, x1, y1, x2, y2 [,color]) - -**例程** -```python -lcd.drawTriangle(22,22,69,98,51,22,lcd.RED) -``` - -**以指定颜色画三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。** - -*如果函数的color值没给出，则使用当前的背景颜色。* - -| 参数 | 描述 | -| --- | --- | -| color | 颜色值 | - -* * * - -### lcd.fillTriangle(x, y, x1, y1, x2, y2 [,color]) - -**例程** -```python -lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) -``` -**以指定颜色画填充形式的三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。** - -*如果函数的color值没给出，则使用当前的背景颜色。* - -| 参数 | 描述 | -| --- | --- | -| color | 颜色值 | - - -* * * -### lcd.drawRect(x, y, w, h, [,color]) -**例程** -```python -lcd.drawRect(180, 12, 122, 10, lcd.BLUE) -``` -**以指定颜色画矩形，其中矩形左上角坐标为(x,y)，宽高分别为width和height。** - -*如果函数的color值没给出，则使用当前的背景颜色。* - -| 参数 | 描述 | -| --- | --- | -| w | 图形宽(单位: 像素) | -| h | 图形高(单位: 像素) | -| color | 颜色值 | - - - - -* * * - -### lcd.drawRoundRect(x, y, w, h, r [,color]) -**例程** -```python -lcd.fillRoundRect(180,70,122,10,4,lcd.BLUE) -``` -**以指定颜色画圆角矩形，其中矩形左上角坐标为(x,y)，宽高分别为width和height，圆角半径为r。** - -*如果函数的color值没给出，则使用当前的背景颜色。* - -| 参数 | 描述 | -| --- | --- | -| w | 图形宽(单位: 像素) | -| h | 图形高(单位: 像素) | -| r | 圆角半径 | -| color | 颜色值 | - - - - -* * * -### lcd.print(‘text’, [x, y]) -**例程** -```python -lcd.print('this is a print text function', 80, 80) -``` -**在(x,y)处开始打印文本(字符串)text。** - -| 参数 | 描述 | -| --- | --- | -| text | 要打印的内容 | - - -* * * - -### lcd.clear([color]) - -**例程** -```python -lcd.clear() -``` - -**清屏(即以当前的背景颜色填充整个屏幕)。** - - -* * * - -### Usage - -```python -from machine import SPI, Pin -from display import LCD - -spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) - -lcd = LCD(spi = spi) #lcd init -lcd.fillScreen(lcd.BLACK) #set the default background color - -lcd.drawLine(0, 0, lcd.WHITE) -lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) -lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) -lcd.drawCircle(180, 180, 10, lcd.BLUE) -lcd.fillcircle(100, 100, 10, lcd.BLUE) -lcd.drawRect(180, 12, 122, 10, lcd.BLUE) -lcd.fillRect(180, 30, 122, 10, lcd.BLUE) -lcd.drawRoundRect(180, 50, 122, 10, 4, lcd.BLUE) -lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) -lcd.print('this is a print text function', 80, 80) -``` +# LCD + +中文 | [English](/en/api_reference/micropython/api_lcd) | [日本語](/ja/api_reference/micropython/api_lcd) + +*屏幕像素为320x240，以屏幕左上角为原点(0,0)* + +### lcd.setRotation(degree) + +**例程** +```python +lcd.setRotation(90) +``` + +**设置整个屏幕显示的旋转角度。** + +| 参数 | 描述 | +| --- | --- | +| degree | 旋转的角度 | + + + +* * * + + +### lcd.setColor(color [, background_color]) +**例程** +```python +lcd.setColor(lcd.RED) +lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) +``` + +**设置显示文本的前景颜色和背景颜色。** + +| 参数 | 描述 | +| --- | --- | +| color | 文本的前景颜色 | +| background_color| 文本的背景颜色 | + +* * * + +### lcd.fillScreen(color) +**例程** +```python +lcd.fillScreen(lcd.RED) +``` +**以指定的颜色填充整个屏幕。** + +| 参数 | 描述 | +| --- | --- | +| color | 颜色值 | + + + +* * * + +### lcd.drawPixel(x, y [,color]) +**例程** +```python +lcd.drawPixel(22,22,lcd.RED) +``` +**在位置(x,y)处画点。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +| 参数 | 描述 | +| --- | --- | +| color | 颜色值 | + + + +* * * + +### lcd.drawLine(x, y, x1, y1 [,color]) +**例程** +```python +lcd.drawLine(0,0,12,12,lcd.WHITE) +``` +**以指定的颜色从点(x,y)到点(x1,y1)画直线。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +| 参数 | 描述 | +| --- | --- | +| color | 颜色值 | + + +* * * + +### lcd.drawTriangle(x, y, x1, y1, x2, y2 [,color]) + +**例程** +```python +lcd.drawTriangle(22,22,69,98,51,22,lcd.RED) +``` + +**以指定颜色画三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +| 参数 | 描述 | +| --- | --- | +| color | 颜色值 | + +* * * + +### lcd.fillTriangle(x, y, x1, y1, x2, y2 [,color]) + +**例程** +```python +lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) +``` +**以指定颜色画填充形式的三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +| 参数 | 描述 | +| --- | --- | +| color | 颜色值 | + + +* * * +### lcd.drawRect(x, y, w, h, [,color]) +**例程** +```python +lcd.drawRect(180, 12, 122, 10, lcd.BLUE) +``` +**以指定颜色画矩形，其中矩形左上角坐标为(x,y)，宽高分别为width和height。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +| 参数 | 描述 | +| --- | --- | +| w | 图形宽(单位: 像素) | +| h | 图形高(单位: 像素) | +| color | 颜色值 | + + + + +* * * + +### lcd.drawRoundRect(x, y, w, h, r [,color]) +**例程** +```python +lcd.fillRoundRect(180,70,122,10,4,lcd.BLUE) +``` +**以指定颜色画圆角矩形，其中矩形左上角坐标为(x,y)，宽高分别为width和height，圆角半径为r。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +| 参数 | 描述 | +| --- | --- | +| w | 图形宽(单位: 像素) | +| h | 图形高(单位: 像素) | +| r | 圆角半径 | +| color | 颜色值 | + + + + +* * * +### lcd.print(‘text’, [x, y]) +**例程** +```python +lcd.print('this is a print text function', 80, 80) +``` +**在(x,y)处开始打印文本(字符串)text。** + +| 参数 | 描述 | +| --- | --- | +| text | 要打印的内容 | + + +* * * + +### lcd.clear([color]) + +**例程** +```python +lcd.clear() +``` + +**清屏(即以当前的背景颜色填充整个屏幕)。** + + +* * * + +### Usage + +```python +from machine import SPI, Pin +from display import LCD + +spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) + +lcd = LCD(spi = spi) #lcd init +lcd.fillScreen(lcd.BLACK) #set the default background color + +lcd.drawLine(0, 0, lcd.WHITE) +lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) +lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) +lcd.drawCircle(180, 180, 10, lcd.BLUE) +lcd.fillcircle(100, 100, 10, lcd.BLUE) +lcd.drawRect(180, 12, 122, 10, lcd.BLUE) +lcd.fillRect(180, 30, 122, 10, lcd.BLUE) +lcd.drawRoundRect(180, 50, 122, 10, 4, lcd.BLUE) +lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) +lcd.print('this is a print text function', 80, 80) +``` diff --git a/docs/zh_CN/api/speaker.md b/docs/zh_CN/api/speaker.md index 9eece7cb..bc8b2de0 100644 --- a/docs/zh_CN/api/speaker.md +++ b/docs/zh_CN/api/speaker.md @@ -1,17 +1,17 @@ -# Speaker - -中文 | [English](/en/api_reference/micropython/api_speaker) | [日本語](/ja/api_reference/micropython/api_speaker) - -### tone -> M5.Speaker.tone(uint32_t freq); - -设置声音音高 - -| Param | Type | Description | -| --- | --- | --- | -| freq | uint32_t | 频率 | - -**例程** -```c++ -M5.Speaker.tone(100); +# Speaker + +中文 | [English](/en/api_reference/micropython/api_speaker) | [日本語](/ja/api_reference/micropython/api_speaker) + +### tone +> M5.Speaker.tone(uint32_t freq); + +设置声音音高 + +| Param | Type | Description | +| --- | --- | --- | +| freq | uint32_t | 频率 | + +**例程** +```c++ +M5.Speaker.tone(100); ``` \ No newline at end of file diff --git a/docs/zh_CN/app/bala.md b/docs/zh_CN/app/bala.md index 3adb9cae..c56105ad 100644 --- a/docs/zh_CN/app/bala.md +++ b/docs/zh_CN/app/bala.md @@ -1,26 +1,26 @@ -# BALA - 平衡车 - - - -* * * - -:memo:**[描述](#描述)**   :bulb:**[上手指南](/zh_CN/quick_start/bala/bala_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Bala/tree/master/examples)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.3b6d425eZah7wG&id=574761698176)** - -## 描述 - -BALA是堆叠了M5Fire，以[M5Fire](http://docs.m5stack.com/#/zh_CN/core/fire)做主控的平衡车应用，还包括了MEGA328为主控的2路直流电机驱动模块和两个轮子。你可以Arduino或MicroPython编程它。 - -2路直流电机模块与M5Fire之间通过IIC通信，它的IIC地址是**0x56**。 - -## 特性 - -- 支持Arduino编程和Python编程 -- 兼容LEGO -- M5Fire支持插入TF卡 - -## 包括 - -- 1x M5Stack BALA -- 1x 电机驱动 -- 2x 带编码器的N20电机 -- Type-C USB线 +# BALA - 平衡车 + + + +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](/zh_CN/quick_start/bala/bala_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Bala/tree/master/examples)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.3b6d425eZah7wG&id=574761698176)** + +## 描述 + +BALA是堆叠了M5Fire，以[M5Fire](http://docs.m5stack.com/#/zh_CN/core/fire)做主控的平衡车应用，还包括了MEGA328为主控的2路直流电机驱动模块和两个轮子。你可以Arduino或MicroPython编程它。 + +2路直流电机模块与M5Fire之间通过IIC通信，它的IIC地址是**0x56**。 + +## 特性 + +- 支持Arduino编程和Python编程 +- 兼容LEGO +- M5Fire支持插入TF卡 + +## 包括 + +- 1x M5Stack BALA +- 1x 电机驱动 +- 2x 带编码器的N20电机 +- Type-C USB线 diff --git a/docs/zh_CN/app/lidarbot.md b/docs/zh_CN/app/lidarbot.md index f5a8f3ee..d7a78999 100644 --- a/docs/zh_CN/app/lidarbot.md +++ b/docs/zh_CN/app/lidarbot.md @@ -1,58 +1,58 @@ -# LidarBot - - - -* * * - -:memo:**[描述](#描述)**   :octocat:**[例程](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.17fd425e0xq2aq&id=580401820385)** - -## 描述 - -LidarBot是一款以室内导航为基础的四轮小车。车体装载了激光雷达、四个麦克纳姆轮、车轮控制低板(主控芯片是MEGA328)、前后RGB灯带(共16颗)、M5Core主控、多个LEGO孔。车与远程遥控手柄之间通过ESP-NOW实时通信，而小车主控接收到控制信号后，通过规定的协议格式实现控制车轮和RGB灯带等。除了能控制小车灵活地前后左右移动之外，还能在小车主控和手柄主控各自的显示屏上显示室内地形。 - -## 特性 - -- 雷达: 8m @ 6Hz -- 支持Arduino编程 -- 兼容LEGO件 - -## 控制底板的协议 - -*协议格式：帧头(命令类型)+数据帧+帧尾* - -| 协议对象 | 协议格式 | -| :-------------: |:------------------------------------: | -| 控制车轮 | 0xAA,SpeedX,SpeedY,SpeedZ,SpeedA,0x55 | -| 控制单颗RGB | 0xAB,LedIndex,R,G,B,0x55 | -| 控制前向RGB灯带 | 0xAC,R,G,B,0x55 | -| 控制后向RGB灯带 | 0xAD,R,G,B,0x55 | -| 控制全部RGB | 0xAE,R,G,B,0x55 | -| 控制舵机0 | 0xAF,Angle,0x55 | -| 控制舵机1 | 0xB0,Angle,0x55 | - -## 参数 - -- 通信参数 - - 车体的M5Core主控与激光雷达传感器（RXD <-> GPIO16） - 串口参数：230400bps，8位数据位，无奇偶校验，1位停止位 - - 车体的M5Core主控与车轮控制底板（TXD <-> GPIO17） - 串口参数：115200bps，8位数据位，无奇偶校验，1位停止位 -- 接口 - - 舵机0 <-> A0(MEGA328) - - 舵机1 <-> A1(MEGA328) - - NeoPixelRGB <-> 11(MEGA328) - -## 包含 - -- 1x LidarBot -- 1x 远程遥控手柄 -- 2x 电池(1300mAh @ 11.1V) -- 1x 电池充电器 -- 1x Type-C USB线 - -## 应用 - -- 室内导航 -- 自主走迷宫 -- 路径规划 -- 自动驾驶 +# LidarBot + + + +* * * + +:memo:**[描述](#描述)**   :octocat:**[例程](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.17fd425e0xq2aq&id=580401820385)** + +## 描述 + +LidarBot是一款以室内导航为基础的四轮小车。车体装载了激光雷达、四个麦克纳姆轮、车轮控制低板(主控芯片是MEGA328)、前后RGB灯带(共16颗)、M5Core主控、多个LEGO孔。车与远程遥控手柄之间通过ESP-NOW实时通信，而小车主控接收到控制信号后，通过规定的协议格式实现控制车轮和RGB灯带等。除了能控制小车灵活地前后左右移动之外，还能在小车主控和手柄主控各自的显示屏上显示室内地形。 + +## 特性 + +- 雷达: 8m @ 6Hz +- 支持Arduino编程 +- 兼容LEGO件 + +## 控制底板的协议 + +*协议格式：帧头(命令类型)+数据帧+帧尾* + +| 协议对象 | 协议格式 | +| :-------------: |:------------------------------------: | +| 控制车轮 | 0xAA,SpeedX,SpeedY,SpeedZ,SpeedA,0x55 | +| 控制单颗RGB | 0xAB,LedIndex,R,G,B,0x55 | +| 控制前向RGB灯带 | 0xAC,R,G,B,0x55 | +| 控制后向RGB灯带 | 0xAD,R,G,B,0x55 | +| 控制全部RGB | 0xAE,R,G,B,0x55 | +| 控制舵机0 | 0xAF,Angle,0x55 | +| 控制舵机1 | 0xB0,Angle,0x55 | + +## 参数 + +- 通信参数 + - 车体的M5Core主控与激光雷达传感器（RXD <-> GPIO16） + 串口参数：230400bps，8位数据位，无奇偶校验，1位停止位 + - 车体的M5Core主控与车轮控制底板（TXD <-> GPIO17） + 串口参数：115200bps，8位数据位，无奇偶校验，1位停止位 +- 接口 + - 舵机0 <-> A0(MEGA328) + - 舵机1 <-> A1(MEGA328) + - NeoPixelRGB <-> 11(MEGA328) + +## 包含 + +- 1x LidarBot +- 1x 远程遥控手柄 +- 2x 电池(1300mAh @ 11.1V) +- 1x 电池充电器 +- 1x Type-C USB线 + +## 应用 + +- 室内导航 +- 自主走迷宫 +- 路径规划 +- 自动驾驶 diff --git a/docs/zh_CN/base/face_base.md b/docs/zh_CN/base/face_base.md index 6ef7a9f3..ecc9155c 100644 --- a/docs/zh_CN/base/face_base.md +++ b/docs/zh_CN/base/face_base.md @@ -1,30 +1,30 @@ -# FACE Base - -## 描述 - -FACE Base是[FACES Kit](zh_CN/core/face_kit)套件中的底座，主要由M5Core底座和电池模块组成，如下图。 - -
- -
- -FACE Base其背面拓展了`M-Bus总线`的部分GPIO接口(*见最后一张图片*)，方便做拓展功能，其下部分内嵌600mAh的电池，方便使用FACES套件时，能离线操作。 - -## 使用 - -**使用时堆叠M5Core主控和功能面板(*如: QWERTY, GameBoy, Calculator*)，如下图所示** - -
- -
- -## 相关链接 - -- **[FACES Kit购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.2545425erZg3jl&id=562810115476)** - - -## M-Bus总线 - -
- basic_05 -
+# FACE Base + +## 描述 + +FACE Base是[FACES Kit](zh_CN/core/face_kit)套件中的底座，主要由M5Core底座和电池模块组成，如下图。 + +
+ +
+ +FACE Base其背面拓展了`M-Bus总线`的部分GPIO接口(*见最后一张图片*)，方便做拓展功能，其下部分内嵌600mAh的电池，方便使用FACES套件时，能离线操作。 + +## 使用 + +**使用时堆叠M5Core主控和功能面板(*如: QWERTY, GameBoy, Calculator*)，如下图所示** + +
+ +
+ +## 相关链接 + +- **[FACES Kit购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.2545425erZg3jl&id=562810115476)** + + +## M-Bus总线 + +
+ basic_05 +
diff --git a/docs/zh_CN/base/lan_base.md b/docs/zh_CN/base/lan_base.md index 4d936b1a..833d0bb0 100644 --- a/docs/zh_CN/base/lan_base.md +++ b/docs/zh_CN/base/lan_base.md @@ -1,49 +1,49 @@ -# LAN底座 - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Base/LAN/Arduino)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.6c24425eKdAPr3&id=574863427657)** - -## 描述 - -LAN底座是集成了以太网芯片W5500的底座，目的是提供给有让M5Core接入有线网络需求的用户。因为M5Core集成了无线WIFI，能接收无线热点的网络，可是没有网络接口，如果你需要让M5Core接入有线网络来工作的话，这个LAN底座正好合适，而且LAN底座还配备了磁铁和滑动杆，方便你装置LAN和M5Core到壁面上。 - -另外LAN底座还有橙色HT3.96端子，这个接口还没有电气连接，它连接不同Pin脚的时候，可以实现对应的Pin拓展。如果你需要这个接口变成RS485的拓展接口的话，那么使用配套的排针和TLL转RS485功能小板子焊接到LAN底座上面，即可实现RS485接口，从而可以通过这个HT3.96端子，通过RS485协议控制M5Core的整个功能。 - -如果TLL转RS485的功能小板子与LAN底板结合的话，小板子上的串口引脚将与LAN底板的GPIO1、GPIO3(UART0)连接。 - -## 管脚映射 - -**W5500以太网芯片** - -| W5500 | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO26 | -| RST | GPIO13 | -| INTn | GPIO34 | - - - -**M-Bus** - - - -## 特性 - -- 允许9-24V范围的电源输入 -- 3.96规格端子，可以自定义引脚 -- 易于固件到墙上，方便装配 - - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 原理图 +# LAN底座 + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Base/LAN/Arduino)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.6c24425eKdAPr3&id=574863427657)** + +## 描述 + +LAN底座是集成了以太网芯片W5500的底座，目的是提供给有让M5Core接入有线网络需求的用户。因为M5Core集成了无线WIFI，能接收无线热点的网络，可是没有网络接口，如果你需要让M5Core接入有线网络来工作的话，这个LAN底座正好合适，而且LAN底座还配备了磁铁和滑动杆，方便你装置LAN和M5Core到壁面上。 + +另外LAN底座还有橙色HT3.96端子，这个接口还没有电气连接，它连接不同Pin脚的时候，可以实现对应的Pin拓展。如果你需要这个接口变成RS485的拓展接口的话，那么使用配套的排针和TLL转RS485功能小板子焊接到LAN底座上面，即可实现RS485接口，从而可以通过这个HT3.96端子，通过RS485协议控制M5Core的整个功能。 + +如果TLL转RS485的功能小板子与LAN底板结合的话，小板子上的串口引脚将与LAN底板的GPIO1、GPIO3(UART0)连接。 + +## 管脚映射 + +**W5500以太网芯片** + +| W5500 | ESP32 Chip | +| :----------: |:------------: | +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO26 | +| RST | GPIO13 | +| INTn | GPIO34 | + + + +**M-Bus** + + + +## 特性 + +- 允许9-24V范围的电源输入 +- 3.96规格端子，可以自定义引脚 +- 易于固件到墙上，方便装配 + + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 原理图 diff --git a/docs/zh_CN/base/m5go_base.md b/docs/zh_CN/base/m5go_base.md index 54c260d9..dcc76a28 100644 --- a/docs/zh_CN/base/m5go_base.md +++ b/docs/zh_CN/base/m5go_base.md @@ -1,76 +1,76 @@ -# M5GO底座 - -## 描述 - -M5GO底座是[M5GO IOT Starter Kit](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit)套件中的底座，[M5Fire](zh_CN/product_documents/m5stack-core/m5core_fire)的套件中也配套了这个底座。 - -M5GO底座由600mAh的电池、M-Bus总线接口、麦克风、红色的充电指示LED、2条RGB灯条(10颗)、PORT B和PORT C组成。 - -M5GO底座在充电过程中，红色LED闪烁，充满了常亮。 - -## 管脚映射 - -**POGO Pin** - -| POGO Pin | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LED Bar** - -*有10颗RGB灯，左右各5颗* - -| LED Pin | ESP32 Chip | -| :----------: |:------------: | -| LED Pin | GPIO15 | - -**麦克风MIC** - -| MIC Pin | ESP32 Chip | -| :----------: |:------------: | -| MIC Pin | GPIO34 | - -**GROVE接口** - -| PORT A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -| :----------: |:------------: | -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -| :----------: |:------------: | -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**M-Bus** - -
- M_BUS -
- -## 相关链接 - -- **[原理图](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** -- **[M5GO IOT Starter Kit购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.690a425eFsoYVX&id=568283585553)** - -- **[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.690a425eFsoYVX&id=584136175270)** - -
- -
- -
- +# M5GO底座 + +## 描述 + +M5GO底座是[M5GO IOT Starter Kit](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit)套件中的底座，[M5Fire](zh_CN/product_documents/m5stack-core/m5core_fire)的套件中也配套了这个底座。 + +M5GO底座由600mAh的电池、M-Bus总线接口、麦克风、红色的充电指示LED、2条RGB灯条(10颗)、PORT B和PORT C组成。 + +M5GO底座在充电过程中，红色LED闪烁，充满了常亮。 + +## 管脚映射 + +**POGO Pin** + +| POGO Pin | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | + +**LED Bar** + +*有10颗RGB灯，左右各5颗* + +| LED Pin | ESP32 Chip | +| :----------: |:------------: | +| LED Pin | GPIO15 | + +**麦克风MIC** + +| MIC Pin | ESP32 Chip | +| :----------: |:------------: | +| MIC Pin | GPIO34 | + +**GROVE接口** + +| PORT A(I2C) | ESP32 Chip | +| :----------: |:------------: | +| SCL | GPIO22 | +| SDA | GPIO21 | +| 5V | 5V | +| GND | GND | + +| PORT B(I/O) | ESP32 Chip | +| :----------: |:------------: | +| G36 | GPIO36 | +| G26 | GPIO26 | +| 5V | 5V | +| GND | GND | + +| PORT C(UART2) | ESP32 Chip | +| :----------: |:------------: | +| RXD | GPIO16 | +| TXD | GPIO17 | +| 5V | 5V | +| GND | GND | + +**M-Bus** + +
+ M_BUS +
+ +## 相关链接 + +- **[原理图](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** +- **[M5GO IOT Starter Kit购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.690a425eFsoYVX&id=568283585553)** + +- **[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.690a425eFsoYVX&id=584136175270)** + +
+ +
+ +
+
\ No newline at end of file diff --git a/docs/zh_CN/base/node_base.md b/docs/zh_CN/base/node_base.md index c0edb79f..4483584a 100644 --- a/docs/zh_CN/base/node_base.md +++ b/docs/zh_CN/base/node_base.md @@ -1,45 +1,45 @@ -# Node - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5StackModule-Node/tree/master/example)**      :electric_plug:**[原理图](https://github.com/m5stack/Bases-Node/tree/master/schematic)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.16.6c2275f4nUJEfh&id=581064610318)** - -## 描述 - -Node是一个物联网情景中的节点/基站类底座。把Node装到墙上，堆叠上任意一款M5Core主控，这时，Node+M5Core就是智能节点，可以与附近众多的节点或终端设备通信，可以用终端遥控器通过Node转发信号控制远程设备，实现多个智能终端互联。 -* 内置12 RGBLed(SK6812)和温湿度传感器，可以显示多种丰富的Node状态，同时感知周围温湿度情况 -* Node的四个角分别有一颗红外发送LED，底部有一颗红外接收管 -* Node上下还有一对麦克风 -* 内置常用于Hi-Fi耳机的高分辨率音频编解码芯片WM8978 - -你可以使用M5Core和Node底座实现智能家居中红外遥控设备，蓝牙wifi遥控设备的转发节点，因为内置高保真音频编解码芯片，甚至还可以实现智能音箱功能 - -## 特性 - -- 内置12颗RGBLed灯环和温湿度传感器 -- 内置Hi-Fi级别的音频编解码芯片(高达24位的分辨率) -- 内置500mAh的小电池 - -## 包含 - -- 1x Node -- Node的墙壁固定底座 -- 4x 螺丝 -- 1x Type-C USB线 - - -## 应用 - -- 物联网中智能网络节点 -- 网络收音机Webradio -- 智能音箱Intelligent sound box - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **数据手册** - [WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) (WM8978) +# Node + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5StackModule-Node/tree/master/example)**      :electric_plug:**[原理图](https://github.com/m5stack/Bases-Node/tree/master/schematic)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.16.6c2275f4nUJEfh&id=581064610318)** + +## 描述 + +Node是一个物联网情景中的节点/基站类底座。把Node装到墙上，堆叠上任意一款M5Core主控，这时，Node+M5Core就是智能节点，可以与附近众多的节点或终端设备通信，可以用终端遥控器通过Node转发信号控制远程设备，实现多个智能终端互联。 +* 内置12 RGBLed(SK6812)和温湿度传感器，可以显示多种丰富的Node状态，同时感知周围温湿度情况 +* Node的四个角分别有一颗红外发送LED，底部有一颗红外接收管 +* Node上下还有一对麦克风 +* 内置常用于Hi-Fi耳机的高分辨率音频编解码芯片WM8978 + +你可以使用M5Core和Node底座实现智能家居中红外遥控设备，蓝牙wifi遥控设备的转发节点，因为内置高保真音频编解码芯片，甚至还可以实现智能音箱功能 + +## 特性 + +- 内置12颗RGBLed灯环和温湿度传感器 +- 内置Hi-Fi级别的音频编解码芯片(高达24位的分辨率) +- 内置500mAh的小电池 + +## 包含 + +- 1x Node +- Node的墙壁固定底座 +- 4x 螺丝 +- 1x Type-C USB线 + + +## 应用 + +- 物联网中智能网络节点 +- 网络收音机Webradio +- 智能音箱Intelligent sound box + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **数据手册** - [WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) (WM8978) diff --git a/docs/zh_CN/base/plc_base.md b/docs/zh_CN/base/plc_base.md index 05afb952..acc42030 100644 --- a/docs/zh_CN/base/plc_base.md +++ b/docs/zh_CN/base/plc_base.md @@ -1,3 +1,3 @@ -# PLC-Base - +# PLC-Base + ## (coming soon...) \ No newline at end of file diff --git a/docs/zh_CN/case.md b/docs/zh_CN/case.md index 3a3f83a4..c537a8a4 100644 --- a/docs/zh_CN/case.md +++ b/docs/zh_CN/case.md @@ -1,69 +1,69 @@ -# M5Stack案例 - -## STEM Education案例 - -## M5Stack优秀作品 - -* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD - card - -* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - TFT library for the ESP8266 and ESP32 that supports different driver chips - - -* [M5Widgets](https://github.com/Kongduino/M5Widgets) - Widgets for the M5Stack - -* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack - -* [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32) - -* [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - A lightweight GUI framework suitable for embedded displays - -* [M5ez](https://github.com/ropg/M5ez) - The easy way to program on the M5Stack - - -* [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - A M5Stack firmware made on PlatformIO - - -* [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - A fully functional oscilloscope based on ESP32 M5Stack - -* [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) - An M5Stack library for rendering avatar faces - -* [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - Crack your M5Stack!! - -* [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - M5_Shuttle_Run - -* [nixietubeM5](https://github.com/drayde/nixietubeM5) - (Fake) Nixie Tube Display on a M5Stack - -* [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - A small Bitcoin price ticker using an M5Stack (ESP32) and the Coindesk API - -* [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - Dependence on example Wifi Setting to get ETH Price from Maicoin - -* [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - M5Stack ESP32 Packet Monitor - -* [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - Graphic Equalizer on the M5Stack platform - -* [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - Playing mp3 stream out of internet using M5Stack prototype - -* [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - MP3 player for M5Stack - -* [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - M5STACK Arduino WiFi Photo Backup device - -* [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - You can send ctrl+alt+del to your PC from M5Stack - -* [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) - Markdown & icons loaded from an Micro SD card/TF card to run a web page - -* [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - Tetris for M5Stack Ported to M5Stack by macsbug - https://macsbug.wordpress.com/ - -* [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - M5Stack FlappyBird Playable - -* [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - Space Invaders knock-off for M5Stack - -* [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - Pacman on M5Stack/PSP Joypad, with sounds - -* [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - M5Stack Thermal Camera with AMG8833 thermal sensor - -* [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) - Links to files for 3D printing custom case parts for the M5Stack - -* [truetype2gfx](https://github.com/ropg/truetype2gfx) - Converting fonts from TrueType to Adafruit GFX - +# M5Stack案例 + +## STEM Education案例 + +## M5Stack优秀作品 + +* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD + card + +* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - TFT library for the ESP8266 and ESP32 that supports different driver chips + + +* [M5Widgets](https://github.com/Kongduino/M5Widgets) - Widgets for the M5Stack + +* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack + +* [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32) + +* [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - A lightweight GUI framework suitable for embedded displays + +* [M5ez](https://github.com/ropg/M5ez) - The easy way to program on the M5Stack + + +* [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - A M5Stack firmware made on PlatformIO + + +* [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - A fully functional oscilloscope based on ESP32 M5Stack + +* [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) - An M5Stack library for rendering avatar faces + +* [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - Crack your M5Stack!! + +* [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - M5_Shuttle_Run + +* [nixietubeM5](https://github.com/drayde/nixietubeM5) - (Fake) Nixie Tube Display on a M5Stack + +* [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - A small Bitcoin price ticker using an M5Stack (ESP32) and the Coindesk API + +* [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - Dependence on example Wifi Setting to get ETH Price from Maicoin + +* [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - M5Stack ESP32 Packet Monitor + +* [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - Graphic Equalizer on the M5Stack platform + +* [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - Playing mp3 stream out of internet using M5Stack prototype + +* [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - MP3 player for M5Stack + +* [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - M5STACK Arduino WiFi Photo Backup device + +* [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - You can send ctrl+alt+del to your PC from M5Stack + +* [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) - Markdown & icons loaded from an Micro SD card/TF card to run a web page + +* [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - Tetris for M5Stack Ported to M5Stack by macsbug - https://macsbug.wordpress.com/ + +* [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - M5Stack FlappyBird Playable + +* [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - Space Invaders knock-off for M5Stack + +* [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - Pacman on M5Stack/PSP Joypad, with sounds + +* [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - M5Stack Thermal Camera with AMG8833 thermal sensor + +* [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) - Links to files for 3D printing custom case parts for the M5Stack + +* [truetype2gfx](https://github.com/ropg/truetype2gfx) - Converting fonts from TrueType to Adafruit GFX + * [m5stack-onscreen-keyboard](https://github.com/yellowelise/m5stack-onscreen-keyboard) - Full size qwerty keyboard for M5Stack \ No newline at end of file diff --git a/docs/zh_CN/core/basic.md b/docs/zh_CN/core/basic.md index 366df692..d5d4a719 100644 --- a/docs/zh_CN/core/basic.md +++ b/docs/zh_CN/core/basic.md @@ -1,126 +1,126 @@ -# 基础版本M5Core - -basic_02 basic_03 basic_04 - -* * * - -:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a230r.7195193.1997079397.11.2bb86d62zW1YQG&id=557295147801&abbucket=8)**   :clapper:**[相关视频](#相关视频)** - -## 描述 - -**M5Core BASIC**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的基础版开发板，包括黑色的主板和底座。你可以用[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)或[Arduino](http://www.arduino.cc)来编程它. - -这个黑色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽。底座的设计用于拓展M-Bus总线的Pin管脚出来，以方便DIY和产品设计，每个Pin脚都引出来做成了排针或排母形式，非常方便(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34这几个关于I2S功能的引脚没引出)。 - -**注意，这款基础版M5Core不包含任何陀螺仪等姿态传感器** - -## 特性 - -- 可编程，支持[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc) -- 支持外置TF卡(最大16G) - -## 外设的管脚映射 - -*我们有几种M5Core的版本，点击[这里](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md)查看他们在硬件配置上比较* - -**LCD屏幕&TF卡** - -*LCD像素：320x240* -*TF卡最大支持16GB* - - - - - -
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF卡MOSIMISOCLK CS
- -**按键&喇叭** - - - - - -
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
按键引脚BUTTON ABUTTON BBUTTON C
喇叭 喇叭引脚
- -**GROVE接口A** - - - - -
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
- -## 参数 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
主控资源参数
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash闪存4M-Bytes
输入电压5V @ 500mA
接口TypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD屏幕2 inch, 320x240 Colorful TFT LCD, ILI9342
喇叭1W-0928
电池150mAh @ 3.7V
工作温度32°F to 104°F ( 0°C to 40°C )
尺寸54 x 54 x 12.5 mm
外壳材质Plastic ( PC )
重量120g with bottom, 100g only core
- -## 包含 - -- 1x M5Stack BASIC 主控 -- 1x M5Core 底座 -- Type-C USB 线 -- 说明书 - - - - - - - -## 相关链接 - -- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - -## 相关视频 - -- **m5stack的简介** - - +# 基础版本M5Core + +basic_02 basic_03 basic_04 + +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a230r.7195193.1997079397.11.2bb86d62zW1YQG&id=557295147801&abbucket=8)**   :clapper:**[相关视频](#相关视频)** + +## 描述 + +**M5Core BASIC**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的基础版开发板，包括黑色的主板和底座。你可以用[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)或[Arduino](http://www.arduino.cc)来编程它. + +这个黑色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽。底座的设计用于拓展M-Bus总线的Pin管脚出来，以方便DIY和产品设计，每个Pin脚都引出来做成了排针或排母形式，非常方便(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34这几个关于I2S功能的引脚没引出)。 + +**注意，这款基础版M5Core不包含任何陀螺仪等姿态传感器** + +## 特性 + +- 可编程，支持[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc) +- 支持外置TF卡(最大16G) + +## 外设的管脚映射 + +*我们有几种M5Core的版本，点击[这里](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md)查看他们在硬件配置上比较* + +**LCD屏幕&TF卡** + +*LCD像素：320x240* +*TF卡最大支持16GB* + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF卡MOSIMISOCLK CS
+ +**按键&喇叭** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
按键引脚BUTTON ABUTTON BBUTTON C
喇叭 喇叭引脚
+ +**GROVE接口A** + + + + +
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
+ +## 参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主控资源参数
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash闪存4M-Bytes
输入电压5V @ 500mA
接口TypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD屏幕2 inch, 320x240 Colorful TFT LCD, ILI9342
喇叭1W-0928
电池150mAh @ 3.7V
工作温度32°F to 104°F ( 0°C to 40°C )
尺寸54 x 54 x 12.5 mm
外壳材质Plastic ( PC )
重量120g with bottom, 100g only core
+ +## 包含 + +- 1x M5Stack BASIC 主控 +- 1x M5Core 底座 +- Type-C USB 线 +- 说明书 + + + + + + + +## 相关链接 + +- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) + +## 相关视频 + +- **m5stack的简介** + + diff --git a/docs/zh_CN/core/face_kit.md b/docs/zh_CN/core/face_kit.md index a72d6dcb..9f91ee3e 100644 --- a/docs/zh_CN/core/face_kit.md +++ b/docs/zh_CN/core/face_kit.md @@ -1,60 +1,60 @@ -# FACES Kit - -**FACES Kit**是有M5Core、功能面板、FACES Base、充电底座FACES Charger和其他配件(杜邦线、FACES Kit挂绳、M3固定螺丝等等)组成的套件。目前功能面板有GameBoy、Calculator和QWERTY三种，以后会继续增加。可以通过Arduino IDE或者M5Cloud对套件编程，在不同的应用场景下，堆叠不一样的功能面板，烧录对应固件到M5Core，实现对应的功能。其中FACES底座的电池是650mAh。而关于FACES底座的详情欢迎阅读介绍[FACES Base](zh_CN/base/face_base)的介绍。 - -*每个功能面板都集成了**MEGA328**芯片，在按下每个独立按键都可以返回唯一的键值。功能面板与M5Core之间通过**I2C**通信，而从机(即功能面板)的I2C地址为0x08。* - - -下图是整个套件的内容 - -
- -
- -### 1. GameBoy Keyboard - -在做游戏娱乐时，需要GameBoy键盘。 -M5Core和FACE底板，再加上GameBoy键盘之后，点击[这里](zh_CN/quick_start/faces/gameboy_burn_a_nes_game)烧录游戏模拟器，然后能玩多款经典的电子游戏。 - -GameBoy游戏烧录方法：[下载游戏](zh_CN/quick_start/faces/gameboy_burn_a_nes_game) - -
- -
- -### 2. Calculator Keyboard - -在做计算器，需要Calculator键盘。 -M5Core和FACE底板，再加上Calculator键盘之后，烧录你的固件到M5Core，固件里读取所按下按键的键值，并执行该按键触发的事件，就可以Calculator键盘功能。 - -
- -
- -### 3. QWERTY Keyboard - -在你做以M5Core为主控的终端需要全键盘输入时，堆叠QWERTY模块，烧录对应固件到M5Core，固件里读取所按下按键的键值，并执行该按键触发的事件，。 - - -烧录如下例程(例程功能: M5Core显示屏和串口终端打印按下的按键) - -- **例程文件** - a. [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) - b. [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES)(for M5Cloud) - -- **M5Cloud使用方法** - [MicroPython(M5Cloud)](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) - -
- -
- - -### 4. FACES Charger充电座 - -**FACES Charger充电座**内置磁铁，充电时，能稳定地吸附FACES主机，并与FACES主机之间通过PIGO Pin连接。 - -
- -
- -### 相关链接 - +# FACES Kit + +**FACES Kit**是有M5Core、功能面板、FACES Base、充电底座FACES Charger和其他配件(杜邦线、FACES Kit挂绳、M3固定螺丝等等)组成的套件。目前功能面板有GameBoy、Calculator和QWERTY三种，以后会继续增加。可以通过Arduino IDE或者M5Cloud对套件编程，在不同的应用场景下，堆叠不一样的功能面板，烧录对应固件到M5Core，实现对应的功能。其中FACES底座的电池是650mAh。而关于FACES底座的详情欢迎阅读介绍[FACES Base](zh_CN/base/face_base)的介绍。 + +*每个功能面板都集成了**MEGA328**芯片，在按下每个独立按键都可以返回唯一的键值。功能面板与M5Core之间通过**I2C**通信，而从机(即功能面板)的I2C地址为0x08。* + + +下图是整个套件的内容 + +
+ +
+ +### 1. GameBoy Keyboard + +在做游戏娱乐时，需要GameBoy键盘。 +M5Core和FACE底板，再加上GameBoy键盘之后，点击[这里](zh_CN/quick_start/faces/gameboy_burn_a_nes_game)烧录游戏模拟器，然后能玩多款经典的电子游戏。 + +GameBoy游戏烧录方法：[下载游戏](zh_CN/quick_start/faces/gameboy_burn_a_nes_game) + +
+ +
+ +### 2. Calculator Keyboard + +在做计算器，需要Calculator键盘。 +M5Core和FACE底板，再加上Calculator键盘之后，烧录你的固件到M5Core，固件里读取所按下按键的键值，并执行该按键触发的事件，就可以Calculator键盘功能。 + +
+ +
+ +### 3. QWERTY Keyboard + +在你做以M5Core为主控的终端需要全键盘输入时，堆叠QWERTY模块，烧录对应固件到M5Core，固件里读取所按下按键的键值，并执行该按键触发的事件，。 + + +烧录如下例程(例程功能: M5Core显示屏和串口终端打印按下的按键) + +- **例程文件** - a. [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) - b. [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES)(for M5Cloud) + +- **M5Cloud使用方法** - [MicroPython(M5Cloud)](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) + +
+ +
+ + +### 4. FACES Charger充电座 + +**FACES Charger充电座**内置磁铁，充电时，能稳定地吸附FACES主机，并与FACES主机之间通过PIGO Pin连接。 + +
+ +
+ +### 相关链接 + - **[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.15.686c425eRw6D4J&id=562810115476)** \ No newline at end of file diff --git a/docs/zh_CN/core/fire.md b/docs/zh_CN/core/fire.md index b541eac6..1c731e90 100644 --- a/docs/zh_CN/core/fire.md +++ b/docs/zh_CN/core/fire.md @@ -1,171 +1,171 @@ -# M5Stack FIRE - -fire_01 - -* * * - -:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.bcec425e3VR4TD&id=571494244869)**   :clapper:**[相关视频](#相关视频)** - -## 描述 - -M5Core **FIRE**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的升级版开发板，包括红色的主板、M5GO底座和M5GO充电底座。你可以用[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)或[Arduino](http://www.arduino.cc)来编程它. 这个红色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽、**MPU9250**。 - -M5GO底座内置PORT B, PORT C, 2个RGBLed灯条(SK6812), 一个麦克风和一个电池(550mAh)。 - -M5GO CHG.底座包含POGO Pin。FIRE主控通过POGO Pin与这个充电底座连接，而且主控和底座都内置磁铁，所以主控随意放置，都可很好地吸附到充电底座上。 - -## 特性 - -- 可编程，支持[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)或[Arduino](http://www.arduino.cc) -- 支持外置TF卡(最大16G) -- 支持LEGO件 - -## 外设的管脚映射 - -*我们有几种M5Core的版本，点击[这里](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md)查看他们在硬件配置上比较* - -#### 主板管脚 - -**LCD屏幕&TF卡** - -*LCD像素：320x240* -*TF卡最大支持16GB* - - - - - -
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF卡MOSIMISOCLK CS
- -**按键&喇叭** - - - - - -
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
按键引脚BUTTON ABUTTON BBUTTON C
喇叭 喇叭引脚
- -**GROVE接口A** - - - - -
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
- -**九轴姿态传感器MPU9250** - -*I2C地址为0x68* - - - - -
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
- -#### M5GO底座管脚 - -**GROVE接口B** - - - - -
ESP32 ChipGPIO36GPIO265VGND
GROVE BGPIO36GPIO265VGND
- -**GROVE接口C** - - - - -
ESP32 ChipGPIO16GPIO175VGND
GROVE CRXDTXD5VGND
- -**LED灯条&麦克风MIC&喇叭Speaker** - - - - - - -
ESP32 ChipGPIO15GPIO34GPIO25
LED灯条SIG管脚
麦克风MIC MIC管脚
喇叭 Speaker管脚
- -## 参数 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
主控资源参数
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash闪存16MB Flash + 4MB pSRAM
输入电压5V @ 500mA
接口TypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD屏幕2 inch, 320x240 Colorful TFT LCD, ILI9342
喇叭1W-0928
麦克风MEMS Analog BSE3729 Microphone
LEDSK6812 3535 RGB LED x 10
MEMSMPU9250
电池550mAh @ 3.7V, inside vb
工作温度32°F to 104°F ( 0°C to 40°C )
尺寸54 x 54 x 12.5 mm
外壳材质Plastic ( PC )
重量120g with bottom, 100g only core
- - -## 包含 - -- 1x M5Stack FIRE主控 -- 1x M5GO 底座 -- 1x M5GO CHG. 充电底座 -- Type-C USB 线 -- 说明书 - -## 相关链接 - -- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - [AK8963](https://www.akm.com/akm/en/file/datasheet/AK8963C.pdf) - -## 相关视频 - -- **m5stack的简介** - - +# M5Stack FIRE + +fire_01 + +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.bcec425e3VR4TD&id=571494244869)**   :clapper:**[相关视频](#相关视频)** + +## 描述 + +M5Core **FIRE**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的升级版开发板，包括红色的主板、M5GO底座和M5GO充电底座。你可以用[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)或[Arduino](http://www.arduino.cc)来编程它. 这个红色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽、**MPU9250**。 + +M5GO底座内置PORT B, PORT C, 2个RGBLed灯条(SK6812), 一个麦克风和一个电池(550mAh)。 + +M5GO CHG.底座包含POGO Pin。FIRE主控通过POGO Pin与这个充电底座连接，而且主控和底座都内置磁铁，所以主控随意放置，都可很好地吸附到充电底座上。 + +## 特性 + +- 可编程，支持[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)或[Arduino](http://www.arduino.cc) +- 支持外置TF卡(最大16G) +- 支持LEGO件 + +## 外设的管脚映射 + +*我们有几种M5Core的版本，点击[这里](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md)查看他们在硬件配置上比较* + +#### 主板管脚 + +**LCD屏幕&TF卡** + +*LCD像素：320x240* +*TF卡最大支持16GB* + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF卡MOSIMISOCLK CS
+ +**按键&喇叭** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
按键引脚BUTTON ABUTTON BBUTTON C
喇叭 喇叭引脚
+ +**GROVE接口A** + + + + +
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
+ +**九轴姿态传感器MPU9250** + +*I2C地址为0x68* + + + + +
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
+ +#### M5GO底座管脚 + +**GROVE接口B** + + + + +
ESP32 ChipGPIO36GPIO265VGND
GROVE BGPIO36GPIO265VGND
+ +**GROVE接口C** + + + + +
ESP32 ChipGPIO16GPIO175VGND
GROVE CRXDTXD5VGND
+ +**LED灯条&麦克风MIC&喇叭Speaker** + + + + + + +
ESP32 ChipGPIO15GPIO34GPIO25
LED灯条SIG管脚
麦克风MIC MIC管脚
喇叭 Speaker管脚
+ +## 参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主控资源参数
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash闪存16MB Flash + 4MB pSRAM
输入电压5V @ 500mA
接口TypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD屏幕2 inch, 320x240 Colorful TFT LCD, ILI9342
喇叭1W-0928
麦克风MEMS Analog BSE3729 Microphone
LEDSK6812 3535 RGB LED x 10
MEMSMPU9250
电池550mAh @ 3.7V, inside vb
工作温度32°F to 104°F ( 0°C to 40°C )
尺寸54 x 54 x 12.5 mm
外壳材质Plastic ( PC )
重量120g with bottom, 100g only core
+ + +## 包含 + +- 1x M5Stack FIRE主控 +- 1x M5GO 底座 +- 1x M5GO CHG. 充电底座 +- Type-C USB 线 +- 说明书 + +## 相关链接 + +- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - [AK8963](https://www.akm.com/akm/en/file/datasheet/AK8963C.pdf) + +## 相关视频 + +- **m5stack的简介** + + diff --git a/docs/zh_CN/core/gray.md b/docs/zh_CN/core/gray.md index 46241ab6..45df6b92 100644 --- a/docs/zh_CN/core/gray.md +++ b/docs/zh_CN/core/gray.md @@ -1,159 +1,159 @@ -# 灰色升级版M5Core - -gray_02 gray_02 gray_04 - - - -* * * - -:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.33.cc8e425e1QylQu&id=559226082388)**   :clapper:**[相关视频](#相关视频)** - -## 描述 - -**M5Core GRAY**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的灰色开发板，内置MEMS传感器(**MPU9250**)。你可以用[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc)来编程它. - -这个灰色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽、九轴陀螺仪MPU9250。 - -底座的设计用于拓展M-Bus总线的Pin管脚出来，以方便DIY和产品设计，每个Pin脚都引出来做成了排针或排母形式，非常方便(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34这几个关于I2S功能的引脚没引出)。 - - -## 特性 - -- 可编程，支持[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc) -- 支持外置TF卡(最大16G) - -## 外设的管脚映射 - -*我们有几种M5Core的版本，点击[这里](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md)查看他们在硬件配置上比较* - -**LCD屏幕&TF卡** - -*LCD像素：320x240* -*TF卡最大支持16GB* - - - - - - -
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF卡MOSIMISOCLK CS
- -**按键&喇叭** - - - - - -
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
按键引脚BUTTON ABUTTON BBUTTON C
喇叭 喇叭引脚
- -**GROVE接口A** - - - - -
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
- -**九轴姿态传感器MPU9250** - -*I2C地址为0x68* - - - - -
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
- -## 参数 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
主控资源参数
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash闪存4M-Bytes
输入电压5V @ 500mA
接口TypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD屏幕2 inch, 320x240 Colorful TFT LCD, ILI9342
喇叭1W-0928
电池150mAh @ 3.7V
工作温度32°F to 104°F ( 0°C to 40°C )
尺寸54 x 54 x 12.5 mm
外壳材质Plastic ( PC )
重量120g with bottom, 100g only core
- -## 包含 - -- 1x M5Stack GRAY 主控 -- 1x M5Core 底座 -- Type-C USB 线 -- 说明书 - - - - - - - -## 相关链接 - -- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - - - - - -## 相关视频 - -- **m5stack的简介** - - - - - - - - +# 灰色升级版M5Core + +gray_02 gray_02 gray_04 + + + +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.33.cc8e425e1QylQu&id=559226082388)**   :clapper:**[相关视频](#相关视频)** + +## 描述 + +**M5Core GRAY**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的灰色开发板，内置MEMS传感器(**MPU9250**)。你可以用[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc)来编程它. + +这个灰色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽、九轴陀螺仪MPU9250。 + +底座的设计用于拓展M-Bus总线的Pin管脚出来，以方便DIY和产品设计，每个Pin脚都引出来做成了排针或排母形式，非常方便(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34这几个关于I2S功能的引脚没引出)。 + + +## 特性 + +- 可编程，支持[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc) +- 支持外置TF卡(最大16G) + +## 外设的管脚映射 + +*我们有几种M5Core的版本，点击[这里](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md)查看他们在硬件配置上比较* + +**LCD屏幕&TF卡** + +*LCD像素：320x240* +*TF卡最大支持16GB* + + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF卡MOSIMISOCLK CS
+ +**按键&喇叭** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
按键引脚BUTTON ABUTTON BBUTTON C
喇叭 喇叭引脚
+ +**GROVE接口A** + + + + +
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
+ +**九轴姿态传感器MPU9250** + +*I2C地址为0x68* + + + + +
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
+ +## 参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主控资源参数
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash闪存4M-Bytes
输入电压5V @ 500mA
接口TypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD屏幕2 inch, 320x240 Colorful TFT LCD, ILI9342
喇叭1W-0928
电池150mAh @ 3.7V
工作温度32°F to 104°F ( 0°C to 40°C )
尺寸54 x 54 x 12.5 mm
外壳材质Plastic ( PC )
重量120g with bottom, 100g only core
+ +## 包含 + +- 1x M5Stack GRAY 主控 +- 1x M5Core 底座 +- Type-C USB 线 +- 说明书 + + + + + + + +## 相关链接 + +- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + + + + + +## 相关视频 + +- **m5stack的简介** + + + + + + + + diff --git a/docs/zh_CN/core/m5go_iot_starter_kit.md b/docs/zh_CN/core/m5go_iot_starter_kit.md index 7040304b..3c925337 100644 --- a/docs/zh_CN/core/m5go_iot_starter_kit.md +++ b/docs/zh_CN/core/m5go_iot_starter_kit.md @@ -1,42 +1,42 @@ -# M5GO IOT Starter Kit - -gray_02 gray_02 gray_04 - - - -* * * - -:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.1b28425eUFn3DY&id=568283585553)**   :clapper:**[相关视频](#相关视频)**** - -## 描述 - -**M5GO IOT Starter Kit**是一款以白色M5Core主控为核心，附带6个units(ENV, IR, RGB, PIR, ANGLE, HUB)的物联网开发套件。 - -你可以用[UiFlow](http://flow.m5stack.com)或Arduino IDE对它编程。 - -我们也提供了一些物联网开发课程方便你更快上手使用，如果你对这个感兴趣的话，欢迎给我司发邮件。 - -## 特性 - -- 可编程，支持[UiFlow](http://flow.m5stack.com), MicroPython和Arduino -- 支持外置TF卡(最大16G) - -## 包含 - -- 1x white M5Core主控 -- 1x M5GO 底座 -- 6x Units(ENV, IR, RGB, PIR, ANGLE, HUB) -- 4x LEGO 接插件 -- 3x GROVE 线 -- Type-C USB 线 -- 说明书 - -## 相关链接 - -- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -## 相关视频 - -- **m5stack的简介** - +# M5GO IOT Starter Kit + +gray_02 gray_02 gray_04 + + + +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.1b28425eUFn3DY&id=568283585553)**   :clapper:**[相关视频](#相关视频)**** + +## 描述 + +**M5GO IOT Starter Kit**是一款以白色M5Core主控为核心，附带6个units(ENV, IR, RGB, PIR, ANGLE, HUB)的物联网开发套件。 + +你可以用[UiFlow](http://flow.m5stack.com)或Arduino IDE对它编程。 + +我们也提供了一些物联网开发课程方便你更快上手使用，如果你对这个感兴趣的话，欢迎给我司发邮件。 + +## 特性 + +- 可编程，支持[UiFlow](http://flow.m5stack.com), MicroPython和Arduino +- 支持外置TF卡(最大16G) + +## 包含 + +- 1x white M5Core主控 +- 1x M5GO 底座 +- 6x Units(ENV, IR, RGB, PIR, ANGLE, HUB) +- 4x LEGO 接插件 +- 3x GROVE 线 +- Type-C USB 线 +- 说明书 + +## 相关链接 + +- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +## 相关视频 + +- **m5stack的简介** + \ No newline at end of file diff --git a/docs/zh_CN/core/m5stick.md b/docs/zh_CN/core/m5stick.md index 326bd113..7248720a 100644 --- a/docs/zh_CN/core/m5stick.md +++ b/docs/zh_CN/core/m5stick.md @@ -1,61 +1,61 @@ -# M5Stick - -gray_02 gray_02 gray_04 - -* * * - -:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stick_get_started_arduino)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Stick/FactoryTest)**   :electric_plug:**[原理图](#原理图)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.257b425esTi92S&id=581055502939)**    -## 描述 - -**M5Stick** 是一个包含1.3寸OLED屏幕(64x128)，LED灯，按键，蜂鸣器，红外发射管和80mA的电池的小型ESP32开发板。你通常可以将它戴在手腕上，也可以利用我们的配件将它固定到墙上。 - -M5Stick有两个版本，第一个是无PSRAM的版本，另外一个是有MPU9250的版本，附送一些配件(`WATCH BELT`, `WALL` 和 `BRICK`)。 - -## 特性 - -- 支持可编程操作: Arduino, UiFlow(Blockly, MicroPython) -- 编程板可穿戴 -- 可选：MEMS(MPU9250) - -## 管脚映射 - -| *BLUE_LED* | *ESP32* | -| :----------: |:------------: | -| LED_Pin | GPIO19 | - -| *BUTTON按键* | *ESP32* | -| :----------: |:------------: | -| Button_Pin | GPIO35 | - -| *BUZZER蜂鸣器* | *ESP32* | -| :----------: |:------------: | -| Buzzer_Pin | GPIO26 | - -| *IR红外发射管* | *ESP32* | -| :----------: |:------------: | -| Buzzer_Pin | GPIO17 | - -| *GROVE* | *ESP32* | -| :----------: |:------------: | -| SDA | GPIO25 | -| SCL | GPIO13 | - - -**可选:** - -| *MPU9250* | *ESP32* | -| :----------: |:------------: | -| SDA | GPIO22 | -| SCL | GPIO21 | - -## 包含 - -- 1x M5Stick 内置 80mAh-Battery -- 1x Type-C USB 线 - -**MPU9250 版本:** -- 一些配件: `WATCH BELT`, `WALL` and `BRICK` - -## 相关链接 - -- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) +# M5Stick + +gray_02 gray_02 gray_04 + +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stick_get_started_arduino)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Stick/FactoryTest)**   :electric_plug:**[原理图](#原理图)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.257b425esTi92S&id=581055502939)**    +## 描述 + +**M5Stick** 是一个包含1.3寸OLED屏幕(64x128)，LED灯，按键，蜂鸣器，红外发射管和80mA的电池的小型ESP32开发板。你通常可以将它戴在手腕上，也可以利用我们的配件将它固定到墙上。 + +M5Stick有两个版本，第一个是无PSRAM的版本，另外一个是有MPU9250的版本，附送一些配件(`WATCH BELT`, `WALL` 和 `BRICK`)。 + +## 特性 + +- 支持可编程操作: Arduino, UiFlow(Blockly, MicroPython) +- 编程板可穿戴 +- 可选：MEMS(MPU9250) + +## 管脚映射 + +| *BLUE_LED* | *ESP32* | +| :----------: |:------------: | +| LED_Pin | GPIO19 | + +| *BUTTON按键* | *ESP32* | +| :----------: |:------------: | +| Button_Pin | GPIO35 | + +| *BUZZER蜂鸣器* | *ESP32* | +| :----------: |:------------: | +| Buzzer_Pin | GPIO26 | + +| *IR红外发射管* | *ESP32* | +| :----------: |:------------: | +| Buzzer_Pin | GPIO17 | + +| *GROVE* | *ESP32* | +| :----------: |:------------: | +| SDA | GPIO25 | +| SCL | GPIO13 | + + +**可选:** + +| *MPU9250* | *ESP32* | +| :----------: |:------------: | +| SDA | GPIO22 | +| SCL | GPIO21 | + +## 包含 + +- 1x M5Stick 内置 80mAh-Battery +- 1x Type-C USB 线 + +**MPU9250 版本:** +- 一些配件: `WATCH BELT`, `WALL` and `BRICK` + +## 相关链接 + +- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) diff --git a/docs/zh_CN/faq.md b/docs/zh_CN/faq.md index 33c1a9e0..46d80fa1 100644 --- a/docs/zh_CN/faq.md +++ b/docs/zh_CN/faq.md @@ -1,48 +1,48 @@ -# 常见问题解答 - -**[主控Core](#主控Core)**      **[功能模块](#功能模块Modules)**      **[底座](#Bases)**      **[Units](#Units)** - -## 主控Core - -### M5Core - -- Q. 这些M5Core有什么区别？ -- A. 这些Core主要区别在内部硬件配置和套件搭配上，从基础版到升级版，分别是增加了运动传感器和加大了RAM和FLASH，具体区别请访问这个链接 - - https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md - -### Minicore - -### 套件 - -## 功能模块Modules - -#### 通信模块 - -#### 拓展模块 - -#### 驱动模块 - -## Units - -### 通信类Unit - -### 传感类Unit - -### 驱动类Unit - - \ No newline at end of file diff --git a/docs/zh_CN/module/battery.md b/docs/zh_CN/module/battery.md index 94fba994..45e71c47 100644 --- a/docs/zh_CN/module/battery.md +++ b/docs/zh_CN/module/battery.md @@ -1,27 +1,27 @@ -# 电池模块 - - - -*** - -:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.64.501375f4xEgd84&id=562045689464)** - -# 描述 - -BATTERY模块是一款850mAh的高容量电池模块。当M5Core堆叠了这个电池模块之后，可以做成移动的设备，不再需要USB线一直供电。 - -# 特性 - -- 850mAh容量 - -# 包括 - -- 1x BATTERY模块 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 原理图 +# 电池模块 + + + +*** + +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.64.501375f4xEgd84&id=562045689464)** + +# 描述 + +BATTERY模块是一款850mAh的高容量电池模块。当M5Core堆叠了这个电池模块之后，可以做成移动的设备，不再需要USB线一直供电。 + +# 特性 + +- 850mAh容量 + +# 包括 + +- 1x BATTERY模块 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 原理图 diff --git a/docs/zh_CN/module/btc.md b/docs/zh_CN/module/btc.md index b3899719..199977da 100644 --- a/docs/zh_CN/module/btc.md +++ b/docs/zh_CN/module/btc.md @@ -1,55 +1,55 @@ -# BTC底座 - - - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.69f6425e8Agsbh&id=559647865340)** - -# 描述 - -BTC模块是一款包含DHT12(温湿度)传感器的底座。有了BTC底座之后，可以方便给M5Core充电。 - -# 特性 - -- 内置DHT12 - -# 包含 - -- Type-C USB线 -- M3 x 16 -- Tools - -# 管脚映射 - -**DHT12** - -| DHT12 | ESP32 | -| :----------: |:------------:| -| SCL | G22 | -| GND | GND | -| SDA | G21 | -| 3V3 | 3V3 | - - - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -float tmp = dht12.readTemperature();//temperature -float hum = dht12.readHumidity();//humidity -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/Arduino)。 - -## 原理图 +# BTC底座 + + + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.69f6425e8Agsbh&id=559647865340)** + +# 描述 + +BTC模块是一款包含DHT12(温湿度)传感器的底座。有了BTC底座之后，可以方便给M5Core充电。 + +# 特性 + +- 内置DHT12 + +# 包含 + +- Type-C USB线 +- M3 x 16 +- Tools + +# 管脚映射 + +**DHT12** + +| DHT12 | ESP32 | +| :----------: |:------------:| +| SCL | G22 | +| GND | GND | +| SDA | G21 | +| 3V3 | 3V3 | + + + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +float tmp = dht12.readTemperature();//temperature +float hum = dht12.readHumidity();//humidity +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/Arduino)。 + +## 原理图 diff --git a/docs/zh_CN/module/commu.md b/docs/zh_CN/module/commu.md index 12fb9927..792fb926 100644 --- a/docs/zh_CN/module/commu.md +++ b/docs/zh_CN/module/commu.md @@ -1,48 +1,48 @@ -# COMMU - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](https://github.com/m5stack/M5-Schematic/blob/master/Modules/module_commu_sch.pdf)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.64.6c2275f4nUJEfh&id=580999880340)** - -## 描述 - -COMMU是一个通讯接口转换模块，能将M5Core的IO口转换并外拓成其他类型的接口，满足多种产品设计需求。目前模块外拓2个I2C接口，MCU的TTL电平已经转换成一个CAN接口和一个RS485接口，同时也附带一个直接外拓的TTL电平接口。这意味着，当你设计产品需要用到CAN通讯或RS485通讯的设备时，可以直接使用该模块，堆叠与M5Core主控板，即可驱动对应设备，无需另外订做接口转换电路板。 - -COMMU模块中的TTL接口，实际上是串口接口，默认连接的是串口0，不过可以通过焊接跳转接口，可以跳转成连接串口2。跳线接口Jumper是J6, J7, J9, J10。 - -## 特性 - -- 2x I2C 接口 -- 1x CAN 接口 -- 1x RS485 接口 -- 1x TTL 接口 - -## 包含 - -- 1x M5Stack COMMU Module - -## 管脚分配 - -| *CAN* | *ESP32 Chip* | -| :----------: |:------------: | -| CAN_CS | GPIO12 | -| CAN_INT | GPIO15 | -| CAN_SCK | GPIO18 | -| CAN_MISO | GPIO19 | -| CAN_MOSI | GPIO23 | - - -| *I2C Interface* | *ESP32 Chip* | -| :--------------: |:------------: | -| IIC_SDA | GPIO21 | -| IIC_SCL | GPIO22 | - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 +# COMMU + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](https://github.com/m5stack/M5-Schematic/blob/master/Modules/module_commu_sch.pdf)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.64.6c2275f4nUJEfh&id=580999880340)** + +## 描述 + +COMMU是一个通讯接口转换模块，能将M5Core的IO口转换并外拓成其他类型的接口，满足多种产品设计需求。目前模块外拓2个I2C接口，MCU的TTL电平已经转换成一个CAN接口和一个RS485接口，同时也附带一个直接外拓的TTL电平接口。这意味着，当你设计产品需要用到CAN通讯或RS485通讯的设备时，可以直接使用该模块，堆叠与M5Core主控板，即可驱动对应设备，无需另外订做接口转换电路板。 + +COMMU模块中的TTL接口，实际上是串口接口，默认连接的是串口0，不过可以通过焊接跳转接口，可以跳转成连接串口2。跳线接口Jumper是J6, J7, J9, J10。 + +## 特性 + +- 2x I2C 接口 +- 1x CAN 接口 +- 1x RS485 接口 +- 1x TTL 接口 + +## 包含 + +- 1x M5Stack COMMU Module + +## 管脚分配 + +| *CAN* | *ESP32 Chip* | +| :----------: |:------------: | +| CAN_CS | GPIO12 | +| CAN_INT | GPIO15 | +| CAN_SCK | GPIO18 | +| CAN_MISO | GPIO19 | +| CAN_MOSI | GPIO23 | + + +| *I2C Interface* | *ESP32 Chip* | +| :--------------: |:------------: | +| IIC_SDA | GPIO21 | +| IIC_SCL | GPIO22 | + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 diff --git a/docs/zh_CN/module/gps.md b/docs/zh_CN/module/gps.md index 0b7fe337..c52e81c4 100644 --- a/docs/zh_CN/module/gps.md +++ b/docs/zh_CN/module/gps.md @@ -1,68 +1,68 @@ -# GPS模块 - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.69f6425e8Agsbh&id=559647865340)** - -## 描述 - -GPS 模块是一款内置了GPS小模组的M5Stack系列可堆叠模块。内置的GPS小模块名字为UBLOX NEO-M8N。堆叠了M5Core之后，你可以用UiFlow、Arduino和MicroPython来编程它。它都可提供全球定位信息，即使你在室外的任何地方。模块上电之后，就会一直接收定位信息。M5Core烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)，堆叠了GPS模块和连接PC串口之后，屏幕和PC的串口显示终端就会打印GPS接收到的信息。 - -## 特性 - -- GPS NEO-M8N模块 -- 高性能 -- 高灵敏度 -- 业界领先的-167dBm灵敏度 - -## 包含 - -- 1x M5Stack GPS模块 -- 1x M5Stack天线 - -## 应用 - -- 儿童定位手表 -- 基于GPS的物流跟踪管理 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **[GPS Info](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) - -## 例程 - -### 1. Arduino IDE - -```c++ -GPSRaw.begin(9600); - -if(GPSRaw.available()) { - int ch = GPSRaw.read(); - Serial.write(ch); -} -``` - -烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)之后，屏幕和串口显示终端会打印如下类似的信息 - -``` -$GPGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*02 -$BDGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*13 -$GPGSV,1,1,00*79 -$BDGSV,1,1,00*68 -$GNRMC,,V,,,,,,,,,,M*4E -$GNVTG,,,,,,,,,M*2D -$GNZDA,,,,,,*56 -$GPTXT,01,01,01,ANTENNA OPEN*25 -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)。 - -## 原理图 - +# GPS模块 + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.69f6425e8Agsbh&id=559647865340)** + +## 描述 + +GPS 模块是一款内置了GPS小模组的M5Stack系列可堆叠模块。内置的GPS小模块名字为UBLOX NEO-M8N。堆叠了M5Core之后，你可以用UiFlow、Arduino和MicroPython来编程它。它都可提供全球定位信息，即使你在室外的任何地方。模块上电之后，就会一直接收定位信息。M5Core烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)，堆叠了GPS模块和连接PC串口之后，屏幕和PC的串口显示终端就会打印GPS接收到的信息。 + +## 特性 + +- GPS NEO-M8N模块 +- 高性能 +- 高灵敏度 +- 业界领先的-167dBm灵敏度 + +## 包含 + +- 1x M5Stack GPS模块 +- 1x M5Stack天线 + +## 应用 + +- 儿童定位手表 +- 基于GPS的物流跟踪管理 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **[GPS Info](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) + +## 例程 + +### 1. Arduino IDE + +```c++ +GPSRaw.begin(9600); + +if(GPSRaw.available()) { + int ch = GPSRaw.read(); + Serial.write(ch); +} +``` + +烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)之后，屏幕和串口显示终端会打印如下类似的信息 + +``` +$GPGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*02 +$BDGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*13 +$GPGSV,1,1,00*79 +$BDGSV,1,1,00*68 +$GNRMC,,V,,,,,,,,,,M*4E +$GNVTG,,,,,,,,,M*2D +$GNZDA,,,,,,*56 +$GPTXT,01,01,01,ANTENNA OPEN*25 +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)。 + +## 原理图 + \ No newline at end of file diff --git a/docs/zh_CN/module/lan.md b/docs/zh_CN/module/lan.md index 2b1238df..aaceaf7d 100644 --- a/docs/zh_CN/module/lan.md +++ b/docs/zh_CN/module/lan.md @@ -1,44 +1,44 @@ -# M5Stack LAN Module - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** - -## Description - -The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports. - -When the speed of our wireless network is so slow that M5Stack Core can not normally connect to the wireless network. -So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem. - - -## Feature - -- W5500 - High-performance ethernet chip -- Less code and Hand-in-hand program experience - -## Include - -- 1x M5Stack LAN Module(including USER-DEFINE 6 PIN and 1 Grove port) -- 1x DIN-RAIL -- 1x STICKER - -## Applications - -- A mini portable Web server - + TCP/UDP Server - + HTTP Server -- A mini portable Web Clinet - + TCP/UDP Clinet - + HTTP Clinet -- SMTP/NTP Server - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** - -- [LAN Info](https://www.u-blox.com/zh/product/neo-m8-series) (LAN) +# M5Stack LAN Module + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** + +## Description + +The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports. + +When the speed of our wireless network is so slow that M5Stack Core can not normally connect to the wireless network. +So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem. + + +## Feature + +- W5500 - High-performance ethernet chip +- Less code and Hand-in-hand program experience + +## Include + +- 1x M5Stack LAN Module(including USER-DEFINE 6 PIN and 1 Grove port) +- 1x DIN-RAIL +- 1x STICKER + +## Applications + +- A mini portable Web server + + TCP/UDP Server + + HTTP Server +- A mini portable Web Clinet + + TCP/UDP Clinet + + HTTP Clinet +- SMTP/NTP Server + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- [LAN Info](https://www.u-blox.com/zh/product/neo-m8-series) (LAN) diff --git a/docs/zh_CN/module/lego_plus.md b/docs/zh_CN/module/lego_plus.md index 5a1bed8f..29236dc5 100644 --- a/docs/zh_CN/module/lego_plus.md +++ b/docs/zh_CN/module/lego_plus.md @@ -1,32 +1,32 @@ -# LEGO+模块 - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/GPS)**      🛒**[购买链接](https://www.aliexpress.com/store/product/M5Stack-MEGA328-4-DC-10-DC-I2C/3226069_32961587834.html)** - -## 描述 - -LEGO+模块是直流编码电机模块，内置MEGA328芯片，管理和控制每个DC口电机。LEGO+模块与M5Core之间通过I2C通信，其I2C地址为0x56。 -模块还自带了直流电源接口，如果需要更高的电压输入驱动电机的话，可以接入电源。 - -## 特性 - -- 电源接口输入电压范围：6-12V - -## 包含 - -- 1x LEGO+模块 -- 1x 10cm LEGO线 -- 1x DC接头 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -## 原理图 +# LEGO+模块 + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/GPS)**      🛒**[购买链接](https://www.aliexpress.com/store/product/M5Stack-MEGA328-4-DC-10-DC-I2C/3226069_32961587834.html)** + +## 描述 + +LEGO+模块是直流编码电机模块，内置MEGA328芯片，管理和控制每个DC口电机。LEGO+模块与M5Core之间通过I2C通信，其I2C地址为0x56。 +模块还自带了直流电源接口，如果需要更高的电压输入驱动电机的话，可以接入电源。 + +## 特性 + +- 电源接口输入电压范围：6-12V + +## 包含 + +- 1x LEGO+模块 +- 1x 10cm LEGO线 +- 1x DC接头 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +## 原理图 diff --git a/docs/zh_CN/module/lora.md b/docs/zh_CN/module/lora.md index b9463845..44a9a8cd 100644 --- a/docs/zh_CN/module/lora.md +++ b/docs/zh_CN/module/lora.md @@ -1,86 +1,86 @@ -# LORA模块 - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.70.6c2275f4nUJEfh&id=559302217850)** - -## 描述 - -LoRa模块是内置名为Ra-02的LoRa小模组的M5Stack系列LoRa模块。堆叠了M5Core之后，你可以用UiFlow、Arduino和MicroPython来编程它。 - -M5Stack LoRa模块适用于长距离通信，结合多个LoRa模块，能组成长达1-2公里的物联网低功耗通信网络。它克服了传统物联网通信中长距离可是高功耗的难点。与蓝牙WIFI等通信技术相互弥补。 - -## 特性 - -- LoRa模块型号RA-02 -- 支持FSK, GFSK, MSK, GMSK调制解调制式 -- 长距离低功耗 -- 内置天线 - -## 包含 - -- 1x M5Stack LoRa模块 - -## 应用 - -- 自动抄表系统 -- 楼宇自动化 -- 远程灌溉系统 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **[LoRa模块信息](http://wiki.ai-thinker.com/lora) (LoRa)** - -?> **Note** 如果堆叠了LoRa模块之后，上电，可是M5Core不能正常显示或者有其他显示问题时，建议在`m5.begin();`语句之前加入如下语句 - -```cpp - pinMode(5,OUTPUT); - digitalWrite(5,HIGH); - m5.begin(); -``` -?> **Note** 因为GPIO5连接到LoRa模块的NSS引脚，该引脚在系统上电的时候需要上拉，从而避免LCD不能显示。 - -## 例程 - -### 1. Arduino IDE - -这是主从LORA模块点对点通信的例程，模块与M5Core之间通过AT指令通讯。 - -```c++ -/* -* Master.ino -*/ -Serial2.begin(9600, SERIAL_8N1, 16, 17); - -/* LoRaWAN Init */ -//entry test mode -Serial2.print("AT+Mode=Test"); -//Configure the modem,like Freq, SF, BW, Preamble length, TX output power -Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); -//send data as HEX format -Serial2.print("AT+TEST=TXLRPKT,"00 00 01 00 00 AF 80 07 02 00 00 39""); -``` - -```c++ -/* -* Slaver.ino -*/ -Serial2.begin(9600, SERIAL_8N1, 16, 17); -/* LoRaWAN Init */ -//entry test mode -Serial2.print("AT+Mode=Test"); -//Configure the modem,like Freq, SF, BW, Preamble length -Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); -//allow to receive data -Serial2.print("AT+TEST=RXLRPKT"); -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/LORAWAN/Arduino)。 - -## 原理图 +# LORA模块 + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.70.6c2275f4nUJEfh&id=559302217850)** + +## 描述 + +LoRa模块是内置名为Ra-02的LoRa小模组的M5Stack系列LoRa模块。堆叠了M5Core之后，你可以用UiFlow、Arduino和MicroPython来编程它。 + +M5Stack LoRa模块适用于长距离通信，结合多个LoRa模块，能组成长达1-2公里的物联网低功耗通信网络。它克服了传统物联网通信中长距离可是高功耗的难点。与蓝牙WIFI等通信技术相互弥补。 + +## 特性 + +- LoRa模块型号RA-02 +- 支持FSK, GFSK, MSK, GMSK调制解调制式 +- 长距离低功耗 +- 内置天线 + +## 包含 + +- 1x M5Stack LoRa模块 + +## 应用 + +- 自动抄表系统 +- 楼宇自动化 +- 远程灌溉系统 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **[LoRa模块信息](http://wiki.ai-thinker.com/lora) (LoRa)** + +?> **Note** 如果堆叠了LoRa模块之后，上电，可是M5Core不能正常显示或者有其他显示问题时，建议在`m5.begin();`语句之前加入如下语句 + +```cpp + pinMode(5,OUTPUT); + digitalWrite(5,HIGH); + m5.begin(); +``` +?> **Note** 因为GPIO5连接到LoRa模块的NSS引脚，该引脚在系统上电的时候需要上拉，从而避免LCD不能显示。 + +## 例程 + +### 1. Arduino IDE + +这是主从LORA模块点对点通信的例程，模块与M5Core之间通过AT指令通讯。 + +```c++ +/* +* Master.ino +*/ +Serial2.begin(9600, SERIAL_8N1, 16, 17); + +/* LoRaWAN Init */ +//entry test mode +Serial2.print("AT+Mode=Test"); +//Configure the modem,like Freq, SF, BW, Preamble length, TX output power +Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); +//send data as HEX format +Serial2.print("AT+TEST=TXLRPKT,"00 00 01 00 00 AF 80 07 02 00 00 39""); +``` + +```c++ +/* +* Slaver.ino +*/ +Serial2.begin(9600, SERIAL_8N1, 16, 17); +/* LoRaWAN Init */ +//entry test mode +Serial2.print("AT+Mode=Test"); +//Configure the modem,like Freq, SF, BW, Preamble length +Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); +//allow to receive data +Serial2.print("AT+TEST=RXLRPKT"); +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/LORAWAN/Arduino)。 + +## 原理图 diff --git a/docs/zh_CN/module/lorawan.md b/docs/zh_CN/module/lorawan.md index e3b58777..5c1e2659 100644 --- a/docs/zh_CN/module/lorawan.md +++ b/docs/zh_CN/module/lorawan.md @@ -1,55 +1,55 @@ -# LoRaWAN - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.61.6c2275f4nUJEfh&id=580998112819)** - -## 描述 - -LoRaWAN是一个内置了LoRaWAN模块的M5模块，LoRaWAN模块主要由LoRa芯片(SX1276)和ST的MCU组成，集成了完整的LoRa协议栈。 所以，在使用这个高集成度模块的时候，你可以直接将它与M5Core堆叠，通过串口发送AT命令就可以开发它，比如配置串口信息、配置射频信息(频率、带宽、发送功率等)、发送信息的内容等等。 - -LoRaWAN默认的串口配置： -波特率：9600；8位数据位；无奇偶校验；1位停止位。 - -?> **注意** 丝印"LoRaWAN"底下的5个孔是专门预留用于升级LoRaWAN模块固件。 - -## 特性 - -- 支持频段： 433/470MHz and 868/915MHz -- 支持数据率范围： 0.018-38.4kbps -- 输出功率: 17 ± 0.5dbm -- 支持 ADR(自适应数据速率) -- 内置天线 - -## 包含 - -- 1x LoRa Module - -## 应用 - -- 自动远程抄表 -- 智能交通智能停车场 -- 远程灌溉及环境监测 - -## 管脚映射 - -| *RHF76-052_UART* | *ESP32 Chip* | -| :----------: |:------------: | -| RXD | GPIO17 | -| TXD | GPIO16 | - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **[LoRaWAN模组信息](http://wiki.ai-thinker.com/sx127x-052) (LoRaWAN)** - -- **[LoRaWAN的AT指令集](http://wiki.ai-thinker.com/_media/rhf-ps01509_lorawan_class_ac_at_command_specification_-_v4.4.pdf)** - -## 例程 - +# LoRaWAN + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.61.6c2275f4nUJEfh&id=580998112819)** + +## 描述 + +LoRaWAN是一个内置了LoRaWAN模块的M5模块，LoRaWAN模块主要由LoRa芯片(SX1276)和ST的MCU组成，集成了完整的LoRa协议栈。 所以，在使用这个高集成度模块的时候，你可以直接将它与M5Core堆叠，通过串口发送AT命令就可以开发它，比如配置串口信息、配置射频信息(频率、带宽、发送功率等)、发送信息的内容等等。 + +LoRaWAN默认的串口配置： +波特率：9600；8位数据位；无奇偶校验；1位停止位。 + +?> **注意** 丝印"LoRaWAN"底下的5个孔是专门预留用于升级LoRaWAN模块固件。 + +## 特性 + +- 支持频段： 433/470MHz and 868/915MHz +- 支持数据率范围： 0.018-38.4kbps +- 输出功率: 17 ± 0.5dbm +- 支持 ADR(自适应数据速率) +- 内置天线 + +## 包含 + +- 1x LoRa Module + +## 应用 + +- 自动远程抄表 +- 智能交通智能停车场 +- 远程灌溉及环境监测 + +## 管脚映射 + +| *RHF76-052_UART* | *ESP32 Chip* | +| :----------: |:------------: | +| RXD | GPIO17 | +| TXD | GPIO16 | + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **[LoRaWAN模组信息](http://wiki.ai-thinker.com/sx127x-052) (LoRaWAN)** + +- **[LoRaWAN的AT指令集](http://wiki.ai-thinker.com/_media/rhf-ps01509_lorawan_class_ac_at_command_specification_-_v4.4.pdf)** + +## 例程 + ## 原理图 \ No newline at end of file diff --git a/docs/zh_CN/module/plc.md b/docs/zh_CN/module/plc.md index 95ef4cc6..92fbea37 100644 --- a/docs/zh_CN/module/plc.md +++ b/docs/zh_CN/module/plc.md @@ -1,48 +1,48 @@ -# M5Stack PLC Module - - - -*** - -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-PLC-Proto-Industrial-Board-Module-Contains-RS485-ACS712-5B-Programmable-Logic-Controller-Relay-with-Magnet/3226069_32874916056.html?spm=2114.12010615.8148356.2.4c5b68a1WZ8sjd)** - -## Description - -The M5Stack PLC Module is a prototye industrial board, including RS484 -adapter and electricity meter module. - -With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin -relay output, digital input, communication interface etc. - -## Feature - -- Free DIY -- Programmable Logic Controller -- Individual package weight: 0.1kg (0.22lb.) -- Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) - -## Include - -- 1x PLC-Proto Broad -- 1x RS485 module -- 1x PLC Plastic Enclosure -- 1x Slide Guide -- 1x Magnet -- 1x 6 Pin 3.96 Pitch Terminal -- 1x 4 Pin 3.96 Pitch Terminal -- 3x Hex Key -- 7x Electrical Terminal -- 1x Sticker - -## Applications - -- Programmable Logic Controller -- Programmable Motion Controller -- Digital Operation Processor -- Strong Electric Controller - -## Related Link - -- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[Forum](http://forum.m5stack.com/)** +# M5Stack PLC Module + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-PLC-Proto-Industrial-Board-Module-Contains-RS485-ACS712-5B-Programmable-Logic-Controller-Relay-with-Magnet/3226069_32874916056.html?spm=2114.12010615.8148356.2.4c5b68a1WZ8sjd)** + +## Description + +The M5Stack PLC Module is a prototye industrial board, including RS484 +adapter and electricity meter module. + +With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin +relay output, digital input, communication interface etc. + +## Feature + +- Free DIY +- Programmable Logic Controller +- Individual package weight: 0.1kg (0.22lb.) +- Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) + +## Include + +- 1x PLC-Proto Broad +- 1x RS485 module +- 1x PLC Plastic Enclosure +- 1x Slide Guide +- 1x Magnet +- 1x 6 Pin 3.96 Pitch Terminal +- 1x 4 Pin 3.96 Pitch Terminal +- 3x Hex Key +- 7x Electrical Terminal +- 1x Sticker + +## Applications + +- Programmable Logic Controller +- Programmable Motion Controller +- Digital Operation Processor +- Strong Electric Controller + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/zh_CN/module/plus.md b/docs/zh_CN/module/plus.md index 9345b535..95ebe986 100644 --- a/docs/zh_CN/module/plus.md +++ b/docs/zh_CN/module/plus.md @@ -1,53 +1,53 @@ -# PLUS模块 - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#原理图)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.6e32425el3pHvc&id=579821616764)** - -## 描述 - -Plus是一个增强型模块，内置了500mAh的电池、齿轮电位器(encoder)、IR发送器、麦克风焊盘、PORT B(GPIO Port)和PORT C(UART Port)。你可以把它与M5Core堆叠在一起，增强M5Core的增能，Plus模块与M5Core通过I2C通信。I2C地址是0x62。 - -## 特性 - -- 500mAh锂电池 -- 可编程的齿轮电位器，可以前后旋动和单击 -- 支持红外发送 -- 包含PORT B和PORT C - -## 包含 - -- 1x PLUS模块 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -/* -* 读取齿轮电位器的数据 -*/ -Wire.requestFrom(0x62, 2); - -if(Wire.available()) { - encode = Wire.read();//read value of encoder - if(press_n == 0xff) { - pressed = 0;//button released - } - else { - pressed = 1;//button pressed - } -} -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/PLUS/Arduino)。 - -## 原理图 +# PLUS模块 + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#原理图)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.6e32425el3pHvc&id=579821616764)** + +## 描述 + +Plus是一个增强型模块，内置了500mAh的电池、齿轮电位器(encoder)、IR发送器、麦克风焊盘、PORT B(GPIO Port)和PORT C(UART Port)。你可以把它与M5Core堆叠在一起，增强M5Core的增能，Plus模块与M5Core通过I2C通信。I2C地址是0x62。 + +## 特性 + +- 500mAh锂电池 +- 可编程的齿轮电位器，可以前后旋动和单击 +- 支持红外发送 +- 包含PORT B和PORT C + +## 包含 + +- 1x PLUS模块 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +/* +* 读取齿轮电位器的数据 +*/ +Wire.requestFrom(0x62, 2); + +if(Wire.available()) { + encode = Wire.read();//read value of encoder + if(press_n == 0xff) { + pressed = 0;//button released + } + else { + pressed = 1;//button pressed + } +} +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/PLUS/Arduino)。 + +## 原理图 diff --git a/docs/zh_CN/module/proto.md b/docs/zh_CN/module/proto.md index 332bb47f..8366a012 100644 --- a/docs/zh_CN/module/proto.md +++ b/docs/zh_CN/module/proto.md @@ -1,50 +1,50 @@ -# PROTO模块 - - - -*** - -:memo:**[描述](#描述)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.19.6c2275f4nUJEfh&id=563688612650)** - -## 描述 - -PROTO模块是一款可以自由焊接元器件的洞洞板模块。如果你需要实现什么M5Stack模块体系没有的电路，可以自行在PROTO模块上焊接相关的元器件，最后还是可以通过堆叠在M5Core主控上，方便控制和打造产品。 - -## 特性 - -- 自由定义的洞洞板 -- 适配M5Core主板 - -## 接口 - -| LINE0 | LINE1 | -|:---:|:---:| -| GND | IO35(ADC1) | -| GND | IO36(ADC2) | -| GND | EN | -| IO23(MOSI) | IO25(DAC0) | -| IO19(MISO) | IO26(DAC1) | -| IO18(EXT\_SCK) | 3V3 | -| IO3(U1\_RX) | IO1(U1\_TX) | -| IO16(U1\_RX) | IO17(U2\_TX) | -| IO21(I2C\_SDA) | IO22(I2C\_SCL) | -| IO2 | IO5 | -| IO12(I2S\_SCLK) | IO13 | -| IO15(I2S\_OUT) | IO0 | -| HPOWR | IO34 | -| HPOWR | 5V | -| HPOWR | BAT | - -## 包含 - -- 1x PROTO模块 -- 1x Bus Socket -- 1x GROVE线 -- 1x 包装盒 -- 用户手册 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** +# PROTO模块 + + + +*** + +:memo:**[描述](#描述)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.19.6c2275f4nUJEfh&id=563688612650)** + +## 描述 + +PROTO模块是一款可以自由焊接元器件的洞洞板模块。如果你需要实现什么M5Stack模块体系没有的电路，可以自行在PROTO模块上焊接相关的元器件，最后还是可以通过堆叠在M5Core主控上，方便控制和打造产品。 + +## 特性 + +- 自由定义的洞洞板 +- 适配M5Core主板 + +## 接口 + +| LINE0 | LINE1 | +|:---:|:---:| +| GND | IO35(ADC1) | +| GND | IO36(ADC2) | +| GND | EN | +| IO23(MOSI) | IO25(DAC0) | +| IO19(MISO) | IO26(DAC1) | +| IO18(EXT\_SCK) | 3V3 | +| IO3(U1\_RX) | IO1(U1\_TX) | +| IO16(U1\_RX) | IO17(U2\_TX) | +| IO21(I2C\_SDA) | IO22(I2C\_SCL) | +| IO2 | IO5 | +| IO12(I2S\_SCLK) | IO13 | +| IO15(I2S\_OUT) | IO0 | +| HPOWR | IO34 | +| HPOWR | 5V | +| HPOWR | BAT | + +## 包含 + +- 1x PROTO模块 +- 1x Bus Socket +- 1x GROVE线 +- 1x 包装盒 +- 用户手册 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** diff --git a/docs/zh_CN/module/servo.md b/docs/zh_CN/module/servo.md index a9346f2d..305e68ce 100644 --- a/docs/zh_CN/module/servo.md +++ b/docs/zh_CN/module/servo.md @@ -1,64 +1,64 @@ -# SERVO - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.6c6f425e2rHsr9&id=581189197514)** - -## 描述 - -Servo是一个普通舵机(比如常见的9g舵机)驱动模块，它理论上可以同时驱动12路舵机。可是实际测试中，因为同时带动12路舵机时，电流很大，所以这个模块暂时能同时驱动9路舵机。过段时间，我们会推出改进升级版本，敬请期待。 - -Servo模块使用起来非常简单，因为内置了MEGA328芯片来管理多路舵机，所以使用的时候，只需要M5Core与Servo模块堆叠之后，通过GRVOE接口(I2C)通信(I2C地址是0x53)。编程时，在Arduino IDE环境下，也只需2-3行即可驱动。而且还支持UiFlow编程，只需要拖拽代码块即可使用。 - -## 特性 - -- 支持同时控制多路舵机 -- 支持6-24V的宽电压范围输入 -- 支持Arduino和UiFlow编程，非常简单 - -## 包含 - -- 1x M5Stack Servo Module -- 1x 电源适配接口 - -## 应用 - -- 人形机器人 -- 仿生多关节机器人 -- 3轴舵机云台 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -#define SERVO_ADDR 0x53 //the IIC address of SERVO Module -/* - * control servo(CH channle) by us - */ -Wire.beginTransmission(SERVO_ADDR); -Wire.write(CH|0x00); -Wire.write(timeL); -Wire.write(timeH); -Wire.endTransmission(); - -/* - * control servo(CH channle) by angle - */ -Wire.beginTransmission(SERVO_ADDR); -Wire.write(CH|0x10); -Wire.write(angle);//0-180° -Wire.endTransmission(); -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/SERVO/Arduino)。 - +# SERVO + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.6c6f425e2rHsr9&id=581189197514)** + +## 描述 + +Servo是一个普通舵机(比如常见的9g舵机)驱动模块，它理论上可以同时驱动12路舵机。可是实际测试中，因为同时带动12路舵机时，电流很大，所以这个模块暂时能同时驱动9路舵机。过段时间，我们会推出改进升级版本，敬请期待。 + +Servo模块使用起来非常简单，因为内置了MEGA328芯片来管理多路舵机，所以使用的时候，只需要M5Core与Servo模块堆叠之后，通过GRVOE接口(I2C)通信(I2C地址是0x53)。编程时，在Arduino IDE环境下，也只需2-3行即可驱动。而且还支持UiFlow编程，只需要拖拽代码块即可使用。 + +## 特性 + +- 支持同时控制多路舵机 +- 支持6-24V的宽电压范围输入 +- 支持Arduino和UiFlow编程，非常简单 + +## 包含 + +- 1x M5Stack Servo Module +- 1x 电源适配接口 + +## 应用 + +- 人形机器人 +- 仿生多关节机器人 +- 3轴舵机云台 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +#define SERVO_ADDR 0x53 //the IIC address of SERVO Module +/* + * control servo(CH channle) by us + */ +Wire.beginTransmission(SERVO_ADDR); +Wire.write(CH|0x00); +Wire.write(timeL); +Wire.write(timeH); +Wire.endTransmission(); + +/* + * control servo(CH channle) by angle + */ +Wire.beginTransmission(SERVO_ADDR); +Wire.write(CH|0x10); +Wire.write(angle);//0-180° +Wire.endTransmission(); +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/SERVO/Arduino)。 + ## 原理图 \ No newline at end of file diff --git a/docs/zh_CN/module/sim800.md b/docs/zh_CN/module/sim800.md index 6d994596..e0e8aae5 100644 --- a/docs/zh_CN/module/sim800.md +++ b/docs/zh_CN/module/sim800.md @@ -1,75 +1,75 @@ -# M5Stack SIM800L Module - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.1c03425emPA4gi&id=559726007780)** - -## 描述 - -SIM800L模块是一款内置了SIM800L GSM/GPRS小模块的M5Stack可堆叠模块堆叠了M5Core之后，你可以用UiFlow、Arduino和MicroPython来编程它。 - -SIM800L是完整的支持四种频宽的GSM/GPRS解决方案。通过串口发送AT支持来控制SIM800模块 - -## 特性 - -- 内置SIM800L模块和天线 -- 3.5 mm耳机插孔和麦克风(麦克风位置需要用户自行焊接O欧姆电阻来使能) -- Parameter: -- GSM/GPRS -- 支持频宽：850/900/1800/1900MHz - -## 管脚映射 - -*SIM800与M5Core堆叠之后，它们之间通过UART2通信* - -**SIM800** - -| SIM800 Pin | ESP32 Chip | -| :----------: |:------------: | -| TXD | U2RXD(GPIO16) | -| RXD | U2TXD(GPIO17) | -| RST | GPIO5 | - - -## 包含 - -- 1x SIM800L模块 - -## 应用 - -- 二氧化氮报警器 -- 带短信通知的网页爬虫系统 -- 远程抄表系统 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **[SIM800L信息](http://simcomm2m.com/En/module/detail.aspx?id=138)** (SIM800L) - -## 例程 - -### 1. Arduino IDE - -这是通过串口显示终端发送命令来实现SIM800模块发短信的例程。 - -```c++ -/* -* Master.ino -*/ -Serial2.begin(9600, SERIAL_8N1, 16, 17); - -/* LoRaWAN Init */ -//entry test mode -Serial2.print("AT+Mode=Test"); -//Configure the modem,like Freq, SF, BW, Preamble length, TX output power -Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); -//send data as HEX format -Serial2.print("AT+TEST=TXLRPKT,"00 00 01 00 00 AF 80 07 02 00 00 39""); -``` - +# M5Stack SIM800L Module + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.1c03425emPA4gi&id=559726007780)** + +## 描述 + +SIM800L模块是一款内置了SIM800L GSM/GPRS小模块的M5Stack可堆叠模块堆叠了M5Core之后，你可以用UiFlow、Arduino和MicroPython来编程它。 + +SIM800L是完整的支持四种频宽的GSM/GPRS解决方案。通过串口发送AT支持来控制SIM800模块 + +## 特性 + +- 内置SIM800L模块和天线 +- 3.5 mm耳机插孔和麦克风(麦克风位置需要用户自行焊接O欧姆电阻来使能) +- Parameter: +- GSM/GPRS +- 支持频宽：850/900/1800/1900MHz + +## 管脚映射 + +*SIM800与M5Core堆叠之后，它们之间通过UART2通信* + +**SIM800** + +| SIM800 Pin | ESP32 Chip | +| :----------: |:------------: | +| TXD | U2RXD(GPIO16) | +| RXD | U2TXD(GPIO17) | +| RST | GPIO5 | + + +## 包含 + +- 1x SIM800L模块 + +## 应用 + +- 二氧化氮报警器 +- 带短信通知的网页爬虫系统 +- 远程抄表系统 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **[SIM800L信息](http://simcomm2m.com/En/module/detail.aspx?id=138)** (SIM800L) + +## 例程 + +### 1. Arduino IDE + +这是通过串口显示终端发送命令来实现SIM800模块发短信的例程。 + +```c++ +/* +* Master.ino +*/ +Serial2.begin(9600, SERIAL_8N1, 16, 17); + +/* LoRaWAN Init */ +//entry test mode +Serial2.print("AT+Mode=Test"); +//Configure the modem,like Freq, SF, BW, Preamble length, TX output power +Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); +//send data as HEX format +Serial2.print("AT+TEST=TXLRPKT,"00 00 01 00 00 AF 80 07 02 00 00 39""); +``` + ## 原理图 \ No newline at end of file diff --git a/docs/zh_CN/module/stepmotor.md b/docs/zh_CN/module/stepmotor.md index 92eb0c3f..65f1d02f 100644 --- a/docs/zh_CN/module/stepmotor.md +++ b/docs/zh_CN/module/stepmotor.md @@ -1,40 +1,40 @@ -# Step Motor Module - - - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.61.501375f4xEgd84&id=572288296141)** - -## 描述 - -StepMotor驱动模块内置了MEGA328P芯片，该MEGA328芯片烧录了GRBL固件，从而可以通过GRBL固件来稳定控制步进电机。该模块通过GROVE接口(I2C)与M5Core通信。I2C地址是0x70。 - -## 特性 - -- 9-24V电源输入 -- 控制3路步进电机(X, Y, Z) -- 内置锂电池 - -## 包含 - -- 1x Step Motor模块 -- 12V电源 -- 1x 5V 风扇扇热模块 - -## 应用 - -- DIY 3D 打印机 -- 搭建机械臂 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -## 原理图 +# Step Motor Module + + + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.61.501375f4xEgd84&id=572288296141)** + +## 描述 + +StepMotor驱动模块内置了MEGA328P芯片，该MEGA328芯片烧录了GRBL固件，从而可以通过GRBL固件来稳定控制步进电机。该模块通过GROVE接口(I2C)与M5Core通信。I2C地址是0x70。 + +## 特性 + +- 9-24V电源输入 +- 控制3路步进电机(X, Y, Z) +- 内置锂电池 + +## 包含 + +- 1x Step Motor模块 +- 12V电源 +- 1x 5V 风扇扇热模块 + +## 应用 + +- DIY 3D 打印机 +- 搭建机械臂 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +## 原理图 diff --git a/docs/zh_CN/module/usb.md b/docs/zh_CN/module/usb.md index 8020692a..6d06461b 100644 --- a/docs/zh_CN/module/usb.md +++ b/docs/zh_CN/module/usb.md @@ -1,40 +1,40 @@ -# USB - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.1dbd425eDUpt0Z&id=583599151180)** - -## 描述 - -USB模块是一款USB控制器，内置了USB芯片MAX3421E。堆叠了M5Core之后，通过通信速率可高达26MHz的SPI接口与M5Core连接，即可作USB外设又可作USB主机。 - -## 特性 - -- 高达26MHz的SPI接口 -- 8路GPIO输入输出 -- 内置锂电池接口 - -## 包含 - -- 1x USB模块 - -## 应用 - -- USB键盘记录器 -- M5Core读写U盘 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **[数据手册](https://www.sparkfun.com/datasheets/DevTools/Arduino/MAX3421E.pdf)** (MAX3421E) - -## 例程 - -## 原理图 - +# USB + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.1dbd425eDUpt0Z&id=583599151180)** + +## 描述 + +USB模块是一款USB控制器，内置了USB芯片MAX3421E。堆叠了M5Core之后，通过通信速率可高达26MHz的SPI接口与M5Core连接，即可作USB外设又可作USB主机。 + +## 特性 + +- 高达26MHz的SPI接口 +- 8路GPIO输入输出 +- 内置锂电池接口 + +## 包含 + +- 1x USB模块 + +## 应用 + +- USB键盘记录器 +- M5Core读写U盘 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **[数据手册](https://www.sparkfun.com/datasheets/DevTools/Arduino/MAX3421E.pdf)** (MAX3421E) + +## 例程 + +## 原理图 + \ No newline at end of file diff --git a/docs/zh_CN/qs.md b/docs/zh_CN/qs.md index d9b131d4..1e843df0 100644 --- a/docs/zh_CN/qs.md +++ b/docs/zh_CN/qs.md @@ -1,15 +1,15 @@ -# 快速上手(Quick Start) - -*这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。* - - | ----|--- -[M5StackCore](/zh_CN/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/zh_CN/quick_start/m5camera/m5camera_quick_start) - - +# 快速上手(Quick Start) + +*这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。* + + | +---|--- +[M5StackCore](/zh_CN/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/zh_CN/quick_start/m5camera/m5camera_quick_start) + + diff --git a/docs/zh_CN/quick_start/bala/bala_quick_start.md b/docs/zh_CN/quick_start/bala/bala_quick_start.md index 8d37e7ca..942a2e27 100644 --- a/docs/zh_CN/quick_start/bala/bala_quick_start.md +++ b/docs/zh_CN/quick_start/bala/bala_quick_start.md @@ -1,142 +1,142 @@ -# BALA 上手指南 - -中文 | [English](en/quick_start/bala/bala_quick_start) | [日本語](ja/quick_start/bala/bala_quick_start) - -!>为了使用M5Bala，需要M5Stack FIRE或M5GO（白色）。 - -## 准备 - -- 安装串行驱动程序 - [如何安装USB驱动并建立与PC的串口通讯](/zh_CN/related_documents/establish_serial_connection) - -## 开发环境 - -1. [UiFlow编辑](#UiFlow编辑) -2. [Arduino IDE编辑](#Arduino-IDE编辑) - -## UIFlow编辑 - -1. 烧录UiFlow的固件 - [如何通过M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware) -2. WiFi链接 - [如何使用M5Core连接可联网的WiFi热点](/zh_CN/related_documents/how_to_connect_wifi_using_core) -3. 检查弹簧针的位置，并将M5Core堆叠在M5Bala上 -
- -
- -4. 按M5Core旁边的红色按钮启动（连续点击两次时关闭电源） -
- -
- -1. 按M5Bala旁边的按钮启动（连续点击两次时关闭电源） -
- -
-
- -
- -6. 转到[UiFlow](http://flow.m5stack.com/)网站并将模式从Blockly切换到Python -
- -
- -7. 粘贴以下代码并执行它以平衡 - -```python -from m5stack import * -from m5ui import * -from m5bala import M5Bala -import i2c_bus -clear_bg(0x111111) - -m5bala = M5Bala(i2c_bus.get(i2c_bus.M_BUS)) -btnA = M5Button(name="ButtonA", text="ButtonA", visibility=False) -btnB = M5Button(name="ButtonB", text="ButtonB", visibility=False) -btnC = M5Button(name="ButtonC", text="ButtonC", visibility=False) -title0 = M5Title(title="Title", fgcolor=0xFFFFFF, bgcolor=0x0000FF) - -title0.setTitle('calirate start') -wait(2) -sampleCount = 2000 -gyroXSum = 0 -gyroYSum = 0 -gyroZSum = 0 - -for _ in range(sampleCount): - gyroXYZ = m5bala.imu.gyro - gyroXSum += gyroXYZ[0] # X - gyroYSum += gyroXYZ[1] # Y - gyroZSum += gyroXYZ[2] # Z - -gyroXMean = gyroXSum / sampleCount -gyroYMean = gyroYSum / sampleCount -gyroZMean = gyroZSum / sampleCount - -m5bala.imu.setGyroOffsets(gyroXMean, gyroYMean, gyroZMean) - -title0.setTitle('balance start') -while True: - m5bala.balance() - wait(0.001) -``` - -## Arduino IDE编辑 - -1. 安装Arduino IDE -2. 在Arduino IDE的设置board manager附加网址加`https://dl.espressif.com/dl/package_esp32_index.json` -
- -
-
- -
- -1. 在Arduino IDE的板管理安装`esp32`库 -
- -
- -1. 在Arduino IDE的库管理安装`m5stack`库 -
- -
- -5. 在Arduino IDE的库管理安装`NeoPixelBus`库 -
- -
- -1. 在Arduino IDE的库管理安装`MPU6050_tockn`库 -
- -
- -7. 确保M5Core连接到PC，然后从`工具 - >串行端口`中选择适当的串行端口 -8. 同样选择`M5Stack-Core-ESP32`或`M5Stack-Fire`板 -9. 下载[M5Bala](https://github.com/m5stack/M5Bala.git)如果你不能使用Git，请从[这里](https://git-scm.com/download/win)安装 -```shell -git clone --recursive https://github.com/m5stack/M5Bala.git -``` -10. 在Arduino IDE上创建一个新文件，然后复制并粘贴`M5Bala/src/Default_firmware.ino`的内容 -
- -
- -11. 在`Default_firmware.ino`的第89行注释掉`M5.setPowerBoostKeepOn(false);` -
- -
- -12. 创建一个新选项卡，并以相同的方式复制和粘贴`M5Bala/src/M5Bala.cpp`的内容 -
- -
-
- -
- -13. 创建一个新选项卡，并以相同的方式复制和粘贴`M5Bala/src/M5Bala.h`的内容 -14. 最后执行 -
- +# BALA 上手指南 + +中文 | [English](en/quick_start/bala/bala_quick_start) | [日本語](ja/quick_start/bala/bala_quick_start) + +!>为了使用M5Bala，需要M5Stack FIRE或M5GO（白色）。 + +## 准备 + +- 安装串行驱动程序 - [如何安装USB驱动并建立与PC的串口通讯](/zh_CN/related_documents/establish_serial_connection) + +## 开发环境 + +1. [UiFlow编辑](#UiFlow编辑) +2. [Arduino IDE编辑](#Arduino-IDE编辑) + +## UIFlow编辑 + +1. 烧录UiFlow的固件 - [如何通过M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware) +2. WiFi链接 - [如何使用M5Core连接可联网的WiFi热点](/zh_CN/related_documents/how_to_connect_wifi_using_core) +3. 检查弹簧针的位置，并将M5Core堆叠在M5Bala上 +
+ +
+ +4. 按M5Core旁边的红色按钮启动（连续点击两次时关闭电源） +
+ +
+ +1. 按M5Bala旁边的按钮启动（连续点击两次时关闭电源） +
+ +
+
+ +
+ +6. 转到[UiFlow](http://flow.m5stack.com/)网站并将模式从Blockly切换到Python +
+ +
+ +7. 粘贴以下代码并执行它以平衡 + +```python +from m5stack import * +from m5ui import * +from m5bala import M5Bala +import i2c_bus +clear_bg(0x111111) + +m5bala = M5Bala(i2c_bus.get(i2c_bus.M_BUS)) +btnA = M5Button(name="ButtonA", text="ButtonA", visibility=False) +btnB = M5Button(name="ButtonB", text="ButtonB", visibility=False) +btnC = M5Button(name="ButtonC", text="ButtonC", visibility=False) +title0 = M5Title(title="Title", fgcolor=0xFFFFFF, bgcolor=0x0000FF) + +title0.setTitle('calirate start') +wait(2) +sampleCount = 2000 +gyroXSum = 0 +gyroYSum = 0 +gyroZSum = 0 + +for _ in range(sampleCount): + gyroXYZ = m5bala.imu.gyro + gyroXSum += gyroXYZ[0] # X + gyroYSum += gyroXYZ[1] # Y + gyroZSum += gyroXYZ[2] # Z + +gyroXMean = gyroXSum / sampleCount +gyroYMean = gyroYSum / sampleCount +gyroZMean = gyroZSum / sampleCount + +m5bala.imu.setGyroOffsets(gyroXMean, gyroYMean, gyroZMean) + +title0.setTitle('balance start') +while True: + m5bala.balance() + wait(0.001) +``` + +## Arduino IDE编辑 + +1. 安装Arduino IDE +2. 在Arduino IDE的设置board manager附加网址加`https://dl.espressif.com/dl/package_esp32_index.json` +
+ +
+
+ +
+ +1. 在Arduino IDE的板管理安装`esp32`库 +
+ +
+ +1. 在Arduino IDE的库管理安装`m5stack`库 +
+ +
+ +5. 在Arduino IDE的库管理安装`NeoPixelBus`库 +
+ +
+ +1. 在Arduino IDE的库管理安装`MPU6050_tockn`库 +
+ +
+ +7. 确保M5Core连接到PC，然后从`工具 - >串行端口`中选择适当的串行端口 +8. 同样选择`M5Stack-Core-ESP32`或`M5Stack-Fire`板 +9. 下载[M5Bala](https://github.com/m5stack/M5Bala.git)如果你不能使用Git，请从[这里](https://git-scm.com/download/win)安装 +```shell +git clone --recursive https://github.com/m5stack/M5Bala.git +``` +10. 在Arduino IDE上创建一个新文件，然后复制并粘贴`M5Bala/src/Default_firmware.ino`的内容 +
+ +
+ +11. 在`Default_firmware.ino`的第89行注释掉`M5.setPowerBoostKeepOn(false);` +
+ +
+ +12. 创建一个新选项卡，并以相同的方式复制和粘贴`M5Bala/src/M5Bala.cpp`的内容 +
+ +
+
+ +
+ +13. 创建一个新选项卡，并以相同的方式复制和粘贴`M5Bala/src/M5Bala.h`的内容 +14. 最后执行 +
+
\ No newline at end of file diff --git a/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md index 0cc6b499..36a2c068 100644 --- a/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md @@ -1,47 +1,47 @@ -# 烧录GameBoy游戏 - -中文 | [English](en/quick_start/faces/gameboy_burn_a_nes_game) | [日本語](ja/quick_start/faces/gameboy_burn_a_nes_game) - -*这篇文档将引导你如何烧录游戏模拟器，并烧录想用的经典游戏，这样你就可以使用FACES Kit来玩GameBoy游戏。* - -## 目录 - -1. [下载固件](#1-download-firmware) - -2. [烧录固件和游戏文件](#2-burn-Game-file) - -3. [重启FACES](#3-reset-you-device) - -## 1. 下载固件 - -下载Gameboy模拟器，固件名为`firmware.zip`，下载地址：[Github](https://github.com/m5stack/M5Stack-nesemu)， 然后解压`firmware.zip`(*包括启动文件bootloader.bin,分区表文件, 模拟器文件, 游戏文件SuperMario*)。 - -
- -
- -
- -
- -## 2. 烧录固件和游戏文件 - -打开乐鑫提供的烧录工具[Flash Download Tools](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar)，选择 `ESP32 DownloadTool` 选项，选择`firmware.zip`解压后的四个文件，并执行如下图的**步骤2-4**( *选择正确的串口号，擦除flash和烧录固件* ) - -
- -
- -
- -
- -## 3. 重启FACES - -重启FACES之后，这时候就可以玩游戏啦。 - -
- -
- -?> Tip *如果你想换另一个游戏，只需替换**游戏文件**，再用以上工具烧录即可。注意是要使用NES格式的游戏文件。** +# 烧录GameBoy游戏 + +中文 | [English](en/quick_start/faces/gameboy_burn_a_nes_game) | [日本語](ja/quick_start/faces/gameboy_burn_a_nes_game) + +*这篇文档将引导你如何烧录游戏模拟器，并烧录想用的经典游戏，这样你就可以使用FACES Kit来玩GameBoy游戏。* + +## 目录 + +1. [下载固件](#1-download-firmware) + +2. [烧录固件和游戏文件](#2-burn-Game-file) + +3. [重启FACES](#3-reset-you-device) + +## 1. 下载固件 + +下载Gameboy模拟器，固件名为`firmware.zip`，下载地址：[Github](https://github.com/m5stack/M5Stack-nesemu)， 然后解压`firmware.zip`(*包括启动文件bootloader.bin,分区表文件, 模拟器文件, 游戏文件SuperMario*)。 + +
+ +
+ +
+ +
+ +## 2. 烧录固件和游戏文件 + +打开乐鑫提供的烧录工具[Flash Download Tools](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar)，选择 `ESP32 DownloadTool` 选项，选择`firmware.zip`解压后的四个文件，并执行如下图的**步骤2-4**( *选择正确的串口号，擦除flash和烧录固件* ) + +
+ +
+ +
+ +
+ +## 3. 重启FACES + +重启FACES之后，这时候就可以玩游戏啦。 + +
+ +
+ +?> Tip *如果你想换另一个游戏，只需替换**游戏文件**，再用以上工具烧录即可。注意是要使用NES格式的游戏文件。** diff --git a/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md b/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md index cdd75db2..06d04ff9 100644 --- a/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md +++ b/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md @@ -1,33 +1,33 @@ -# ESP32Cam/M5Camera Quick Start - -中文 | [English](en/quick_start/m5camera/m5camera_quick_start) | [日本語](ja/quick_start/m5camera/m5camera_quick_start) - -## 1. 开箱即用的Demo - -*这是一个开箱即用的例程，摄像头模块预置了这个例程。* - -*如果你拿到摄像头模块之后，不需要写任何代码即可能看到摄像头拍摄的图像。* - -1. 向ESP32Cam/M5Camera插入USB线以供电，然后打开电脑的串口终端。 - -
- -
- - -2. 等待几秒之后，用电脑连接名为`M5CAM`的热点。 - -
- -
- - -3. 打开浏览器，访问网址`http://192.168.4.1`。 此时，即可看到ESP32Cam/M5Camera实时传输的图像。 - -
- -
- -*注意:* - +# ESP32Cam/M5Camera Quick Start + +中文 | [English](en/quick_start/m5camera/m5camera_quick_start) | [日本語](ja/quick_start/m5camera/m5camera_quick_start) + +## 1. 开箱即用的Demo + +*这是一个开箱即用的例程，摄像头模块预置了这个例程。* + +*如果你拿到摄像头模块之后，不需要写任何代码即可能看到摄像头拍摄的图像。* + +1. 向ESP32Cam/M5Camera插入USB线以供电，然后打开电脑的串口终端。 + +
+ +
+ + +2. 等待几秒之后，用电脑连接名为`M5CAM`的热点。 + +
+ +
+ + +3. 打开浏览器，访问网址`http://192.168.4.1`。 此时，即可看到ESP32Cam/M5Camera实时传输的图像。 + +
+ +
+ +*注意:* + ESP32CAM的热点一次只能连接一台电脑 \ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index af0d633a..da99d4ea 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,126 +1,126 @@ - -# M5Core 上手指南(macOS, Arudino) - -?> 如果你的操作系统是Windows，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows)。 - -!> 在配置环境之前，先确保你已经安装了USB驱动，并且M5Core能通过串口与PC通信。 如果还没的话，看这篇文章[如何建立串口连接](zh_CN/related_documents/establish_serial_connection). - -## 目录 - -1. [配置环境](#配置环境) - - - [Step1. 安装Arduino IDE](#Step1-安装arduino-ide) - - - [Step2. 安装ESP32的支持包](#Step2-安装ESP32的支持包) - - - [Step3. 安装Arduino-M5Stack库](#Step3-安装arduino-m5stack库) - -2. [示例](#示例) - -## 配置环境 - -### Step1. 安装Arduino IDE - -首先，如果Arduino IDE还没安装的话，先安装它。 这是下载地址 *download address* https://www.arduino.cc/en/Main/Software - -
- -
- -### Step2. 安装ESP32的支持包 - -打开终端Terminal执行以下命令 (复制以下命令到Terminal，然后回车): - -``` - -mkdir -p ~/Documents/Arduino/hardware/espressif && \ -cd ~/Documents/Arduino/hardware/espressif && \ -git clone https://github.com/espressif/arduino-esp32.git esp32 && \ -cd esp32 && \ -git submodule update --init --recursive && \ -cd tools && \ -python get.py - -``` - -?> **Tip** 如果你遇到如下错误: `xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),` -`missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, 请在终端输入如下命令`xcode-select --install`并Enter，等`xcode-select`安装好了，重启Arduino IDE。 - - -### Step3. 安装Arduino-M5Stack库 - -打开Arduino IDE, 然后选择`Sketch`->`Include Library`->`Manage Libraries...` - -在搜索框输入`M5Stack`搜索并安装。 - -
- -
- - -
- -
- - - -## 示例 - -用USB线连接M5Core和PC，然后选择PC上正与M5Core连接的串口号。 - -### 1. 选择板子和串口 - -打开Arduino IDE, 并点击`Tools`->`Boards`->`M5Stack-Core-ESP32` - -
- -
- - -点击`Tools` -> `Ports` 以选择合适的串口号 - -
- -
- - -### 2. 选择一个例程 - -点击`File`->`Examples`->`M5Stack`->`Basics` - -选择例程`HelloWorld`. - - -
- -
- - -编译并上传这个例程，然后M5Stack屏幕会显示"Hello World!" - -
- -
- - - -## 注意 - -虽然大多数版本的MacOS系统都没找不到串口号这个问题，可是有些最新版本系统就可能出现这个问题。 -如果真的遇到这个问题了，请连接M5并在`system preferences`中打开`security and privacy`，设置`permit` - -
- -
- - -
- -
- - -
- -
- -?> **如果你想了解更多关于CP2104 USB驱动的资料，请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html + +# M5Core 上手指南(macOS, Arudino) + +?> 如果你的操作系统是Windows，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows)。 + +!> 在配置环境之前，先确保你已经安装了USB驱动，并且M5Core能通过串口与PC通信。 如果还没的话，看这篇文章[如何建立串口连接](zh_CN/related_documents/establish_serial_connection). + +## 目录 + +1. [配置环境](#配置环境) + + - [Step1. 安装Arduino IDE](#Step1-安装arduino-ide) + + - [Step2. 安装ESP32的支持包](#Step2-安装ESP32的支持包) + + - [Step3. 安装Arduino-M5Stack库](#Step3-安装arduino-m5stack库) + +2. [示例](#示例) + +## 配置环境 + +### Step1. 安装Arduino IDE + +首先，如果Arduino IDE还没安装的话，先安装它。 这是下载地址 *download address* https://www.arduino.cc/en/Main/Software + +
+ +
+ +### Step2. 安装ESP32的支持包 + +打开终端Terminal执行以下命令 (复制以下命令到Terminal，然后回车): + +``` + +mkdir -p ~/Documents/Arduino/hardware/espressif && \ +cd ~/Documents/Arduino/hardware/espressif && \ +git clone https://github.com/espressif/arduino-esp32.git esp32 && \ +cd esp32 && \ +git submodule update --init --recursive && \ +cd tools && \ +python get.py + +``` + +?> **Tip** 如果你遇到如下错误: `xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),` +`missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, 请在终端输入如下命令`xcode-select --install`并Enter，等`xcode-select`安装好了，重启Arduino IDE。 + + +### Step3. 安装Arduino-M5Stack库 + +打开Arduino IDE, 然后选择`Sketch`->`Include Library`->`Manage Libraries...` + +在搜索框输入`M5Stack`搜索并安装。 + +
+ +
+ + +
+ +
+ + + +## 示例 + +用USB线连接M5Core和PC，然后选择PC上正与M5Core连接的串口号。 + +### 1. 选择板子和串口 + +打开Arduino IDE, 并点击`Tools`->`Boards`->`M5Stack-Core-ESP32` + +
+ +
+ + +点击`Tools` -> `Ports` 以选择合适的串口号 + +
+ +
+ + +### 2. 选择一个例程 + +点击`File`->`Examples`->`M5Stack`->`Basics` + +选择例程`HelloWorld`. + + +
+ +
+ + +编译并上传这个例程，然后M5Stack屏幕会显示"Hello World!" + +
+ +
+ + + +## 注意 + +虽然大多数版本的MacOS系统都没找不到串口号这个问题，可是有些最新版本系统就可能出现这个问题。 +如果真的遇到这个问题了，请连接M5并在`system preferences`中打开`security and privacy`，设置`permit` + +
+ +
+ + +
+ +
+ + +
+ +
+ +?> **如果你想了解更多关于CP2104 USB驱动的资料，请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index e7061aef..652ce48e 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,104 +1,104 @@ -# M5Core 上手指南(Windows, Arudino) - -?> 如果你的操作系统是MacOS的话，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)。 - -!> 建议你先确认安装了`USB驱动`和`Arduino IDE`。 如果还没的话，阅读这两篇文档[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection)和[安装Arduino IDE](/zh_CN/related_documents/how_to_install_git_and_arduino)。 - -## 目录 - -1. [配置环境](#配置环境) - - - [Step1. 下载Arduino-ESP32的支持包](#Step1-下载Arduino-ESP32的支持包) - - - [Step2. 安装Arduino-M5Stack库](#Step2-安装Arduino-M5Stack库) - -2. [示例](#示例) - - -## 1. 配置环境 - -#### (*仅仅只需两步就能完成安装，并开始开发M5Core啦*) - -### Step1. 下载Arduino-ESP32的支持包 - -打开Arduino IDE，选择`File`->`Peferences`->`Settings` - - - - - -输入最新的ESP32板管理网址 - -目前最新的板管理网址是这个："https://github.com/espressif/arduino-esp32/releases/download/1.0.1-rc1/package_esp32_dev_index.json" - - - -选择`Tools`->`Board:`->`Boards Manager...`，在新弹出的对话框中，输入并搜索`ESP32`，点击`安装` - - - - - -### Step2. 安装Arduino-M5Stack库 - -打开Arduino IDE, 然后选择`Sketch`->`Include Library`->`Manage Libraries...` -搜索`M5Stack`并安装，如下图所示。 - - - - - -!> *如果显示下图这样，表示你需要升级Arduino-M5Stack库* - - - -## 示例 - -这部分是为了验证现在你是否能通过Arduino IDE对M5Core编程。 -现在，用USB线连接M5Core和PC，然后打开Arduino IDE，并选择正确的串口号。这个串口号其实就是连接M5Core的串口号，注意不要选错啦。 - -选择一个example例程，然后上传运行试试。 - -### 1. 运行一个示例程序，比如`FactoryTest.ino` - -选择你板子的名字，波特率和串口号： M5Stack-Core-ESP32, 921600, COM4(你看，像我现在与M5Core相连的串口就是`COM4`，所以我应该选择`COM4`) - - - -选择示例程序`FactoryTest.ino` - - - -点击上传 - - - -### 2. 自己尝试新建一个M5Stack程序 - -打开Arduino IDE，然后新建一个`.ino`后缀的文件，并且重命名它为`my_test.ino` - -复制以下代码到my_test.ino文件中 - -```cpp -#include - -// the setup routine runs once when M5Stack starts up -void setup(){ - - // Initialize the M5Stack object - M5.begin(); - - // LCD display - M5.Lcd.print("Hello World!"); - M5.Lcd.print("M5Stack is running successfully!"); -} - -// the loop routine runs over and over again forever -void loop() { - -} -``` - -编译并上传这个程序，如果成功后，就会看到屏幕上显示"Hello World!" "M5Stack is running successfully!"啦！ - +# M5Core 上手指南(Windows, Arudino) + +?> 如果你的操作系统是MacOS的话，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)。 + +!> 建议你先确认安装了`USB驱动`和`Arduino IDE`。 如果还没的话，阅读这两篇文档[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection)和[安装Arduino IDE](/zh_CN/related_documents/how_to_install_git_and_arduino)。 + +## 目录 + +1. [配置环境](#配置环境) + + - [Step1. 下载Arduino-ESP32的支持包](#Step1-下载Arduino-ESP32的支持包) + + - [Step2. 安装Arduino-M5Stack库](#Step2-安装Arduino-M5Stack库) + +2. [示例](#示例) + + +## 1. 配置环境 + +#### (*仅仅只需两步就能完成安装，并开始开发M5Core啦*) + +### Step1. 下载Arduino-ESP32的支持包 + +打开Arduino IDE，选择`File`->`Peferences`->`Settings` + + + + + +输入最新的ESP32板管理网址 + +目前最新的板管理网址是这个："https://github.com/espressif/arduino-esp32/releases/download/1.0.1-rc1/package_esp32_dev_index.json" + + + +选择`Tools`->`Board:`->`Boards Manager...`，在新弹出的对话框中，输入并搜索`ESP32`，点击`安装` + + + + + +### Step2. 安装Arduino-M5Stack库 + +打开Arduino IDE, 然后选择`Sketch`->`Include Library`->`Manage Libraries...` +搜索`M5Stack`并安装，如下图所示。 + + + + + +!> *如果显示下图这样，表示你需要升级Arduino-M5Stack库* + + + +## 示例 + +这部分是为了验证现在你是否能通过Arduino IDE对M5Core编程。 +现在，用USB线连接M5Core和PC，然后打开Arduino IDE，并选择正确的串口号。这个串口号其实就是连接M5Core的串口号，注意不要选错啦。 + +选择一个example例程，然后上传运行试试。 + +### 1. 运行一个示例程序，比如`FactoryTest.ino` + +选择你板子的名字，波特率和串口号： M5Stack-Core-ESP32, 921600, COM4(你看，像我现在与M5Core相连的串口就是`COM4`，所以我应该选择`COM4`) + + + +选择示例程序`FactoryTest.ino` + + + +点击上传 + + + +### 2. 自己尝试新建一个M5Stack程序 + +打开Arduino IDE，然后新建一个`.ino`后缀的文件，并且重命名它为`my_test.ino` + +复制以下代码到my_test.ino文件中 + +```cpp +#include + +// the setup routine runs once when M5Stack starts up +void setup(){ + + // Initialize the M5Stack object + M5.begin(); + + // LCD display + M5.Lcd.print("Hello World!"); + M5.Lcd.print("M5Stack is running successfully!"); +} + +// the loop routine runs over and over again forever +void loop() { + +} +``` + +编译并上传这个程序，如果成功后，就会看到屏幕上显示"Hello World!" "M5Stack is running successfully!"啦！ + ?> *如果你想升级Arduino-M5Stack库的话，请移步阅读这篇文档[如何升级Arduino-M5Stack库](/zh_CN/related_documents/upgrade_m5stack_lib).* \ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md index 3f854e8e..5ac672eb 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -1,111 +1,111 @@ -# UiFlow 上手指南(Blockly/MicroPython) - -:clapper:**[相关视频](#相关视频)** - -?> a. 如果你的设备还没烧录UiFlow固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). b. 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和UiFlow](/zh_CN/related_documents/how_to_connect_wifi_using_core)。 - -这时候，你的M5Core已经连接到了可联网WIFI热点，如果按下Core上左边的按键`UPLOAD`的话，会如下图显示。如果M5Core开机之后，两三秒内没做操作的话，会自动地显示预置的程序界面。所以最好开机之后，立马按下`upload`按键。 - -
- -
- - -## 目录 - -1. [连接到UiFlow](#连接到UiFlow) - -2. [编程Core](#编程Core) - -3. [音乐例程](#音乐例程) - - -## 连接到UiFlow - -1. 现在用手机或者平板扫描M5Core上的二维码，或者你使用PC编程的话，在PC的浏览器上输入网址`flow.m5stack.com`。 - -
- -
- -2. 因为每次上传代码到M5Core之前都要确保UiFlow正与手上的M5Core连接，而不是其他M5Core，所以需要点击UiFlow IDE页面右上角的齿轮，并在弹出的对话框内输入手上M5Core屏幕上显示的`APIKEY`，最后点击保存。 - -
- -
- -然后UiFlow就会连接到M5Core，此时M5Core屏幕右上角的小圆点就会变成绿色，不然会是一直红色。 - -现在，可以继续下面的步骤，开始M5Core编程啦！ - -## 编程Core - -### a. 画一个UI - -拖拽UiFlow IDE左上角的4种控件到`M5Stack Core`的UI界面，并点击页面右上角的`Run`按钮，执行效果。 - -
- -
- -### b. 编写Blockly程序 - -从左边的`Emoji`分类里拖拽`Set emoji map in0`程序块到到`Blockly`的编码区域上，然后点击`Run`按钮。 - -
- -
- -*The source code of this demostration: https://tower.im/projects/65b1c6743d194d22a801ed916832eb2b/uploads/fd59d8000b541c346d6c6d18291c29bb?version=1* - - -### c. 编写MicroPython程序 - -复制以下代码到Python编辑区，然后点击右上角的`Run`执行代码 -```Python -from m5stack import * -from m5ui import * -clear_bg(0x111111) - - -btnA = M5Button(name='ButtonA', text='ButtonA', visibility=False) -btnB = M5Button(name='ButtonB', text='ButtonB', visibility=False) -btnC = M5Button(name='ButtonC', text='ButtonC', visibility=False) - - -lcd.print("Hello M5Stack") -``` - -
- -
- -这时候，M5Core屏幕上会打印出`Hello M5Stack`字样。 - -## 音乐例程 - -下面，让我们在一两分钟内编写一个音乐例程。 - -拖拽`loop`, `music`和`timer`这几个程序块到`Blockly`编码区域。 - -然后设置`music block`和`timer block`的相关参数，如下图所示。 - - - -现在，点击`Run`就可以运行音乐程序啦! - -*The source code of this demostration: https://tower.im/projects/65b1c6743d194d22a801ed916832eb2b/uploads/9062b4bc81b3dc9be74f92be510a81d0?version=1* - -## 相关视频 - -- **UIFlow的简介** - - - -- **UIFlow的快速指南(Mac&Linux)** - - - -## 最后 - -?> *如果你想了解更多UiFlow方面的编程的话，可以给我们发邮件，报名我们的课程.* +# UiFlow 上手指南(Blockly/MicroPython) + +:clapper:**[相关视频](#相关视频)** + +?> a. 如果你的设备还没烧录UiFlow固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). b. 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和UiFlow](/zh_CN/related_documents/how_to_connect_wifi_using_core)。 + +这时候，你的M5Core已经连接到了可联网WIFI热点，如果按下Core上左边的按键`UPLOAD`的话，会如下图显示。如果M5Core开机之后，两三秒内没做操作的话，会自动地显示预置的程序界面。所以最好开机之后，立马按下`upload`按键。 + +
+ +
+ + +## 目录 + +1. [连接到UiFlow](#连接到UiFlow) + +2. [编程Core](#编程Core) + +3. [音乐例程](#音乐例程) + + +## 连接到UiFlow + +1. 现在用手机或者平板扫描M5Core上的二维码，或者你使用PC编程的话，在PC的浏览器上输入网址`flow.m5stack.com`。 + +
+ +
+ +2. 因为每次上传代码到M5Core之前都要确保UiFlow正与手上的M5Core连接，而不是其他M5Core，所以需要点击UiFlow IDE页面右上角的齿轮，并在弹出的对话框内输入手上M5Core屏幕上显示的`APIKEY`，最后点击保存。 + +
+ +
+ +然后UiFlow就会连接到M5Core，此时M5Core屏幕右上角的小圆点就会变成绿色，不然会是一直红色。 + +现在，可以继续下面的步骤，开始M5Core编程啦！ + +## 编程Core + +### a. 画一个UI + +拖拽UiFlow IDE左上角的4种控件到`M5Stack Core`的UI界面，并点击页面右上角的`Run`按钮，执行效果。 + +
+ +
+ +### b. 编写Blockly程序 + +从左边的`Emoji`分类里拖拽`Set emoji map in0`程序块到到`Blockly`的编码区域上，然后点击`Run`按钮。 + +
+ +
+ +*The source code of this demostration: https://tower.im/projects/65b1c6743d194d22a801ed916832eb2b/uploads/fd59d8000b541c346d6c6d18291c29bb?version=1* + + +### c. 编写MicroPython程序 + +复制以下代码到Python编辑区，然后点击右上角的`Run`执行代码 +```Python +from m5stack import * +from m5ui import * +clear_bg(0x111111) + + +btnA = M5Button(name='ButtonA', text='ButtonA', visibility=False) +btnB = M5Button(name='ButtonB', text='ButtonB', visibility=False) +btnC = M5Button(name='ButtonC', text='ButtonC', visibility=False) + + +lcd.print("Hello M5Stack") +``` + +
+ +
+ +这时候，M5Core屏幕上会打印出`Hello M5Stack`字样。 + +## 音乐例程 + +下面，让我们在一两分钟内编写一个音乐例程。 + +拖拽`loop`, `music`和`timer`这几个程序块到`Blockly`编码区域。 + +然后设置`music block`和`timer block`的相关参数，如下图所示。 + + + +现在，点击`Run`就可以运行音乐程序啦! + +*The source code of this demostration: https://tower.im/projects/65b1c6743d194d22a801ed916832eb2b/uploads/9062b4bc81b3dc9be74f92be510a81d0?version=1* + +## 相关视频 + +- **UIFlow的简介** + + + +- **UIFlow的快速指南(Mac&Linux)** + + + +## 最后 + +?> *如果你想了解更多UiFlow方面的编程的话，可以给我们发邮件，报名我们的课程.* diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index 54d13221..81c38833 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -1,155 +1,155 @@ -# M5Cloud 上手指南(MicroPython) - -?> 如果你的设备还没烧录M5Cloud固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). - -?> 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和M5Cloud](/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud). - -如果你的Core已经连接了可联网WIFI热点之后，屏幕会如下图显示，出现check code(check code用于M5Core设备与M5Cloud绑定)，下面开始M5Cloud的编程 - -
- -
- -## 目录 - -1. [连接到M5Cloud](#连接到M5Cloud) - -2. [绑定设备](#绑定设备) - -3. [编程Core](#编程Core) - - -## 1. 连接到M5Cloud - -如果你想用PC连编程M5Core的话，请在浏览器页面输入M5Core屏幕上显示的网址`cloud.m5stack.com` - -
- -
- -然后，注册一个M5Cloud账号 - -## 2. 绑定设备 - - -点击M5Cloud上`Device`->`Add`按钮，并输入check code到对话框。(看，我的check code是`052879`) - -
- -
- -
- -
- -这时候，你可以按照下面的步骤使用Python编程Core啦！ - -## 3. 编程Core - -### a. 新建工程 - -
- -
- -### a. 开始编程 - -*现在我们以使用FACES Kit为举例如何使用M5Cloud。* - -在创建新工程之后，新建文件，并重命名为`faces.py`。 - -
- -
- -
- -
- -然后分别拷贝如下的代码到`faces.py`和`main.py`，并保存。 - -```Python -""" -File name: faces.py - -M5Stack MicroPython FACES keyboard I2C driver -""" - -class Faces: - def __init__(self, i2c=None): - if i2c == None: - from machine import I2C, Pin - self.i2c = I2C(sda=21, scl=22) - else: - self.i2c = i2c - self.addr = 0x08 - self.cb = None - - def read(self): - return self.i2c.readfrom(self.addr, 1) - - def _callback(self, pin): - from machine import Pin - if pin == Pin(5): - self.cb(self.read()) - - def callback(self, cb): - from machine import Pin - self.pin = Pin(5) - self.pin.init(Pin.IN) - self.pin.irq(trigger=Pin.IRQ_FALLING, handler=self._callback) - self.cb = cb -``` - -
- -
- - -```Python -""" -File name: main.py -""" - -from m5stack import * -from faces import Faces - -keyboard = Faces() - -# read once -print("Key value:", end='') -print(keyboard.read()) - -# callback -def keyboard_cb(value): - print("Key value:", end='') - print(value) - lcd.print(value) - -keyboard.callback(keyboard_cb) -``` - -
- -
- -
- -
- - -现在点击M5Cloud界面上的`Upload`按钮，如下图所示的操作。 - -
- -
- -## 最后 - -这个FACES Kits的例程功能是，当你按下FACES面板上的某个按键之后，屏幕上会显示对应按键的值。 - -现在我按下QWERTY键盘上第一行的按键。("q", "w", "e", "r", "t", "y", "u", "i", "o", "p") - -
- +# M5Cloud 上手指南(MicroPython) + +?> 如果你的设备还没烧录M5Cloud固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). + +?> 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和M5Cloud](/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud). + +如果你的Core已经连接了可联网WIFI热点之后，屏幕会如下图显示，出现check code(check code用于M5Core设备与M5Cloud绑定)，下面开始M5Cloud的编程 + +
+ +
+ +## 目录 + +1. [连接到M5Cloud](#连接到M5Cloud) + +2. [绑定设备](#绑定设备) + +3. [编程Core](#编程Core) + + +## 1. 连接到M5Cloud + +如果你想用PC连编程M5Core的话，请在浏览器页面输入M5Core屏幕上显示的网址`cloud.m5stack.com` + +
+ +
+ +然后，注册一个M5Cloud账号 + +## 2. 绑定设备 + + +点击M5Cloud上`Device`->`Add`按钮，并输入check code到对话框。(看，我的check code是`052879`) + +
+ +
+ +
+ +
+ +这时候，你可以按照下面的步骤使用Python编程Core啦！ + +## 3. 编程Core + +### a. 新建工程 + +
+ +
+ +### a. 开始编程 + +*现在我们以使用FACES Kit为举例如何使用M5Cloud。* + +在创建新工程之后，新建文件，并重命名为`faces.py`。 + +
+ +
+ +
+ +
+ +然后分别拷贝如下的代码到`faces.py`和`main.py`，并保存。 + +```Python +""" +File name: faces.py + +M5Stack MicroPython FACES keyboard I2C driver +""" + +class Faces: + def __init__(self, i2c=None): + if i2c == None: + from machine import I2C, Pin + self.i2c = I2C(sda=21, scl=22) + else: + self.i2c = i2c + self.addr = 0x08 + self.cb = None + + def read(self): + return self.i2c.readfrom(self.addr, 1) + + def _callback(self, pin): + from machine import Pin + if pin == Pin(5): + self.cb(self.read()) + + def callback(self, cb): + from machine import Pin + self.pin = Pin(5) + self.pin.init(Pin.IN) + self.pin.irq(trigger=Pin.IRQ_FALLING, handler=self._callback) + self.cb = cb +``` + +
+ +
+ + +```Python +""" +File name: main.py +""" + +from m5stack import * +from faces import Faces + +keyboard = Faces() + +# read once +print("Key value:", end='') +print(keyboard.read()) + +# callback +def keyboard_cb(value): + print("Key value:", end='') + print(value) + lcd.print(value) + +keyboard.callback(keyboard_cb) +``` + +
+ +
+ +
+ +
+ + +现在点击M5Cloud界面上的`Upload`按钮，如下图所示的操作。 + +
+ +
+ +## 最后 + +这个FACES Kits的例程功能是，当你按下FACES面板上的某个按键之后，屏幕上会显示对应按键的值。 + +现在我按下QWERTY键盘上第一行的按键。("q", "w", "e", "r", "t", "y", "u", "i", "o", "p") + +
+
\ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md b/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md index 460bd05b..0d0492a2 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md @@ -1,9 +1,9 @@ -# M5Stack Core上手指南 - -## 选择你需要的编程语言 - -*使用Arduino/C++编程的话，选择Arduino；使用Blockly/MicroPython，选择UiFlow(Blockly/MicroPython)* - - | ----|--- -[Arduino](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [UiFlow(Blockly/MicroPython)](/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) +# M5Stack Core上手指南 + +## 选择你需要的编程语言 + +*使用Arduino/C++编程的话，选择Arduino；使用Blockly/MicroPython，选择UiFlow(Blockly/MicroPython)* + + | +---|--- +[Arduino](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [UiFlow(Blockly/MicroPython)](/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) diff --git a/docs/zh_CN/quick_start/m5core/m5stick_get_started_arduino.md b/docs/zh_CN/quick_start/m5core/m5stick_get_started_arduino.md index a65c733b..11a4bcde 100644 --- a/docs/zh_CN/quick_start/m5core/m5stick_get_started_arduino.md +++ b/docs/zh_CN/quick_start/m5core/m5stick_get_started_arduino.md @@ -1,18 +1,18 @@ -# M5Stick 上手指南(Arduino) - -## 1. 安装`U8g2`库 - -如果你已经安装了`U8g2`库的话，直接跳到第二步往下执行。 -如果还没的话，打开Arduino IDE，并点击`Sketch`->`Include Library`->`Manage Libraries...`，搜索`U8g2`进行安装。 - -
- -
- -## 2. Arduino-ESP32的开发设置 - -请根据你PC的操作系统类型阅读对应的文档。 - - | ----|--- -[MacOS](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Windows](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) +# M5Stick 上手指南(Arduino) + +## 1. 安装`U8g2`库 + +如果你已经安装了`U8g2`库的话，直接跳到第二步往下执行。 +如果还没的话，打开Arduino IDE，并点击`Sketch`->`Include Library`->`Manage Libraries...`，搜索`U8g2`进行安装。 + +
+ +
+ +## 2. Arduino-ESP32的开发设置 + +请根据你PC的操作系统类型阅读对应的文档。 + + | +---|--- +[MacOS](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Windows](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) diff --git a/docs/zh_CN/related_documents.md b/docs/zh_CN/related_documents.md index 19569630..e2916932 100644 --- a/docs/zh_CN/related_documents.md +++ b/docs/zh_CN/related_documents.md @@ -1,11 +1,11 @@ -# 相关文档 - -1. [如何安装USB驱动并建立与PC的串口通讯](zh_CN/related_documents/establish_serial_connection) - -2. [如何安装Git和Arduino](zh_CN/related_documents/how_to_install_git_and_arduino) - -3. [如何更新Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib) - -4. [如何通过M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware) - -5. [如何使用M5Core连接可联网的WiFi热点](zh_CN/related_documents/how_to_connect_wifi_using_core) +# 相关文档 + +1. [如何安装USB驱动并建立与PC的串口通讯](zh_CN/related_documents/establish_serial_connection) + +2. [如何安装Git和Arduino](zh_CN/related_documents/how_to_install_git_and_arduino) + +3. [如何更新Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib) + +4. [如何通过M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware) + +5. [如何使用M5Core连接可联网的WiFi热点](zh_CN/related_documents/how_to_connect_wifi_using_core) diff --git a/docs/zh_CN/related_documents/establish_serial_connection.md b/docs/zh_CN/related_documents/establish_serial_connection.md index 6e471e90..d950402a 100644 --- a/docs/zh_CN/related_documents/establish_serial_connection.md +++ b/docs/zh_CN/related_documents/establish_serial_connection.md @@ -1,97 +1,97 @@ -# 如何安装USB驱动并建立与PC的串口通讯 - -**这个文档会介绍如何安装USB驱动，并与PC建立串口通信.** - -## For MacOS - -### 1. 安装USB驱动 - -**[下载SiLabs CP2104驱动](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)** - -**如果镜像文件SiLabsUSBDriverDisk.dmg已经下载了, 挂载它, 根据以下图片显示的步骤来安装.** - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -### 2. 在MacOS上检查确认COM串口号 - -**打开终端terminal并执行以下命令两次, 第一次在板子或者dongle还未插入PC的时候, 然后把板子或者dongle插入执行第二次. 这时候，在执行第二次命令之后，出现的串口号就是此时板子与PC相连的串口号** - -**MacOS** - - ls /dev/cu.* - - - -## For Windows - -### 1. 安装USB驱动 - -**下载[SiLabs CP2104驱动](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)** - -**根据你windows版本来下载对应版本的USB驱动(Windows7/8/10).** - -
- -
- -**选择正确的版本来安装，如果电脑系统是32位，则下载符合Windows版本的X86版本USB驱动，如果电脑系统是64位，则下载符合Windows版本的X64版本USB驱动, 然后安装驱动.** - -
- -
- -
- -
- -
- -
- -### 2. 在Windows上检查确认COM串口号 - -**在Windows的设备管理器上查看COM串口号. 插上板子或者dongle之后，查看显示的COM口，再拔掉，此时消失的COM口就是该板子或dongle对应的COM口.** - -**下图显示了M5Core板子与PC通信的COM串口号** - -
- -
+# 如何安装USB驱动并建立与PC的串口通讯 + +**这个文档会介绍如何安装USB驱动，并与PC建立串口通信.** + +## For MacOS + +### 1. 安装USB驱动 + +**[下载SiLabs CP2104驱动](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)** + +**如果镜像文件SiLabsUSBDriverDisk.dmg已经下载了, 挂载它, 根据以下图片显示的步骤来安装.** + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +### 2. 在MacOS上检查确认COM串口号 + +**打开终端terminal并执行以下命令两次, 第一次在板子或者dongle还未插入PC的时候, 然后把板子或者dongle插入执行第二次. 这时候，在执行第二次命令之后，出现的串口号就是此时板子与PC相连的串口号** + +**MacOS** + + ls /dev/cu.* + + + +## For Windows + +### 1. 安装USB驱动 + +**下载[SiLabs CP2104驱动](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)** + +**根据你windows版本来下载对应版本的USB驱动(Windows7/8/10).** + +
+ +
+ +**选择正确的版本来安装，如果电脑系统是32位，则下载符合Windows版本的X86版本USB驱动，如果电脑系统是64位，则下载符合Windows版本的X64版本USB驱动, 然后安装驱动.** + +
+ +
+ +
+ +
+ +
+ +
+ +### 2. 在Windows上检查确认COM串口号 + +**在Windows的设备管理器上查看COM串口号. 插上板子或者dongle之后，查看显示的COM口，再拔掉，此时消失的COM口就是该板子或dongle对应的COM口.** + +**下图显示了M5Core板子与PC通信的COM串口号** + +
+ +
diff --git a/docs/zh_CN/related_documents/how_to_burn_firmware.md b/docs/zh_CN/related_documents/how_to_burn_firmware.md index 39202b72..4631bd31 100644 --- a/docs/zh_CN/related_documents/how_to_burn_firmware.md +++ b/docs/zh_CN/related_documents/how_to_burn_firmware.md @@ -1,64 +1,64 @@ -# 如何通过M5Burner烧录固件 - -**这个文档会介绍如何下载M5Burner，并通过M5Burner烧录固件.** - -## For MacOS - -***(在编辑中...)*** - -## For Windows - -### 1. 下载最新的M5Burner - -访问[官网](http://www.m5stack.com)来下载M5Burner. - -
- Screenshot of coverpage -
- -### 2. 烧录固件 - -解压刚刚下载的M5Burner压缩包, 然后双击`M5Burner.exe`. - -**选择板子正与PC相连的`串口号`和`921600 波特率`, 选择合适的固件文件, 点击`Erase`, 然后等擦除固件完成，点击`Burn`** - -?> **Tip** **a.** 如果你想通过[UiFlow](http://flow.m5stack.com)(/[M5Cloud](http://cloud.m5stack.com))来编程的话，请选择最新的`M5Flow-vx.x`(/`M5Cloud-vx.x.x`) **b.** 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的`M5Cam-vx.x (/M5Cam-psram)` - -
- -
- -!> **注意** 如何M5Burner的串口号选项框没有显示任何的`COMx`号或者只显示`COM1`, 这时候你需要参考这篇文档[建立串口通信](/zh_CN/related_documents/establish_serial_connection)来重新安装USB驱动. - -**a. 选择合适的固件文件** - -a. 如果你想通过[UiFlow](http://flow.m5stack.com)来编程的话，请选择最新的`M5Flow-vx.x` - -b. 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的`M5Cam-vx.x (/M5Cam-psram)` - -**b. 点击`Erase`** - -
- Screenshot of coverpage -
- - -*如果M5Burner打印出这样的信息的话`Hard resetting via RTS pin...`，这就表明你擦除固件成功了.* - -
- Screenshot of coverpage -
- - -*如果M5Burner打印出这样的信息的话`Leaving... Staying in bootloader.`，这就表明你烧录固件成功了.* - -
- Screenshot of coverpage -
- -### 3. 然后重启板子 - -?> **提示** -如果M5Burner在点击`Burn`之后，显示`busy...`, 也就是卡顿的话，不要慌张，稍微等几分钟，软件自然就会烧录成功。 - +# 如何通过M5Burner烧录固件 + +**这个文档会介绍如何下载M5Burner，并通过M5Burner烧录固件.** + +## For MacOS + +***(在编辑中...)*** + +## For Windows + +### 1. 下载最新的M5Burner + +访问[官网](http://www.m5stack.com)来下载M5Burner. + +
+ Screenshot of coverpage +
+ +### 2. 烧录固件 + +解压刚刚下载的M5Burner压缩包, 然后双击`M5Burner.exe`. + +**选择板子正与PC相连的`串口号`和`921600 波特率`, 选择合适的固件文件, 点击`Erase`, 然后等擦除固件完成，点击`Burn`** + +?> **Tip** **a.** 如果你想通过[UiFlow](http://flow.m5stack.com)(/[M5Cloud](http://cloud.m5stack.com))来编程的话，请选择最新的`M5Flow-vx.x`(/`M5Cloud-vx.x.x`) **b.** 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的`M5Cam-vx.x (/M5Cam-psram)` + +
+ +
+ +!> **注意** 如何M5Burner的串口号选项框没有显示任何的`COMx`号或者只显示`COM1`, 这时候你需要参考这篇文档[建立串口通信](/zh_CN/related_documents/establish_serial_connection)来重新安装USB驱动. + +**a. 选择合适的固件文件** + +a. 如果你想通过[UiFlow](http://flow.m5stack.com)来编程的话，请选择最新的`M5Flow-vx.x` + +b. 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的`M5Cam-vx.x (/M5Cam-psram)` + +**b. 点击`Erase`** + +
+ Screenshot of coverpage +
+ + +*如果M5Burner打印出这样的信息的话`Hard resetting via RTS pin...`，这就表明你擦除固件成功了.* + +
+ Screenshot of coverpage +
+ + +*如果M5Burner打印出这样的信息的话`Leaving... Staying in bootloader.`，这就表明你烧录固件成功了.* + +
+ Screenshot of coverpage +
+ +### 3. 然后重启板子 + +?> **提示** +如果M5Burner在点击`Burn`之后，显示`busy...`, 也就是卡顿的话，不要慌张，稍微等几分钟，软件自然就会烧录成功。 + ?> **提示** 如果M5Burner在擦除或者烧录过程中被中断了(如突然关闭软件), 为了保证板子能正常工作，你最好重新擦除和烧录一遍固件. \ No newline at end of file diff --git a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md index 55bfed3a..79b09845 100644 --- a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md +++ b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md @@ -1,61 +1,61 @@ -# 连接Wi-Fi(For UiFlow) - -?> *如果你的M5Core还没预先烧录了UiFlow固件的话，参考这篇文章[如何使用M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware))* - -**烧录了UiFlow的固件，并重启M5Core之后，你会看到如下的欢迎界面，然后我们开始连接Wi-Fi.** - -
- -
- -## 目录 - -1. [按下 UPLOAD 按键](#press-upload-button) - -2. [选择可联网的Wi-Fi](#select-networkable-ap) - -3. [重启M5Core](#reset-your-device) - - -## 1. 按下 `UPLOAD` 按键 - -**现在, 按下 `upload` 按键. 屏幕会出现如下界面.** - -
- -
- -## 2. 选择可联网的Wi-Fi - -**用手机或者PC去连接屏幕上显示的M5Core的热点(like `M5Stack-a67c`)，然后打开浏览器输入网址`192.168.4.1`，然后选择可联网的路由器Wi-Fi，然后输入密码。(你看，像我这样，我现在可以联网的Wi-Fi是`MasterHax_5G`)** - -
- -
- -## 3. 重启M5Core - -**输入密码后，成功连接可联网的路由器Wi-Fi之后，重启M5Core** - -
- -
- -## 完成 - -重启M5Core之后，按`upload`按键，这时候，看到下图带二维码的界面。这很好我们就可以跟着这篇文章[UiFlow编程](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython)学习UiFlow的编程啦！ - - -
- -
- -?> **Note** 同样地，如果你想换一个可联网的wifi的话，按`SETUP`按键。 - -
- -
- -## 最后 - +# 连接Wi-Fi(For UiFlow) + +?> *如果你的M5Core还没预先烧录了UiFlow固件的话，参考这篇文章[如何使用M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware))* + +**烧录了UiFlow的固件，并重启M5Core之后，你会看到如下的欢迎界面，然后我们开始连接Wi-Fi.** + +
+ +
+ +## 目录 + +1. [按下 UPLOAD 按键](#press-upload-button) + +2. [选择可联网的Wi-Fi](#select-networkable-ap) + +3. [重启M5Core](#reset-your-device) + + +## 1. 按下 `UPLOAD` 按键 + +**现在, 按下 `upload` 按键. 屏幕会出现如下界面.** + +
+ +
+ +## 2. 选择可联网的Wi-Fi + +**用手机或者PC去连接屏幕上显示的M5Core的热点(like `M5Stack-a67c`)，然后打开浏览器输入网址`192.168.4.1`，然后选择可联网的路由器Wi-Fi，然后输入密码。(你看，像我这样，我现在可以联网的Wi-Fi是`MasterHax_5G`)** + +
+ +
+ +## 3. 重启M5Core + +**输入密码后，成功连接可联网的路由器Wi-Fi之后，重启M5Core** + +
+ +
+ +## 完成 + +重启M5Core之后，按`upload`按键，这时候，看到下图带二维码的界面。这很好我们就可以跟着这篇文章[UiFlow编程](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython)学习UiFlow的编程啦！ + + +
+ +
+ +?> **Note** 同样地，如果你想换一个可联网的wifi的话，按`SETUP`按键。 + +
+ +
+ +## 最后 + 现在，你可以阅读这篇文章开始使用UiFlow编程啦！[UiFlow上手指南](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) \ No newline at end of file diff --git a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md index 542b10cb..0ffce343 100644 --- a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md +++ b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md @@ -1,53 +1,53 @@ -# 如何连接WIFI (For M5Cloud) - -?> *如果你的M5Cloud还没预先烧录名为`M5Cloud`固件的话，请阅读这篇文章[如何烧录使用M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware)* - -**重启M5Core之后，你会看到M5Core出现下图界面。现在我们就开始连接WIFI吧** - -
- -
- -## 目录 - -1. [连接M5Core的热点](#connect-to-m5Core-AP) - -2. [选择可联网的WIFI热点](#select-networkable-ap) - -3. [重启M5Core](#reset-your-device) - -## 1. 连接M5Core的热点 - -**使用手机或者PC连接M5Core发出的热点AP(看，现在我的M5Core发出的热点名是`M5Stack-a67c`)** - -## 2. 选择可联网的WIFI热点 - -**打开浏览器并输入网址`192.168.4.1`，然后选择可联网的WIFI，并输入其密码(如下图，我的WIFI名字是`MasterHax_2.4G`)** - -
- -
- -
- -
- -?> 如果你的M5Core没成功连接WIFI，请重试一次. - -## 3. 重启M5Core - -**在M5Core成功连接WIFI之后，重启你的Core** - -
- -
- -!> **Note** 可是如果你的Core之前绑定过M5Cloud账号(也就是之前有过将check code输入到[M5Cloud](http://cloud.m5stack.com))，这时M5Core屏幕会如下图所示。 - -
- -
- -## 最后 - -现在，你可以阅读这篇文章开始使用M5Cloud编程啦！[M5Cloud上手指南](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) +# 如何连接WIFI (For M5Cloud) + +?> *如果你的M5Cloud还没预先烧录名为`M5Cloud`固件的话，请阅读这篇文章[如何烧录使用M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware)* + +**重启M5Core之后，你会看到M5Core出现下图界面。现在我们就开始连接WIFI吧** + +
+ +
+ +## 目录 + +1. [连接M5Core的热点](#connect-to-m5Core-AP) + +2. [选择可联网的WIFI热点](#select-networkable-ap) + +3. [重启M5Core](#reset-your-device) + +## 1. 连接M5Core的热点 + +**使用手机或者PC连接M5Core发出的热点AP(看，现在我的M5Core发出的热点名是`M5Stack-a67c`)** + +## 2. 选择可联网的WIFI热点 + +**打开浏览器并输入网址`192.168.4.1`，然后选择可联网的WIFI，并输入其密码(如下图，我的WIFI名字是`MasterHax_2.4G`)** + +
+ +
+ +
+ +
+ +?> 如果你的M5Core没成功连接WIFI，请重试一次. + +## 3. 重启M5Core + +**在M5Core成功连接WIFI之后，重启你的Core** + +
+ +
+ +!> **Note** 可是如果你的Core之前绑定过M5Cloud账号(也就是之前有过将check code输入到[M5Cloud](http://cloud.m5stack.com))，这时M5Core屏幕会如下图所示。 + +
+ +
+ +## 最后 + +现在，你可以阅读这篇文章开始使用M5Cloud编程啦！[M5Cloud上手指南](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) diff --git a/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md b/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md index e0066f32..e9768061 100644 --- a/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md +++ b/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md @@ -1,25 +1,25 @@ -# 安装Git和Arduino IDE (Windows) - -## 1. 安装`Git` -如果你已经安装了`Git`，请直接从第2步开始。 - -否则点击这里下载[Git](https://git-scm.com/download/win)并安装它 - -## 2. 安装`Arduino IDE` - -*下载地址* -https://www.arduino.cc/en/Main/Software - -
- -
- -双击安装Arduino IDE，全程保持默认的选择，包括安装路径也是默认。 - -
- -
- -
- +# 安装Git和Arduino IDE (Windows) + +## 1. 安装`Git` +如果你已经安装了`Git`，请直接从第2步开始。 + +否则点击这里下载[Git](https://git-scm.com/download/win)并安装它 + +## 2. 安装`Arduino IDE` + +*下载地址* +https://www.arduino.cc/en/Main/Software + +
+ +
+ +双击安装Arduino IDE，全程保持默认的选择，包括安装路径也是默认。 + +
+ +
+ +
+
\ No newline at end of file diff --git a/docs/zh_CN/related_documents/upgrade_m5stack_lib.md b/docs/zh_CN/related_documents/upgrade_m5stack_lib.md index c8a89dcf..68b23858 100644 --- a/docs/zh_CN/related_documents/upgrade_m5stack_lib.md +++ b/docs/zh_CN/related_documents/upgrade_m5stack_lib.md @@ -1,17 +1,17 @@ -# 升级M5Stack库(Arduino IDE Library) - -### 1. 打开Arduino IDE，然后点击`Sketch`->`Include Library`->`Manage Libraries...` - -### 2. 在搜索框输入`M5Stack`，并搜索 - -
- Screenshot of coverpage -
- -### 3. 如果显示如下，则点击`Update`. - -**但是如果显示`Install`，这意味着你之前还没安装M5Stack库，所以点击`Install`进行安装。** - -
- Screenshot of coverpage -
+# 升级M5Stack库(Arduino IDE Library) + +### 1. 打开Arduino IDE，然后点击`Sketch`->`Include Library`->`Manage Libraries...` + +### 2. 在搜索框输入`M5Stack`，并搜索 + +
+ Screenshot of coverpage +
+ +### 3. 如果显示如下，则点击`Update`. + +**但是如果显示`Install`，这意味着你之前还没安装M5Stack库，所以点击`Install`进行安装。** + +
+ Screenshot of coverpage +
diff --git a/docs/zh_CN/sidebar.md b/docs/zh_CN/sidebar.md index 5b368e80..ce3156a1 100644 --- a/docs/zh_CN/sidebar.md +++ b/docs/zh_CN/sidebar.md @@ -1,10 +1,10 @@ -- [产品介绍](zh_CN/) -- [API参考](zh_CN/api) -- [M5Stack案例](zh_CN/case) -- [相关文档](zh_CN/related_documents) -- [常见问题解答](zh_CN/faq) - - -- **Links** -- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/m5stack) -- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) +- [产品介绍](zh_CN/) +- [API参考](zh_CN/api) +- [M5Stack案例](zh_CN/case) +- [相关文档](zh_CN/related_documents) +- [常见问题解答](zh_CN/faq) + + +- **Links** +- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/m5stack) +- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) diff --git a/docs/zh_CN/tool/usb_downloader.md b/docs/zh_CN/tool/usb_downloader.md index e4375218..4a1559b4 100644 --- a/docs/zh_CN/tool/usb_downloader.md +++ b/docs/zh_CN/tool/usb_downloader.md @@ -1,35 +1,35 @@ -# M5Stack USB Downloader - -中文 | [English](en/product_documents/tools/tool_usb_downloader) | [日本語](ja/product_documents/tools/tool_usb_downloader) - -## 描述 - -内置CP2104芯片的串口转USB烧录工具，使用这款工具，能自动烧录固件。 - -## 参数 - -| 管脚号 | 管脚名字 | -| :-------------------: |:------------------------: | -| 1 | GND | -| 2 | GPIO0 | -| 3 | EN | -| 4 | TXD | -| 5 | RXD | -| 6 | 3.3V | - -### 其他 - -有两个引脚作为预留(RTS, DTR) - -## 包含 - -- 1x M5Stack USB Downloader - -## 相关链接 - -- [原理图](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/USBtool.pdf) -- [用户指南](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/M5Stack-USB-Downloader-UserGuide.md) - - +# M5Stack USB Downloader + +中文 | [English](en/product_documents/tools/tool_usb_downloader) | [日本語](ja/product_documents/tools/tool_usb_downloader) + +## 描述 + +内置CP2104芯片的串口转USB烧录工具，使用这款工具，能自动烧录固件。 + +## 参数 + +| 管脚号 | 管脚名字 | +| :-------------------: |:------------------------: | +| 1 | GND | +| 2 | GPIO0 | +| 3 | EN | +| 4 | TXD | +| 5 | RXD | +| 6 | 3.3V | + +### 其他 + +有两个引脚作为预留(RTS, DTR) + +## 包含 + +- 1x M5Stack USB Downloader + +## 相关链接 + +- [原理图](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/USBtool.pdf) +- [用户指南](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/M5Stack-USB-Downloader-UserGuide.md) + + diff --git a/docs/zh_CN/unit/396port.md b/docs/zh_CN/unit/396port.md index a57e7b51..65f2b48d 100644 --- a/docs/zh_CN/unit/396port.md +++ b/docs/zh_CN/unit/396port.md @@ -1,23 +1,23 @@ -# 396PORT - GROVE接口转HT3.96接口Unit - - - -*** - -:memo:**[描述](#描述)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.64.3a93425e5PQbBs&id=577159181877)** - -## 描述 - -3.96port是一个GROVE接口转VH3.96-4Pin接口的适配模块. 如果你想外接VH3.96-4Pin接口的设备的话，最好使用上这个Unit，会更加方便. - -## 特性 - -- VH3.96接口 -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** +# 396PORT - GROVE接口转HT3.96接口Unit + + + +*** + +:memo:**[描述](#描述)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.64.3a93425e5PQbBs&id=577159181877)** + +## 描述 + +3.96port是一个GROVE接口转VH3.96-4Pin接口的适配模块. 如果你想外接VH3.96-4Pin接口的设备的话，最好使用上这个Unit，会更加方便. + +## 特性 + +- VH3.96接口 +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** diff --git a/docs/zh_CN/unit/adc.md b/docs/zh_CN/unit/adc.md index e855d000..6a7c52b8 100644 --- a/docs/zh_CN/unit/adc.md +++ b/docs/zh_CN/unit/adc.md @@ -1,64 +1,64 @@ -# ADC - 模数转换Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.37.3a93425e5PQbBs&id=580131730176)** - -## 描述 - -这是带自校准功能的16位模拟数字转换unit，相比ESP32芯片自带的ADC（12位）功能分辨率高了不少，意味着你可以测量更小幅值的电压等模拟量，也就是能测量更细微一倍的模拟量，比如采集心电电压做心电监护项目、做血压监测项目、高精度电压监控项目等等。unit集成的ADC芯片通过I2C接口与M5的主控通讯(I2C地址为0x48)，可以设置成单周期转换和连续转换方式。 - -## 特性 - -- ADC有16位分辨率，可以设置每秒采样8、16、32、128次以进行A/D转换 -- ADC芯片内部可以产生高达8倍的放大，从而可以采集幅值更小的模拟信号 -- 能测量0~12V的电压输入 -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 应用 - -- 心电信号采集 -- 血压测量 -- 测力计 - -## 文档 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **数据手册** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) - -## 例程 - -### 1. Arduino IDE - -```c++ -ADS1100 ads;//new a object -ads.getAddr_ADS1100(0x48);//ADS1100_DEFAULT_ADDRESS: 0x48 - -ads.setOSMode(OSMODE_SINGLE);// Set to start a single-conversion -result = ads.Measure_Differential();//Reads the conversion results -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ADC/Arduino)。 - -### 2. UIFlow - - - -## 原理图 - - - -### 管脚映射 - - - - +# ADC - 模数转换Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.37.3a93425e5PQbBs&id=580131730176)** + +## 描述 + +这是带自校准功能的16位模拟数字转换unit，相比ESP32芯片自带的ADC（12位）功能分辨率高了不少，意味着你可以测量更小幅值的电压等模拟量，也就是能测量更细微一倍的模拟量，比如采集心电电压做心电监护项目、做血压监测项目、高精度电压监控项目等等。unit集成的ADC芯片通过I2C接口与M5的主控通讯(I2C地址为0x48)，可以设置成单周期转换和连续转换方式。 + +## 特性 + +- ADC有16位分辨率，可以设置每秒采样8、16、32、128次以进行A/D转换 +- ADC芯片内部可以产生高达8倍的放大，从而可以采集幅值更小的模拟信号 +- 能测量0~12V的电压输入 +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 应用 + +- 心电信号采集 +- 血压测量 +- 测力计 + +## 文档 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **数据手册** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) + +## 例程 + +### 1. Arduino IDE + +```c++ +ADS1100 ads;//new a object +ads.getAddr_ADS1100(0x48);//ADS1100_DEFAULT_ADDRESS: 0x48 + +ads.setOSMode(OSMODE_SINGLE);// Set to start a single-conversion +result = ads.Measure_Differential();//Reads the conversion results +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ADC/Arduino)。 + +### 2. UIFlow + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
ADC UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
ADC UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/angle.md b/docs/zh_CN/unit/angle.md index 9fec2b3a..bb7feab4 100644 --- a/docs/zh_CN/unit/angle.md +++ b/docs/zh_CN/unit/angle.md @@ -1,75 +1,75 @@ -# ANGLE - 角度传感器Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.40.312f425eRDFbqp&id=578201949805)** - -## 描述 - -ANGLE是一个电位器Unit，通过这个Unit可以检测手动旋转的角度. - -## 特性 - -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -#include -// select the input pin for the potentiometer -int sensorPin = 36; -// last variable to store the value coming from the sensor -int last_sensorValue = 0; -// current variable to store the value coming from the sensor -int cur_sensorValue = 0; - -void setup() { - M5.begin(); - pinMode(sensorPin, INPUT); - M5.Lcd.setTextSize(2); - M5.Lcd.setCursor(0, 0); - M5.Lcd.print("the value of ANGLE: "); -} - -void loop() { - // read the value from the sensor: - cur_sensorValue = analogRead(sensorPin); - M5.Lcd.setCursor(0, 25); - if(abs(cur_sensorValue - last_sensorValue) > 10){//debaunce - M5.Lcd.fillRect(0, 25, 100, 25, BLACK); - M5.Lcd.print(cur_sensorValue); - last_sensorValue = cur_sensorValue; - } - delay(50); -} -``` - -具体例程`potentiometer_read.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/Arduino)。 - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/UIFlow)。 - -## 原理图 - - - -### 管脚映射 - - - - +# ANGLE - 角度传感器Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.40.312f425eRDFbqp&id=578201949805)** + +## 描述 + +ANGLE是一个电位器Unit，通过这个Unit可以检测手动旋转的角度. + +## 特性 + +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +#include +// select the input pin for the potentiometer +int sensorPin = 36; +// last variable to store the value coming from the sensor +int last_sensorValue = 0; +// current variable to store the value coming from the sensor +int cur_sensorValue = 0; + +void setup() { + M5.begin(); + pinMode(sensorPin, INPUT); + M5.Lcd.setTextSize(2); + M5.Lcd.setCursor(0, 0); + M5.Lcd.print("the value of ANGLE: "); +} + +void loop() { + // read the value from the sensor: + cur_sensorValue = analogRead(sensorPin); + M5.Lcd.setCursor(0, 25); + if(abs(cur_sensorValue - last_sensorValue) > 10){//debaunce + M5.Lcd.fillRect(0, 25, 100, 25, BLACK); + M5.Lcd.print(cur_sensorValue); + last_sensorValue = cur_sensorValue; + } + delay(50); +} +``` + +具体例程`potentiometer_read.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/Arduino)。 + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/UIFlow)。 + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE B)GPIO36GPIO265VGND
ANGLE UnitANGLE Pin 5VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
ANGLE UnitANGLE Pin 5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/button.md b/docs/zh_CN/unit/button.md index 29955673..880cbd9e 100644 --- a/docs/zh_CN/unit/button.md +++ b/docs/zh_CN/unit/button.md @@ -1,54 +1,54 @@ -# BUTTON - 单按键Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.49.3a93425e5PQbBs&id=577636117298)** - -## 描述 - -BUTTON是一个单按键unit，这个Unit能检测你是否按下了. - -## 特性 - -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - - - -## 原理图 - - - -### 管脚映射 - - - - +# BUTTON - 单按键Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.49.3a93425e5PQbBs&id=577636117298)** + +## 描述 + +BUTTON是一个单按键unit，这个Unit能检测你是否按下了. + +## 特性 + +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO36GPIO265VGND
BUTTON UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE A)GPIO36GPIO265VGND
BUTTON UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/color.md b/docs/zh_CN/unit/color.md index 093b948b..7c705049 100644 --- a/docs/zh_CN/unit/color.md +++ b/docs/zh_CN/unit/color.md @@ -1,67 +1,67 @@ -# COLOR - 颜色传感器Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.55.312f425eRDFbqp&id=580005441373)** - -## 描述 - -Color是一个颜色传感器. 通过GROVE接口(I2C)与M5Core相连，能够识别物体表面颜色，它内置了颜色传感器芯片TCS3472. - -## 特性 - -- 高精度 -- 检测的适用温度范围: -70℃~382.2℃ -- Unit上配置两个乐高安装孔 - -## 应用 - -- RGB LED背光灯控制 -- 产品颜色验证 - -## 文档 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **数据手册** - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) - -## 例程 - -### 1. Arduino IDE - -```c++ -Adafruit_TCS34725 tcs; - -tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS, TCS34725_GAIN_4X); - -tcs.getRawData(&red, &green, &blue, &clear);//get rgb value -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/Arduino)。 - -烧录了例程后，串口显示终端会打印原始值，包括明光感应值(Clear)、红、绿、蓝(RGB) - -下图是感应红色的输出结果 - - - -### 2. UIFlow - - -## 原理图 - - - -### 管脚映射 - - - - +# COLOR - 颜色传感器Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.55.312f425eRDFbqp&id=580005441373)** + +## 描述 + +Color是一个颜色传感器. 通过GROVE接口(I2C)与M5Core相连，能够识别物体表面颜色，它内置了颜色传感器芯片TCS3472. + +## 特性 + +- 高精度 +- 检测的适用温度范围: -70℃~382.2℃ +- Unit上配置两个乐高安装孔 + +## 应用 + +- RGB LED背光灯控制 +- 产品颜色验证 + +## 文档 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **数据手册** - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) + +## 例程 + +### 1. Arduino IDE + +```c++ +Adafruit_TCS34725 tcs; + +tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS, TCS34725_GAIN_4X); + +tcs.getRawData(&red, &green, &blue, &clear);//get rgb value +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/Arduino)。 + +烧录了例程后，串口显示终端会打印原始值，包括明光感应值(Clear)、红、绿、蓝(RGB) + +下图是感应红色的输出结果 + + + +### 2. UIFlow + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
COLOR UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
COLOR UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/dac.md b/docs/zh_CN/unit/dac.md index 1452c07f..97b04663 100644 --- a/docs/zh_CN/unit/dac.md +++ b/docs/zh_CN/unit/dac.md @@ -1,89 +1,89 @@ -# DAC - 数模转换Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.28.312f425eRDFbqp&id=580257615943)** - -## 描述 - -DAC是一款集成数字信号转模拟信号芯片的Unit，能够实现输出模拟信号，如电压、声音等，内置的DAC芯片型号是MCP4725，并且不带EEPROM。 - -## 特性 - -- 高达12位的转换精度 -- 0~3.3V幅度的电压输出 -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 应用 - -- MP3播放器 -- mini信号发生器 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **数据手册** - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html) - -## 例程 - -### 1. Arduino IDE - - -### 2. UIFlow - - - -## 原理图 - - - -### 管脚映射 - - - - +# DAC - 数模转换Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.28.312f425eRDFbqp&id=580257615943)** + +## 描述 + +DAC是一款集成数字信号转模拟信号芯片的Unit，能够实现输出模拟信号，如电压、声音等，内置的DAC芯片型号是MCP4725，并且不带EEPROM。 + +## 特性 + +- 高达12位的转换精度 +- 0~3.3V幅度的电压输出 +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 应用 + +- MP3播放器 +- mini信号发生器 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **数据手册** - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html) + +## 例程 + +### 1. Arduino IDE + + +### 2. UIFlow + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
DAC UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
DAC UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/dual_button.md b/docs/zh_CN/unit/dual_button.md index ea06964e..c27003ab 100644 --- a/docs/zh_CN/unit/dual_button.md +++ b/docs/zh_CN/unit/dual_button.md @@ -1,54 +1,54 @@ -# DUAL_BUTTON - 双按键Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.58.3a93425e5PQbBs&id=577469112270)** - -## 描述 - -Dual Button是一款双机械按键Unit - -## 特性 - -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - - - -## 原理图 - - - -### 管脚映射 - - - - +# DUAL_BUTTON - 双按键Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.58.3a93425e5PQbBs&id=577469112270)** + +## 描述 + +Dual Button是一款双机械按键Unit + +## 特性 + +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE B)GPIO36GPIO265VGND
DUAL_BUTTON UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
DUAL_BUTTON UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/earth.md b/docs/zh_CN/unit/earth.md index 65cb41ed..9eeda69f 100644 --- a/docs/zh_CN/unit/earth.md +++ b/docs/zh_CN/unit/earth.md @@ -1,57 +1,57 @@ -# EARTH - 土壤湿度传感Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.67.3a93425e5PQbBs&id=576995412485)** - -## 描述 - -EARTH实际上是一款用于测量土壤湿度、水果含水量等固态物体的含水量的Unit。被测物体不同的含水量(湿度)，导致Unit返回的电阻值不同，从而能判断被测物体的含水量。 - -Unit可以输出0/1的数字信号，也可以直接输出被测物体反映的模拟量，可以调节Unit上的电位器来改变测量阈值。 - -## 特性 - -- 可调节测量阈值(通过改变Unit上的10K可调电阻) -- 数字或模拟信号输出 -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -//disable the speak noise -dacWrite(25, 0); - -analogRead_value = analogRead(36); -digitalRead_value = digitalRead(26); -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/Arduino)。 - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/UIFlow)。 - -## 原理图 - - - -### 管脚映射 - - - - +# EARTH - 土壤湿度传感Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.67.3a93425e5PQbBs&id=576995412485)** + +## 描述 + +EARTH实际上是一款用于测量土壤湿度、水果含水量等固态物体的含水量的Unit。被测物体不同的含水量(湿度)，导致Unit返回的电阻值不同，从而能判断被测物体的含水量。 + +Unit可以输出0/1的数字信号，也可以直接输出被测物体反映的模拟量，可以调节Unit上的电位器来改变测量阈值。 + +## 特性 + +- 可调节测量阈值(通过改变Unit上的10K可调电阻) +- 数字或模拟信号输出 +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +//disable the speak noise +dacWrite(25, 0); + +analogRead_value = analogRead(36); +digitalRead_value = digitalRead(26); +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/Arduino)。 + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/UIFlow)。 + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE B)GPIO36GPIO265VGND
EARTH UnitAinDin5VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
EARTH UnitAinDin5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/env.md b/docs/zh_CN/unit/env.md index d43cac30..55d36d14 100644 --- a/docs/zh_CN/unit/env.md +++ b/docs/zh_CN/unit/env.md @@ -1,60 +1,60 @@ -# ENV - 温湿度和压力传感器 - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.1-c.w4004-1172588101.29.f64c4476tugBw5&id=578200145474)** - -## 描述 - -ENV是一款集成DHT12(环境温湿度传感器)和压强传感器BMP280的Unit，这个Unit连接了M5Core之后能很方便的读取环境中的温湿度值和大气压强。接M5Core的GROVE A口。 - -## 特性 - -- 温度测量 - - 范围: 20 ~ 60℃ - - 精度: ±0.2℃ -- 湿度测量 - - 范围: 20 ~ 95℃ - - 精度: 0.1% -- 气压测量 - - 范围: 300 ~ 1100hPa - - 精度: ±1hPa -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -float tmp = dht12.readTemperature();//temperature -float hum = dht12.readHumidity();//humidity -float pressure = bme.readPressure();//pressure -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/Arduino)。 - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/UIFlow)。 - -## 原理图 - - - -### 管脚映射 - - - - +# ENV - 温湿度和压力传感器 + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.1-c.w4004-1172588101.29.f64c4476tugBw5&id=578200145474)** + +## 描述 + +ENV是一款集成DHT12(环境温湿度传感器)和压强传感器BMP280的Unit，这个Unit连接了M5Core之后能很方便的读取环境中的温湿度值和大气压强。接M5Core的GROVE A口。 + +## 特性 + +- 温度测量 + - 范围: 20 ~ 60℃ + - 精度: ±0.2℃ +- 湿度测量 + - 范围: 20 ~ 95℃ + - 精度: 0.1% +- 气压测量 + - 范围: 300 ~ 1100hPa + - 精度: ±1hPa +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +float tmp = dht12.readTemperature();//temperature +float hum = dht12.readHumidity();//humidity +float pressure = bme.readPressure();//pressure +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/Arduino)。 + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/UIFlow)。 + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
ENV UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
ENV UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/esp32cam.md b/docs/zh_CN/unit/esp32cam.md index 23cb4db9..a70b5f53 100644 --- a/docs/zh_CN/unit/esp32cam.md +++ b/docs/zh_CN/unit/esp32cam.md @@ -1,90 +1,90 @@ -# ESP32CAM - 摄像头 - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.46.6c2275f4nUJEfh&id=570594844588)** - -## 描述 - -ESP32Cam是一款基于ESP32芯片，集成OV2640摄像头驱动芯片的摄像头模块，但不带including PSRAM，也就是模块的RAM只有520KB。你可以通过ESP-IDF来编程摄像头功能。 - -同时，M5Camera Unit还预留了9轴陀螺仪(MPU6050)、大气压3合1传感器(BME280)和**模拟麦克风**的焊接口，如果你需要这些器件，可以焊接到对应位置上。M5Camera Unit还预留了电池接口，如果你需要做可移动的摄像头，那么可以焊接手头的锂电池到对应位置上。 - - -## 包含 - -- 1x ESP32Cam Unit -- 1x Type-C USB线 - - -## 特性 - -- ESP32模组特性 - + 集成双核Tensilica LX6 - + 高达240MHz的时钟频率 - + **520KB RAM** - + **4MB Flash memory** - + 集成802.11 BGN WiFi和双模蓝牙(经典蓝牙和BLE) - + 硬件加密(AES, SHA2, ECC, RSA-4096) -- CP2104 USB转串口 -- OV2640摄像头驱动 - - 输出格式(8-bit): - + YUV(422/420)/YCbCr422 - + RGB565/555 - + 8-bit compressed data - + 8-/10-bit Raw RGB data - - 图片最大传输速率 - + UXGA/SXGA: 15fps - + SVGA: 30fps - + CIF: 60fps - - 扫描模式: Progressive -- 摄像头特性 - + CCD尺寸: 1/4inch - + 可视范围: 78 degree - + 最大像素: 200W -- 重量: 5g - - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **[数据手册]** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - -- **[上手指南](/en/quick_start/m5camera/m5camera_quick_start)** - -## 例程 - - - -## 原理图 - - - -### 管脚映射 - - + +## 原理图 + + + +### 管脚映射 + + \ No newline at end of file diff --git a/docs/zh_CN/unit/gps.md b/docs/zh_CN/unit/gps.md index f253b7a5..84accd73 100644 --- a/docs/zh_CN/unit/gps.md +++ b/docs/zh_CN/unit/gps.md @@ -1,80 +1,80 @@ -# GPS - 北斗导航 - - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.51a6425e6lnUwE&id=583664452054)** - - - -## 描述 - -GPS是一款集成车载设备级别的中科微北斗导航AT6558的Unit，芯片性能强悍，能获取准确全球位置信息，支持多种卫星导航系统，比如中国的BDS, 美国的GPS, 俄罗斯的GLONASS等，同时接受六个卫星导航系统的GNSS信号，并且实现联合定位、导航和授时。接M5Core的GROVE C口，M5Core通过串口与该unit通讯。其中unit还集成了信号放大芯片MAX2659。 - -## 特性 - -- 支持多种卫星导航系统，比如中国的BDS, 美国的GPS, 俄罗斯的GLONASS等 -- AT6558 - - 15mA超低功耗 - - 集成射频、基带、flash - - 工作温度：-40~85℃ - -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 应用 - -- 车载定位 -- 智能执法定位 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **[数据手册]** - [AT6558](http://www.icofchina.com/d/file/xiazai/2016-12-05/b1be6f481cdf9d773b963ab30a2d11d8.pdf) - [MAX2659](https://datasheets.maximintegrated.com/en/ds/MAX2659.pdf) - -- **[CASIC多模卫星导航接收机协议规范](http://www.icofchina.com/d/file/xiazai/2017-05-02/ea0cdd3d81eeebcc657b5dbca80925ee.pdf)** - -- **[上位机软件GnssToolKit3(Windows版本)](http://www.icofchina.com/d/file/xiazai/2018-05-23/2b29a8da746eec0ef1dcd9deae895298.zip)** - -## 例程 - -### 1. Arduino IDE - -```c++ -GPSRaw.begin(9600); - -if(GPSRaw.available()) { - int ch = GPSRaw.read(); - Serial.write(ch); -} -``` - -烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)之后，屏幕和串口显示终端会打印如下类似的信息 - -``` -$GPGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*02 -$BDGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*13 -$GPGSV,1,1,00*79 -$BDGSV,1,1,00*68 -$GNRMC,,V,,,,,,,,,,M*4E -$GNVTG,,,,,,,,,M*2D -$GNZDA,,,,,,*56 -$GPTXT,01,01,01,ANTENNA OPEN*25 -``` - -具体例程`GPSRaw.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/GPS/Arduino)。 - - - -### 管脚映射 - - - - -
M5Core(GROVE C)GPIO16GPIO17
5VGND
GPS UnitTXDRXD
5VGND
+# GPS - 北斗导航 + + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.51a6425e6lnUwE&id=583664452054)** + + + +## 描述 + +GPS是一款集成车载设备级别的中科微北斗导航AT6558的Unit，芯片性能强悍，能获取准确全球位置信息，支持多种卫星导航系统，比如中国的BDS, 美国的GPS, 俄罗斯的GLONASS等，同时接受六个卫星导航系统的GNSS信号，并且实现联合定位、导航和授时。接M5Core的GROVE C口，M5Core通过串口与该unit通讯。其中unit还集成了信号放大芯片MAX2659。 + +## 特性 + +- 支持多种卫星导航系统，比如中国的BDS, 美国的GPS, 俄罗斯的GLONASS等 +- AT6558 + - 15mA超低功耗 + - 集成射频、基带、flash + - 工作温度：-40~85℃ + +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 应用 + +- 车载定位 +- 智能执法定位 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **[数据手册]** - [AT6558](http://www.icofchina.com/d/file/xiazai/2016-12-05/b1be6f481cdf9d773b963ab30a2d11d8.pdf) - [MAX2659](https://datasheets.maximintegrated.com/en/ds/MAX2659.pdf) + +- **[CASIC多模卫星导航接收机协议规范](http://www.icofchina.com/d/file/xiazai/2017-05-02/ea0cdd3d81eeebcc657b5dbca80925ee.pdf)** + +- **[上位机软件GnssToolKit3(Windows版本)](http://www.icofchina.com/d/file/xiazai/2018-05-23/2b29a8da746eec0ef1dcd9deae895298.zip)** + +## 例程 + +### 1. Arduino IDE + +```c++ +GPSRaw.begin(9600); + +if(GPSRaw.available()) { + int ch = GPSRaw.read(); + Serial.write(ch); +} +``` + +烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)之后，屏幕和串口显示终端会打印如下类似的信息 + +``` +$GPGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*02 +$BDGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*13 +$GPGSV,1,1,00*79 +$BDGSV,1,1,00*68 +$GNRMC,,V,,,,,,,,,,M*4E +$GNVTG,,,,,,,,,M*2D +$GNZDA,,,,,,*56 +$GPTXT,01,01,01,ANTENNA OPEN*25 +``` + +具体例程`GPSRaw.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/GPS/Arduino)。 + + + +### 管脚映射 + + + + +
M5Core(GROVE C)GPIO16GPIO17
5VGND
GPS UnitTXDRXD
5VGND
diff --git a/docs/zh_CN/unit/heart.md b/docs/zh_CN/unit/heart.md index 93eeceb3..d74254dc 100644 --- a/docs/zh_CN/unit/heart.md +++ b/docs/zh_CN/unit/heart.md @@ -1,46 +1,46 @@ -# HEART - 血氧心率传感器 - - - -*** - -:memo:**[描述](#描述)**|🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.7a46425eWmFRNi&id=583999638264)** - - - -## 描述 - -HEART是一款能够非侵入式检测血氧和心率的Unit，集成MAX30110 pulse oximeter模块，其原理是通过红外led灯照射，检测红血球携带氧气和非携带氧气情况数量变化情况，能够得到心率的ADC值，包含两个发光二极管和一个光检测器。unit接入M5Core的GROVE A口之后，只需要将手指紧贴在unit的MAX30110模块上，即可读出生理信息。 - -## 特性 - - -- Unit内置两个Lego插件孔，方便与Lego件结合 - - - - - - - -## 相关链接 - -- [MAX30100](https://datasheets.maximintegrated.com/en/ds/MAX30110.pdf) +# HEART - 血氧心率传感器 + + + +*** + +:memo:**[描述](#描述)**|🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.7a46425eWmFRNi&id=583999638264)** + + + +## 描述 + +HEART是一款能够非侵入式检测血氧和心率的Unit，集成MAX30110 pulse oximeter模块，其原理是通过红外led灯照射，检测红血球携带氧气和非携带氧气情况数量变化情况，能够得到心率的ADC值，包含两个发光二极管和一个光检测器。unit接入M5Core的GROVE A口之后，只需要将手指紧贴在unit的MAX30110模块上，即可读出生理信息。 + +## 特性 + + +- Unit内置两个Lego插件孔，方便与Lego件结合 + + + + + + + +## 相关链接 + +- [MAX30100](https://datasheets.maximintegrated.com/en/ds/MAX30110.pdf) diff --git a/docs/zh_CN/unit/hub.md b/docs/zh_CN/unit/hub.md index 82f96af5..97a548e1 100644 --- a/docs/zh_CN/unit/hub.md +++ b/docs/zh_CN/unit/hub.md @@ -1,25 +1,25 @@ -# HUB - GROVE接口拓展Unit - - - -*** - -:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.48.159c425eoqBTTY&id=578028344563)** - -## 描述 - -HUB Unit是一款GROVE接口的集中器，目的是通过HUB能把GROVE接口拓展为3个，这样同时能连接更多的Unit传感器。 - -## 特性 - -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 原理图 - - +# HUB - GROVE接口拓展Unit + + + +*** + +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.48.159c425eoqBTTY&id=578028344563)** + +## 描述 + +HUB Unit是一款GROVE接口的集中器，目的是通过HUB能把GROVE接口拓展为3个，这样同时能连接更多的Unit传感器。 + +## 特性 + +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 原理图 + + diff --git a/docs/zh_CN/unit/ir.md b/docs/zh_CN/unit/ir.md index eb618c15..bf684040 100644 --- a/docs/zh_CN/unit/ir.md +++ b/docs/zh_CN/unit/ir.md @@ -1,85 +1,85 @@ -# IR - 红外对管 - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**       :electric_plug:**[原理图](#原理图)**       🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.49.6dd575f4jqLzgO&id=578200569184)** - -## 描述 - -IR是一款红外光电对管Unit，集成一对红外发送和接收管。与M5Core连接之后，可以通过M5Core来控制是否发出红外光，另外的接收管能检测是否有红外光发送给unit。 - -因为GROVE接口有两个信号引脚，一个控制红外发送，一个控制红外接收，所以如果要发送红外光则需要OUTPUT管脚(GPIO26)输出高电平。 - -## 特性 - -- 内置一对红外发送和接收管 -- 检测距离: 2 ~ 5cm -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -#include -// select the input pin for the potentiometer -int ir_recv_pin = 36; -int ir_send_pin = 26; -int last_recv_value = 0; -int cur_recv_value = 0; - -void setup() { - M5.begin(); - pinMode(ir_recv_pin, INPUT); - pinMode(ir_send_pin, OUTPUT); - //send infrared light - //now, you can see the infrared light through mobile phone camera - digitalWrite(ir_send_pin, 1); - M5.Lcd.setTextSize(2); - M5.Lcd.setCursor(0, 0); - M5.Lcd.print("Test for IR receiver: "); -} - -void loop() { - //now, once you press the button on a remote controller to send infrared light - //the screen will display "detected!" - cur_recv_value = digitalRead(ir_recv_pin); - if(last_recv_value != cur_recv_value){ - M5.Lcd.setCursor(0, 25); - M5.Lcd.fillRect(0, 25, 150, 25, BLACK); - if(cur_recv_value == 0){//0: detected 1: not detected - M5.Lcd.print("detected!"); - } - last_recv_value = cur_recv_value; - } - delay(100); -} -``` - -具体例程`ir_dectect.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/Arduino)。 - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/UIFlow)。 - -## 原理图 - - - -### 管脚映射 - - - - +# IR - 红外对管 + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**       :electric_plug:**[原理图](#原理图)**       🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.49.6dd575f4jqLzgO&id=578200569184)** + +## 描述 + +IR是一款红外光电对管Unit，集成一对红外发送和接收管。与M5Core连接之后，可以通过M5Core来控制是否发出红外光，另外的接收管能检测是否有红外光发送给unit。 + +因为GROVE接口有两个信号引脚，一个控制红外发送，一个控制红外接收，所以如果要发送红外光则需要OUTPUT管脚(GPIO26)输出高电平。 + +## 特性 + +- 内置一对红外发送和接收管 +- 检测距离: 2 ~ 5cm +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +#include +// select the input pin for the potentiometer +int ir_recv_pin = 36; +int ir_send_pin = 26; +int last_recv_value = 0; +int cur_recv_value = 0; + +void setup() { + M5.begin(); + pinMode(ir_recv_pin, INPUT); + pinMode(ir_send_pin, OUTPUT); + //send infrared light + //now, you can see the infrared light through mobile phone camera + digitalWrite(ir_send_pin, 1); + M5.Lcd.setTextSize(2); + M5.Lcd.setCursor(0, 0); + M5.Lcd.print("Test for IR receiver: "); +} + +void loop() { + //now, once you press the button on a remote controller to send infrared light + //the screen will display "detected!" + cur_recv_value = digitalRead(ir_recv_pin); + if(last_recv_value != cur_recv_value){ + M5.Lcd.setCursor(0, 25); + M5.Lcd.fillRect(0, 25, 150, 25, BLACK); + if(cur_recv_value == 0){//0: detected 1: not detected + M5.Lcd.print("detected!"); + } + last_recv_value = cur_recv_value; + } + delay(100); +} +``` + +具体例程`ir_dectect.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/Arduino)。 + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/UIFlow)。 + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE B)GPIO36GPIO265VGND
IR UnitReceiver PinTransmitter Pin5VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
IR UnitReceiver PinTransmitter Pin5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/joystick.md b/docs/zh_CN/unit/joystick.md index aef9b92b..45eb0c43 100644 --- a/docs/zh_CN/unit/joystick.md +++ b/docs/zh_CN/unit/joystick.md @@ -1,66 +1,66 @@ -# JOYSTICK - 摇杆Unit - - - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.66.159c425eoqBTTY&id=577874535012)** - -## 描述 - -Joystick是一款内置MEGA328芯片控制的摇杆模块，可以输出X-Y两个方向的摇杆偏移量，可以判断Z方向是否按下的。 - -内部电路里，摇杆的X方向与MEGA328的A0管脚相连，Y方向与MEGA328的A1管脚相连，Z方向与MEGA的A2管脚相连。 - -Joystick Unit同样也是与M5Core相连之后，通过PORT A(I2C)控制，其I2C地址是0x52。M5Core只需要读取0x52的I2C地址数据即可知道摇杆的偏移情况。 - -## 特性 - -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -#define JOY_ADDR 0x52 - -//disable the speak noise -dacWrite(25, 0); -Wire.begin(21, 22, 400000); -Wire.requestFrom(JOY_ADDR); -while(Wire.available()) -{ - x_data = Wire.read();//x - y_data = Wire.read();//x - button_data = Wire.read();//x -} -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/Arduino)。 - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/UIFlow)。 - -## 原理图 - - - -### 管脚映射 - - - - +# JOYSTICK - 摇杆Unit + + + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.66.159c425eoqBTTY&id=577874535012)** + +## 描述 + +Joystick是一款内置MEGA328芯片控制的摇杆模块，可以输出X-Y两个方向的摇杆偏移量，可以判断Z方向是否按下的。 + +内部电路里，摇杆的X方向与MEGA328的A0管脚相连，Y方向与MEGA328的A1管脚相连，Z方向与MEGA的A2管脚相连。 + +Joystick Unit同样也是与M5Core相连之后，通过PORT A(I2C)控制，其I2C地址是0x52。M5Core只需要读取0x52的I2C地址数据即可知道摇杆的偏移情况。 + +## 特性 + +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +#define JOY_ADDR 0x52 + +//disable the speak noise +dacWrite(25, 0); +Wire.begin(21, 22, 400000); +Wire.requestFrom(JOY_ADDR); +while(Wire.available()) +{ + x_data = Wire.read();//x + y_data = Wire.read();//x + button_data = Wire.read();//x +} +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/Arduino)。 + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/UIFlow)。 + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
JOYSTICK UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
JOYSTICK UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/light.md b/docs/zh_CN/unit/light.md index 58f7e3f5..dbd7b15c 100644 --- a/docs/zh_CN/unit/light.md +++ b/docs/zh_CN/unit/light.md @@ -1,55 +1,55 @@ -# LIGHT - 光线传感Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.52.3a93425e5PQbBs&id=577601079444)** - -## 描述 - -LIGHT是一款光线传感器，内置光敏电阻和10K的可调电阻，可以通过调节可调电阻，从而改变触发信号的光强阈值。Unit的GRVE接口可以输出数字信号或者光强对应的模拟信号(电压信号)。 - -## 特性 - -- 10K可调电阻 -- 模拟或数字信号输出 -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -//disable the speak noise -dacWrite(25, 0); - -analogRead_value = analogRead(36);//get analog value of LIGHT(0-4095) -digitalRead_value = digitalRead(26);//0: sense the ligth 1: do not sense -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/Arduino)。 - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/UIFlow)。 - -## 原理图 - - - -### 管脚映射 - - - - +# LIGHT - 光线传感Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.52.3a93425e5PQbBs&id=577601079444)** + +## 描述 + +LIGHT是一款光线传感器，内置光敏电阻和10K的可调电阻，可以通过调节可调电阻，从而改变触发信号的光强阈值。Unit的GRVE接口可以输出数字信号或者光强对应的模拟信号(电压信号)。 + +## 特性 + +- 10K可调电阻 +- 模拟或数字信号输出 +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +//disable the speak noise +dacWrite(25, 0); + +analogRead_value = analogRead(36);//get analog value of LIGHT(0-4095) +digitalRead_value = digitalRead(26);//0: sense the ligth 1: do not sense +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/Arduino)。 + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/UIFlow)。 + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE B)GPIO36GPIO265VGND
LIGHT UnitAinDin5VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
LIGHT UnitAinDin5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/m5camera.md b/docs/zh_CN/unit/m5camera.md index 6a052e9d..19819c50 100644 --- a/docs/zh_CN/unit/m5camera.md +++ b/docs/zh_CN/unit/m5camera.md @@ -1,88 +1,88 @@ -# M5CAMERA - 摄像头 - -
- -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.22.6c2275f4nUJEfh&id=575652539758)** - -## 描述 - -M5Camera是一款基于ESP32芯片，集成OV2640摄像头驱动芯片的摄像头模块，并集成了including PSRAM。你可以通过ESP-IDF来编程摄像头功能。 - -同时，M5Camera Unit还预留了9轴陀螺仪(MPU6050)、大气压3合1传感器(BME280)和数字硅晶麦克风(SPM1423)的焊接口，如果你需要这些器件，可以焊接到对应位置上。M5Camera Unit还预留了电池接口，如果你需要做可移动的摄像头，那么可以焊接手头的锂电池到对应位置上。 - -## 包含 - -- 1x M5 Camera Unit -- 1x Type-C USB线 - -## 特性 - -- ESP32模组特性 - + 集成双核Tensilica LX6 - + 高达240MHz的时钟频率 - + 4MB internal SRAM - + 4+16MB Flash memory(包括16M的PSRAM) - + 集成802.11 BGN WiFi和双模蓝牙(经典蓝牙和BLE) - + 硬件加密(AES, SHA2, ECC, RSA-4096) -- CP2104 USB转串口 -- OV2640摄像头驱动 - - 输出格式(8-bit): - + YUV(422/420)/YCbCr422 - + RGB565/555 - + 8-bit compressed data - + 8-/10-bit Raw RGB data - - 图片最大传输速率 - + UXGA/SXGA: 15fps - + SVGA: 30fps - + CIF: 60fps - - 扫描模式: Progressive -- 摄像头特性 - + CCD尺寸: 1/4inch - + 可视范围: 78 degree - + 最大像素: 200W -- 重量: 5g - - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **[数据手册]** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - -- **[上手指南](/en/quick_start/m5camera/m5camera_quick_start)** - -## 例程 - - - -## 原理图 - - - -### 管脚映射 - - + +## 原理图 + + + +### 管脚映射 + + \ No newline at end of file diff --git a/docs/zh_CN/unit/makey.md b/docs/zh_CN/unit/makey.md index 9da5af73..d7258896 100644 --- a/docs/zh_CN/unit/makey.md +++ b/docs/zh_CN/unit/makey.md @@ -1,60 +1,60 @@ -# MAKEY - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.51.159c425eoqBTTY&id=577636777112)** - -## 描述 - -MAKEY是一款自带16引脚的Makey Unit，不过比市面上的Makey模块更容易编程，因为该Unit内置了MEGA328芯片来处理触摸引脚产生的信号。该Unit同样也是与M5Core相连之后，通过PORT A(I2C)控制，其I2C地址是0x51。 - -## 特性 - -- 内置Mega328p芯片，蜂鸣器，RGBLed - -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 应用 - -- 水果键盘 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - - - -## 原理图 - - - -### 管脚映射 - - - - +# MAKEY + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.51.159c425eoqBTTY&id=577636777112)** + +## 描述 + +MAKEY是一款自带16引脚的Makey Unit，不过比市面上的Makey模块更容易编程，因为该Unit内置了MEGA328芯片来处理触摸引脚产生的信号。该Unit同样也是与M5Core相连之后，通过PORT A(I2C)控制，其I2C地址是0x51。 + +## 特性 + +- 内置Mega328p芯片，蜂鸣器，RGBLed + +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 应用 + +- 水果键盘 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
MAKEY UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
MAKEY UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/ncir.md b/docs/zh_CN/unit/ncir.md index c041928c..68af9c05 100644 --- a/docs/zh_CN/unit/ncir.md +++ b/docs/zh_CN/unit/ncir.md @@ -1,63 +1,63 @@ -# NCIR - 单点红外检测Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.43.3a93425e5PQbBs&id=580005645359)** - -## 描述 - -NCIR是一款可以测量人体体温和人体走动的Unit，它内置了MLX90641传感器。它与Thermal Unit的区别，主要是NCIR Unit做表面单点温度测量，而Thermal Unit做大面积范围的温度测量。 - -## 特性 - -- 高精度 -- 测量温度范围: -70℃~382.2℃ -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 应用 - -- 人体体温测量 -- 物体(生物)移动检测 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **数据手册** - [MLX90614](https://pdf1.alldatasheet.com/datasheet-pdf/view/218977/ETC2/MLX90614.html) - -## 例程 - - - -## 原理图 - - - -### 管脚映射 - - - - +# NCIR - 单点红外检测Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.43.3a93425e5PQbBs&id=580005645359)** + +## 描述 + +NCIR是一款可以测量人体体温和人体走动的Unit，它内置了MLX90641传感器。它与Thermal Unit的区别，主要是NCIR Unit做表面单点温度测量，而Thermal Unit做大面积范围的温度测量。 + +## 特性 + +- 高精度 +- 测量温度范围: -70℃~382.2℃ +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 应用 + +- 人体体温测量 +- 物体(生物)移动检测 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **数据手册** - [MLX90614](https://pdf1.alldatasheet.com/datasheet-pdf/view/218977/ETC2/MLX90614.html) + +## 例程 + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/neopixel.md b/docs/zh_CN/unit/neopixel.md index 957a256d..b0fb9b6d 100644 --- a/docs/zh_CN/unit/neopixel.md +++ b/docs/zh_CN/unit/neopixel.md @@ -1,57 +1,57 @@ -# NEOPIXEL - 灯条Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.31.6c2275f4nUJEfh&id=580453719549)** - -## 描述 - -NeoPixel是带GROVE接口的NeoPixel灯带，将NeoPixel Unit与M5Core相连，可以很方便地实现控制，特别是使用[UiFlow](http://flow.m5stack.com)来编程。 - -?> **Tip** 注意NeoPixel Unit有输入和输出口，在接M5Core的时候，记得看清楚Unit上的箭头(顺序)方向，一定要输入口接M5Core，然后输出口还可以通过GROVE线，接下一条NeoPixel Unit，从而串联一起。 - -## 特性 - -- 可选长度: 10cm/20cm/0.5m/1m/2m -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - - - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow)。 - - - - - - + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow)。 + + + + + + \ No newline at end of file diff --git a/docs/zh_CN/unit/pir.md b/docs/zh_CN/unit/pir.md index 21174083..d7a57692 100644 --- a/docs/zh_CN/unit/pir.md +++ b/docs/zh_CN/unit/pir.md @@ -1,55 +1,55 @@ -# PIR - 人体红外Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.46.3a93425e5PQbBs&id=578444443796)** - -## 描述 - -PIR是一款感应人体(生物)红外信号的Unit，通过该Unit可以感知Unit前面是否有人经过，适用于做人体感应方面的项目。 - -## 特性 - -- 检测距离：150cm -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - - - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow)。 - -## 原理图 - - - -### 管脚映射 - - - - +# PIR - 人体红外Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.46.3a93425e5PQbBs&id=578444443796)** + +## 描述 + +PIR是一款感应人体(生物)红外信号的Unit，通过该Unit可以感知Unit前面是否有人经过，适用于做人体感应方面的项目。 + +## 特性 + +- 检测距离：150cm +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + + + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow)。 + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE B)GPIO36GPIO265VGND
PIR UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
PIR UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/proto.md b/docs/zh_CN/unit/proto.md index bc7219f5..478952f1 100644 --- a/docs/zh_CN/unit/proto.md +++ b/docs/zh_CN/unit/proto.md @@ -1,34 +1,34 @@ -# PROTO - - - -*** - -:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.61.3a93425e5PQbBs&id=577364213337)** - -## 描述 - -PROTO是一款可以自定义电路并焊接到上面的洞洞板Unit。你可以定义项目适用的电路到该Unit上，然后最终可以通过M5Core来实现控制。 - -## 特性 - -- 70 孔(每个孔宽：100mil) -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 原理图 - - - -### 管脚映射 - - - - +# PROTO + + + +*** + +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.61.3a93425e5PQbBs&id=577364213337)** + +## 描述 + +PROTO是一款可以自定义电路并焊接到上面的洞洞板Unit。你可以定义项目适用的电路到该Unit上，然后最终可以通过M5Core来实现控制。 + +## 特性 + +- 70 孔(每个孔宽：100mil) +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE B)GPIO36GPIO265VGND
PROTO UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
PROTO UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/relay.md b/docs/zh_CN/unit/relay.md index bf49b44e..be99c2a0 100644 --- a/docs/zh_CN/unit/relay.md +++ b/docs/zh_CN/unit/relay.md @@ -1,62 +1,62 @@ -# RELAY - 继电器Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.55.3a93425e5PQbBs&id=577469172757)**:clapper:**[相关视频](#相关视频)** - -## 描述 - -RELAY是一款继电器Unit，通过该Unit可以安全地用弱电控制强电，用M5Core或者手机来控制家里的电视、空调、冰箱等大功率电器。控制直流电的话，最大控制30V，3A；控制交流的话，最大控制220V，3A。 - - -## 特性 -- DC: 3A @ 30V; AC: 3A @ 220V -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - -### 1. Arduino IDE - -```c++ -// RELAY is connected to GROVE B -pinMode(26, OUTPUT); - -digitalWrite(26, 0);//relay opened -delay(1000); -digitalWrite(26, 1);//relay closed -delay(1000); -``` - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/Arduino)。 - -### 2. UIFlow - - - -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/UIFlow)。 - -## 原理图 - - - -### 管脚映射 - - - - -
M5Core(GROVE B)GPIO36GPIO265VGND
RELAY Unit RELAY Pin5VGND
- -## 相关视频 - -- **m5stack的简介** - - +# RELAY - 继电器Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.55.3a93425e5PQbBs&id=577469172757)**:clapper:**[相关视频](#相关视频)** + +## 描述 + +RELAY是一款继电器Unit，通过该Unit可以安全地用弱电控制强电，用M5Core或者手机来控制家里的电视、空调、冰箱等大功率电器。控制直流电的话，最大控制30V，3A；控制交流的话，最大控制220V，3A。 + + +## 特性 +- DC: 3A @ 30V; AC: 3A @ 220V +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + +### 1. Arduino IDE + +```c++ +// RELAY is connected to GROVE B +pinMode(26, OUTPUT); + +digitalWrite(26, 0);//relay opened +delay(1000); +digitalWrite(26, 1);//relay closed +delay(1000); +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/Arduino)。 + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/UIFlow)。 + +## 原理图 + + + +### 管脚映射 + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
RELAY Unit RELAY Pin5VGND
+ +## 相关视频 + +- **m5stack的简介** + + diff --git a/docs/zh_CN/unit/rgb.md b/docs/zh_CN/unit/rgb.md index 07c33055..6a90a4e2 100644 --- a/docs/zh_CN/unit/rgb.md +++ b/docs/zh_CN/unit/rgb.md @@ -1,54 +1,54 @@ -# RGB - 三色灯Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.78.159c425eoqBTTY&id=578321806638)** - -## 描述 - -RGB是一款集成3颗RGB Led的Unit，可以方便显示多彩颜色。一个Unit分别有IN口和OUT口，所以多个Unit可以通过GRVE线串联起来。 - -## 特性 - -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -## 例程 - - - -## 原理图 - - - -### 管脚映射 - - - - +# RGB - 三色灯Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.78.159c425eoqBTTY&id=578321806638)** + +## 描述 + +RGB是一款集成3颗RGB Led的Unit，可以方便显示多彩颜色。一个Unit分别有IN口和OUT口，所以多个Unit可以通过GRVE线串联起来。 + +## 特性 + +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +## 例程 + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE B)GPIO36GPIO265VGND
RGB UnitGPIO36GPIO265VGND
+ +
M5Core(GROVE B)GPIO36GPIO265VGND
RGB UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/thermal.md b/docs/zh_CN/unit/thermal.md index 47fac729..be52f985 100644 --- a/docs/zh_CN/unit/thermal.md +++ b/docs/zh_CN/unit/thermal.md @@ -1,69 +1,69 @@ -# THERMAL - 人体红外成像Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.70.3a93425e5PQbBs&id=576966170317)** - -## 描述 - -Thermal是一款内置热电堆传感器(一种热释红外传感器，型号MLX90640)的Unit，可以用了测量物体表面温度，并由各个表面温度不同组成的温度梯度而形成热成像图。MLX90640的像素是32x64。 - -该Unit同样与M5Core通过PORT A(I2C)接口通信。 - -使用该Unit可以方便的测量各个物体表面温度(正常误差±1.5°C) - - -## 特性 - -- 32x24像素 -- 目标温度：-40°C ÷ 300°C -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 应用 - -- 高精度的非接触性测温器 -- 生物移动检测 -- 可视化红外成像 - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **数据手册** - [MLX90640](http://www.alldatasheet.com/datasheet-pdf/pdf/884988/MELEXIS/MLX90640.html) - -## 例程 - - - -## 原理图 - - - -### 管脚映射 - - - - +# THERMAL - 人体红外成像Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.70.3a93425e5PQbBs&id=576966170317)** + +## 描述 + +Thermal是一款内置热电堆传感器(一种热释红外传感器，型号MLX90640)的Unit，可以用了测量物体表面温度，并由各个表面温度不同组成的温度梯度而形成热成像图。MLX90640的像素是32x64。 + +该Unit同样与M5Core通过PORT A(I2C)接口通信。 + +使用该Unit可以方便的测量各个物体表面温度(正常误差±1.5°C) + + +## 特性 + +- 32x24像素 +- 目标温度：-40°C ÷ 300°C +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 应用 + +- 高精度的非接触性测温器 +- 生物移动检测 +- 可视化红外成像 + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **数据手册** - [MLX90640](http://www.alldatasheet.com/datasheet-pdf/pdf/884988/MELEXIS/MLX90640.html) + +## 例程 + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
THERMAL UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
THERMAL UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/zh_CN/unit/tof.md b/docs/zh_CN/unit/tof.md index 204f0b67..def17580 100644 --- a/docs/zh_CN/unit/tof.md +++ b/docs/zh_CN/unit/tof.md @@ -1,72 +1,72 @@ -# TOF - 红外测距Unit - - - -*** - -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.40.3a93425e5PQbBs&id=580005945330)** - -## 描述 - -ToF是一款用"Time-to-Flight"传感器(VL53L0X)发出940nm的激光来测量距离的Unit，相比其他测距传感器，具有更高的精度，可以直接确定以毫米为单位的目标物体的距离。不到30ms即可提供最长2米的毫米级的绝对距离读值。 - -该Unit与M5Core通过PORT A(I2C)通信。I2C地址为0x29 - -## 特性 - -- 高精度 -- 测量距离最大2m -- 激光波长: 940nm -- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 -- Unit内置两个Lego插件孔，方便与Lego件结合 - -## 应用 - -- 手势控制 - -- 激光测距 - -- 3D结构光成像(3D感测) - -- 摄像机辅助（超快速自动对焦和景深图） - -## 相关链接 - -- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** - -- **[官方论坛](http://forum.m5stack.com/)** - -- **数据手册** - [VL53L0X](https://pdf1.alldatasheet.com/datasheet-pdf/view/948120/STMICROELECTRONICS/VL53L0X.html) - -## 例程 - -### 1. Arduino IDE - -```c++ -#define SYSRANGE_START 0x00 -#define RESULT_RANGE_STATUS 0x14 -#define ToF_ADDR 0x29 //the IIC address of ToF - -write_byte_data_at(SYSRANGE_START, 0x01); //start measure -read_block_data_at(RESULT_RANGE_STATUS, 12); //read 12 bytes once -dist = makeuint16(gbuf[11], gbuf[10]); //split distance data and save at "dist" -``` - -具体例程`MeasureDistance.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TOF/Arduino)。 - - - -## 原理图 - - - -### 管脚映射 - - - - +# TOF - 红外测距Unit + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.40.3a93425e5PQbBs&id=580005945330)** + +## 描述 + +ToF是一款用"Time-to-Flight"传感器(VL53L0X)发出940nm的激光来测量距离的Unit，相比其他测距传感器，具有更高的精度，可以直接确定以毫米为单位的目标物体的距离。不到30ms即可提供最长2米的毫米级的绝对距离读值。 + +该Unit与M5Core通过PORT A(I2C)通信。I2C地址为0x29 + +## 特性 + +- 高精度 +- 测量距离最大2m +- 激光波长: 940nm +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 +- Unit内置两个Lego插件孔，方便与Lego件结合 + +## 应用 + +- 手势控制 + +- 激光测距 + +- 3D结构光成像(3D感测) + +- 摄像机辅助（超快速自动对焦和景深图） + +## 相关链接 + +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** + +- **[官方论坛](http://forum.m5stack.com/)** + +- **数据手册** - [VL53L0X](https://pdf1.alldatasheet.com/datasheet-pdf/view/948120/STMICROELECTRONICS/VL53L0X.html) + +## 例程 + +### 1. Arduino IDE + +```c++ +#define SYSRANGE_START 0x00 +#define RESULT_RANGE_STATUS 0x14 +#define ToF_ADDR 0x29 //the IIC address of ToF + +write_byte_data_at(SYSRANGE_START, 0x01); //start measure +read_block_data_at(RESULT_RANGE_STATUS, 12); //read 12 bytes once +dist = makeuint16(gbuf[11], gbuf[10]); //split distance data and save at "dist" +``` + +具体例程`MeasureDistance.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TOF/Arduino)。 + + + +## 原理图 + + + +### 管脚映射 + +
M5Core(GROVE A)GPIO22GPIO215VGND
TOF UnitSCLSDA5VGND
+ +
M5Core(GROVE A)GPIO22GPIO215VGND
TOF UnitSCLSDA5VGND
\ No newline at end of file diff --git a/rollup.config.js b/rollup.config.js index d8965c3e..5e72e9b5 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -1,122 +1,122 @@ -// Dependencies -// ============================================================================= -const path = require('path'); - -import babel from 'rollup-plugin-babel'; -import commonjs from 'rollup-plugin-commonjs'; -import json from 'rollup-plugin-json'; -import merge from 'lodash.merge'; -import pkg from './package.json'; -import resolve from 'rollup-plugin-node-resolve'; -import { eslint } from 'rollup-plugin-eslint'; -import { uglify } from 'rollup-plugin-uglify'; - - -// Settings -// ============================================================================= -// Output -const entryFile = path.resolve(__dirname, 'src', 'js', 'index.js'); -const outputFile = path.resolve(__dirname, 'dist', 'js', `${pkg.name}.js`); - -// Banner -const bannerData = [ - `${pkg.name}`, - `v${pkg.version}`, - `${pkg.homepage}`, - `(c) ${(new Date()).getFullYear()} ${pkg.author}`, - `${pkg.license} license` -]; - -// Plugins -const pluginSettings = { - eslint: { - exclude : ['node_modules/**', './package.json'], - throwOnWarning: false, - throwOnError : true - }, - babel: { - exclude: ['node_modules/**'], - presets: [ - ['env', { - modules: false, - targets: { - browsers: ['ie >= 9'] - } - }] - ], - plugins: [ - 'external-helpers' - ] - }, - uglify: { - beautify: { - compress: false, - mangle : false, - output: { - beautify: true, - comments: /(?:^!|@(?:license|preserve))/ - } - }, - minify: { - compress: true, - mangle : true, - output : { - comments: new RegExp(pkg.name) - } - } - } -}; - - -// Config -// ============================================================================= -// Base -const config = { - input : entryFile, - output: { - file : outputFile, - banner : `/*!\n * ${ bannerData.join('\n * ') }\n */`, - sourcemap: true - }, - plugins: [ - resolve(), - commonjs(), - json(), - eslint(pluginSettings.eslint), - babel(pluginSettings.babel) - ], - watch: { - clearScreen: false - } -}; - -// Formats -// ----------------------------------------------------------------------------- -// IIFE -const iife = merge({}, config, { - output: { - format: 'iife' - }, - plugins: [ - uglify(pluginSettings.uglify.beautify) - ] -}); - -// IIFE (Minified) -const iifeMinified = merge({}, config, { - output: { - file : iife.output.file.replace(/\.js$/, '.min.js'), - format: iife.output.format - }, - plugins: [ - uglify(pluginSettings.uglify.minify) - ] -}); - - -// Exports -// ============================================================================= -export default [ - iife, - iifeMinified -]; +// Dependencies +// ============================================================================= +const path = require('path'); + +import babel from 'rollup-plugin-babel'; +import commonjs from 'rollup-plugin-commonjs'; +import json from 'rollup-plugin-json'; +import merge from 'lodash.merge'; +import pkg from './package.json'; +import resolve from 'rollup-plugin-node-resolve'; +import { eslint } from 'rollup-plugin-eslint'; +import { uglify } from 'rollup-plugin-uglify'; + + +// Settings +// ============================================================================= +// Output +const entryFile = path.resolve(__dirname, 'src', 'js', 'index.js'); +const outputFile = path.resolve(__dirname, 'dist', 'js', `${pkg.name}.js`); + +// Banner +const bannerData = [ + `${pkg.name}`, + `v${pkg.version}`, + `${pkg.homepage}`, + `(c) ${(new Date()).getFullYear()} ${pkg.author}`, + `${pkg.license} license` +]; + +// Plugins +const pluginSettings = { + eslint: { + exclude : ['node_modules/**', './package.json'], + throwOnWarning: false, + throwOnError : true + }, + babel: { + exclude: ['node_modules/**'], + presets: [ + ['env', { + modules: false, + targets: { + browsers: ['ie >= 9'] + } + }] + ], + plugins: [ + 'external-helpers' + ] + }, + uglify: { + beautify: { + compress: false, + mangle : false, + output: { + beautify: true, + comments: /(?:^!|@(?:license|preserve))/ + } + }, + minify: { + compress: true, + mangle : true, + output : { + comments: new RegExp(pkg.name) + } + } + } +}; + + +// Config +// ============================================================================= +// Base +const config = { + input : entryFile, + output: { + file : outputFile, + banner : `/*!\n * ${ bannerData.join('\n * ') }\n */`, + sourcemap: true + }, + plugins: [ + resolve(), + commonjs(), + json(), + eslint(pluginSettings.eslint), + babel(pluginSettings.babel) + ], + watch: { + clearScreen: false + } +}; + +// Formats +// ----------------------------------------------------------------------------- +// IIFE +const iife = merge({}, config, { + output: { + format: 'iife' + }, + plugins: [ + uglify(pluginSettings.uglify.beautify) + ] +}); + +// IIFE (Minified) +const iifeMinified = merge({}, config, { + output: { + file : iife.output.file.replace(/\.js$/, '.min.js'), + format: iife.output.format + }, + plugins: [ + uglify(pluginSettings.uglify.minify) + ] +}); + + +// Exports +// ============================================================================= +export default [ + iife, + iifeMinified +]; diff --git a/server.js b/server.js index f89a2775..4856629a 100644 --- a/server.js +++ b/server.js @@ -1,80 +1,80 @@ -// Dependencies -// ============================================================================= -const browserSync = require('browser-sync').create(); -const compression = require('compression'); - -browserSync.init({ - files: [ - './dist/**/*.*', - './docs/**/*.*' - ], - ghostMode: { - clicks: false, - forms : false, - scroll: false - }, - open: false, - notify: false, - cors: true, - reloadDebounce: 1000, - reloadOnRestart: true, - server: { - baseDir: [ - './docs/' - ], - middleware: [ - compression() - ] - }, - serveStatic: [ - './dist/' - ], - snippetOptions: { - rule: { - match: /<\/body>/i, - fn: function (snippet, match) { - // Fix CSS injection for alternate stylesheets - const styleSwitchFix = ` - - `; - - return snippet + styleSwitchFix + match; - } - } - }, - rewriteRules: [ - { - // Replace CDN default with local js path - match : /"https:\/\/unpkg\.com\/docsify-themeable"/g, - replace: '"/js/docsify-themeable.min.js"' - }, - { - // Replace CDN URLs with local paths - match : /https:\/\/unpkg\.com\/docsify-themeable\/dist\//g, - replace: '/' - } - ] -}); +// Dependencies +// ============================================================================= +const browserSync = require('browser-sync').create(); +const compression = require('compression'); + +browserSync.init({ + files: [ + './dist/**/*.*', + './docs/**/*.*' + ], + ghostMode: { + clicks: false, + forms : false, + scroll: false + }, + open: false, + notify: false, + cors: true, + reloadDebounce: 1000, + reloadOnRestart: true, + server: { + baseDir: [ + './docs/' + ], + middleware: [ + compression() + ] + }, + serveStatic: [ + './dist/' + ], + snippetOptions: { + rule: { + match: /<\/body>/i, + fn: function (snippet, match) { + // Fix CSS injection for alternate stylesheets + const styleSwitchFix = ` + + `; + + return snippet + styleSwitchFix + match; + } + } + }, + rewriteRules: [ + { + // Replace CDN default with local js path + match : /"https:\/\/unpkg\.com\/docsify-themeable"/g, + replace: '"/js/docsify-themeable.min.js"' + }, + { + // Replace CDN URLs with local paths + match : /https:\/\/unpkg\.com\/docsify-themeable\/dist\//g, + replace: '/' + } + ] +}); diff --git a/sw.js b/sw.js index cf6295c4..0e865b01 100644 --- a/sw.js +++ b/sw.js @@ -1,83 +1,83 @@ -/* =========================================================== - * docsify sw.js - * =========================================================== - * Copyright 2016 @huxpro - * Licensed under Apache 2.0 - * Register service worker. - * ========================================================== */ - -const RUNTIME = 'docsify' -const HOSTNAME_WHITELIST = [ - self.location.hostname, - 'fonts.gstatic.com', - 'fonts.googleapis.com', - 'unpkg.com' -] - -// The Util Function to hack URLs of intercepted requests -const getFixedUrl = (req) => { - var now = Date.now() - var url = new URL(req.url) - - // 1. fixed http URL - // Just keep syncing with location.protocol - // fetch(httpURL) belongs to active mixed content. - // And fetch(httpRequest) is not supported yet. - url.protocol = self.location.protocol - - // 2. add query for caching-busting. - // Github Pages served with Cache-Control: max-age=600 - // max-age on mutable content is error-prone, with SW life of bugs can even extend. - // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string. - // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190 - if (url.hostname === self.location.hostname) { - url.search += (url.search ? '&' : '?') + 'cache-bust=' + now - } - return url.href -} - -/** - * @Lifecycle Activate - * New one activated when old isnt being used. - * - * waitUntil(): activating ====> activated - */ -self.addEventListener('activate', event => { - event.waitUntil(self.clients.claim()) -}) - -/** - * @Functional Fetch - * All network requests are being intercepted here. - * - * void respondWith(Promise r) - */ -self.addEventListener('fetch', event => { - // Skip some of cross-origin requests, like those for Google Analytics. - if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) { - // Stale-while-revalidate - // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale - // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1 - const cached = caches.match(event.request) - const fixedUrl = getFixedUrl(event.request) - const fetched = fetch(fixedUrl, { cache: 'no-store' }) - const fetchedCopy = fetched.then(resp => resp.clone()) - - // Call respondWith() with whatever we get first. - // If the fetch fails (e.g disconnected), wait for the cache. - // If there’s nothing in cache, wait for the fetch. - // If neither yields a response, return offline pages. - event.respondWith( - Promise.race([fetched.catch(_ => cached), cached]) - .then(resp => resp || fetched) - .catch(_ => { /* eat any errors */ }) - ) - - // Update the cache with the version we fetched (only for ok status) - event.waitUntil( - Promise.all([fetchedCopy, caches.open(RUNTIME)]) - .then(([response, cache]) => response.ok && cache.put(event.request, response)) - .catch(_ => { /* eat any errors */ }) - ) - } +/* =========================================================== + * docsify sw.js + * =========================================================== + * Copyright 2016 @huxpro + * Licensed under Apache 2.0 + * Register service worker. + * ========================================================== */ + +const RUNTIME = 'docsify' +const HOSTNAME_WHITELIST = [ + self.location.hostname, + 'fonts.gstatic.com', + 'fonts.googleapis.com', + 'unpkg.com' +] + +// The Util Function to hack URLs of intercepted requests +const getFixedUrl = (req) => { + var now = Date.now() + var url = new URL(req.url) + + // 1. fixed http URL + // Just keep syncing with location.protocol + // fetch(httpURL) belongs to active mixed content. + // And fetch(httpRequest) is not supported yet. + url.protocol = self.location.protocol + + // 2. add query for caching-busting. + // Github Pages served with Cache-Control: max-age=600 + // max-age on mutable content is error-prone, with SW life of bugs can even extend. + // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string. + // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190 + if (url.hostname === self.location.hostname) { + url.search += (url.search ? '&' : '?') + 'cache-bust=' + now + } + return url.href +} + +/** + * @Lifecycle Activate + * New one activated when old isnt being used. + * + * waitUntil(): activating ====> activated + */ +self.addEventListener('activate', event => { + event.waitUntil(self.clients.claim()) +}) + +/** + * @Functional Fetch + * All network requests are being intercepted here. + * + * void respondWith(Promise r) + */ +self.addEventListener('fetch', event => { + // Skip some of cross-origin requests, like those for Google Analytics. + if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) { + // Stale-while-revalidate + // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale + // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1 + const cached = caches.match(event.request) + const fixedUrl = getFixedUrl(event.request) + const fetched = fetch(fixedUrl, { cache: 'no-store' }) + const fetchedCopy = fetched.then(resp => resp.clone()) + + // Call respondWith() with whatever we get first. + // If the fetch fails (e.g disconnected), wait for the cache. + // If there’s nothing in cache, wait for the fetch. + // If neither yields a response, return offline pages. + event.respondWith( + Promise.race([fetched.catch(_ => cached), cached]) + .then(resp => resp || fetched) + .catch(_ => { /* eat any errors */ }) + ) + + // Update the cache with the version we fetched (only for ok status) + event.waitUntil( + Promise.all([fetchedCopy, caches.open(RUNTIME)]) + .then(([response, cache]) => response.ok && cache.put(event.request, response)) + .catch(_ => { /* eat any errors */ }) + ) + } }) \ No newline at end of file