Skip to content

Commit

Permalink
Init
Browse files Browse the repository at this point in the history
  • Loading branch information
junhuanchen committed May 27, 2019
1 parent 8fa258b commit 408b32b
Show file tree
Hide file tree
Showing 34 changed files with 343 additions and 8 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
build
build
source/micropython
source/mPython
6 changes: 6 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[submodule "mPython"]
path = source/mPython
url = https://github.com/labplus-cn/mPython
[submodule "micropython"]
path = source/micropython
url = https://github.com/micropython/micropython
Binary file added images/facade.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# build

[![Documentation Status](https://readthedocs.org/projects/bpi-steam-docs/badge/?version=latest)](https://bpi-steam-docs.readthedocs.io/zh_CN/latest/?badge=latest)

## python

```unix
pip install sphinx, sphinx_rtd_theme, recommonmark
```

## powershell

```bat
.\make.bat html
```

## git

```unix
git submodule add https://github.com/micropython/micropython
git submodule add https://github.com/labplus-cn/mPython
git submodule update --init --recursive
```

## related

[esp32 中文](https://docs.singtown.com/micropython/zh/latest/esp32/index.html)

[openmv 中文](https://docs.singtown.com/micropython/zh/latest/openmvcam/index.html)

[microbit 中文](http://www.qingchuangzhiyi.com/doc/tutorials/hello.html)

[micropython 官方](http://docs.micropython.org/en/latest/esp32/quickref.html)

[mPython 中文](https://mpython.readthedocs.io/zh/master/)

Binary file added source/_static/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions source/bpi-dev/mpy-release.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
固件发布
========================================
2 changes: 2 additions & 0 deletions source/bpi-dev/mpy-tools.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
开发工具
========================================
2 changes: 2 additions & 0 deletions source/bpi-dev/web-release.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
固件发布
========================================
2 changes: 2 additions & 0 deletions source/bpi-dev/web-tools.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
编程软件
========================================
21 changes: 21 additions & 0 deletions source/bpi-steam/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 Open Source STEAM

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.
45 changes: 45 additions & 0 deletions source/bpi-steam/driver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# 安装驱动

## 连接板子

本产品采用 CH340 / CH341 串口驱动芯片,可以轻松的在 Windows 、 Linux 等系统下自动安装驱动。

> [CH341SER 相关系统驱动](http://www.wch.cn/download/CH341SER_ZIP.html)
将板子通过 MicroUSB 线连接到你的电脑里,以下以 Windows 10 为例。

![](driver/connect.png)

## 查看驱动

进入 **设备管理器** 确认串口驱动(Serial)是否安装,进入方法如下。

- (右键)此电脑 -> 属性 -> **设备管理器**
- 开始菜单 -> (输入)**设备管理器**
- 控制面板 -> (搜索)**设备管理器**

![](driver/error.png)

可以看到 设备显示 **USB2.0-Serial** ,说明**未安装驱动**,若此前已安装驱动,可以跳至步骤 5 。

## 安装驱动

点此获取 [Serial CH341](http://www.wch.cn/downloads/file/5.html) 驱动,并按如下说明操作安装驱动

打开下载的 **CH341SER.ZIP** 压缩包,进入 **CH341SER** 文件夹,打开 **SETUP.EXE**,即可看到如下图。

![](driver/install.png)

点击 **INSTALL** (安装),等待片刻即可完成安装。

## 确认串口

核对板子是否连接成功

![](driver/success.png)

可以看到原来的 **USB2.0-Serial** 消失了,取而代之的是 **USB-SERIAL CH340(COM3)**,这意味着你已经成功安装驱动,并且得到板子串口名称为(**COM3**),你可以通过各种串口工具来查看串口名(COM3)的板子传出的信息。

## 其他系统

- 至此板子连接成功,是 Linux 或 Mac 系统则需要你自行 baidu 或 Google 了。
Binary file added source/bpi-steam/driver/connect.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/driver/error.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/driver/install.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/driver/success.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions source/bpi-steam/hello.md

This file was deleted.

125 changes: 125 additions & 0 deletions source/bpi-steam/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@

# 产品介绍

![](https://img.shields.io/badge/open%20source-bananpi-brightgreen.svg)
![](https://img.shields.io/badge/support-webduino-blue.svg)

![](https://webduino.com.cn/site/img/tutorials/zh_cn/detail-03.gif)

本产品采用 ESP-WROOM-32 (ESP32)模组作为核心进行设计,拥有 40nm 工艺、使用 Tensilica LX6 双核32位处理器,频率高达 240 MHz,带有 32 个 I/O 引脚,支持 2.4G Wi-Fi 、蓝牙 4.0 以上等多种通信方式,具备 448KB ROM 和 520 KB SRAM 的内存容量,处理速度达 600 DMIPS,搭配 40nm 工艺的超低功耗,是目前市面上最高效能、最稳定以及最通用的产品之一。

它又名 Webduino Bit ,是 Webduino 最新的开发板,除了原本的功能一应俱全 ( Wi-Fi 控制、多装置并联、协同工作... 等 ),更是内置了许多有趣的组件与传感器。

同时 bpi:bit 开源社区还将持续兼容 micro:bit 的大部分配件以及用法。

## 外观介绍

![](readme/Interface_CN.jpg)

Webduino Bit 开发板长 5 公分宽 5 公分,重量约 10 ~ 12 公克,除了下方 20 Pin 的「金手指接口」,更内置一个 25 颗全彩 LED 灯的矩阵,两个光敏电阻、两个按钮开关、一个温度感应电阻、一个蜂鸣器和一个九轴传感器 ( 三轴加速度、三轴陀螺仪与三轴磁力指南针 ),脚位配置如下:

- 全彩 LED 矩阵:A10 ( GPIO 4 )
- 光敏传感器:左上 A0 ( GPIO 36 )、右上 A3 ( GPIO 39 )
- 按钮开关:按钮 A P5 ( GPIO 35 )、按钮 B P11 ( GPIO 27 )
- 温度传感器:A6 ( GPIO 34 )
- 蜂鸣器:P0 ( GPIO 25 )
- 九轴传感器 MPU-9250:P20 ( GPIO 21 )、P19 ( GPIO 22 )

## 拓展引脚

![](readme/goldfinger.jpg)

![](readme/pin-define.jpg)

### LED 编号

板子按照 5 * 5 排列方式焊接了 25 颗(编号 0 ~ 24 ) 1600 万色全彩 LED (WS2812) ,所有的 LED 的控制仅使用一个引脚 (GPIO 4) 即可控制。

![](readme/product.jpg)

板子正面 LED 序号排布方式如下(5 * 5)

![](readme/table.png)

(将板子正面朝向自己,并结合底盘金手指可知其位置)

## 版本区别

板子分 1.2 和 1.4 版本等多个版本,版本号标识在板子背面右下角。

![](readme/version.jpg)

## 产品支持

### [安装驱动](driver.md)

### Webduino

- [Webduino 基础教学](https://webduino.com.cn/site/zh_cn/tutorials.html)
- [Webduino 玩家指南](https://github.com/BPI-STEAM/BPI-BIT-WebDuino)
- [Webduino 中文社区](https://forum.banana-pi.org.cn/c/bpi-bit/webduino)

### MicroPython

- [MicroPython 玩家指南](https://github.com/BPI-STEAM/BPI-BIT-MicroPython)
- [MicroPython 示例代码](https://github.com/BPI-STEAM/BPI-BIT-Samples)
- [MicroPython 中文社区](https://forum.banana-pi.org.cn/c/bpi-bit/micropython)

### Arduino

- [Arduino 玩家指南](https://github.com/BPI-STEAM/BPI-BIT-Arduino)

## 硬件设计

### 引脚占用

![](readme/extern.png)

### 外观资料

![](readme/bot.png)

![](readme/top.png)

### 硬件资料

- [BPI-WEBDUINO-BIT-V1_2](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/BPI-WEBDUINO-BIT-V1_2.pdf)

- [BPI-WEBDUINO-BIT-V1_4](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/BPI-WEBDUINO-BIT-V1_4.pdf)

- [Buzzer-SS-S050020Z-120](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/Buzzer-SS-S050020Z-120.pdf)

- [CH340DS1-ch](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/CH340DS1-ch.pdf)

- [CH340DS1-en](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/CH340DS1-en.pdf)

- [esp32_hardware_design_guidelines_en](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/esp32_hardware_design_guidelines_en.pdf)

- [ESP32-datesheet_english](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/ESP32-datesheet_english.pdf)

- [esp-wroom-32_datasheet_cn](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/esp-wroom-32_datasheet_cn.pdf)

- [LightSensor-PTSMD021-0805](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/LightSensor-PTSMD021-0805.pdf)

- [LM1117](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/LM1117.pdf)

- [MPU-9250 Datasheet-v1.1-ch](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/MPU-9250%20Datasheet-v1.1-ch.pdf)

- [MPU-9250 Datasheet-v1.1-en](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/MPU-9250%20Datasheet-v1.1-en.pdf)

- [MPU-9250 Register Map-v1.6](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/MPU-9250%20Register%20Map-v1.6.pdf)

- [NTC-0805-103F-3950F](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/NTC-0805-103F-3950F.pdf)

- [SY7208](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/SY7208.pdf)

- [WS2812B](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/WS2812B.pdf)

- [DS-000189-ICM-20948-v1.3](https://github.com/BPI-STEAM/BPI-BIT-Hardware/tree/master/docs/DS-000189-ICM-20948-v1.3.pdf)

## 相关网站

- [官方中文社区](https://forum.banana-pi.org.cn/c/bpi)
- [官方英文社区](http://forum.banana-pi.org/c/bpi-bit)
- [Webduino 国内版](https://webduino.com.cn/site/)
- [Webduino 国际版](https://webduino.io/)
Binary file added source/bpi-steam/readme/Interface_CN.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/Interface_EN.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/bot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/extern.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/goldfinger.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/pin-define.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/product.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/table.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/top.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/bpi-steam/readme/version.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 33 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'junhuanchen'

# The full version, including alpha/beta/rc tags
release = '0.0.1'
release = '0.0.2'


# -- General configuration ---------------------------------------------------
Expand All @@ -31,6 +31,14 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -48,25 +56,48 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# html_theme = 'alabaster'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False

# -- Options for sphinx_rtd_theme --------------------------------------------

import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]


# Theme options
html_theme_options = {
# 'typekit_id': 'hiw1hhg',
# 'analytics_id': '',
'sticky_navigation': True, # Set to False to disable the sticky nav while scrolling.
#'titles_only': True,
'style_external_links': True,
'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text
'collapse_navigation': False, # Collapse navigation (False makes it tree-like)
# 'display_version': True, # Display the docs version
# 'navigation_depth': 4, # Depth of the headers shown in the navigation bar
}


html_logo = 'logo.png'

from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
Expand Down
Empty file removed source/contents.rst
Empty file.

0 comments on commit 408b32b

Please sign in to comment.