Skip to content

Commit

Permalink
Add instructions for use of BSP
Browse files Browse the repository at this point in the history
  • Loading branch information
Tinyu-Zhao committed Jul 15, 2024
1 parent 9e73b0a commit bbf14a2
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@ English | [中文](README_cn.md)

[Compilation File](https://github.com/m5stack/M5CoreS3/blob/main/platformio.ini)

## Start with Board Support Package

To speed up prototyping on some development boards, you can use [Board Support Packages](https://github.com/espressif/esp-bsp) (BSPs), which makes initialization of a particular board as easy as few function calls.

A BSP typically supports all of the hardware components provided on development board. Apart from the pinout definition and initialization functions, a BSP ships with drivers for the external components such as sensors, displays, audio codecs etc.

The BSPs are distributed via IDF Component Manager, so they can be found in IDF Component Registry.

Here is an example of how to add M5CoreS3 BSP to your project:

`idf.py add-dependency m5stack_core_s3`

More examples of BSP usage can be found in [BSP examples folder](https://github.com/espressif/esp-bsp/tree/master/examples).


## M5CoreS3 M-BUS Schematic diagram

<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/core/CoreS3/S3.jpg" width = "35%">
Expand Down
15 changes: 15 additions & 0 deletions README_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,21 @@

[编译文件](https://github.com/m5stack/M5CoreS3/blob/main/platformio.ini)


## 上手板级支持包

可以使用 [板级支持包](https://github.com/espressif/esp-bsp) (BSP),协助在开发板上的原型开发。仅需要调用几个函数,便可以完成对特定开发板的初始化。

一般来说,BSP 支持开发板上所有硬件组件。除了管脚定义和初始化功能外,BSP 还附带如传感器、显示器、音频编解码器等外部元件的驱动程序。

BSP 通过 IDF 组件管理器 发布,可以前往 IDF 组件注册器 进行下载。

以下示例演示了如何将 M5CoreS3 BSP 添加到项目中:

`idf.py add-dependency m5stack_core_s3`

更多有关使用 BSP 的示例,请前往 [BSP 示例文件夹](https://github.com/espressif/esp-bsp/tree/master/examples)

## M5CoreS3 M-BUS示意图

<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/core/CoreS3/S3.jpg" width = "35%">
Expand Down

0 comments on commit bbf14a2

Please sign in to comment.