Merge pull request #3 from QuecPython/main

update audio.Record()

Author: luoyangyang1989

en-us/api/QuecPythonClasslib.md

@@ -1355,6 +1355,70 @@ This function sets DTMF.
 
 
 
+##### Enable DTMF identification
+
+> **voiceCall.dtmfDetEnable(enable)**
+
+Enable DTMF identification. It is disabled by default.
+
+* Parameter
+
+| Parameter | Type   | Description                                                  |
+| --------- | ------ | ------------------------------------------------------------ |
+| enable    | int    | 1:Enable DTMF identification, 0:Disable DTMF identification  |
+
+* Return Value
+
+  * Returns 0 on success, -1 otherwise.
+
+* Example
+
+See the example of 'voiceCall.dtmfSetCb()'
+
+
+
+##### set the callback of DTMF identification
+
+> **voiceCall.dtmfSetCb(cb)**
+
+Set the callback of DTMF identification
+
+* Parameter
+
+| Parameter | Type     | Description                                                  |
+| --------- | ------   | ------------------------------------------------------------ |
+| cb        | function | callback function                                            |
+
+* Return Value
+
+  * Returns 0 on success, -1 otherwise.
+
+* Example
+
+```
+>>> def cb(args):
+... print(args)
+...
+...
+...
+>>> voiceCall.dtmfSetCb(cb)
+0
+>>> voiceCall.dtmfDetEnable(1)
+0
+
+>>> voiceCall.callStart('13855169092')
+
+0
+>>>
+1   //Press "1" on the phone, callback function will receive the pressed character "1".
+
+8   //Press "8" on the phone
+
+9   //Press "9" on the phone
+```
+
+
+
 ##### Set FWmode
 
 > **voiceCall.setFw(reason, fwmode, phonenum)**
@@ -7558,7 +7622,7 @@ True
   | timeout       | Integer type | This parameter is the timeout of upper layer application. When the application triggers timeout, it actively reports the scanned hot spot information. The application automatically reports the hot spot information if it scans all the hop spots which have been set previously or the underlying layer scan reaches the frequency sweeping timeout before the timeout of the application. <br>Range:<br/>600S: 4–255; unit: s.<br/>200U/600U: 120–5000; unit: ms. |
   | round         | Integer type | This parameter is the scanning rounds of wifi. When reaching the scanning rounds, the scan stops and the scanning results are obtained. <br/>Range:<br/>600S: 1–3; unit: round<br/>200U/600U: 1–10; unit: round |
   | max_bssid_num | Integer type | This parameter determines the maximum number of hot spots to be scanned. If the number of hot spots scanned by the underlying layer reaches the maximum, the scan stops and the scanning results are obtained. <br/>Range:<br/>600S: 4–30<br/>200U/600U: 1–300 |
-  | scan_timeout  | Integer type | This parameter is the wifi hot spot scanning timeout of underlying layer. If the underlying layer scan reaches the hot spot scanning timeout set previously,  the scan stops and the scanning results are obtained. Range: 1–255. Unit: second. 200U or 600U platforms do not support this parameter. You can set this parameter to 0. |
+  | scan_timeout  | Integer type | This parameter is the wifi hot spot scanning timeout of underlying layer. If the underlying layer scan reaches the hot spot scanning timeout set previously,  the scan stops and the scanning results are obtained. Range: 1–255.  |
   | priority      | Integer type | This parameter is the priority setting of wifi scanning service. 0 indicates that ps is preferred; 1 indicates that wifi is preferred. When ps is preferred, the wifi scan is terminated when a data service is initiated. When wifi is preferred, RRC connection is not connected when a data service is initiated. wifi scan runs normally. The RRC connection is only established after the scan completes. 200U or 600U platforms do not support this parameter. You can set this parameter to 0. |
 
 * Return Value：
@@ -11182,7 +11246,7 @@ $GNGSA,A,3,31,3
 
 Module function: the module provides a bare flash area and a special read-write interface for customers to store important information, and the information will not be lost after burning the firmware (burning the firmware without this function cannot be guaranteed not to be lost). Provide a storage and read interface, not a delete interface.
 
-At present, only ec600n and ec600s series projects are supported
+At present, only ec600n series projects are supported
 
 ##### Data storage
 
@@ -11234,10 +11298,10 @@ databuf = '\x31\x32\x33\x34\x35\x36\x37\x38'
 SecureData.Store(1, databuf, 8)
 #Define an array with a length of 20 to read the stored data
 buf = bytearray(20)
-#Read the data in the storage area with index 1 into buf, and store the length of the read data in the variable len
-lenth = SecureData.Read(1, buf, 20)
+#Read the data in the storage area with index 1 into buf, and store the length of the read data in the variable length
+length = SecureData.Read(1, buf, 20)
 #Output read data
-print(buf[:lenth])
+print(buf[:length])
 ```
 
 * implementation results
@@ -11248,8 +11312,8 @@ print(buf[:lenth])
 >>> SecureData.Store(1, databuf, 8)
 0
 >>> buf = bytearray(20)
->>> lenth = SecureData.Read(1, buf, 20)
->>> print(buf[:lenth])
+>>> length = SecureData.Read(1, buf, 20)
+>>> print(buf[:length])
 bytearray(b'12345678')
 >>> 
 ```

zh-cn/api/QuecPythonClasslib.md

@@ -1386,6 +1386,70 @@ sim.setCallback(cb)
 
 
 
+##### DTMF识别使能接口
+
+> **voiceCall.dtmfDetEnable(enable)**
+
+DTMF识别使能接口，默认不开启DTMF识别
+
+* 参数
+
+| 参数     | 参数类型 | 参数说明                                                     |
+| -------- | -------- | ------------------------------------------------------------ |
+| enable   | int      | 使能开关，取值0/1,0：不开启DTMF识别，1：开启DTMF识别         |
+
+* 返回值
+
+  设置成功返回整型0，设置失败返回整型-1。
+
+* 示例
+
+见voiceCall.dtmfSetCb()接口示例
+
+
+
+##### 设置DTMF识别回调接口
+
+> **voiceCall.dtmfSetCb(cb)**
+
+设置DTMF识别回调接口
+
+* 参数
+
+| 参数     | 参数类型 | 参数说明                                                     |
+| -------- | -------- | ------------------------------------------------------------ |
+| cb       | function | 回调函数                                                     |
+
+* 返回值
+
+  设置成功返回整型0，设置失败返回整型-1。
+
+* 示例
+
+```
+>>> def cb(args):
+... print(args)
+...
+...
+...
+>>> voiceCall.dtmfSetCb(cb)
+0
+>>> voiceCall.dtmfDetEnable(1)
+0
+
+>>> voiceCall.callStart('13855169092')
+
+0
+>>>
+1   //手机端按下1，callback中会收到按下的字符“1”
+
+8   //手机端按下8
+
+9   //手机端按下9
+```
+
+
+
 ##### 设置控制呼叫转移
 
 > **voiceCall.setFw(reason, fwmode, phonenum)**
@@ -4870,7 +4934,7 @@ while 1:
 
 
 
-###### 获取模块启动原因
+###### 获取模块开机原因
 
 > **Power. powerOnReason()**
 
@@ -7996,7 +8060,7 @@ True
   | timeout       | 整型 | 该超时时间参数是上层应用的超时，当触发超时会主动上报已扫描到的热点信息，若在超时前扫描到设置的热点个数或达到底层扫频超时时间会自动上报热点信息。<br>参数范围：<br/>600S ：4-255秒<br/>200U/600U ：120-5000毫秒 |
   | round         | 整型 | 该参数是wifi扫描轮，达到扫描轮数后，会结束扫描并获取扫描结果。<br/>参数范围：<br/>600S ：1-3轮次<br/>200U/600U ：1-10轮次 |
   | max_bssid_num | 整型 | 该参数是wifi扫描热点最大个，若底层扫描热点个数达到设置的最大个数，会结束扫描并获取扫描结果。<br/>参数范围：<br/>600S ：4-30个<br/>200U/600U ：1-300个 |
-  | scan_timeout  | 整型 | 该参数是底层wifi扫描热点超时时间，若底层扫描热点时间达到设置的超时时间，会结束扫描并获取扫描结果。该参数设置范围为1-255秒。200U/600U 平台不支持该参数，设置时写0即可。 |
+  | scan_timeout  | 整型 | 该参数是底层wifi扫描热点超时时间，若底层扫描热点时间达到设置的超时时间，会结束扫描并获取扫描结果。该参数设置范围为1-255秒。 |
   | priority      | 整型 | 该参数是wifi扫描业务优先级设置，0为ps优先，1为wifi优先。ps优先时，当有数据业务发起时会中断wifi扫描。Wifi优先时，当有数据业务发起时，不会建立RRC连接，保障wifi扫描正常执行，扫描结束后才会建立RRC连接。200U/600U 平台不支持该参数，设置时写0即可。 |
 
 * 返回值：
@@ -11595,7 +11659,7 @@ $GNGSA,A,3,31,3
 #### SecureData - 安全数据区
 
 模块功能：模组提供一块裸flash区域及专门的读写接口供客户存贮重要信息，且信息在烧录固件后不丢失(烧录不包含此功能的固件无法保证不丢失)。提供一个存储和读取接口，不提供删除接口。
-目前只支持EC600N、EC600S系列项目
+目前只支持EC600N系列项目
 
 ##### 数据存储
 
@@ -11647,10 +11711,10 @@ databuf = '\x31\x32\x33\x34\x35\x36\x37\x38'
 SecureData.Store(1, databuf, 8)
 # 定义一个长度为20的数组用于读取存储的数据
 buf = bytearray(20)
-# 读取index为1的存储区域中的数据至buf中,将读取到数据的长度存储在变量len中
-lenth = SecureData.Read(1, buf, 20)
+# 读取index为1的存储区域中的数据至buf中,将读取到数据的长度存储在变量length中
+length = SecureData.Read(1, buf, 20)
 # 输出读到的数据
-print(buf[:lenth])
+print(buf[:length])
 ```
 
  * 执行结果
@@ -11661,8 +11725,8 @@ print(buf[:lenth])
 >>> SecureData.Store(1, databuf, 8)
 0
 >>> buf = bytearray(20)
->>> lenth = SecureData.Read(1, buf, 20)
->>> print(buf[:lenth])
+>>> length = SecureData.Read(1, buf, 20)
+>>> print(buf[:length])
 bytearray(b'12345678')
 >>> 
 ```