API Documentation Template

Note

  1. Please follow the template below to write your API documentation;

  2. Strict use of reStructuredText syntax;

  3. Write strictly according to the various tags of the template

  4. When you are finished, delete all instructions (similar to this one) and any extra header information.

Support the following products:

xxx Unit

xxx Unit

Below is the detailed support for Speaker on the host:

Controller

Atomic Echo Base

Atom Echo

⭕

Atom Lite

✅

  • ✅: Supported.

  • ⭕: Optional, It conflicts with some internal resource of the host.

UiFlow2 Example

Note

Prepare one or more examples that fully demonstrate the functionality of the API. Delete this part of the description when you are done.

Example1

MicroPython Example

Example1

API

Function

func1(arg1: int, arg2: int) → int

Function 1, please write a detailed description of the function.

Parameters:

  • arg1 (int) – Parameter 1.

  • arg2 (int) – Parameter 2.

Returns:

Return value.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

pass # Please put the MicroPython code of the function, and delete this line when you are done

Class1

class Class1(arg1: int)

Constructor.

Parameters:

arg1 (int) – Parameter 1.

method1(arg1: int, arg2: int) → int

Method 1, please write a detailed description of the method.

Parameters:

  • arg1 (int) – Parameter 1.

  • arg2 (int) – Parameter 2.

Returns:

Return value.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

pass # Please put the MicroPython code of the function, and delete this line when you are done.
property property1: int

Property 1, please write a detailed description of the property.

UiFlow2 Code Block:

MicroPython Code Block:

pass # Please put the MicroPython code of the function, and delete this line when you are done.
static staticmethod1(arg1: int, arg2: int) → int

Static method 1, please write a detailed description of the static method.

Parameters:

  • arg1 (int) – Parameter 1.

  • arg2 (int) – Parameter 2.

Returns:

Return value.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

pass # Please put the MicroPython code of the function, and delete this line when you are done.
classmethod classmethod1(arg1: int, arg2: int) → int

Class method 1, please write a detailed description of the class method.

Parameters:

  • arg1 (int) – Parameter 1.

  • arg2 (int) – Parameter 2.

Returns:

Return value.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

pass # Please put the MicroPython code of the function, and delete this line when you are done.
b: int

Attribute b, please write a detailed description of the attribute.

UiFlow2 Code Block:

MicroPython Code Block:

pass # Please put the MicroPython code of the function, and delete this line when you are done.
CONSTANT1: int

Constant 1, Please write a detailed description of the constant. Constants are named using uppercase letters.

UiFlow2 Code Block:

MicroPython Code Block:

pass # Please put the MicroPython code of the function, and delete this line when you are done.

Class2

class Class2

Constructor.