MaixPy

https://wiki.sipeed.com/maixpy/
Admin
MaixPy is an easy-to-use platform with Python and C++ APIs for rapidly developing and deploying AI...
Tokens:237,388
Snippets:2,727
Trust Score:8.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Constructor

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

Constructor for the Example class. Ensure Kind uses the full namespace example::Kind.

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

```C++
Example(std::string &name, int age = 18, example::Kind pet = example::KIND_NONE)
```

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

### FPS Start Method

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

Sets the starting point for FPS calculation.

```python
def start(self) -> None
```

```cpp
void start()
```

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

### maix.example.Example.__init__

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

Constructor for the Example class.

```APIDOC
## maix.example.Example.__init__(name: str, age: int = 18, pet: Kind = ...)

### Description
Initializes a new instance of the Example class.

### Parameters
- **name** (str) - Required - Name of the Example.
- **age** (int) - Optional - Age of the Example (default: 18, range: [0, 100]).
- **pet** (Kind) - Optional - Pet type.
```

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

### record_start()

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

Starts the video recording process.

```APIDOC
## record_start()

### Description
Starts recording. Requires camera binding; optional bindings include display, audio, and IMU.

### Returns
- **maix.err.Err** - Error code.
```

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

### maix.example.Example.get_name

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

Retrieves the name of the Example instance.

```APIDOC
## maix.example.Example.get_name() -> str

### Description
Returns the name of the Example instance.
```

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

### Start FPS Calculation

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

Manually sets the starting point for FPS calculation.

```python
def fps_start() -> None
```

```cpp
void fps_start()
```

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

### Get Name Method

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

Retrieves the name property of the Example instance.

```Python
def get_name(self) -> str
```

```C++
std::string get_name()
```

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

### Get APP path

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

Returns the installation or project path for the current application or a specified application ID.

```python
def get_app_path(app_id: str = '') -> str
```

```cpp
string get_app_path(const string &app_id = "")
```

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

### maix.example.Example.set_name

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

Sets the name of the Example instance.

```APIDOC
## maix.example.Example.set_name(name: str)

### Description
Updates the name of the Example instance.
```

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

### Get Age Method

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

Retrieves the age property of the Example instance.

```Python
def get_age(self) -> int
```

```C++
int get_age()
```

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

### maix.example.Example.get_age

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

Retrieves the age of the Example instance.

```APIDOC
## maix.example.Example.get_age() -> int

### Description
Returns the age of the Example instance (range: [0, 100]).
```

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

### change_arg_name(e: Example) -> Example

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

A function that accepts an Example object and returns it.

```APIDOC
## change_arg_name(e: Example) -> Example

### Description
Change arg name example.

### Parameters
- **e** (Example) - Required - An Example object.

### Returns
- **Example** - The same Example object passed as an argument.
```

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

### fps_start()

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

Manually sets the starting point for FPS calculation.

```APIDOC
## fps_start()

### Description
Manually sets the FPS calculation start point, allowing for precise measurement between this call and a subsequent fps() call.
```

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

### Start Streaming

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

Starts the RTMP push stream.

```python
def start(self, path: str = '') -> maix.err.Err
```

```cpp
err::Err start(std::string path = std::string())
```

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

### Example Class Definition

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

Basic class structure for Example.

```C++
class Example
```

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

### Get APP info list

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

Retrieves a list of information objects for installed applications, with options to filter out the launcher or app store.

```python
def get_apps_info(ignore_launcher: bool = False, ignore_app_store: bool = False) -> list[APP_Info]
```

```cpp
vector<app::APP_Info> &get_apps_info(bool ignore_launcher = false, bool ignore_app_store = false)
```

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

### Rtmp.start

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

Starts the RTMP push stream.

```APIDOC
## Rtmp.start(path: str = '')

### Description
Starts the push stream process. If a camera is bound, it pushes the camera image.

### Parameters
- **path** (str) - Optional - File path for cyclic push (deprecated).
```

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

### Video.open

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

Opens the video stream and starts the process.

```APIDOC
## Video.open(path: str = '', fps: float = 30.0)

### Description
Open video and run.

### Parameters
- **path** (str) - Optional - Video path.
- **fps** (float) - Optional - Video fps.

### Returns
- **err** (maix.err.Err) - Error code, err::ERR_NONE means success.
```

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

### maix.example.Example.set_age

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

Sets the age of the Example instance.

```APIDOC
## maix.example.Example.set_age(age: int)

### Description
Updates the age of the Example instance (range: [0, 100]).
```

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

### Start WiFi Access Point

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

Configures and starts the device in Access Point mode with specified network parameters.

```python
def start_ap(self, ssid: str, password: str, mode: str = 'g', channel: int = 0, ip: str = '192.168.66.1', netmask: str = '255.255.255.0', hidden: bool = False) -> maix.err.Err
```

```cpp
err::Err start_ap(const std::string &ssid, const std::string &password,
                          std::string mode = "g", int channel = 0,
                          const std::string &ip = "192.168.66.1", const std::string &netmask = "255.255.255.0",
                          bool hidden = false)
```

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

### VideoRecorder.open()

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

Starts a thread to handle the input function.

```APIDOC
## VideoRecorder.open()

### Description
Starts a thread to handle the input function.

### Returns
- **maix.err.Err** - Error code.
```

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

### change_arg_name2(e: Example) -> None

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

A function that accepts an Example object and performs an operation without returning a value.

```APIDOC
## change_arg_name2(e: Example) -> None

### Description
Change arg name example.

### Parameters
- **e** (Example) - Required - An Example object.
```

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

### Context.pts

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

Gets the start time of the current playback.

```APIDOC
## Context.pts()

### Description
Returns the start time of the current playback in units of time base.
```

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

### Initialize before main

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

Executes preparatory operations before the main program starts.

```python
def init_before_main() -> None
```

```cpp
void init_before_main()
```

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

### maix.example.Example.hello

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

Static method to say hello.

```APIDOC
## maix.example.Example.hello(name: str) -> str

### Description
Returns a greeting string combined with the provided name.
```

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

### File.sample_bits

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

Gets or sets the sample bits.

```APIDOC
## File.sample_bits(new_sample_bits=-1)

### Description
Get or set the sample bit.

### Parameters
- **new_sample_bits** (int) - Optional - If > 0, sets the sample bit.

### Returns
- **int** - The current sample bit.
```

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

### init(dev_type, device_name)

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

Initializes the ASR library and selects the audio device type and name.

```APIDOC
## init(dev_type, device_name)

### Description
Initializes the ASR library and selects the type and name of the audio device.

### Parameters
- **dev_type** (SpeechDevice) - Required - Device type to detect (WAV, PCM, or MIC).
- **device_name** (str) - Optional - Device name or file path to detect.

### Returns
- **maix.err.Err** - Returns err::ERR_NONE if success.
```

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

### Get Pet Method

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

Retrieves the pet enum member for the Example instance.

```Python
def get_pet(self) -> Kind
```

```C++
example::Kind get_pet()
```

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

### Open Camera

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

Initializes the camera hardware with specified parameters.

```python
def open(self, width: int = -1, height: int = -1, format: maix.image.Format = ..., fps: float = -1, buff_num: int = -1) -> maix.err.Err
```

```cpp
err::Err open(int width = -1, int height = -1, image::Format format = image::FMT_INVALID, double fps = -1, int buff_num = -1)
```

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

### switch_app

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

Exits the current application and starts another one via the launcher.

```APIDOC
## switch_app(app_id: str, idx: int = -1, start_param: str = '') -> None

### Description
Exit this APP and start another APP. Calling this API will set the exit flag; you should check app::need_exit() in your code.

### Parameters
- **app_id** (str) - Required - APP ID which will be started. app_id and idx must have one is valid.
- **idx** (int) - Optional - APP index. app_id and idx must have one is valid.
- **start_param** (str) - Optional - String type, will be sent to the app.
```

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

### Get Playback PTS

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

Retrieves the start time of the current playback in timebase units.

```Python
def pts(self) -> int
```

```C++
uint64_t pts()
```

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

### Get Previous Playback PTS

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

Retrieves the start time of the previous playback in timebase units.

```Python
def last_pts(self) -> int
```

```C++
uint64_t last_pts()
```

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

### File Constructor

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

Initializes a new File object with specified audio parameters.

```python
def __init__(self, sample_rate: int = 16000, channels: int = 1, bits_per_sample: int = 16) -> None
```

```cpp
File(int sample_rate = 16000, int channels = 1, int bits_per_sample = 16)
```

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

### get_start_param

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

Retrieves the start parameter set by the caller.

```APIDOC
## get_start_param() -> str

### Description
Get start param set by caller.

### Return
- **str** - The start parameter.
```

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

### Initialize MasterRTU Object

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

Constructs a new MasterRTU instance with optional device path and baudrate settings.

```python
def __init__(self, device: str = '', baudrate: int = 115200) -> None
```

```cpp
MasterRTU(const std::string& device="", const int baudrate=115200)
```

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

### start_service

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

Starts the LLM/VLM background service if it is not already running.

```APIDOC
## start_service()

### Description
Starts the LLM/VLM service in the background. Use this if the model failed to start automatically.

### Returns
- **maix.err.Err** - Returns maix.err.Err.ERR_NONE if no error occurred.
```

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

### Start Video Recording

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

Initiates recording. Requires camera binding; optional bindings include display, audio, and IMU.

```python
def record_start(self) -> maix.err.Err
```

```cpp
err::Err record_start()
```

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

### Player.__init__(path: str = '', sample_rate: int = 48000, format: Format = ..., channel: int = 1, block: bool = True)

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

Constructs a new Player object for audio playback.

```APIDOC
## Player.__init__(path: str = '', sample_rate: int = 48000, format: Format = ..., channel: int = 1, block: bool = True)

### Description
Initializes a new Player instance.

### Parameters
- **path** (str) - Optional - File path for saving audio; if None, no file is saved.
- **sample_rate** (int) - Optional - Sample rate in Hz, default 48000.
- **format** (Format) - Optional - Sample format, default audio::Format::FMT_S16_LE.
- **channel** (int) - Optional - Number of channels, default 1.
- **block** (bool) - Optional - Whether to use blocking mode, default True.
```

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

### Context.__init__

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

Constructs a new Context object with a specified media type and timebase.

```APIDOC
## Context.__init__(media_type, timebase)

### Description
Constructs a new Context object. The timebase is an array [num, den] used for calculating playback time.

### Parameters
- **media_type** (MediaType) - Required - Enable capture; if true, capture() can be used to get an image object.
- **timebase** (list[int]) - Required - Time base in [num, den] format.
```

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

### Get Host

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

Retrieves the configured host name.

```python
def host(self) -> str
```

```cpp
std::string host()
```

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

### Get Circle Radius - C++

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

C++ definition for getting the radius of a circle.

```cpp
int r()
```

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

### NanoTrack init Method

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

Initializes the tracker with an image and target coordinates. Throws an exception if the image format is incompatible.

```python
def init(self, img: maix.image.Image, x: int, y: int, w: int, h: int) -> None
```

```cpp
void init(image::Image &img, int x, int y, int w, int h)
```

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

### Get startup parameters

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

Retrieves the startup parameters passed to the current application.

```python
def get_start_param() -> str
```

```cpp
const std::string get_start_param()
```

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

### Get Circle Y-coordinate - C++

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

C++ definition for getting the y-coordinate of a circle.

```cpp
int y()
```

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

### Get Circle X-coordinate - C++

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

C++ definition for getting the x-coordinate of a circle.

```cpp
int x()
```

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

### File.__init__

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

Constructs a new File object for audio processing.

```APIDOC
## File.__init__(sample_rate=16000, channels=1, bits_per_sample=16)

### Description
Constructs a new File object.

### Parameters
- **sample_rate** (int) - Optional - Sample rate, required for .pcm files.
- **channels** (int) - Optional - Number of channels, required for .pcm files.
- **bits_per_sample** (int) - Optional - Bits per sample, required for .pcm files.
```

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

### Get Loaded Fonts - C++

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

C++ definition to get a list of all loaded fonts.

```cpp
std::vector<std::string> *fonts()
```

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

### Camera Initialization

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

Constructs a new Camera object with configurable resolution, format, and buffer settings.

```python
def __init__(self, width: int = -1, height: int = -1, format: maix.image.Format = ..., device: str = None, fps: float = -1, buff_num: int = 3, open: bool = True, raw: bool = False) -> None
```

```cpp
Camera(int width = -1, int height = -1, image::Format format = image::FMT_RGB888, const char *device = nullptr, double fps = -1, int buff_num = 3, bool open = true, bool raw = false)
```

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

### Learn

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

Starts the auto-learning process for class features based on added samples.

```python
def learn(self) -> int
```

```cpp
int learn()
```

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

### get_apps_info()

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

Retrieves a list of information about installed applications.

```APIDOC
## def get_apps_info(ignore_launcher: bool = False, ignore_app_store: bool = False) -> list[APP_Info]

### Description
Get APP info list.

### Parameters
- **ignore_launcher** (bool) - Optional - If true, ignore launcher APP. Default: false.
- **ignore_app_store** (bool) - Optional - If true, ignore app store APP. Default: false.

### Returns
- **list[APP_Info]**: APP info list.
```

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

### Start LLM/VLM Service

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

Manually trigger the background LLM model service if it fails to start automatically.

```python
def start_service(self) -> maix.err.Err
```

```cpp
err::Err start_service()
```

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

### Key.__init__

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

Constructor for the Key class. Initializes the key device with optional callback, device path, and long press duration.

```APIDOC
## Key.__init__(callback=None, open=True, device='', long_press_time=2000)

### Description
Initializes the key device. If a callback is provided, it will be triggered on key events in a separate thread.

### Parameters
- **callback** (typing.Callable[[int, int], None]) - Optional - Function called when a key is triggered.
- **open** (bool) - Optional - Whether to automatically open the device upon initialization.
- **device** (str) - Optional - Path to the input device (e.g., "/dev/input/device").
- **long_press_time** (int) - Optional - Duration in milliseconds to trigger a long press event.
```

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

### Start JpegStreamer

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

Starts the JPEG streamer. Returns an error code where err::ERR_NONE indicates success.

```python
def start(self) -> maix.err.Err
```

```cpp
err::Err start()
```

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

### Set Name Method

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

Updates the name property of the Example instance.

```Python
def set_name(self, name: str) -> None
```

```C++
void set_name(std::string name)
```

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

### Get Audio Format

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

Retrieves the current audio sample format.

```python
def format(self) -> Format
```

```cpp
audio::Format format()
```

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

### Camera.__init__

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

Constructs a new Camera object with specified resolution, format, and device settings.

```APIDOC
## Camera.__init__(width: int = -1, height: int = -1, format: maix.image.Format = ..., device: str = None, fps: float = -1, buff_num: int = 3, open: bool = True, raw: bool = False)

### Description
Construct a new Camera object. Maximum resolution support 2560x1440.

### Parameters
- **width** (int) - Optional - Camera width, default is -1 (auto).
- **height** (int) - Optional - Camera height, default is -1 (auto).
- **format** (maix.image.Format) - Optional - Camera output format.
- **device** (str) - Optional - Camera device path.
- **fps** (float) - Optional - Camera fps, default is -1 (auto).
- **buff_num** (int) - Optional - Camera buffer number, default is 3.
- **open** (bool) - Optional - If true, camera will automatically call open() after creation.
- **raw** (bool) - Optional - If true, you can use read_raw() to capture the raw image output.
```

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

### Qwen Model Initialization

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

Constructor for the Qwen model, accepting a path to a MUD model file.

```python
def __init__(self, model: str) -> None
```

```cpp
Qwen(const std::string &model)
```

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

### Get Colormap Names - C++

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

C++ definition to get a list of all supported colormap name strings. The 'classify' parameter filters the results.

```cpp
std::vector<std::string> cmap_strs(bool classify = false)
```

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

### Get All Colormap RGB Colors - C++

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

C++ definition to get all 256 mapped RGB colors for a colormap. The return value is a reference to an internal table.

```cpp
const std::vector<std::array<uint8_t, 3>> &cmap_colors_rgb(image::CMap cmap)
```

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

### Initialize Video Object

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

Constructs a new Video object with specified parameters.

```python
def __init__(self, path: str = '', width: int = 2560, height: int = 1440, format: maix.image.Format = ..., time_base: int = 30, framerate: int = 30, capture: bool = False, open: bool = True) -> None
```

```cpp
Video(std::string path = std::string(), int width = 2560, int height = 1440, image::Format format = image::Format::FMT_YVU420SP, int time_base = 30, int framerate = 30, bool capture = false, bool open = true)
```

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

### Initialize MLX90640Kelvin Object (C++)

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

Constructs a new MLX90640Kelvin object. Use this to configure I2C bus, frame rate, color mapping, temperature ranges, and emissivity.

```cpp
MLX90640Kelvin( int i2c_bus_num,
                    ::maix::ext_dev::mlx90640::FPS fps=::maix::ext_dev::mlx90640::FPS::FPS_32,
                    ::maix::ext_dev::cmap::Cmap cmap=::maix::ext_dev::cmap::Cmap::WHITE_HOT,
                    float temp_min=-1, float temp_max=-1,  float emissivity=0.95)
```

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

### WDT Constructor

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

Initializes the WDT instance and starts the timer automatically.

```python
def __init__(self, id: int, feed_ms: int) -> None
```

```cpp
WDT(int id, int feed_ms)
```

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

### Get Display Format

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

Retrieves the current display format.

```python
def format(self) -> maix.image.Format
```

```cpp
image::Format format()
```

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

### SelfLearnClassifier.learn

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

Starts the auto-learning process.

```APIDOC
## learn()

### Description
Start auto-learning class features from class images and samples.

### Returns
- **int** - Learn epoch count.
```

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

### Camera.open

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

Opens the camera and initializes the stream with the provided parameters.

```APIDOC
## Camera.open(width: int = -1, height: int = -1, format: maix.image.Format = ..., fps: float = -1, buff_num: int = -1)

### Description
Open camera and run.

### Parameters
- **width** (int) - Optional - Camera width.
- **height** (int) - Optional - Camera height.
- **format** (maix.image.Format) - Optional - Camera output format.
- **fps** (float) - Optional - Camera fps.
- **buff_num** (int) - Optional - Camera buffer number.

### Returns
- **maix.err.Err** - Error code, err::ERR_NONE means success.
```

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

### Qwen.__init__

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

Constructor for the Qwen model class.

```APIDOC
## Qwen(model: str)

### Description
Initializes the Qwen model instance.

### Parameters
- **model** (str) - Required - The path to the model file (e.g., MUD file). If provided, the model is loaded immediately; otherwise, it must be loaded later.
```

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

### height()

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

Gets the video height.

```APIDOC
## height()

### Description
Gets the video height.

### Returns
- **int** - The video height.
```

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

### width()

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

Gets the video width.

```APIDOC
## width()

### Description
Gets the video width.

### Returns
- **int** - The video width.
```

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

### maix.example.Example.get_list

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

Manipulates a list of integers.

```APIDOC
## maix.example.Example.get_list(in: list[int]) -> list[int]

### Description
Takes an input list of integers and returns a new list containing [1, 2, 3] concatenated with the input list.
```

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

### AXP2101.init

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

Initializes the AXP2101 hardware.

```APIDOC
## AXP2101.init

### Description
Performs the initialization sequence for the AXP2101 device.

### Returns
- **err** (maix.err.Err) - Returns err::ERR_NONE if initialization is successful.
```

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

### Get Disk Partitions

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

Lists disk partitions and their mount points.

```python
def disk_partitions(only_disk: bool = True) -> list[dict[str, str]]
```

```cpp
std::vector<std::map<std::string, std::string>> disk_partitions(bool only_disk = true)
```

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

### Load Configuration

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

Loads configuration settings from a file path.

```Python
def load_conf(self, path: str) -> None
```

```C++
void load_conf(std::string path)
```

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

### Start WiFi Scan

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

Initiates a background scan for access points.

```python
def start_scan(self) -> maix.err.Err
```

```cpp
err::Err start_scan()
```

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

### TouchScreen.__init__

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

Constructs a new TouchScreen object.

```APIDOC
## TouchScreen.__init__(device: str = '', open: bool = True)

### Description
Construct a new TouchScreen object.

### Parameters
- **device** (str) - Optional - Touchscreen device path, default is the first device.
- **open** (bool) - Optional - If true, touchscreen will automatically call open() after creation.
```

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

### Initialize MLX90640Kelvin Object (Python)

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

Constructs a new MLX90640Kelvin object. Use this to configure I2C bus, frame rate, color mapping, temperature ranges, and emissivity.

```python
def __init__(self, i2c_bus_num: int, fps: FPS = ..., cmap: maix.ext_dev.cmap.Cmap = ..., temp_min: float = -1, temp_max: float = -1, emissivity: float = 0.95) -> None
```

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

### JpegStreamer.start

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

Starts the JPEG streamer service.

```APIDOC
## JpegStreamer.start

### Description
Start jpeg streamer.

### Returns
- **err** (maix.err.Err) - error code, err::ERR_NONE means success, others means failed
```

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

### Initialize Qwen3VL Model

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

Constructor for the Qwen3VL class.

```python
def __init__(self, model: str) -> None
```

```cpp
Qwen3VL(const std::string &model)
```

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

### SelfLearnClassifier.sample_num

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

Gets the current number of samples.

```APIDOC
## sample_num()

### Description
Get the total number of samples.

### Returns
- **int** - Number of samples.
```

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

### Initialize Player Class

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

Defines the Player class and its constructor for audio playback.

```cpp
class Player
```

```python
def __init__(self, path: str = '', sample_rate: int = 48000, format: Format = ..., channel: int = 1, block: bool = True) -> None
```

```cpp
Player(std::string path = std::string(), int sample_rate = 48000, audio::Format format = audio::Format::FMT_S16_LE, int channel = 1, bool block = true)
```

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

### SelfLearnClassifier.class_num

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

Gets the current number of classes.

```APIDOC
## class_num()

### Description
Get the total number of classes.

### Returns
- **int** - Number of classes.
```

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

### Video.__init__

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

Constructs a new Video object with specified parameters for path, dimensions, format, and frame settings.

```APIDOC
## Video.__init__(path: str = '', width: int = 2560, height: int = 1440, format: maix.image.Format = ..., time_base: int = 30, framerate: int = 30, capture: bool = False, open: bool = True)

### Description
Construct a new Video object.

### Parameters
- **path** (str) - Optional - Video path. Determines location to load or save file.
- **width** (int) - Optional - Picture width. Default is 2560.
- **height** (int) - Optional - Picture height. Default is 1440.
- **format** (maix.image.Format) - Optional - Picture pixel format.
- **time_base** (int) - Optional - Frame time base. Default is 30.
- **framerate** (int) - Optional - Frame rate. Default is 30.
- **capture** (bool) - Optional - Enable capture.
- **open** (bool) - Optional - If true, automatically calls open() after creation.
```

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

### Recorder.mute

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

Sets or gets the mute status.

```APIDOC
## Recorder.mute(data: int = -1)

### Description
Mute the audio recording. Note: MaixCAM2 does not support this API.

### Parameters
- **data** (int) - Optional - If set to true, the audio will be muted. If omitted, the current mute status is returned.

### Returns
- **bool** - Returns whether mute is currently enabled.
```

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

### Recorder.volume

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

Sets or gets the recording volume.

```APIDOC
## Recorder.volume(value: int = -1)

### Description
Set or get the record volume. The range is [0, 100].

### Parameters
- **value** (int) - Optional - The volume value to set. If omitted, the current volume is returned.

### Returns
- **int** - The current volume.
```

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

### Hid.__init__

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

Constructor for the Hid class. Initializes the device with a specified type and optionally opens it immediately.

```APIDOC
## Hid.__init__(self, device_type: DeviceType, open: bool = True)

### Description
Initializes a new HID device instance. You can specify the device type (mouse, keyboard, or touchpad) and whether to open the device automatically upon initialization.

### Parameters
- **device_type** (DeviceType) - Required - The type of HID device (DEVICE_MOUSE, DEVICE_KEYBOARD, or DEVICE_TOUCHPAD).
- **open** (bool) - Optional - Whether to automatically open the device. Defaults to True.
```

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

### File.sample_rate

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

Gets or sets the sample rate.

```APIDOC
## File.sample_rate(new_sample_rate=-1)

### Description
Get or set the sample rate.

### Parameters
- **new_sample_rate** (int) - Optional - If > 0, changes the sample rate.

### Returns
- **int** - The current sample rate.
```

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

### File.channels

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

Gets or sets the number of channels.

```APIDOC
## File.channels(new_channels=-1)

### Description
Get or set the number of channels.

### Parameters
- **new_channels** (int) - Optional - If > 0, changes the number of channels.

### Returns
- **int** - The current number of channels.
```

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

### maix.example.Example.get_dict

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

Manipulates a dictionary.

```APIDOC
## maix.example.Example.get_dict(in: dict[str, int]) -> dict[str, int]

### Description
Takes an input dictionary and returns a new dictionary containing {"a": 1} merged with the input dictionary.
```

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

### Initialize Context Object

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

Constructs a new Context object with specified media type and timebase.

```Python
def __init__(self, media_type: MediaType, timebase: list[int]) -> None
```

```C++
Context(video::MediaType media_type, std::vector<int> timebase)
```

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

### VideoRecorder.__init__()

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

Constructs a new VideoRecorder object.

```APIDOC
## VideoRecorder.__init__(open: bool = True)

### Description
Constructs a new VideoRecorder object. This object integrates recording, video capturing, and display functions.

### Parameters
- **open** (bool) - Optional - If true, video will automatically call open() after creation. Default is true.
```

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

### PWM.freq

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

Gets or sets the PWM frequency.

```APIDOC
## PWM.freq(freq: int = -1) -> int

### Description
Gets or sets the PWM frequency in Hz. If a value is provided, it sets the frequency; otherwise, it returns the current frequency.

### Parameters
- **freq** (int) - Optional - Frequency in Hz (default: -1 to read).
```

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

### BM8563.now

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

Get the current datetime from the RTC.

```APIDOC
## BM8563.now()

### Description
Retrieves the current date and time from the BM8563.

### Returns
- **list[int]** - The current time tuple.
```

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

### Initialize VideoRecorder

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

Constructs a new VideoRecorder object. If open is true, it automatically calls open().

```python
def __init__(self, open: bool = True) -> None
```

```cpp
VideoRecorder(bool open = true)
```

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

### File constructor

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

Initializes a new File object.

```python
def __init__(self, path: str = '', mode: str = 'r') -> None
```

```cpp
File(const std::string path = "", const std::string &mode = "r")
```

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

### Add Sample

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

Adds an image as a sample for a class. Call the learn method after adding samples.

```python
def add_sample(self, img: maix.image.Image, fit: maix.image.Fit = ...) -> None
```

```cpp
void add_sample(image::Image &img, image::Fit fit = image::FIT_COVER)
```

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

### Get landmarks number

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

Accesses the number of landmarks.

```cpp
int landmarks_num
```

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

### Decoder.__init__(path: str, format: maix.image.Format = ...)

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

Construct a new decoder object.

```APIDOC
## Decoder.__init__(path, format)

### Description
Construct a new decoder object for a specified file path.

### Parameters
- **path** (str) - Required - Path to the file to be decoded. Supports .264 and .mp4 (h.264 streams).
- **format** (maix.image.Format) - Optional - Decoded output format. Currently supports GRAYSCALE and YUV420SP.
```

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

### Qwen Post Configuration Parameters

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

Configuration settings for Qwen model sampling, including temperature, repetition penalty, and top-k/top-p sampling.

```cpp
class QwenPostConfig
```

```cpp
bool enable_temperature
```

```cpp
float temperature
```

```cpp
bool enable_repetition_penalty
```

```cpp
float repetition_penalty
```

```cpp
int penalty_window
```

```cpp
bool enable_top_p_sampling
```

```cpp
float top_p
```

```cpp
bool enable_top_k_sampling
```

```cpp
int top_k
```

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

### Get Resolution

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

Retrieves the current video resolution.

```python
def get_resolution(self) -> list[int]
```

```cpp
std::vector<int> get_resolution()
```

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

### Get Timebase

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

Retrieves the time base configuration.

```Python
def timebase(self) -> list[int]
```

```C++
std::vector<int> timebase()
```

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

### Get Bitrate

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

Retrieves the current bitrate setting.

```python
def bitrate(self) -> int
```

```cpp
int bitrate()
```

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

### Key.open

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

Opens or re-initializes the key device.

```APIDOC
## Key.open()

### Description
Opens or initializes the key device. If the device is already open, it will be closed and re-opened.

### Returns
- **maix.err.Err** - Returns ERR_NONE on success.
```

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

### NanoTrack.init

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

Initializes the tracker with an image and target position.

```APIDOC
## NanoTrack.init

### Description
Initializes the tracker by providing the first target image and the target's bounding box coordinates.

### Parameters
- **img** (maix.image.Image) - Required - The image containing the target.
- **x** (int) - Required - Target top-left x coordinate.
- **y** (int) - Required - Target top-left y coordinate.
- **w** (int) - Required - Target width.
- **h** (int) - Required - Target height.
```

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

### iso(value=-1)

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

Sets or gets the camera ISO.

```APIDOC
## iso(value: int = -1)

### Description
Sets or gets the camera ISO. Note: This affects the ISP and image quality.

### Parameters
- **value** (int) - Optional - Camera ISO. If -1, returns current ISO. If != 0, sets ISO.

### Returns
- **int** - Camera ISO.
```

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

### gain(value=-1)

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

Sets or gets the camera gain.

```APIDOC
## gain(value: int = -1)

### Description
Sets or gets the camera gain. Note: This affects the ISP and image quality.

### Parameters
- **value** (int) - Optional - Camera gain. If -1, returns current gain. If != 0, sets gain.

### Returns
- **int** - Camera gain.
```

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

### start_ap(ssid, password, mode='g', channel=0, ip='192.168.66.1', netmask='255.255.255.0', hidden=False)

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

Starts the WiFi module in Access Point mode.

```APIDOC
## start_ap(ssid, password, mode='g', channel=0, ip='192.168.66.1', netmask='255.255.255.0', hidden=False)

### Description
Configures and starts the device as a WiFi Access Point.

### Parameters
- **ssid** (str) - Required - SSID of the AP.
- **password** (str) - Required - Password of the AP.
- **mode** (str) - Optional - WiFi mode ('g', 'a', or 'b').
- **channel** (int) - Optional - WiFi channel number.
- **ip** (str) - Optional - IP address of the host AP.
- **netmask** (str) - Optional - Netmask for the AP.
- **hidden** (bool) - Optional - Whether the SSID is hidden.

### Returns
- **maix.err.Err** - Returns err.Err.ERR_NONE on success, otherwise indicates failure.
```

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

### vflip

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

Sets or gets the vertical flip setting.

```APIDOC
## vflip(value)

### Description
Set or get camera vertical flip.

### Parameters
- **value** (int) - Optional - Flip value, default -1 (get current).
```

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

### Initialize Display Object

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

Constructs a new Display object with optional dimensions, format, and device selection.

```python
def __init__(self, width: int = -1, height: int = -1, format: maix.image.Format = ..., device: str = '', open: bool = True) -> None
```

```cpp
Display(int width = -1, int height = -1, image::Format format = image::FMT_RGB888, const std::string &device = "", bool open = true)
```

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

### hmirror

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

Sets or gets the horizontal mirror setting.

```APIDOC
## hmirror(value)

### Description
Set or get camera horizontal mirror.

### Parameters
- **value** (int) - Optional - Mirror value, default -1 (get current).
```

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

### Protocol.__init__

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

Constructs a new Protocol object with a specified buffer size and header.

```APIDOC
## __init__(self, buff_size: int = 1024, header: int = 3148663466) -> None

### Description
Construct a new Protocol object.

### Parameters
- **buff_size** (int) - Optional - Data queue buffer size
- **header** (int) - Optional - Header value
```

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

### aldo1

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

Sets or gets the PMU ALDO1 voltage.

```APIDOC
## aldo1(voltage=-1)

### Description
Sets the ALDO1 voltage if a value is provided, otherwise returns the current voltage.

### Parameters
- **voltage** (int) - Optional. The voltage to set (500mV-3500mV, step 100mV).

### Returns
- **int** - The current ALDO1 voltage.
```

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

### Qwen3VL Post Configuration

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

Manually set the post-configuration for Qwen3VL, which otherwise defaults to values from the MUD file.

```cpp
nn::Qwen3VLPostConfig post_config
```

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

### PWM.duty

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

Gets or sets the PWM duty cycle.

```APIDOC
## PWM.duty(duty: float = -1) -> float

### Description
Gets or sets the PWM duty cycle. If a value is provided, it sets the duty cycle; otherwise, it returns the current duty cycle.

### Parameters
- **duty** (float) - Optional - Duty cycle percentage [0, 100] (default: -1 to read).
```

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

### dcdc5

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

Sets or gets the PMU DCDC5 voltage.

```APIDOC
## dcdc5(voltage=-1)

### Description
Sets the DCDC5 voltage if a value is provided, otherwise returns the current voltage.

### Parameters
- **voltage** (int) - Optional. The voltage to set (1400mV-3700mV, step 100mV).

### Returns
- **int** - The current DCDC5 voltage.
```

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

### list_devices()

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

Lists all supported camera devices available on the system.

```APIDOC
## list_devices()

### Description
List all supported camera devices.

### Signature
`def list_devices() -> list[str]`

### Returns
- **list[str]**: A list containing the paths to the available camera devices.
```

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

### dcdc4

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

Sets or gets the PMU DCDC4 voltage.

```APIDOC
## dcdc4(voltage=-1)

### Description
Sets the DCDC4 voltage if a value is provided, otherwise returns the current voltage.

### Parameters
- **voltage** (int) - Optional. The voltage to set (500mV-1840mV range).

### Returns
- **int** - The current DCDC4 voltage.
```

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

### Image Constructor

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

Initializes a new Image object with specified width, height, format, and background color.

```APIDOC
## Image Constructor

### Description
Initializes a new Image object.

### Parameters
- **width** (int) - Required - Image width, must be greater than 0.
- **height** (int) - Required - Image height, must be greater than 0.
- **format** (Format) - Optional - Image format (default is determined by implementation).
- **bg** (Color) - Optional - Background color. Defaults to black. If set to `image.COLOR_INVALID`, the background will not be filled, potentially saving time.
```

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

### dcdc3

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

Sets or gets the PMU DCDC3 voltage.

```APIDOC
## dcdc3(voltage=-1)

### Description
Sets the DCDC3 voltage if a value is provided, otherwise returns the current voltage.

### Parameters
- **voltage** (int) - Optional. The voltage to set (500mV-1540mV range).

### Returns
- **int** - The current DCDC3 voltage.
```

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

### Hello Static Method

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

Static method to return a greeting string.

```Python
def hello(name: str) -> str
```

```C++
static std::string hello(std::string name)
```

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

### FP5510.__init__

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

Constructs a new FP5510 object with specified I2C parameters.

```APIDOC
## FP5510.__init__(id: int = 4, slave_addr: int = 12, freq: int = 400000)

### Description
Construct a new FP5510 object to interface with the hardware.

### Parameters
- **id** (int) - Optional - IIC number, default is 4.
- **slave_addr** (int) - Optional - Slave address of fp5510, default is 0x0c (12).
- **freq** (int) - Optional - IIC frequency, default is 400000.
```

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

### dcdc2

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

Sets or gets the PMU DCDC2 voltage.

```APIDOC
## dcdc2(voltage=-1)

### Description
Sets the DCDC2 voltage if a value is provided, otherwise returns the current voltage.

### Parameters
- **voltage** (int) - Optional. The voltage to set (500mV-1540mV range).

### Returns
- **int** - The current DCDC2 voltage.
```

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

### dcdc1

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

Sets or gets the PMU DCDC1 voltage.

```APIDOC
## dcdc1(voltage=-1)

### Description
Sets the DCDC1 voltage if a value is provided, otherwise returns the current voltage.

### Parameters
- **voltage** (int) - Optional. The voltage to set (1500mV-3400mV, step 20mV).

### Returns
- **int** - The current DCDC1 voltage.
```

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

### Recorder.__init__

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

Constructs a new Recorder object for audio capture.

```APIDOC
## Recorder.__init__(path: str = '', sample_rate: int = 48000, format: Format = ..., channel: int = 1, block: bool = True)

### Description
Constructs a new Recorder object. Currently only pcm and wav formats are supported.

### Parameters
- **path** (str) - Optional - The location to save the file. If None, the audio module will not save the file.
- **sample_rate** (int) - Optional - Record sample rate, default is 48000 (48KHz).
- **format** (Format) - Optional - Record sample format, default is audio::Format::FMT_S16_LE.
- **channel** (int) - Optional - Record sample channel, default is 1.
- **block** (bool) - Optional - Whether to use block recording, default is True.
```

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

### Slide.stop_default_per

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

Gets or sets the stop default percentage.

```APIDOC
## Slide.stop_default_per(per=-1)

### Description
Retrieves or sets the stop default percentage. If the parameter is -1, it returns the current setting.

### Parameters
- **per** (int) - Optional - Stop default percentage 0-100 (default: -1).

### Returns
- **int** - Current stop default percentage or the newly set percentage.
```

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

### Key Constructor

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

Initializes the key device. The callback runs in a separate thread.

```python
def __init__(self, callback: typing.Callable[[int, int], None] = None, open: bool = True, device: str = '', long_press_time: int = 2000) -> None
```

```cpp
Key(std::function<void(int, int)> callback = nullptr, bool open = true, const string &device = "", int long_press_time = 2000)
```

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

### Get Port

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

Retrieves the configured port number.

```python
def port(self) -> int
```

```cpp
int port()
```
Tokens:
Raw