Skip to content

update docs #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Taoxuan-168 wants to merge 8 commits into from
Closed

update docs #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
925b002
更新自带APPs的文档
Jan 14, 2026
ff0fc28
Merge branch 'dev' of https://github.com/sipeed/MaixPy into dev
Jan 14, 2026
a280ed0
update doc
Taoxuan-168 Jan 16, 2026
6fe2af5
update docs
Taoxuan-168 Jan 23, 2026
c59c0ee
update docs
Taoxuan-168 Jan 23, 2026
f88350f
Merge branch 'sipeed:dev' into dev
Taoxuan-168 Jan 24, 2026
9c4fc23
Merge branch 'sipeed:dev' into dev
Taoxuan-168 Jan 24, 2026
eb1f2b0
Merge branch 'dev' of https://github.com/Taoxuan-168/MaixPy-dev into dev
Taoxuan-168 Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/doc/en/audio/recognize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Speech recognition model support list:
| ------- | ------- | ----------- | -------- |
| Whisper | ❌ | ❌ | ✅ |
| SenseVoice | ❌ | ❌ | ✅ |
| Speech | ✅ | ✅ | ❌ |
| Speech | ✅ | ✅ | ✅ |

In addition, we have ported OpenAI's Whisper speech recognition model to the `MaixCAM2`, enabling powerful speech-to-text functionality even on resource-constrained devices.

Expand Down
97 changes: 51 additions & 46 deletions docs/doc/en/projects/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,52 +42,57 @@ These are usually complete projects that include source code, documentation, dem

Applications pre-installed on platforms such as `MaixCAM`, `MaixCAM Pro`, and `MaixCAM2`

| Built-in Application | Supported Platforms | Description | Documentation |
| --------------- | ------------------------------------ | -------------------------------------- | ------------ |
| Benchmark | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Tests the comprehensive performance of CPU/NPU and other hardware | [Docs]() |
| Local Chat | `MaixCAM2` | Offline chat | [Docs]() |
| Desktop Monitor | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Host performance monitoring widget | [Docs]() |
| Face Emotion | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Emotion recognition | [Docs]() |
| Face Landmarks | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Keypoint recognition | [Docs]() |
| Face Recognizer | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Face recognition | [Docs]() |
| Face tracking | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Face tracking | [Docs]() |
| Gesture Classifier | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Recognizes different gestures | [Docs]() |
| Hand Landmarks | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Hand keypoint detection | [Docs]() |
| HTTP File Browser | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | View and download files via a browser | [Docs]() |
| Human Pose | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Human pose recognition | [Docs]() |
| Pose Classifier | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Recognizes different human poses | [Docs]() |
| Image Generation | `MaixCAM2` | Text-to-image, image-to-image | [Docs]() |
| IMU AHRS | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Calculates IMU data | [Docs]() |
| MaixHub Client | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Interacts with MaixHub | [Docs]() |
| Depth Estimation | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Monocular depth estimation | [Docs]() |
| Mouse Simulator | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Uses the device as a mouse | [Docs]() |
| OCR | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Text recognition | [Docs]() |
| RTMP Live | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | RTMP streaming | [Docs]() |
| RTSP Stream | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | RTSP streaming | [Docs]() |
| Scan QR Code | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Scans and recognizes barcodes, QR codes, Apriltag labels | [Docs]() |
| Self Learn Classifier | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Learns and classifies targets | [Docs]() |
| Self Learn Tracker | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Learns and detects targets | [Docs]() |
| Speech Recognition | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Speech-to-text | [Docs]() |
| Thermal256 Camera | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | External thermal imaging module | [Docs]() |
| Thermal Night Vision | `MaixCAM2` | Fusion of thermal imaging and AI night vision | [Docs]() |
| Tracker Counter | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | People/object counting | [Docs]() |
| USB Hand Contrl | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Controls the mouse via gestures | [Docs]() |
| USB Pose Mario | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Controls the keyboard via human pose | [Docs]() |
| Local VLM | `MaixCAM2` | Image-to-text | [Docs]() |
| WebRTC Stream | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | WebRTC streaming | [Docs]() |
| YOLO11 OBB | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Image detection with rotation angle | [Docs]() |
| YOLO11 Seg | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Image segmentation | [Docs]() |
| YOLO-World | `MaixCAM2` | YOLO-World detection | [Docs]() |
| Camera | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Photo taking, video recording | [Docs]() |
| Photos | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Displays photos | [Docs]() |
| AI Classifier | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | AI classification | [Docs]() |
| AI Detector | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | AI detection | [Docs]() |
| Find blobs | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Finds color blobs | [Docs]() |
| Line tracking | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Find line | [Docs]() |
| Speech Recognition | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Speech-to-text | [Docs]() |
| Thermal Camera | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | External infrared camera module (PMOD_Thermal32) | [Docs]() |
| ToF Camera | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | External ToF module (ToF100) | [Docs]() |
| UVC Camera | `MaixCAM`, `MaixCAM Pro` | Serves as a USB camera | [Docs]() |
Here is the translation of the table into English:

| Built-in Application | Supported Platforms | Description | Documentation |
| :--- | :--- | :--- | :--- |
| **Benchmark Test** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Tests comprehensive performance of CPU/NPU and other hardware | [Documentation](https://maixhub.com/app/188) |
| **Local Chat** | `MaixCAM2` | Offline voice chat | [Documentation](https://maixhub.com/app/187) |
| **Desktop Monitor** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Host performance monitoring gadget | [Documentation](https://maixhub.com/app/13) |
| **Facial Emotion** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Emotion recognition | [Documentation](https://maixhub.com/app/189) |
| **Facial Key Points** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Key point recognition | [Documentation](https://maixhub.com/app/186) |
| **Face Recognition** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Face recognition | [Documentation](https://maixhub.com/app/190) |
| **Face Tracking** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Face tracking | [Documentation](https://maixhub.com/app/31) |
| **Gesture Classification** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Recognize different gestures | [Documentation](https://maixhub.com/app/192) |
| **Hand Key Points** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Hand key point detection | [Documentation](https://maixhub.com/app/227) |
| **HTTP File Browser** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | View and download files via browser | [Documentation](https://maixhub.com/app/59) |
| **Human Pose** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Human pose recognition | [Documentation](https://maixhub.com/app/191) |
| **Human Pose Classification** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Recognize different human poses | [Documentation](https://maixhub.com/app/193) |
| **Image Generation** | `MaixCAM2` | Text-to-Image, Image-to-Image | [Documentation](https://maixhub.com/app/198) |
| **Pose Calculation** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | IMU data calculation | [Documentation](https://maixhub.com/app/128) |
| **MaixHub Client** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Interact with MaixHub | [Documentation](https://maixhub.com/app/48) |
| **Depth Estimation** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Monocular depth estimation | [Documentation](https://maixhub.com/app/195) |
| **Mouse Simulation** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Use device as a mouse | [Documentation](https://maixhub.com/app/196) |
| **Text Recognition** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Text recognition (OCR) | [Documentation](https://maixhub.com/app/70) |
| **RTMP Live Streaming** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | RTMP streaming | [Documentation](https://maixhub.com/app/35) |
| **RTSP Streaming** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | RTSP streaming | [Documentation](https://maixhub.com/app/197) |
| **QR Code Scanner** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Scan and recognize barcodes, QR codes, Apriltag | [Documentation](https://maixhub.com/app/199) |
| **Self-learning Classification** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Learn targets and classify | [Documentation](https://maixhub.com/app/200) |
| **Self-learning Detector** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Learn targets and detect | [Documentation](https://maixhub.com/app/62) |
| **Speech Recognition** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Speech to text | [Documentation](https://maixhub.com/app/65) |
| **Thermal Camera 256** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | External thermal imaging module | [Documentation](https://maixhub.com/app/208) |
| **Thermal Fusion Night Vision** | `MaixCAM2` | Fusion of thermal camera and AI night vision | [Documentation](https://maixhub.com/app/228) |
| **Tracking Count** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | People flow counting | [Documentation](https://maixhub.com/app/61) |
| **Gesture Control Mouse** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Control mouse via gestures | [Documentation](https://maixhub.com/app/223) |
| **Pose Control Keyboard** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Control keyboard via human pose | [Documentation](https://maixhub.com/app/178) |
| **Local Visual LLM** | `MaixCAM2` | Image-to-text | [Documentation](https://maixhub.com/app/194) |
| **WebRTC Streaming** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | WebRTC streaming | [Documentation](https://maixhub.com/app/202) |
| **OBB Detection** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Image detection with rotation angle | [Documentation](https://maixhub.com/app/203) |
| **YOLO11 Segmentation** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Image segmentation | [Documentation](https://maixhub.com/app/204) |
| **YOLO-World** | `MaixCAM2` | YOLO-World detection | [Documentation](https://maixhub.com/app/229) |
| **Camera** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Take photos, record videos | [Documentation](https://maixhub.com/app/221) |
| **Album** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Display photos | [Documentation](https://maixhub.com/app/222) |
| **AI Classifier** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | AI classification | [Documentation](https://maixhub.com/app/211) |
| **AI Detector** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | AI detection | [Documentation](https://maixhub.com/app/213) |
| **Find Color Blocks** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Find color blocks | [Documentation](https://maixhub.com/app/33) |
| **Line Patrol** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Find lines | [Documentation](https://maixhub.com/app/215) |
| **Speech Recognition (Maix-Speech)** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | Speech to text | [Documentation](https://maixhub.com/app/216) |
| **Speech Recognition (AI LLM)** | `MaixCAM2` | Speech to text | [Documentation](https://maixhub.com/app/217) |
| **Thermal Camera** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | External thermal camera module (PMOD_Thermal32) | [Documentation](https://maixhub.com/app/218) |
| **ToF Camera** | `MaixCAM`, `MaixCAM Pro`, `MaixCAM2` | External ToF module (ToF100) | [Documentation](https://maixhub.com/app/219) |
| **UVC Camera** | `MaixCAM`, `MaixCAM Pro` | Act as USB camera | [Documentation](https://maixhub.com/app/220) |
| **App Store** | `MaixCAM`, `MaixCAM Pro` | Install other applications | [Documentation](https://maixhub.com/app/225) |
| **Settings** | `MaixCAM`, `MaixCAM Pro` | Modify system settings | [Documentation](https://maixhub.com/app/224) |


### Tools
Expand Down
2 changes: 1 addition & 1 deletion docs/doc/zh/audio/recognize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ update:
| ------- | ------- | ----------- | -------- |
| Whisper | ❌ | ❌ | ✅ |
| Sensevoice | ❌ | ❌ | ✅ |
| Speech | ✅ | ✅ | ❌ |
| Speech | ✅ | ✅ | ✅ |

## 使用Whisper做语音转文字

Expand Down
Loading