m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:m5stack/m5-docs

Browse Source
This commit is contained in:
Gitshaoxiang
2020-05-29 16:37:17 +08:00
parent c24fee7229 d8e923c12d
commit 4feaeb0591
7 changed files with 82 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/img/product_pics/atom_base/atom_qr/atomic_qr_01.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 95 KiB

docs/assets/img/product_pics/atom_base/atom_qr/atomic_qr_encode.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 163 KiB

docs/assets/img/product_pics/atom_base/atom_qr/atomic_qr_uiflow.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 49 KiB

docs/en/atom/atomic_qr.md
+32 -33
View File
@@ -1,23 +1,26 @@
# ATOMIC QR-CODE READER
# ATOM QR-CODE
<div class="badge badge-pill badge-primary product_sku_tag">SKU:A</div>
<div class="badge badge-pill badge-primary product_sku_tag">SKU:K041</div>
<div class="product_pic"><img src="assets/img/product_pics/atom_base/atomic/atomic_qr_01.webp"></div>
<div class="product_pic"><img src="assets/img/product_pics/atom_base/atom_qr/atomic_qr_01.webp"></div>
## Description
**ATOMIC QR-CODE READER** is a kit of scanning modules for reading Barcode/QR-codes, The product includes two parts: M5Atom Lite and code scanning module,it supports 6 kinds of 2D codes and 19 kinds of 1D codes. It has built-in lighting LED, which can easily identify even in dark environment. The green LED is convenient for focusing and aiming. The effective recognition accuracy of high-resolution CMOS imaging reaches 5mil. In addition, it has a variety of reading modes, which can be adjusted to automatic continuous trigger or manual trigger as required. The module has its own buzzer, which has different prompt sound effects in different states, and the module supports adding custom Prefix suffix to data, defining multi-national keyboard, data editing and many other functions. You can send the scanned data to the receiver for processing in wired or wireless way through M5Atom Lite。
**ATOM QR-CODE** is an M5Atom compatible module for reading Barcode/QR-codes. The product includes two parts: an M5Atom Lite unit and code scanning module. It supports 6 kinds of 2D codes and 19 kinds of 1D codes. It has built-in lighting LED, which can easily identify codes even in a dark environment. The green LED is convenient for focusing and aiming. The effective recognition accuracy of high-resolution CMOS imaging reaches 5mil. In addition, it has a variety of reading modes, which can be adjusted to automatic continuous trigger or manual trigger as required. The module has its own buzzer, which has different prompt sound effects in different states. The module also supports adding custom prefix/suffix to the data, defining multi-national keyboard, data editing and many other functions, it uses TTL-232 for communication, and can easily use serial port for data transmission. It can be easily used in Arduino or UIFlow programming,You can send the scanned data to the receiver for processing via wired or wireless connection through M5Atom Lite.
## Product Features
- Compatible with Atom Matrix/Atom Lite
- Built in lighting and focus LED
- TTL-232 communication
- Support Bluetooth and WiFi Based on esp32
- Support Arduino、Micropython、UIFlow
- UART/TTL communication
- Manual and automatic scanning mode
- Light and sound reminders
- Multiple output formats
- Data can be pre-edited and hidden
- Rich custom instructions
- Support RAW / GBK / Unicode
- 2D：QR Code,Mrico QR, Data Matrix, PDF417,Mrico PDF417，Aztec
- 1D：EAN,UPC,Code 39,Code 93,Code 128,UCC/EAN 128, Codabar，Interleaved 2 of 5, ITF-6,ITF-14,ISBN,ISSN, MSI-Plessey,GS1 Databar,Code 11,Industrial 25，Standard 25,Plessey, Matrix 2 of 5
@@ -25,18 +28,18 @@
## Inclued
- 1x ATOMIC QR-CODE READER
- 1x ATOMIC QR-CODE
- 1x M5Atom Lite
- 1x Hex Key
- 1x M2*8 Hexagon socket cup head machine screw
- 1x TYPE-C USB Cable（20cm)
## Application
- Cash register scanning
- Barcode/QR-code input
- Barcode/QR-code input device
- Warehouse inventory
<img src="assets/img/product_pics/atom_base/atomic/ATOMIC.gif" width = 30%>
## Specification
<table class="table-1">
@@ -73,7 +76,7 @@
</tr>
<tr>
<td>Reading range</td>
<td>EAN-13: 50-200mm(13mil), Code39: 40-90mm(5mil 10字节), QR Code: 25-240mm(20mil 16字节), Data Matrix: 50-90mm(10mil 20字节), PDF 417: 30-130mm(6.67mil 7字节)</td>
<td>EAN-13: 50-200mm(13mil), Code39: 40-90mm(5mil 10bytes), QR Code: 25-240mm(20mil 16bytes), Data Matrix: 50-90mm(10mil 20bytes), PDF 417: 30-130mm(6.67mil 7bytes)</td>
</tr>
<tr>
<td>Contrast ratio</td>
@@ -89,7 +92,7 @@
</tr>
<tr>
<td>Communication interface</td>
<td>TTL-232</td>
<td>UART/TTL</td>
</tr>
<tr>
<td>Voltage and Current</td>
@@ -97,15 +100,15 @@
</tr>
<tr>
<td>Net weight</td>
<td>g</td>
<td>17g</td>
</tr>
<tr>
<td>Gross weight</td>
<td> g</td>
<td> 37g</td>
</tr>
<tr>
<td>Product size</td>
<td>50*24*17mm</td>
<td>48*24*18mm</td>
</tr>
<tr>
<td>Package size</td>
@@ -118,6 +121,10 @@
</tbody>
</table>
## USAGE
The scan module has been configured at the factory. M5Atom Lite has no pre-burn preset program.You need to burn the following example program for use. If you need to change the configuration, please refer to the user manual to scan the QR code for configuration. If you restore the factory settings, please scan to confirm that you are in TTL communication mode,and the baud rate setting is correct.The reading of some 1D code or 2D code needs to be enabled by scanning qr-code of user manual to configure.
## EasyLoader
>EasyLoader is a concise and fast program writer, which has a built-in case program related to the product. It can be burned to the main control by simple steps to perform a series of function verification. Please install the corresponding driver according to the device type. M5Core host [Please click here to view the CP210X driver installation tutorial](en/arduino/arduino_development), M5StickC/V/T/ATOM series can be used without driver)
@@ -126,14 +133,15 @@
<div style="background-color:white;">
<div><img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/easyloader_intro.webp"></div>
<div class="easyloader-btn">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Windows/CORE/EasyLoader_UIFlow_v1.4.5.exe">Windows</a>
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Windows/ATOM_BASE/EasyLoader_QRCODE_ATOM_BASE.exe">Windows</a>
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/MacOS/ATOM_BASE/EasyLoader_QRCODE_ATOM_BASE.dmg">MacOS</a>
<!-- <a>Linux</a>
<a>MacOS</a> -->
</div>
</div>
<div>
<video id="example_video" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/Core/M5GO.mp4" type="video/mp4">
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/AtomBase/Atomic_QR.mp4" type="video/mp4">
</video>
<div class="easyloader-mask">
<a>
@@ -151,39 +159,30 @@
<tr><td>QR-CODE READER</td><td>TRIG</td><td>DLED</td><td>3.3V</td><td>GND</td></tr>
</table>
## Scan value - Character
## Schematic
<img src="assets/img/product_pics/hat/finger_hat/finger_hat_04.webp" width="50%" height="50%">
## USAGE
The scan module has been configured at the factory. If you need to change the configuration, please refer to the user manual to scan the QR code for configuration. If you restore the factory settings, please scan to confirm that you are in TTL communication mode,and the baud rate setting is correct。
<img src="assets/img/product_pics/atom_base/atom_qr/atomic_qr_encode.webp" width = "50%">
## Example
- **UIFlow**
Click[here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/AtomBase/AtomicQR/Arduino/AtomicQR)to download UIFlow example
Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/AtomBase/AtomicQR/UIFlow) to download UIFlow example
<img src="assets/img/product_pics/atom_base/atomic_qr/atomic_qr.webp">
<img src="assets/img/product_pics/atom_base/atom_qr/atomic_qr_uiflow.webp" width = "50%">
- **Arduino**
Click[here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/AtomBase/AtomicQR/Arduino/AtomicQR)to download Arduino example
Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/AtomBase/AtomicQR/AtomicQR) to download Arduino example
## Related Link
- **[Instruction description of QR code](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/atombase/AtomicQR/AtomicQR_Reader%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8C.docx)**
- **[User manual of QR code command](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/atombase/AtomicQR/AtomicQR_Reader%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8C.docx)**
## Video
<video class="video_size" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/AtomBase/AtomicQR.mp4" type="video/mp4" >
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/AtomBase/Atomic_QR.mp4" type="video/mp4" >
</video>
docs/index.md
+1
View File
@@ -28,6 +28,7 @@
{a:"/#/en/atom/tail485", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/atom_base/tail485_01.webp", p:"Tail485", sku:"T002" ,kw:"RS485"},
{a:"/#/en/atom/tailbat", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/atom_base/tailbat_01.webp", p:"TailBat", sku:"T001" ,kw:"BATTERY POWER SUPPLY LIPO"},
{a:"/#/en/atom/atomhub", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/atom_base/atom_hub_proto.webp", p:"ATOM HUB PROTO", sku:"K039" ,kw:"ATOM HUB PROTO BASE"},
{a:"/#/en/atom/atomic_qr", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/atom_base/atomic_qr_01.webp", p:"ATOM QR-CODE", sku:"K041" ,kw:"ATOM QR CODE SCAN"},
]
const module_list = [
docs/zh_CN/README.md
+1
View File
@@ -29,6 +29,7 @@
{a:"/#/zh_CN/atom/tail485", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/atom_base/tail485_01.webp", p:"Tail485", sku:"T002" ,kw:"RS485"},
{a:"/#/zh_CN/atom/tailbat", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/atom_base/tailbat_01.webp", p:"TailBat", sku:"T001" ,kw:"BATTERY POWER SUPPLY LIPO"},
{a:"/#/zh_CN/atom/atomhub", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/atom_base/atom_hub_proto.webp", p:"ATOM HUB PROTO", sku:"K039" ,kw:"ATOM HUB PROTO BASE"},
{a:"/#/zh_CN/atom/atomic_qr", img:"https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/atom_base/atomic_qr_01.webp", p:"ATOM QR-CODE", sku:"K041" ,kw:"ATOM QR CODE SCAN"},
]
const module_list = [
docs/zh_CN/atom/atomic_qr.md
+48 -29
View File
@@ -1,23 +1,26 @@
# ATOMIC QR-CODE READER
# ATOM QR-CODE
<div class="badge badge-pill badge-primary product_sku_tag">SKU:A</div>
<div class="badge badge-pill badge-primary product_sku_tag">SKU:K041</div>
<div class="product_pic"><img src="assets/img/product_pics/atom_base/atomic/atomic_qr_01.webp"></div>
<div class="product_pic"><img src="assets/img/product_pics/atom_base/atom_qr/atomic_qr_01.webp"></div>
## 描述
**ATOMIC QR-CODE READER** 是一款识别读取一维/二维码扫描模组套件，内含M5Atom Lite主机，支持6类二维码和19类一维码，内置照明LED，即使黑暗环境也能轻松识别，绿色LED方便对焦与瞄准，高分辨率CMOS成像有效识别精度达到5mil，同时具备多种识读模式，您可以根据需要调整为自动连续触发或手动触发。模块自带蜂鸣器，在不同状态下有不同的提示音效。此外模块支持数据添加自定义前缀后缀，定义多国键盘、数据编辑等众多功能。您可通过M5Atom Lite将扫描得到的数据以有线或无线的方式发送至接收端进行处理。
**ATOM QR-CODE** 是一款识别读取一维/二维码扫描模组套件，内含M5Atom Lite主机，支持6类二维码和19类一维码，内置照明LED，即使黑暗环境也能轻松识别，绿色LED方便对焦与瞄准，高分辨率CMOS成像有效识别精度达到5mil，同时具备多种识读模式，您可以根据需要调整为自动连续触发或手动触发。模块自带蜂鸣器，在不同状态下有不同的提示音效。此外模块支持数据添加自定义前缀后缀，定义多国键盘、数据编辑等众多功能。该模块采用TTL-232进行通讯，可以方便的使用串口进行数据传输，无论使用Arduino还是UIFlow编程都能轻松上手，您可通过M5Atom Lite内置的ESP32将扫描得到的数据以有线或无线的方式发送至接收端进行处理。
## 产品特性
- 基于ESP32,支持蓝牙、WIFI
- 兼容Atom Matrix/Atom Lite
- 支持Arduino、UIFlow、Micropython
- 自带照明与对焦LED
- TTL-232通讯
- UART/TTL通讯
- 手动、自动扫描模式
- 灯光、声音提醒
- 多种输出格式
- 数据可预编辑和隐藏
- 丰富的自定义指令
- 支持原始数据/GBK/Unicode编码方式
- 二维码：QR Code,Mrico QR, Data Matrix, PDF417,Mrico PDF417，Aztec
- 一维码：EAN,UPC,Code 39,Code 93,Code 128,UCC/EAN 128, Codabar，Interleaved 2 of 5, ITF-6,ITF-14,ISBN,ISSN, MSI-Plessey,GS1 Databar,Code 11,Industrial 25，Standard 25,Plessey, Matrix 2 of 5
@@ -25,8 +28,10 @@
## 包含
- 1x ATOMIC QR-CODE READER
- 1x ATOMIC QR-CODE
- 1x M5Atom Lite
- 1x M2内六角扳手
- 1x M2*8杯头机械牙螺丝
- 1x TYPE-C USB Cable（20cm)
## 应用
@@ -35,7 +40,6 @@
- 条码录入
- 仓库盘点
<img src="assets/img/product_pics/atom_base/atomic/ATOMIC.gif" width = 30%>
## 规格参数
@@ -65,7 +69,7 @@
</tr>
<tr>
<td>识读一维码类型</td>
<td>EAN,UPC,Code 39,Code 93,Code 128,UCC/EAN 128, Codabar，Interleaved 2 of 5, ITF-6,ITF-14,ISBN,ISSN, MSI-Plessey, GS1 Databar,Code 11,Industrial 25, Standard 25,Plessey, Matrix 2 of 5</td>
<td>EAN,UPC,Code 39,Code 93,Code 128,UCC/EAN 128, Codabar，Interleaved 2 of 5, ITF-6,ITF-14,ISBN,ISSN, MSI-Plessey, GS1 Databar,Code 11,Industrial 25, Standard 2 of 5,Plessey, Matrix 2 of 5</td>
</tr>
<tr>
<td>识别读取精度</td>
@@ -89,7 +93,7 @@
</tr>
<tr>
<td>通讯接口</td>
<td>TTL-232</td>
<td>UART/TTL</td>
</tr>
<tr>
<td>电压电流</td>
@@ -97,15 +101,15 @@
</tr>
<tr>
<td>净重</td>
<td>g</td>
<td>17g</td>
</tr>
<tr>
<td>毛重</td>
<td> g</td>
<td>37g</td>
</tr>
<tr>
<td>产品尺寸</td>
<td>50*24*17mm</td>
<td>48*24*18mm</td>
</tr>
<tr>
<td>包装尺寸</td>
@@ -126,46 +130,61 @@
</table>
## 原理图
<img src="assets/img/product_pics/hat/finger_hat/finger_hat_04.webp" width="50%" height="50%">
## 使用说明
扫码模块在出厂时已经进行了配置，如果您需要更改配置，请参照用户手册扫描二维码进行配置，如果您恢复了出厂设置，请务必扫描确认您处于TTL通讯模式下,并且波特率设置正确。
扫码模块在出厂时已经进行了配置，M5Atom Lite未内置程序，您需要在M5Atom Lite中烧录以下示例程序。如果您需要更改配置，请参照用户手册扫描二维码进行配置，如果您恢复了出厂设置，请务必扫描确认您处于TTL通讯模式下,并且波特率设置正确。部分一维码和二维码的识读需要扫描二维码配置使能。
## EasyLoader
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/EasyLoader_M5StickC_logo.webp" width="100px" style="margin-top:20px">
>EasyLoader是一个简洁快速的程序烧录器，其内置了一个产品相关的案例程序，通过简单步骤将其烧录至主控，即可进行一系列的功能验证。
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/HAT/FINGER/EasyLoader_StickC_HAT_FINGER.exe"><button type="button" class="btn btn-primary">点击下载EasyLoader</button></a>
<div class="easyloader-box">
<div style="background-color:white;">
<div><img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/easyloader_intro.webp"></div>
<div class="easyloader-btn">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Windows/ATOM_BASE/EasyLoader_QRCODE_ATOM_BASE.exe">Windows</a>
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/MacOS/ATOM_BASE/EasyLoader_QRCODE_ATOM_BASE.dmg">MacOS</a>
<!-- <a>Linux</a>
<a>MacOS</a> -->
</div>
</div>
<div>
<video id="example_video" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/AtomBase/Atomic_QR.mp4" type="video/mp4">
</video>
<div class="easyloader-mask">
<a>
<svg id="play-btn" t="1583228776634" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="4152" width="75" height="75"><path d="M512 0C229.216 0 0 229.216 0 512s229.216 512 512 512 512-229.216 512-512S794.784 0 512 0z m0 928C282.24 928 96 741.76 96 512S282.24 96 512 96s416 186.24 416 416-186.24 416-416 416zM384 288l384 224-384 224z" p-id="4153" fill="#007aff"></path></svg></a>
<p>案例描述:</p>
<p>按下按键开始扫描，串口打印扫描信息</p>
</div>
</div>
</div>
>1.EasyLoader是一个简洁快速的程序烧录器，每一个产品页面里的EasyLoader都提供了一个与产品相关的案例程序，通过简单步骤将其烧录至主控，能够进行一系列的功能验证.**(目前EasyLoader仅适用于Windows操作系统)**
## 扫描值-键盘值
>2.下载软件后，双击运行应用程序，将M5设备通过数据线连接至电脑,选择端口参数，点击 **"Burn"** 即可开始烧录.(**为M5StickC烧录时，请将波特率设置在750000或115200**)
<img src="assets/img/product_pics/atom_base/atom_qr/atomic_qr_encode.webp" width = "50%">
## 案例程序
- **UIFlow**
- **UIFlow**
打开 http://flow.m5stack.com 点击Demo载入UIFlow例程
点击 [此处](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/AtomBase/AtomicQR/UIFlow) 查看完整示例。
<img src="assets/img/product_pics/atom_base/atomic_qr/atomic_qr.webp">
<img src="assets/img/product_pics/atom_base/atom_qr/atomic_qr_uiflow.webp" width = "50%">
- **Arduino**
点击[此处](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/AtomBase/AtomicQR/Arduino/AtomicQR)查看完整示例
点击 [此处](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/AtomBase/AtomicQR/AtomicQR) 查看完整示例。
## 相关链接
- **[QR模块二维码指令说明](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/atombase/AtomicQR/AtomicQR_Reader%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8C.docx)**
- **[用户手册QR模块二维码指令说明](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/atombase/AtomicQR/AtomicQR_Reader%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8C.docx)**
## 相关视频
<video class="video_size" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/AtomBase/AtomicQR.mp4" type="video/mp4" >
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/AtomBase/Atomic_QR.mp4" type="video/mp4" >
</video>