Sipeed Wiki

https://wiki.sipeed.com/
Admin
The Sipeed Wiki provides comprehensive documentation and resources for Sipeed's various hardware and...
Tokens:1,808,848
Snippets:14,464
Trust Score:8.8
Update:1 day ago
Show doc for...
Tokens:
Raw
### Keyword configuration example

Source: https://wiki.sipeed.com/soft/maixpy/en/course/speech/recognizer_cnn.html

Shows how to configure the recognizer with custom keywords and their thresholds, then retrieve the configuration. This is a subset of the main example, highlighting the `config` and `get` methods.

```python
  t.config({
    'xiao-ai': 0.3,
    'hao-de': 0.2,
    'ni-hao': 0.3,
  })

  print(t.get())
```

--------------------------------

### Install ARMv7 toolchain

Source: https://wiki.sipeed.com/hardware/en/kvm/NanoKVM_Go/system/introduction.html

Runs the project's toolchain setup script.

```bash
cd ~/NanoKVM_Go/NanoKVM-Go/support/scripts
./toolchain_setup.sh
```

--------------------------------

### Configure and build an example project with maixcdk menuconfig and build

Source: https://wiki.sipeed.com/maixcdk/doc/index.html

Navigate to the examples/hello_world directory and run menuconfig to select the device platform. For first-time use, default parameters are fine; press ESC and Y to save and exit. Then run maixcdk build to compile; the first run downloads the toolchain, which may be slow in China. After compilation, binaries are in build and dependent .so files in build/dl_lib.

```shell
cd examples/hello_world
maixcdk menuconfig
```

```shell
maixcdk build
```

--------------------------------

### Install and configure Python virtual environment for YOLOX

Source: https://wiki.sipeed.com/hardware/en/lichee/th1520/lpi4a/8_application.html

Follow these commands to install system dependencies, download and install the c920 library, create a Python 3.11 virtual environment, and install the required prebuilt packages. This setup is referenced for the YOLOX example and is also used for the YOLOv5n example.

```shell
sudo apt update
sudo apt install wget git vim

wget https://github.com/T-head-Semi/csi-nn2/releases/download/v2.4-beta.1/c920.tar.gz
tar xf c920.tar.gz
cp c920/lib/* /usr/lib/riscv64-linux-gnu/ -rf

sudo apt install python3-pip
sudo apt install python3.11-venv

cd /root
python3 -m venv ort
source /root/ort/bin/activate

git clone -b python3.11 https://github.com/zhangwm-pt/prebuilt_whl.git
cd prebuilt_whl

pip install numpy-1.25.0-cp311-cp311-linux_riscv64.whl
pip install opencv_python-4.5.4+4cd224d-cp311-cp311-linux_riscv64.whl
pip install kiwisolver-1.4.4-cp311-cp311-linux_riscv64.whl
pip install Pillow-9.5.0-cp311-cp311-linux_riscv64.whl
pip install matplotlib-3.7.2.dev0+gb3bd929cf0.d20230630-cp311-cp311-linux_riscv64.whl
pip install pycocotools-2.0.6-cp311-cp311-linux_riscv64.whl
pip3 install loguru-0.7.0-py3-none-any.whl
pip3 install torch-2.0.0a0+gitc263bd4-cp311-cp311-linux_riscv64.whl
pip3 install MarkupSafe-2.1.3-cp311-cp311-linux_riscv64.whl
pip3 install torchvision-0.15.1a0-cp311-cp311-linux_riscv64.whl
pip3 install psutil-5.9.5-cp311-abi3-linux_riscv64.whl
pip3 install tqdm-4.65.0-py3-none-any.whl
pip3 install tabulate-0.9.0-py3-none-any.whl

```

--------------------------------

### Example::get_age

Source: https://wiki.sipeed.com/maixcdk/api/maix/example.html

Gets the age of the Example.

```APIDOC
## Class: Example

### Method: get_age

#### Description
Get age of Example.

#### Return
- **int** - Age of Example, value range is [0, 100].

#### Type
func

#### Static
False

#### C++ Definition
```cpp
int get_age()
```
```

--------------------------------

### Example vLLM server output for Qwen3-VL-30B-A3B-Instruct

Source: https://wiki.sipeed.com/hardware/en/kvm/NanoKVM_Pro/cua.html

Example output from launching the vLLM server for the Qwen3-VL-30B-A3B-Instruct model, showing startup logs and configuration details. Useful for verifying successful deployment.

```none
(vllm) zp@server105:~/work/vllm$ vllm serve \ \
    /home/zp/work/models/Qwen/Qwen3-VL-30B-A3B-Instruct \
    --host 0.0.0.0 \
    --port 8000 \
    --tensor-parallel-size 4 \
    --gpu-memory-utilization 0.90 \
    --max-model-len 65536 \
    --served-model-name Qwen3-VL-30B-A3B-Instruct\
    --api-key sk123
INFO 10-06 15:56:22 [__init__.py:216] Automatically detected platform cuda.
(APIServer pid=41428) INFO 10-06 15:56:26 [api_server.py:1839] vLLM API server version 0.11.0
(APIServer pid=41428) INFO 10-06 15:56:26 [utils.py:233] non-default args: {'model_tag': '/home/zp/work/models/Qwen/Qwen3-VL-30B-A3B-Instruct', 'host': '0.0.0.0', 'api_key': ['sk123'], 'model': '/home/zp/work/models/Qwen/Qwen3-VL-30B-A3B-Instruct', 'max_model_len': 65536, 'served_model_name': ['Qwen3-VL-30B-A3B-Instruct'], 'tensor_parallel_size': 4}
(APIServer pid=41428) INFO 10-06 15:56:26 [model.py:547] Resolved architecture: Qwen3VLMoeForConditionalGeneration
(APIServer pid=41428) `torch_dtype` is deprecated! Use `dtype` instead!
(APIServer pid=41428) INFO 10-06 15:56:26 [model.py:1510] Using max model len 65536
(APIServer pid=41428) INFO 10-06 15:56:27 [scheduler.py:205] Chunked prefill is enabled with max_num_batched_tokens=2048.
INFO 10-06 15:56:32 [__init__.py:216] Automatically detected platform cuda.
(EngineCore_DP0 pid=41565) INFO 10-06 15:56:35 [core.py:644] Waiting for init message from front-end.
```

--------------------------------

### Example::get_pet

Source: https://wiki.sipeed.com/maixcdk/api/maix/example.html

Gets the pet kind of the Example.

```APIDOC
## Class: Example

### Method: get_pet

#### Description
Example enum member.

#### Return
- **example::Kind** - Pet kind.

#### Type
func

#### Static
False

#### C++ Definition
```cpp
example::Kind get_pet()
```
```

--------------------------------

### Install wget, git, and vim

Source: https://wiki.sipeed.com/hardware/en/lichee/th1520/lpi4a/8_application.html

Installs essential tools needed for subsequent steps in the tutorial.

```bash
sudo apt install wget git vim
```

--------------------------------

### Build source distribution with setup.py

Source: https://wiki.sipeed.com/soft/maixpy/zh/get_started/mpfshell-lite/English.html

Build the source distribution and wheel using setup.py.

```shell
python setup.py sdist build
```

--------------------------------

### Example::get_name

Source: https://wiki.sipeed.com/maixcdk/api/maix/example.html

Gets the name of the Example. Can also be accessed via property 'name'.

```APIDOC
## Class: Example

### Method: get_name

#### Description
Get name of Example. You can also get name by property `name`.

#### Return
- **string** - Name of Example.

#### Type
func

#### Static
False

#### C++ Definition
```cpp
std::string get_name()
```
```

--------------------------------

### Build and Run Valgrind on MaixCDK Example

Source: https://wiki.sipeed.com/maixcdk/doc/convention/memcheck.html

Build the hello_world example, then run Valgrind with default settings for a brief log, or with detailed options for full leak checking and logging to a file.

```shell
cd examples/hello_world
maixcdk build

# Output a brief log
valgrind ./build/hello_world

# Output a detailed log
# --tool=memcheck: Specifies the tool as memcheck. Memcheck is the default tool, so this option can be omitted.
# --leak-check=full: Displays detailed information for each memory leak.
# --log-file=valgrind.log: Outputs the memory leak check result to the specified file. Here, valgrind.log is a custom filename.
valgrind --tool=memcheck --leak-check=full --log-file=valgrind.log ./build/hello_world
```

--------------------------------

### FP5510 get position example

Source: https://wiki.sipeed.com/maixpy/doc/en/modules/fp5510.html

Gets the current position of the voice coil motor and prints it.

```python
position = fp.get_pos()
print(f'set position to {position}')
```

--------------------------------

### Example::get_dict

Source: https://wiki.sipeed.com/maixcdk/api/maix/example.html

Gets a dict example. Takes an input dict and returns a new dict with {'a': 1} merged.

```APIDOC
## Class: Example

### Method: get_dict

#### Description
Example dict API.

#### Parameters
- **in** (dict of string to int) - Required - Input dict. In MaixPy, you can pass `dict` to this API.

#### Return
- **dict of string to int** - Content is {"a": 1} + in. In MaixPy, return type is `dict` object.

#### Type
func

#### Static
False

#### C++ Definition
```cpp
std::map<std::string, int> get_dict(std::map<std::string, int> &in)
```
```

--------------------------------

### Install and launch KODI

Source: https://wiki.sipeed.com/hardware/en/lichee/th1520/lpi4a/8_application.html

Installs KODI and launches it directly.

```shell
sudo apt install kodi
kodi
```

--------------------------------

### Example::get_list

Source: https://wiki.sipeed.com/maixcdk/api/maix/example.html

Gets a list example. Takes an input list and returns a new list with [1,2,3] prepended.

```APIDOC
## Class: Example

### Method: get_list

#### Description
Get list example.

#### Parameters
- **in** (list of int) - Required - Input list. In MaixPy, you can pass list or tuple to this API.

#### Return
- **list of int** - Content is [1, 2, 3] + in. Alloc item, del in MaixPy will auto free memory.

#### Type
func

#### Static
False

#### C++ Definition
```cpp
std::vector<int> *get_list(std::vector<int> in)
```
```

--------------------------------

### DEMO1: Turn on the LED

Source: https://wiki.sipeed.com/soft/maixpy/en/api_reference/Maix/gpio.html

Example demonstrating how to configure a GPIO pin as output and set its value to turn on an LED.

```APIDOC
## DEMO1: Turn on the LED

### Description
This example shows how to initialize a GPIO pin as output and set its value to turn on an LED. It uses `fm.register` to map a board pin to a GPIO function, creates a GPIO object, and then sets the output value.

### Code
```python
import utime
from Maix import GPIO
from board import board_info
from fpioa_manager import fm

fm.register(board_info.LED_R,fm.fpioa.GPIO0)
led_r=GPIO(GPIO.GPIO0,GPIO.OUT)
utime.sleep_ms(500)
led_r.value()
fm.unregister(board_info.LED_R)
```

### Notes
- `board_info` is related to the board, and different board configurations are different. [Manual configuration](https://wiki.sipeed.com/soft/maixpy/en/api_reference/builtin_py/board_info.html) is required before use.
```

--------------------------------

### Build and run libmaix example

Source: https://wiki.sipeed.com/hardware/en/maixIII/ax-pi/flash_system.html

Commands to build and run a libmaix example application. The screen displays the camera content; if it fails, check the Q&A for camera switching.

```bash
cd /home/libmaix/examples/axpi/
python3 project.py build
fbon
./dist/start_app.sh
```

--------------------------------

### RTSP Streaming Basic Example

Source: https://wiki.sipeed.com/maixpy/doc/en/video/rtsp_streaming.html

Complete example to start RTSP streaming with a camera. The camera must output NV21 format (FMT_YVU420SP). After starting, the stream URL is printed and can be played with VLC 3.0.20 at rtsp://device ip:8554/live.

```python
from maix import time, rtsp, camera, image

server = rtsp.Rtsp()
cam = camera.Camera(2560, 1440, image.Format.FMT_YVU420SP)
server.bind_camera(cam)
server.start()

print(server.get_url())

while True:
    time.sleep(1)
```

--------------------------------

### Install mpfshell-lite via pip and run mpfs

Source: https://wiki.sipeed.com/soft/maixpy/zh/get_started/mpfshell-lite/English.html

Install the mpfshell-lite package using pip and then launch the mpfs shell. The command 'pip install mpfshell-lite' installs the package, and 'mpfs' starts the interactive shell.

```shell
pip install mpfshell-lite

mpfs
```

--------------------------------

### Set up Python environment and install axengine

Source: https://wiki.sipeed.com/hardware/en/maixIV/m4chat/pcie-slaveboard.html

Creates a virtual environment and installs dependencies including the axengine wheel. Run from the AIDemos/extra directory.

```bash
cd /path/to/AIDemos/extra
python -m venv venv-llm
source venv-llm/bin/activate
pip install -r requirements.txt
pip install axengine-0.1.3-py3-none-any.whl
```

--------------------------------

### Example /boot/configs file with maix_<item>_<key>=value format

Source: https://wiki.sipeed.com/maixpy/doc/en/basic/app.html

Shows the format and editable options for the /boot/configs file. Each line must be shell-compatible with no spaces around '='. Settings include language, wifi mode, comm method, backlight, and NPU AI ISP.

```ini
# All configs user can edit easily
# Format: maix_<item>_<key>=value
#         all key characters should be lowercase
# Full supported items see documentation of maixpy at:
#      https://wiki.sipeed.com/maixpy/doc/zh/basic/app.html

### [language]
maix_language_locale=en

### [wifi]
# can be "ap" or "sta" or "off"
maix_wifi_mode=sta
maix_wifi_ssid=Sipeed_Guest
maix_wifi_passwd=qwert123
# encryption, auto detected by default. Can be:
# "NONE", "WPA-PSK", "WPA-EAP", "SAE"
# maix_wifi_encrypt="WPA-PSK"

### [comm] Maix comm protocol
# can be "uart" or "none"
maix_comm_method=uart

## [backlight] Screen backlight, from 0 to 100
maix_backlight_value = 50

### [npu]
# for MaixCAM2, enable AI ISP(1) or not(0)
# AI ISP improves image quality but occupies half NPU
maix_npu_ai_isp=0
```

--------------------------------

### Kubectl Get Nodes Output

Source: https://wiki.sipeed.com/hardware/en/cluster/NanoCluster/k3s.html

Example output from 'sudo kubectl get nodes' showing all nodes in the cluster with their statuses.

```bash
sipeed@lpi3h-a2d1:~$ sudo kubectl get nodes
NAME         STATUS   ROLES                  AGE     VERSION
lpi3h-1967   Ready    <none>                 20h   v1.31.5+k3s1
lpi3h-231e   Ready    <none>                 20h   v1.31.5+k3s1
lpi3h-4782   Ready    <none>                 56m   v1.31.5+k3s1
lpi3h-a2d1   Ready    control-plane,master   23h   v1.31.5+k3s1
lpi3h-ba13   Ready    <none>                 19h   v1.31.5+k3s1
lpi3h-c06b   Ready    <none>                 21h   v1.31.5+k3s1
```

--------------------------------

### Deploy local package with maixtool

Source: https://wiki.sipeed.com/maixpy/doc/en/basic/app.html

Start a local service on your PC to display a QR code for installing a local package. Ensure maixtool is installed via pip install maixtool.

```shell
maixtool deploy --pkg <path_to_package>
```

--------------------------------

### Compile and run sample_vio example

Source: https://wiki.sipeed.com/hardware/en/lichee/RV_Nano/8_mmf_development_guide.html

Commands to compile the sample_vio example, upload it to the development board via scp, log in via ssh, load the display driver with /opt/fb_load.sh (only needed once), and run the example. The board IP address is represented by xxx.xxx.xxx.xxx.

```shell
# Ensure that the basic MMF compilation environment has been set up and that build_middleware has been compiled once
# Compile sample_vio
cd middleware/v2/sample/vio
make

# Upload to the development board (account root, password cvitek)
scp sample_vio root@xxx.xxx.xxx.xxx:/root  # xxx.xxx.xxx.xxx is the board's IP address

# Log into the development board
ssh root@xxx.xxx.xxx.xxx

# If you need to use the display, you need to run fb_load.sh to make sure the driver is loaded (it only needs to be executed once)
/opt/fb_load.sh

# Run the example
cd ~
./sample_vio
```

--------------------------------

### Get GPIO pin state with gpioget

Source: https://wiki.sipeed.com/hardware/en/longan/h618/lpi3h/6_peripheral.html

Command to get the state of a GPIO pin. Example reads pin 196 on gpiochip0.

```shell
sudo gpioget gpiochip0 196
```

--------------------------------

### Example.__init__

Source: https://wiki.sipeed.com/maixpy/api/maix/example.html

Constructor for the Example class. Initializes with name, age, and pet.

```APIDOC
## Example.__init__

### Description
Example constructor. This constructor will be exported to MaixPy as maix.example.Example.__init__.

### Function Signature
```python
def __init__(self, name: str, age: int = 18, pet: Kind = ...) -> None
```

### Parameters
- **name** (str) - Required - Name of Example, string type.
- **age** (int) - Optional - Age of Example, int type, default is 18, value range is [0, 100].
- **pet** (Kind) - Optional - Pet kind, should use full namespace name `example::Kind` instead of `Kind`.

```

--------------------------------

### ROS2: List installed ROS distributions

Source: https://wiki.sipeed.com/hardware/en/maixsense/maixsense-a010/maixsense-a010.html

Check which ROS distributions are installed in /opt/ros. The example output shows 'noetic' (ROS1) and 'rolling' (ROS2) installed, which is relevant when both ROS1 and ROS2 are present.

```bash
ls /opt/ros
ros@ros-virtual-machine:~/Desktop$ ls /opt/ros
noetic  rolling
```

--------------------------------

### Release command example

Source: https://wiki.sipeed.com/hardware/en/kvm/NanoKVM_Go/system/introduction.html

Example using version 0.0.21.

```bash
python3 build.py release --version 0.0.21
```

--------------------------------

### Get vocabulary template data with get()

Source: https://wiki.sipeed.com/soft/maixpy/en/api_reference/machine_vision/isolated_word.html

Returns a tuple (frm_len, frm_data) for the template at the given index. The example prints the result for index 0.

```python
from speech_recognizer import isolated_word
sr = isolated_word()
print(sr.get(0))
```

--------------------------------

### List available demo binaries

Source: https://wiki.sipeed.com/hardware/en/maixIII/ax-pi/flash_system.html

These are the sample binaries available in the system. Edit run.sh to load and test other models.

```bash
sample_vin_ivps_joint_vo
sample_vin_ivps_joint_venc_rtsp_vo
```

--------------------------------

### Create ~/.vnc/xstartup

Source: https://wiki.sipeed.com/hardware/en/lichee/th1520/lpi4a/5_desktop.html

Create and edit ~/.vnc/xstartup with the provided content to start Xfce when the VNC server starts.

```shell
#!/bin/sh
unset SESSION_MANAGER
unset DBUS_SESSION_BUS_ADDRESS
exec startxfce4 
```

--------------------------------

### List installed packages with opkg list

Source: https://wiki.sipeed.com/hardware/en/maixII/M2/usage.html

Run this command to list all installed packages. The output shows package names and versions, as demonstrated with the example output.

```bash
root@sipeed:/# opkg list 
MaixPy3 - 0.2.5-1
alsa-lib - 1.1.4.1-1
busybox - 1.27.2-3
busybox-init-base-files - 167-1612350358
ca-certificates - 20160104
curl - 7.54.1-1
dropbear - 2015.71-2
e2fsprogs - 1.42.12-1
eyesee-mpp-external - 1.0-1
eyesee-mpp-middleware - 1.0-1
eyesee-mpp-system - 1.0-1
```

--------------------------------

### Set up build environment and install dependencies

Source: https://wiki.sipeed.com/hardware/en/lichee/th1520/lpi4a/7_develop_revyos.html

Run this bash script to set environment variables, create a build directory, and install required packages. Adjust the nproc value based on your CPU. The GITHUB_WORKSPACE variable assumes the build directory is in the user's home directory.

```bash
export xuetie_toolchain=https://occ-oss-prod.oss-cn-hangzhou.aliyuncs.com/resource//1663142514282
export toolchain_file_name=Xuantie-900-gcc-linux-5.10.4-glibc-x86_64-V2.6.1-20220906.tar.gz
export toolchain_tripe=riscv64-unknown-linux-gnu-
export ARCH=riscv
export nproc=12 #Please set according to their own CPU configuration, the document uses cpu i5-11400
mkdir th1520_build && cd th1520_build
export GITHUB_WORKSPACE="~/th1520_build" #The assumptions in this article are downloaded to the user's directory and can be changed according to your needs.
sudo apt update && \
              sudo apt install -y gdisk dosfstools g++-12-riscv64-linux-gnu build-essential \
                                  libncurses-dev gawk flex bison openssl libssl-dev tree \
                                  dkms libelf-dev libudev-dev libpci-dev libiberty-dev autoconf device-tree-compiler
              sudo update-alternatives --install \
                  /usr/bin/riscv64-linux-gnu-gcc riscv64-gcc /usr/bin/riscv64-linux-gnu-gcc-12 10
              sudo update-alternatives --install \
                  /usr/bin/riscv64-linux-gnu-g++ riscv64-g++ /usr/bin/riscv64-linux-gnu-g++-12 10
```

--------------------------------

### Enter the NanoKVM-Go repository

Source: https://wiki.sipeed.com/hardware/en/kvm/NanoKVM_Go/system/introduction.html

Navigate to the repository root where build.py is located.

```bash
cd ~/NanoKVM_Go/NanoKVM-Go
```

--------------------------------

### last_pts

Source: https://wiki.sipeed.com/maixcdk/api/maix/video.html

Gets the start time of the previous playback, in units of time base.

```APIDOC
## last_pts

### Description
Gets the start time of the previous playback, in units of time base.

### Method
func

### Signature
```cpp
uint64_t last_pts()
```

### Parameters
None

### Static
False
```

--------------------------------

### pts

Source: https://wiki.sipeed.com/maixcdk/api/maix/video.html

Gets the start time of the current playback, in units of time base.

```APIDOC
## pts

### Description
Gets the start time of the current playback, in units of time base.

### Method
func

### Signature
```cpp
uint64_t pts()
```

### Parameters
None

### Static
False
```

--------------------------------

### Turn on the LED

Source: https://wiki.sipeed.com/soft/maixpy/en/modules/on_chip/gpio.html

Example that turns on an LED by registering the LED_R pin, setting it as output, waiting 500ms, then setting the value to 0. Note that board_info is board-specific and must be configured manually before use.

```python
import utime
from Maix import GPIO
from board import board_info
from fpioa_manager import fm

fm.register(board_info.LED_R,fm.fpioa.GPIO0)
led_r=GPIO(GPIO.GPIO0,GPIO.OUT)
utime.sleep_ms(500)
led_r.value(0)
fm.unregister(board_info.LED_R)
```

--------------------------------

### Configure ~/.vnc/config

Source: https://wiki.sipeed.com/hardware/en/lichee/th1520/lpi4a/5_desktop.html

Add startup parameters to ~/.vnc/config, such as resolution and dpi.

```shell
geometry=your_prefer_resolution
dpi=your_prefer_dpi
```

--------------------------------

### Run sample_vin_ivps_joint_vo_h265 with camera 2

Source: https://wiki.sipeed.com/hardware/en/maixIII/ax-pi/flash_system.html

Example command to run the H265 video output demo, with -c 2 selecting the camera.

```bash
/home/bin/sample_vin_ivps_joint_vo_h265 -c 2
```

--------------------------------

### Install and run guvcview for USB camera

Source: https://wiki.sipeed.com/hardware/en/lichee/th1520/lpi4a/6_peripheral.html

Install guvcview and start the image stream from a USB camera. Press Ctrl+C or click the quit button to end the stream.

```shell
sudo apt-get install guvcview
guvcview
```

--------------------------------

### Navigate to example and configure with maixcdk menuconfig

Source: https://wiki.sipeed.com/maixcdk/doc/

Use this to enter the project directory and open the interactive configuration menu. First-time users can accept defaults or skip menuconfig entirely; press ESC and Y to save and exit.

```shell
cd examples/hello_world
maixcdk menuconfig
```

--------------------------------

### Example: Execute callback function regularly

Source: https://wiki.sipeed.com/soft/maixpy/en/modules/on_chip/timer.html

Complete example that creates a timer, prints the period, starts it, sleeps, stops, restarts, stops again, and deletes the timer object.

```python
from machine import Timer

def on_timer(timer):
    print("time up:",timer)
    print("param:",timer.callback_arg())

tim = Timer(Timer.TIMER0, Timer.CHANNEL0, mode=Timer.MODE_PERIODIC, period=1, unit=Timer.UNIT_S, callback=on_timer, arg=on_timer, start=False, priority=1, div=0)

print("period:",tim.period())

tim.start()
time.sleep(5)
tim.stop()
time.sleep(5)
tim.restart()
time.sleep(5)
tim.stop()
del tim
```

--------------------------------

### Complete keyword recognition example

Source: https://wiki.sipeed.com/maixpy/doc/en/audio/keyword.html

Full example that imports maix modules, loads an acoustic model, initializes the microphone, sets up a keyword table with gates and a callback, and runs recognition until exit.

```python
from maix import app, nn

speech = nn.Speech("/root/models/am_3332_192_int8.mud")
speech.init(nn.SpeechDevice.DEVICE_MIC)

kw_tbl = ['xiao3 ai4 tong2 xue2',
          'ni3 hao3',
          'tian1 qi4 zen3 me yang4']
kw_gate = [0.1, 0.1, 0.1]

def callback(data:list[float], len: int):
    for i in range(len):
        print(f"\tkw{i}: {data[i]:.3f};", end=' ')
    print("\n")

speech.kws(kw_tbl, kw_gate, callback, True)

while not app.need_exit():
    frames = speech.run(1)
    if frames < 1:
        print("run out\n")
        break
```
Tokens:
Raw