diff --git a/docs/Application_guide/zh/README.md b/docs/Application_guide/zh/README.md index e3d032de821258a49c75a8c2343116bffc31c39a..79b7375b0bbc79daacae4901c64cf9dd7d23a012 100644 --- a/docs/Application_guide/zh/README.md +++ b/docs/Application_guide/zh/README.md @@ -47,7 +47,10 @@ QuecPython 应用指导，是对QuecPython常用功能模块如何使用的指 多媒体 - [GUI](multi-media/lvgl/lvgl.md) - + +- [POC](multi-media/poc/poc_api.md) + +
网络与通信 diff --git a/docs/Application_guide/zh/multi-media/README.md b/docs/Application_guide/zh/multi-media/README.md index 2922a1397a7c7a6bd3d84a8ab2a04f8569b047c5..953d953fb8a64cd949cb7b96e759640b50320cce 100644 --- a/docs/Application_guide/zh/multi-media/README.md +++ b/docs/Application_guide/zh/multi-media/README.md @@ -1,8 +1,9 @@ # 多媒体 多媒体是多种媒体的综合，一般包括文本，声音和图像等多种媒体形式。 -本系列包括三部分： +本系列包括四部分： - [GUI](./lvgl/README.md) +- [POC](./poc/README.md) - 二维码 (文档未发布) - 音频 (文档未发布) diff --git a/docs/Application_guide/zh/multi-media/poc/README.md b/docs/Application_guide/zh/multi-media/poc/README.md new file mode 100644 index 0000000000000000000000000000000000000000..29e3b8a9efd0e0816a0f525788d81683f77cf063 --- /dev/null +++ b/docs/Application_guide/zh/multi-media/poc/README.md @@ -0,0 +1,3 @@ +Quecpyhton POC 提供实时的语音通信，减少信息传递的延迟，同时支持连接各种对讲平台：卓智达、善理、伯纳德、 芯平台。并且使用 python 语言，便于二次开发。 + +- [POC](./poc_api.md) \ No newline at end of file diff --git a/docs/Application_guide/zh/multi-media/poc/poc_api.md b/docs/Application_guide/zh/multi-media/poc/poc_api.md new file mode 100644 index 0000000000000000000000000000000000000000..a0be200732f109fd4304e5c988589d5b7e0e1d9c --- /dev/null +++ b/docs/Application_guide/zh/multi-media/poc/poc_api.md @@ -0,0 +1,375 @@ +# poc - 对讲服务 + + + +该类基于伯纳德库，实现对讲功能。 + +### `poc.init(init_cb)` + +```python +def init_cb(msg): + print("poc init (state) -> {}".format(msg)) + +poc.init(init_cb) +``` + +该方法用于初始化poc。 + +**参数描述：** + +- `init_cb` - 初始化回调函数，fun类型。`1`表示初始化成功，`0`表示初始化失败。 + +### `poc.get_init_status()` + +该方法用于获取初始化状态。 + +**返回值描述：** + +`1` - 已初始化； + +`0` - 未初始化。 + +### `poc.set_solution(solution)` + +该方法用于设置方案。 + +**参数描述：** + +- `solution` - 方案名，str类型。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.set_solution(version)` + +该方法用于设置solution版本。 + +**参数描述：** + +- `version` - 方案版本号，str类型。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.set_productInfo(productInfo)` + +该方法用于设置产品信息。 + +**参数描述：** + +- `productInfo` - 产品信息，str类型。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.set_manufacturer(manufacturer)` + +该方法用于设置制造商信息。 + +**参数描述：** + +- `manufacturer` - 制造商信息，str类型。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.login(login_cb)` + +该方法用于登录平台。 + +**参数描述：** + +- `login_cb` - 登录状态回调函数，fun类型。 + +**返回值描述：** + +`0`表示成功； + +`小于0`表示失败。 + +### `poc.speak(value)` + +该方法用于呼叫组内用户。 + +**参数描述：** + +- `value` - 1：呼叫，0：退出呼叫。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.calluser(uid,cb)` + +该方法用于呼叫指定用户。 + +**参数描述：** + +- `uid` - 对方用户id，int类型。 +- `cb` - 单呼回调，fun类型。1：成功，0：失败。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.member_getbyid(uid)` + +该方法用于查询用户信息。 + +**参数描述：** + +- `uid` - 用户id，int类型。若为0，则查询当前用户信息。 + +**返回值描述：** + +列表：（用户id，用户名，在线状态，索引号） + +在线状态：`1` - 在线，`2` - 离线，`3` - 在线在组。 + +### `poc.get_loginstate()` + +该方法用于查询当前用户在线状态。 + +**返回值描述：** + +`1` - 在线； + +`2` - 离线； + +`3` - 在线在组。 + +### `poc.jiongroup(gid)` + +该方法用于设备入组。 + +**参数描述：** + +- `gid` - 组id，int类型。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.leavegroup()` + +该方法用于设备离开当前组。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.get_groupcount()` + +该方法用于获取群组数。 + +**返回值描述：** + +群组个数。 + +### `poc.get_grouplist(index_begin, count)` + +该方法用于查询群组信息。 + +**参数描述：** + +- `index_begin` - 查询的索引起始值，int类型。 +- `count` - 计划查询的个数，int类型。 + +**返回值描述：** + +`-1`表示失败； + +`元组`表示成功。 + +（群组id，群组名，群组类型，群组索引号） + +### `poc.group_getbyindex(index)` + +该方法用于按索引查询群组信息。 + +**参数描述：** + +- `index` - 索引号，int类型。 + +**返回值描述：** + +列表：（群组id，群组名，群组类型，群组索引号） + +### `poc.group_getbyid(gid)` + +该方法用于按组id查询群组信息。 + +**参数描述：** + +- `gid` - 群组id，int类型。若为0，则查询当前群组信息。 + +**返回值描述：** + +列表：（群组id，群组名，群组类型，群组索引号） + +### `poc.get_membercount(gid)` + +该方法用于查询群组内成员个数。 + +**参数描述：** + +- `gid` - 群组id，int类型。 + +**返回值描述：** + +成员个数。 + +### `poc.get_memberlist(gid,index_begin,count)` + +该方法用于获取群组内成员列表。 + +**参数描述：** + +- `gid` - 群组id，int类型； +- `index_begin` - 查询的索引起始值，int类型； +- `count` - 计划查询的个数，int类型。 + +**返回值描述：** + +`-1`表示失败； + +`元组`表示成功。 + +（用户id，用户名，在线状态，优先级，索引号） + +### `poc.get_audiostate()` + +该方法用于获取当前音频状态。 + +**返回值描述：** + +`0` - 空闲； + +`1` - 开始通话； + +`2` - 通话中； + +`3` - 停止通话； + +`4` - 开始接听； + +`5` - 接听中； + +`6` - 停止接听； + +`7` - 开始播放tts； + +`8` - 停止播放tts； + +`9` - 开始播放提示音； + +`10` - 停止播放提示音； + +`11` - 开始录音； + +`12` - 结束录音。 + +### `poc.set_tts_enable(enable)` + +该方法用于使能tts。 + +**参数描述：** + +- `enable` - 使能tts，int类型。1：使用，0：不使用。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.play_tts(tts_str,interrupt)` + +该方法用于播放tts。 + +**参数描述：** + +- `tts_str` - 播放的内容，str类型； +- `interrupt` - 可否中断。 + +**返回值描述：** + +`0`表示成功； + +`其他`表示失败。 + +### `poc.register_join_group_cb(cb)` + +该方法用于注册入组回调。 + +**参数描述：** + +- `cb` - 进组回调，触发源包括主动进组和被动进组，fun类型。 + +> 回调参数说明：列表（groupname，gid） +> +> `groupname` - 当前群组的名字； +> `gid` - 当前群组gid。 + +### `poc.register_audio_cb(poc_audio_cb)` + +该方法用于注册音频回调。 + +**参数描述：** + +- `poc_audio_cb` - 音频回调，fun类型。 + +> 回调参数说明：列表（state，uid, name，flag） +> +> `state` - 当前语音状态：收听/讲话/TTS/TONE； +> `uid` - 当前操作用户uid，讲话/TTS/TONE时为0； +> `name` - 当前操作用户名字，讲话/TTS/TONE时为NULL； +> `flag` - 如果state为BND_LISTEN_START，flag1表示本机可以打断对方讲话，flag0表示本机不能打断对方讲话。 + +### `poc.register_listupdate_cb(poc_listupdate_cb)` + +该方法注册数据更新回调。 + +**参数描述：** + +- `poc_listupdate_cb` - 数据变化的回调，fun类型。 + +> 回调参数说明： +> +> `1` - 群组列表变化； +> +> `2` - 成员列表变化。 + +### `poc.register_upgrade_cb(cb)` + +该方法用于注册是否升级回调。 + +**参数描述：** + +- `cb` - 升级回调，fun类型。 + +> 回调参数说明： +> +> `1` - 需要升级； +> +> `0` - 不需要升级。 \ No newline at end of file diff --git a/docs/Application_guide/zh/sidebar.yaml b/docs/Application_guide/zh/sidebar.yaml index cc36d5eaedf44024443ad929ef24668df896dd1a..bcedfe388dfaddc1cccc89ab2a7cea5c55adb806 100644 --- a/docs/Application_guide/zh/sidebar.yaml +++ b/docs/Application_guide/zh/sidebar.yaml @@ -122,6 +122,11 @@ items: file: multi-media/lvgl/lvgl_application_scenarios.md - label: LVGL开发注意事项 file: multi-media/lvgl/lvgl_notes.md + label: POC + file: multi-media/poc/README.md + items: + - label: POC API + file: multi-media/poc/poc_api.md - label: 网络与通信 file: network-comm/README.md items: diff --git a/docs/FAQ/en/hardware/bsp.md b/docs/FAQ/en/hardware/bsp.md index 17be91c99a22894861850a391166be31a29d5e8a..e60cba856bcd107d9473d24b3d7d8ad2ecfc8f11 100644 --- a/docs/FAQ/en/hardware/bsp.md +++ b/docs/FAQ/en/hardware/bsp.md @@ -18,15 +18,15 @@ GPIO output current capability: 4mA For specific pins that can be used as GPIO, please refer to the Section machine.Pin on the wiki. -> Specific link: [GPIO pin description]([class Pin - Control I/O pins - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html)) +> Specific link: [GPIO pin description](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) ### **Which pins can be used as external interrupts?** The external interrupt number will go along with the number of GPIO pins. For details, please refer to machine.Pin and machine.Extlnt on the GPIO pin wiki. -> Specific link: [GPIO pin description]([class Pin - Control I/O pins - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html)); +> Specific link: [GPIO pin description](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html); > -> [Extlnt-External Interrupt Description]([class ExtInt - External Interrupt - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html)) +> [Extlnt-External Interrupt Description](https://python.quectel.com/doc/API_reference/en/peripherals/machine.ExtInt.html) ### **Which pins can be used as wake-up interrupts?** diff --git a/docs/Getting_started/en/evb/ec600u-235.md b/docs/Getting_started/en/evb/ec600u-235.md deleted file mode 100644 index 83acf9b669987d41b11fcc75f283da2a9f98890d..0000000000000000000000000000000000000000 --- a/docs/Getting_started/en/evb/ec600u-235.md +++ /dev/null @@ -1,135 +0,0 @@ -# EC600U U-235 EVB Introduction - -## Supported Module List - -- [EC600U-EU](https://python.quectel.com/en/products/ec600u-eu) - -## Feature List - -### Basic Overview - -QuecPython U-235 large screen evb integrates almost all the functions of the existing modules, including a wealth of peripherals, including external Flash, WiFi, screen and so on. - -The evaluation board has a USB Type-C interface, making it convenient for development. Developers only need a USB Type-C cable to easily use the evaluation board. - -### Function Description - -This section provides instructions for some functions of the U-235 EVB. - - -![](../media/evb/ec600u-235-evb/image8.jpg) - -1. **SD Card: ** - -Pull up Pin 53 (QuecPython GPIO27) of the EC600U module. - -2. **Wi-Fi Module: ** - -Pull the switch marked with "3" in the figure above to the "**GND**" side to download the firmware of the Wi-Fi module through the UART of the Wi-Fi module (marked with "2" in the figure above). After the download is complete, pull the switch marked with "3" to the "**NONE**" side, and reboot the Wi-Fi module. To enable the communication between the Wi-Fi module and the EC600U module, pull up Pin 3 of the EC600U module to switch the pin from UART 1 to Wi-Fi UART and pull up Pin 121 to power the Wi-Fi module. - -3. **Zigbee: ** - -When Pin 3 of the EC600U module is at a low level, the serial port marked with "1" in the figure above functions as UART 1. When this pin is at a high level, the serial port marked with "1" functions as Zigbee. - -4. **MIC & SPK: ** - -Both the left channel and the right channel of the microphone and the speaker interfaces are available. - -5. **External Power Supply:** - -Pull the Power Supply Selection Switch to the “**5V**” side, and connect the external power supply through the 5V Power Supply Interface. The maximum input voltage is 6.5 V. - -6. **Buzzer:** - -Pull up or down Pin 119 of the EC600U module to control the buzzer sound. - -7. **RS-485:** - -The RS-485 interface is connected to a physical serial port by default and communicates through UART 2. - -8. **MIPI:** - -Pull up Pin 118 (QuecPython GPIO 8) of the EC600U module. - -9. **Audio:** - -To enable PA, pull up Pin 4 (QuecPython GPIO 11) of the EC600U module. - -10. **Screen**: - -ST7701, 5 inch, MIPI interface, 480x854 Resolution, Capacitive touch screen, Touch chip GT911 - - -> In the QuecPython solution, for details about the correspondence between GPIOs and pins of EC600U series, please refer to QuecPython Documentation > Wiki > Peripherals > machine – Hardware > class Pin – Control I/O Pins. [**Control I/O Pins**](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) - -## Resource Download - -- [EC600U_U-235_EVB_SCH](https://images.quectel.com/python/sites/2/2023/10/600U_U-235-SCH.pdf) -- [Quectel_QuecPython_U 235_EVB](https://images.quectel.com/python/sites/2/2023/08/Quectel_QuecPython_U-235_EVB_User_Guide_V1.0.pdf) - -## Evaluation Board Resources - -The abundant onboard resources of U-235 EVB are illustrated by the figure below: - -![](../media/evb/ec600u-235-evb/image7.jpg) - -Starting from the "EC600U Module" indicator box in the figure above, the EVB resources are introduced as follows in a clockwise direction. - -- EC600U Module: The CPU with a Flash of 8 MB and a RAM of 16 MB. -- MIPI Screen I/O Interface -- MIPI LED Backlight Module -- Speaker R: The right channel speaker -- MIC: The microphone interface -- Speaker L: The left channel speaker -- TP I/O Interface -- Temperature & Humidity Sensor -- 5V Power Supply: The interface for 5V power supply -- Power Supply Selection Switch: The switch to select USB power supply or external power supply -- USB: The USB interface for downloading program codes and debugging scripts -- SIM Card Slot -- Ordinary Key: Three ordinary keys (no default function) -- Buzzer -- PWR Key: The power key for turning on/off the EC600U module -- RST Key: The reset key for reseting the EC600U module -- BOOT Key: The USB boot key for force-downloading firmware -- Camera Interface: The camera interface supporting taking photos and scanning -- Flash/MIPI_TE Selection Switch: If you need to use an external Flash, you must switch to the SIO3 side because the SIO3 of the Flash conflicts with the MIPI_TE pin. And most MIPI screens do not use MIPI_TE, so this switch is usually switched to the SIO3 side. -- Extended SPI Flash: The memory of the Flash W25Q32JWUUIQ is 4 MB. -- LTE Antenna Connector -- Wi-Fi Module -- WRST Key: The reset key for resetting the Wi-Fi module -- Ordinary KEY1 (no default function) -- Ordinary KEY2 (no default function) -- Wi-Fi Module UART -- TP Level Selection Switch: The switch to select the voltage level (1.8 V or 3.3 V) of the touch panel -- TP Interface -- SD Card Slot -- MIPI Screen Interface -- RS-485 Interface: SP3485EIM/TR is used - -> The MIPI interface and the TP interface are available synchronously to improve the reusability of U-235 EVB. - -## Getting Started Preparation - -> First, you will need a computer running Windows 10 or later. - -- **Step 1: Antenna Installation** - -Install the antenna that comes with the development board. Place it in the LTE antenna slot and insert the SIM card into the SIM card slot on the development board. - -- **Step 2: Connecting the Development Board** - -Use a USB Type-C data cable to connect the Type-C port on the development board to a USB port on your computer to provide power. - -- **Step 3: Development Board Power Settings** - -Set the power selection switch on the development board to USB, - -- **Step 4: Powering On the Development Board** - -Press and hold PWR until the power indicator light on the mainboard (labeled as PWR) lights up. - -**Once you've completed these steps, a constant PWR light indicates a successful power-on.** - - - diff --git a/docs/Getting_started/en/sidebar.yaml b/docs/Getting_started/en/sidebar.yaml index 5f400d5725f9129543d95001bd7e62254d43e1ed..9bb444f20ea90d9de08dc311d072c89ad1c6f683 100644 --- a/docs/Getting_started/en/sidebar.yaml +++ b/docs/Getting_started/en/sidebar.yaml @@ -43,7 +43,5 @@ items: file: evb/fcm360w-evb.md - label: FCM360W TE-B EVB Introduction file: evb/fcm360w-teb.md - - label: EC600U U-235 EVB Introduction - file: evb/ec600u-235.md - label: BG95/EG915U/EG912U Core EVB Introduction file: evb/bg-eg-core-evb.md \ No newline at end of file diff --git a/docs/Getting_started/zh/README.md b/docs/Getting_started/zh/README.md index cc3f6f3625417673160ccf1db075843b69c9f95d..d0fc99375fde15def77ac0d18d50017942235de5 100644 --- a/docs/Getting_started/zh/README.md +++ b/docs/Getting_started/zh/README.md @@ -15,4 +15,4 @@ QuecPython模组具有以下优势 | 区域 | Cat 1 | Cat 4 | Cat M | NB | WIFI | | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | --------------------------------------------------------- | | 国内 | [EG810M-CN](https://python.quectel.com/products/eg810m-cn)
[EC800E-CN](https://python.quectel.com/products/ec800e-cn)
[EC600E-CN](https://python.quectel.com/products/ec600e-cn)
[EC600G-CN](https://python.quectel.com/products/ec600g-cn)
[EC800G-CN](https://python.quectel.com/products/ec800g-cn)
[EC200N-CN](https://python.quectel.com/products/ec200n-cn)
[EC800M-CN](https://python.quectel.com/products/ec800m-cn)
[EC600M-CN](https://python.quectel.com/products/ec600m-cn)
[EC200U-CN](https://python.quectel.com/products/ec200u-cn)
[EC600U-CN](https://python.quectel.com/products/ec600u-cn)
[EC600N-CN](https://python.quectel.com/products/ec600n-cn) | [EC200A-CN](https://python.quectel.com/products/ec200a-cn)
| / | [BC25](https://python.quectel.com/products/bc25) | [FCM360W](https://python.quectel.com/products/fcm360w) | -| 海外 | [EG915U-EU](https://python.quectel.com/en/products/eg915u-eu)
[EG915N-EU](https://python.quectel.com/en/products/eg915n-eu)
[EG912U-GL](https://python.quectel.com/en/products/eg912u-gl)
[EG912N-EN](https://python.quectel.com/en/products/eg912n-en)
[EC200U-EU](https://python.quectel.com/en/products/ec200u-eu)
[EC600U-EU](https://python.quectel.com/en/products/ec600u-eu) | [EC200A-EU](https://python.quectel.com/en/products/ec200a-eu)
[EC200A-AU](https://python.quectel.com/en/products/ec200a-au) | [BG95-M1](https://python.quectel.com/en/products/bg95)
[BG95-M3
](https://python.quectel.com/en/products/bg95m3)[BG95-M8](https://python.quectel.com/en/products/bg95m8) | [BG95-M3
](https://python.quectel.com/en/products/bg95m3)[BG95-M8](https://python.quectel.com/en/products/bg95m8) | [FCM360W](https://python.quectel.com/en/products/fcm360w) | \ No newline at end of file +| 海外 | [EG915U-EU](https://python.quectel.com/en/products/eg915u-eu)
[EG915N-EU](https://python.quectel.com/en/products/eg915n-eu)
[EG912U-GL](https://python.quectel.com/en/products/eg912u-gl)
[EG912N-EN](https://python.quectel.com/en/products/eg912n-en)
[EC200U-EU](https://python.quectel.com/en/products/ec200u-eu) | [EC200A-EU](https://python.quectel.com/en/products/ec200a-eu)
[EC200A-AU](https://python.quectel.com/en/products/ec200a-au) | [BG95-M1](https://python.quectel.com/en/products/bg95)
[BG95-M3
](https://python.quectel.com/en/products/bg95m3)[BG95-M8](https://python.quectel.com/en/products/bg95m8) | [BG95-M3
](https://python.quectel.com/en/products/bg95m3)[BG95-M8](https://python.quectel.com/en/products/bg95m8) | [FCM360W](https://python.quectel.com/en/products/fcm360w) | \ No newline at end of file diff --git a/docs/Getting_started/zh/prepare.md b/docs/Getting_started/zh/prepare.md index 942104324074eecf80318a16b75b24f9007d4046..3578333d8a7304bec53c4f825637a80c763c6d3d 100644 --- a/docs/Getting_started/zh/prepare.md +++ b/docs/Getting_started/zh/prepare.md @@ -15,7 +15,7 @@ - [BG95_EVB](evb/bg95-evb.md) - [FCM360W_EVB](evb/fcm360w-evb.md) - [EC200X_EVB](evb/ec200x-evb.md) -- [EG915X_EVB](evb/eg915x-evb.md) +- [EG91X_EVB](evb/eg91x-evb.md) 软件：