From 333503bbbb46d8b3378c1349ad35e1648fa59d6b Mon Sep 17 00:00:00 2001
From: LiHuashen <854410664@qq.com>
Date: Fri, 15 Feb 2019 15:23:36 +0800
Subject: [PATCH] add M5CameraF docs (english chinese)
---
.../m5camera/m5camera_quick_start.md | 6 +-
docs/en/unit/m5camera_f.md | 186 ++++++++++++++++++
.../m5camera/m5camera_quick_start.md | 8 +-
.../m5camera/m5camera_quick_start.md | 16 +-
docs/zh_CN/unit/m5camera_f.md | 160 ++++++++-------
5 files changed, 299 insertions(+), 77 deletions(-)
create mode 100644 docs/en/unit/m5camera_f.md
diff --git a/docs/en/quick_start/m5camera/m5camera_quick_start.md b/docs/en/quick_start/m5camera/m5camera_quick_start.md
index ca3fb298..765556c4 100644
--- a/docs/en/quick_start/m5camera/m5camera_quick_start.md
+++ b/docs/en/quick_start/m5camera/m5camera_quick_start.md
@@ -28,10 +28,14 @@ Now, A WebCam you achieved successfully !
*Note:*
-ESP32CAM AP only can connect with one device at a time.
+ESP32Cam/M5Camera AP only can connect with one device at a time.
## Firmware
ESP32Cam Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/normal
M5Camera(A model default) Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/master
+
+M5CameraX Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/master
+
+M5CameraF Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/master
diff --git a/docs/en/unit/m5camera_f.md b/docs/en/unit/m5camera_f.md
new file mode 100644
index 00000000..ef2ef1a6
--- /dev/null
+++ b/docs/en/unit/m5camera_f.md
@@ -0,0 +1,186 @@
+# M5CameraF - Fisheye Lens {docsify-ignore-all}
+
+
+
+***
+
+:memo:**[Description](#Description)** :bulb:**[Quick Start](en/quick_start/m5camera/m5camera_quick_start)** :octocat:**[Code](#Code)** 🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Fish-eye-Camera-Module-OV2640-Fisheye-Mini-Camera-Unit-Demoboard-with-ESP32-PSRAM-Development/3226069_32973208335.html?spm=a2g1y.12024536.productList_5885013.subject_2)**
+
+
+
+## Description
+
+The **M5CameraF** is a camera unit based on ESP32 chip and OV2640 **including PSRAM**, **160° Fisheye Lens**. You can even program it through ESP-IDF or Arduino IDE.
+
+
+
+This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and humidity pressure sensor (BME280) and **Digital silicon microphone (SPM1423)**. If you need those devices, you can Self-weld them or purchase those version thraightly. Additionally, M5CameraF also reserves the weld of battery. The size of the battery that can be accommodated in the case corresponds to a battery capacity of **80mAh**.
+
+**Note: M5CameraF is named differently when different hardware is selected. They follow the rules below.**
+
+*M5CameraF_#_#... means optional hardware name follows "M5CameraF".*
+
+* If configured with MPU6050, will be named M5CameraF_6050
+* If also configured with microphone, will be named M5CameraF_6050_MIC
+* If also configured with BME280, will be named M5CameraX_6050_MIC_BME280
+* If also configured with battery, will be named M5CameraX_6050_MIC_BME280_BAT
+
+
+
+
+
+## Include
+
+- 1x M5Camera
+- 1x LEGO Adapter
+- 1x Wall/1515
+- 1x Type-C USB Cable
+
+
+
+## Feature
+
+- ESP32 specifications
+ + Dual-core Tensilica LX6 microprocessor
+ + Up to 240MHz clock frequency
+ + **4MB pSRAM**
+ + **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-to-TTL convertor
+- 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 according to specific format
+ + UXGA/SXGA: 15fps
+ + SVGA: 30fps
+ + CIF: 60fps
+ - Scan Mode: Progressive
+- Camera specifications
+ + Field of View : **160 degree**
+ + Maxmium Pixel: 200W
+- Sensor best resolution: 1600 * 1200
+- 尺寸:23.5 × 48 × 23.5mm
+
+## PinMap
+
+**Camera Interface PinMap**
+
+| *Interface* | *Camera Pin*| *M5CameraF* |
+| :------------------- | :--------:| :------: |
+| SCCB Clock | SIOC |IO23 |
+| SCCB Data | SIOD |**IO22** |
+| System Clock | XCLK |IO27 |
+| Vertical Sync | VSYNC |**IO25** |
+| Horizontal Reference | HREF |IO26 |
+| Pixel Clock | PCLK |IO21 |
+| Pixel Data Bit 0 | D2 |IO32 |
+| Pixel Data Bit 1 | D3 |IO35 |
+| Pixel Data Bit 2 | D4 |IO34 |
+| Pixel Data Bit 3 | D5 |IO5 |
+| Pixel Data Bit 4 | D6 |IO39 |
+| Pixel Data Bit 5 | D7 |IO18 |
+| Pixel Data Bit 6 | D8 |IO36 |
+| Pixel Data Bit 7 | D9 |IO19 |
+| Camera Reset | RESET |IO15 |
+| Camera Power Down | PWDN | *see Note 1* |
+| Power Supply 3.3V | 3V3 | 3V3 |
+| Ground | GND | GND |
+
+**GROVE Interface**
+
+| *Grove* | *M5CameraF* |
+| :-----------: | :------: |
+| SCL | **IO13** |
+| SDA | **IO4** |
+| 5V | 5V |
+| GND | GND |
+
+**LED Interface**
+
+| *LED* | *M5CameraF* |
+| :-----------: | :------: |
+| LED_Pin | IO14 |
+
+**The following tables are Reserved Chip Interfaces**
+
+**BME280 Interface**
+
+*It's IIC address is 0x76.*
+
+| *BME280* | *M5CameraF* |
+| :-----------: | :------: |
+| SCL | IO23 |
+| SDA | IO22 |
+
+
+**MPU6050 Interface**
+
+*It's IIC address is 0x68.*
+
+| *MPU6050* | *M5CameraF* |
+| :-----------: | :------: |
+| SCL | IO23 |
+| SDA | IO22 |
+
+**MIC(SPM1423) Interface**
+
+| *MIC(SPM1423)* | *M5CameraF* |
+| :-----------: | :------: |
+| CLK |IO4|
+| DATA |IO2|
+
+**NOTE:**
+
+1. **Camera Power Down** pin does not need to be connected to ESP32 GPIO. Instead it may be pulled down to ground with 10 kOhm resistor.
+
+2. We have several kinds of camera boards, the following figures show the main differece with them. If you want the detailed defference with them, please click [here](https://shimo.im/sheets/gP96C8YTdyjGgKQC).
+
+
+
+## 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)
+
+
+
+## Code
+
+### Firmware
+
+- **[M5Camera Firmware](https://github.com/m5stack/m5stack-cam-psram/tree/master)**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/ja/quick_start/m5camera/m5camera_quick_start.md b/docs/ja/quick_start/m5camera/m5camera_quick_start.md
index 02708921..90c8e058 100644
--- a/docs/ja/quick_start/m5camera/m5camera_quick_start.md
+++ b/docs/ja/quick_start/m5camera/m5camera_quick_start.md
@@ -24,10 +24,14 @@
ESP32Cam/M5Cameraの映像がブラウザにリアルタイムに表示されましたか?
-?> メモ: ESP32CAMのAPには一度にひとつのデバイスしか接続できません。
+?> メモ: ESP32Cam/M5Camera のAPには一度にひとつのデバイスしか接続できません。
## コード
ESP32Cam: https://github.com/m5stack/m5stack-cam-psram/tree/normal
-M5Camera (A model): https://github.com/m5stack/m5stack-cam-psram/tree/master
\ No newline at end of file
+M5Camera (A model): https://github.com/m5stack/m5stack-cam-psram/tree/master
+
+M5CameraX : https://github.com/m5stack/m5stack-cam-psram/tree/master
+
+M5CameraF : https://github.com/m5stack/m5stack-cam-psram/tree/master
\ No newline at end of file
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 665f09a5..84e2ad59 100644
--- a/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md
+++ b/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md
@@ -1,26 +1,26 @@
# ESP32Cam/M5Camera Quick Start {docsify-ignore-all}
-## 开箱即用的Demo
+## 开箱即用的 Demo
*这是一个开箱即用的例程,摄像头模块预置了这个例程。*
*如果你拿到摄像头模块之后,不需要写任何代码即可能看到摄像头拍摄的图像。*
-1. 向ESP32Cam/M5Camera插入USB线以供电,然后打开电脑的串口终端。
+1. 向 ESP32Cam/M5Camera 插入 USB 线以供电,然后打开电脑的串口终端。
-2. 等待几秒之后,用电脑连接名为`M5CAM`的热点。
+2. 等待几秒之后,用电脑连接名为 `M5CAM` 的热点。
-3. 打开浏览器,访问网址`http://192.168.4.1`。 此时,即可看到ESP32Cam/M5Camera实时传输的图像。
+3. 打开浏览器,访问网址`http://192.168.4.1`。 此时,即可看到 ESP32Cam/M5Camera 实时传输的图像。
@@ -28,10 +28,14 @@
*注意:*
-ESP32CAM的热点一次只能连接一台电脑
+ESP32Cam/M5Camera 的热点一次只能连接一台电脑
## 固件
ESP32Cam 固件地址:https://github.com/m5stack/m5stack-cam-psram/tree/normal
-M5Camera 固件地址 (默认是 A model):https://github.com/m5stack/m5stack-cam-psram/tree/master
\ No newline at end of file
+M5Camera 固件地址 (默认是 A model):https://github.com/m5stack/m5stack-cam-psram/tree/master
+
+M5CameraX 固件地址:https://github.com/m5stack/m5stack-cam-psram/tree/master
+
+M5CameraF 固件地址:https://github.com/m5stack/m5stack-cam-psram/tree/master
\ No newline at end of file
diff --git a/docs/zh_CN/unit/m5camera_f.md b/docs/zh_CN/unit/m5camera_f.md
index ff0a5beb..fd96f070 100644
--- a/docs/zh_CN/unit/m5camera_f.md
+++ b/docs/zh_CN/unit/m5camera_f.md
@@ -1,32 +1,51 @@
-# M5CAMERA - 摄像头(内置PSRAM) {docsify-ignore-all}
+# M5CameraF - 鱼眼摄像头 {docsify-ignore-all}
-
+
***
-:memo:**[描述](#描述)** :bulb:**[上手指南](zh_CN/quick_start/m5camera/m5camera_quick_start)** :octocat:**[代码](#代码)** 🛒**[购买链接](https://item.taobao.com/item.htm?spm=2013.1.20141001.1.7e6a3f17eDikoR&id=575652539758&scm=1007.12144.95220.42296_0&pvid=922f08d2-0a50-42fe-b89b-d5fef17bc52a&utparam=%7B%22x_hestia_source%22%3A%2242296%22%2C%22x_object_type%22%3A%22item%22%2C%22x_mt%22%3A0%2C%22x_src%22%3A%2242296%22%2C%22x_pos%22%3A1%2C%22x_pvid%22%3A%22922f08d2-0a50-42fe-b89b-d5fef17bc52a%22%2C%22x_object_id%22%3A575652539758%7D)** :clapper:**[相关视频](#相关视频)**
+:memo:**[描述](#描述)** :bulb:**[上手指南](zh_CN/quick_start/m5camera/m5camera_quick_start)** :octocat:**[代码](#代码)** 🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.18.550e425eB8OqGB&id=587046526441)**
-
+
+
+
## 描述
-**M5Camera**是一款基于 ESP32 芯片,集成 OV2640 摄像头驱动芯片的摄像头模块,并集成了 **PSRAM**。你可以通过 ESP-IDF 或 Arduino IDE 来编程摄像头功能。
+**M5CameraF**是一款基于 ESP32 芯片,集成 OV2640 摄像头驱动芯片的摄像头模块,并集成了 **PSRAM**,镜头采用 **鱼眼镜头**,你可以通过 ESP-IDF 或 Arduino IDE 来编程摄像头功能。
-同时,M5Camera Unit 还预留了9轴陀螺仪 (MPU6050) 、大气压3合1传感器 (BME280) 和**数字硅晶麦克风 (SPM1423)**的焊接口,如果你需要这些器件,可以焊接到对应位置上。M5Camera Unit 还预留了电池接口,如果你需要做可移动的摄像头,那么可以焊接手头的锂电池到对应位置上。
+
-因为模块可以生成 WIFI 热点 AP,所以可以用手机、PC 或其他设备通过 WIFI 无线获取摄像头图片,也可以通过模块的 GROVE 接口有线获取摄像头图片。目前可以实现网络摄像头、颜色识别和人脸识别功能。
+这个 Unit 还预留了 9 轴陀螺仪 (MPU6050) 、温湿度气压传感器 (BME280) 和**数字硅晶麦克风 (SPM1423)**的焊接口,如果你需要这些器件,可以自行焊接到对应位置上或者直接购买选配指定硬件版本的 M5CameraF。M5CameraF Unit 还预留了电池接口。外壳内可以容纳的电池大小对应电池容量为 **80mAh**。
+
+**注意:选配不同硬件时,M5CameraF 的命名不一样,遵循以下规则**
+
+*M5CameraF_#_#... 即 M5CameraF 后跟选配的硬件。*
+
+* 如果选配 MPU6050,则命名为 M5CameraF_6050
+* 如果还选配了麦克风 SPM1423,则命名为 M5CameraF_6050_MIC
+* 如果还选配了温湿度气压传感器 BME280,则命名为 M5CameraF_6050_BME280
+* 如果还选配电池,则命名为 M5CameraF_6050_MIC_BME280_BAT
+
+
+
+
## 包含
-- 1x M5 Camera Unit
-- 1x Type-C USB线
+- 1x M5CameraF
+- 1x LEGO 适配件
+- 1x Wall/1515
+- 1x Type-C USB 线
+
+
## 特性
-
- ESP32 模组特性
+ 集成双核 Tensilica LX6
+ 高达 240MHz 的时钟频率
@@ -47,48 +66,50 @@
+ CIF: 60fps
- 扫描模式: Progressive
- 摄像头特性
- + CCD尺寸: 1/4 寸
- + 可视范围: 78 度
+ + 可视范围: **160 度**
+ 最大像素: 200W
- 传感器最大分辨率:1600 * 1200
-- 尺寸:25mm x 24mm
-- 重量: 5g
+- 尺寸:23.5 × 48 × 23.5mm
-## 管脚对比
-
-**M5Camera 有两个版本,分别为版本A和版本B。**
+## 管脚映射
**摄像头驱动芯片 OV2640 接口**
-| *接口* | *OV2640 引脚*| *M5Camera(A 版本)* | *M5Camera(B 版本)* |
-| :------------------- | :--------:| :------: | :------: |
-| SCCB Clock | SIOC |IO23 |IO23 |
-| SCCB Data | SIOD |**IO25** |**IO22** |
-| System Clock | XCLK |IO27 |IO27 |
-| Vertical Sync | VSYNC |**IO22** |**IO25** |
-| Horizontal Reference | HREF |IO26 |IO26 |
-| Pixel Clock | PCLK |IO21 |IO21 |
-| Pixel Data Bit 0 | D2 |IO32 |IO32 |
-| Pixel Data Bit 1 | D3 |IO35 |IO35 |
-| Pixel Data Bit 2 | D4 |IO34 |IO34 |
-| Pixel Data Bit 3 | D5 |IO5 |IO5 |
-| Pixel Data Bit 4 | D6 |IO39 |IO39 |
-| Pixel Data Bit 5 | D7 |IO18 |IO18 |
-| Pixel Data Bit 6 | D8 |IO36 |IO36 |
-| Pixel Data Bit 7 | D9 |IO19 |IO19 |
-| Camera Reset | RESET |IO15 |IO15 |
-| Camera Power Down | PWDN | *see Note 1* | *see Note 1* |
-| Power Supply 3.3V | 3V3 | 3V3 | 3V3 |
-| Ground | GND | GND | GND |
+| *接口* | *OV2640 引脚*| *M5CameraF* |
+| :------------------- | :--------:| :------: |
+| SCCB Clock | SIOC |IO23 |
+| SCCB Data | SIOD |**IO22** |
+| System Clock | XCLK |IO27 |
+| Vertical Sync | VSYNC |**IO25** |
+| Horizontal Reference | HREF |IO26 |
+| Pixel Clock | PCLK |IO21 |
+| Pixel Data Bit 0 | D2 |IO32 |
+| Pixel Data Bit 1 | D3 |IO35 |
+| Pixel Data Bit 2 | D4 |IO34 |
+| Pixel Data Bit 3 | D5 |IO5 |
+| Pixel Data Bit 4 | D6 |IO39 |
+| Pixel Data Bit 5 | D7 |IO18 |
+| Pixel Data Bit 6 | D8 |IO36 |
+| Pixel Data Bit 7 | D9 |IO19 |
+| Camera Reset | RESET |IO15 |
+| Camera Power Down | PWDN | *see Note 1* |
+| Power Supply 3.3V | 3V3 | 3V3 |
+| Ground | GND | GND |
**GROVE 接口**
-| *Grove* | *M5Camera(A 版本)* | *M5Camera(B 版本)* |
-| :-----------: | :------: | :------: |
-| SCL | IO13 | IO13 |
-| SDA | **IO12** | **IO4** |
-| 5V | 5V | 5V |
-| GND | GND | GND |
+| *Grove* | *M5CameraF* |
+| :-----------: | :------: |
+| SCL | **IO13** |
+| SDA | **IO4** |
+| 5V | 5V |
+| GND | GND |
+
+**LED 接口**
+
+| *LED* | *M5CameraF* |
+| :-----------:| :------: |
+| LED_Pin | IO14 |
**以下为预留的IC接口**
@@ -96,37 +117,38 @@
*IIC 地址是 0x76*
-| *BME280* | *M5Camera(A 版本)* | *M5Camera(B 版本)* |
-| :-----------: | :------: | :------: |
-| SCL | IO23 | IO23 |
-| SDA | IO22 | IO22 |
+| *BME280* | *M5CameraF* |
+| :-----------: | :------: |
+| SCL | IO23 |
+| SDA | IO22 |
**MPU6050 接口**
-| *MPU6050* | *M5Camera(A 版本)* | *M5Camera(B 版本)* |
-| :-----------: | :------: | :------: |
-| SCL | IO23 | IO23 |
-| SDA | IO22 | IO22 |
+*IIC 地址是 0x68*
+
+| *MPU6050* | *M5CameraF* |
+| :-----------: | :------: |
+| SCL | IO23 |
+| SDA | IO22 |
**MIC(SPM1423) 接口**
-| *SPM1423* | *M5Camera(A 版本)* | *M5Camera(B 版本)* |
-| :-----------: | :------: | :------: |
-| CLK |IO4|IO4|
-| DATA |IO2|IO2|
+| *SPM1423* | *M5CameraF* |
+| :-----------: | :------: |
+| CLK |IO4|
+| DATA |IO2|
-**LED 接口**
-
-| *LED* | *M5Camera(A 版本)* | *M5Camera(B 版本)* |
-| :-----------:| :------: | :------: |
-| LED_Pin | IO14 | IO14 |
-
-Notes:
+**注意:**
1. **Camera Power Down 引脚** 没必要连接到 ESP32 的引脚。
-
+2. 我们有几个版本的摄像头板子,下图是它们主要区别的比较,如果想查看详细的资源对比,请点击[这里](https://shimo.im/sheets/gP96C8YTdyjGgKQC/e2041)。
+
+
+
+
+
## 相关链接
@@ -141,13 +163,15 @@ Notes:
### 固件
-- **[M5Camera 固件](https://github.com/m5stack/m5stack-cam-psram/tree/master)**
+- **[M5CameraF 固件](https://github.com/m5stack/m5stack-cam-psram/tree/master)**
-### 例程
+
+
+
@@ -183,7 +207,7 @@ float pressure = bme.readPressure();//pressure
| M5CAMERA Unit | SCL | SDA | 5V | GND |
-->
-## 相关视频
+