Skip to content

Commit 8963c6e

Browse files
authored
Merge pull request #2 from m5stack/update-readme
Update readme
2 parents 7f227e5 + 6de1c61 commit 8963c6e

1 file changed

Lines changed: 14 additions & 31 deletions

File tree

README.md

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,30 @@
44

55
### SKU:K151
66

7-
Description of the product
7+
**StackChan is a super kawaii AI desktop robot co-created by M5Stack and the user community.** It uses the M5Stack **flagship IoT development kit [CoreS3](https://docs.m5stack.com/en/core/CoreS3)** as its main controller, powered by an ESP32-S3 SoC featuring a 240 MHz dual-core processor, with 16MB Flash and 8MB PSRAM onboard, and supporting Wi-Fi and BLE. The main unit also integrates a 2.0-inch capacitive touch display with a high-strength glass cover, a 0.3 MP camera, a proximity & ambient light sensor, a 9-axis IMU (accelerometer + gyroscope + magnetometer), a microSD card slot, a 1W speaker, dual microphones, and power/reset buttons.
88

9-
## Related Link
10-
11-
- [Document & Datasheet](https://docs.m5stack.com/en/unit/product_Link)
12-
13-
## Required Libraries:
14-
15-
- [M5Unified](https://github.com/m5stack/M5Unified)
16-
- [IRremoteESP8266](https://github.com/crankyoldgit/irremoteesp8266)
17-
- [M5Unit-NFC](https://github.com/m5stack/M5Unit-NFC)
18-
19-
## License
9+
The **robot body**, connected to the main unit, includes a USB-C interface for power and data, a 550 mAh battery, two feedback servos (360-degree continuous rotation on the horizontal axis and 90-degree movement on the vertical axis), two rows totaling 12 RGB LEDs, infrared transmitter and receiver, a three-zone touch panel, and a full-featured NFC module.
2010

21-
- [Product Name- MIT](LICENSE)
11+
The **factory firmware** is feature-rich, including an AI Agent, lively and expressive animations, ESP-NOW wireless remote control, and online app downloads. It can connect to a mobile app for video viewing, remote avatar control, and more, and also supports online updates (OTA). The product also supports programming via Arduino, UiFlow2, and other methods, and can connect to various expansion units in the M5Stack ecosystem, making it easy to implement a wide range of custom functions.
2212

23-
## Remaining steps(Editorial Staff Look,After following the steps, remember to delete all the content below)
13+
Thank you to the contributors of the StackChan community, especially:
2414

25-
1. Change [clang format check path](./.github/workflows/clang-format-check.yml#L42-L47).
26-
2. Add License content to [LICENSE](/LICENSE).
27-
3. Change link on line 78 of [bug-report.yml](./.github/ISSUE_TEMPLATE/bug-report.yml#L79).
28-
29-
```cpp
30-
Example
31-
# M5Unit-ENV
32-
33-
## Overview
34-
35-
### SKU:U001 & U001-B & U001-C
36-
37-
Contains M5Stack-**UNIT ENV** series related case programs.ENV is an environmental sensor with integrated SHT30 and QMP6988 internally to detect temperature, humidity, and atmospheric pressure data.
15+
| ![](https://m5stack-doc.oss-cn-shenzhen.aliyuncs.com/1205/avatar_stack_chan.jpg) | ![](https://m5stack-doc.oss-cn-shenzhen.aliyuncs.com/1205/avatar_takao.jpg) |
16+
| ------------------------------------------------------------ | ------------------------------------------------------------ |
17+
| [@stack_chan](https://x.com/stack_chan) | [@mongonta555](https://x.com/mongonta555) |
18+
| Shinya Ishikawa | Takao Akaki |
3819

3920
## Related Link
4021

41-
- [Document & Datasheet](https://docs.m5stack.com/en/unit/envIII)
22+
- [Document & Datasheet](https://docs.m5stack.com/en/StackChan)
4223

4324
## Required Libraries:
4425

45-
- [Adafruit_BMP280_Library](https://github.com/adafruit/Adafruit_BMP280_Library)
26+
- [M5Unified](https://github.com/m5stack/M5Unified)
27+
- [IRremoteESP8266](https://github.com/crankyoldgit/irremoteesp8266)
28+
- [M5Unit-NFC](https://github.com/m5stack/M5Unit-NFC)
4629

4730
## License
4831

49-
- [M5Unit-ENV - MIT](LICENSE)
50-
```
32+
- [StackChan- MIT](LICENSE)
33+

0 commit comments

Comments
 (0)