Merge pull request QuecPython#1 from ArnoldFeng767/pyi_add

Pyi add new api descriptions

Author: dustin007442

quecpython_stubs/audio.pyi

@@ -309,3 +309,133 @@ class Record(object):
  """
 
  AMRNB: int = ... # AMR format.
+
+class TTS(object):
+ """Class Text-to-speech playback.
+
+ Currently supported models: EC600N series, EC800N series, EC600M-CN (LA, LE), EC800M-CN (LA, LE, GA), EG810MCN_GA, EC600U series, EC200U series, EG912U, EG915U, EG915N-EUAG.
+ Description: https://developer.quectel.com/doc/quecpython/API_reference/zh/medialib/audio.TTS.html
+ """
+
+ def __init__(self, device):
+ """Creates an TTS object.
+
+ :param device: Integer type. The output channel. 0 indicates earpiece, 1 indicates headphone, and 2 indicates speaker. See the table below for the specific channels supported by each module.
+ Channels Supported by the Module:
+ Module	Earpiece	Headphone	Speaker
+ EC200N/EC600N/EC800N	Supported	Unsupported	Unsupported
+ EC600M-CN(LA/LE)	Supported	Unsupported	Unsupported
+ EC800M-CN(LA/LE/GA)	Supported	Unsupported	Unsupported
+ EG810M	Supported	Unsupported	Unsupported
+ EG915N/EG912N	Supported	Unsupported	Unsupported
+ EG912U	Supported	Unsupported	Unsupported
+ EC200U	Unsupported	Unsupported	Supported
+ EC600U	Supported	Supported	Supported
+ EG915U	Supported	Supported	Unsupported
+ EC600S	Supported	Unsupported	Unsupported
+ EC600K/EC800K	Supported	Unsupported	Unsupported
+ EC800G-CN(GA/TT/LA)	Supported	Supported	Supported
+ EC600G-CN(LA)	Supported	Supported	Supported
+ """
+
+ def close(self):
+ """This method disables the TTS function.
+
+ :return: 0 - Successful execution; -1 - Failed execution.
+ """
+ 
+ def play(self, priority, breakin, mode, str):
+ """This method starts TTS playback. For usage examples, click here.
+ 
+ The playback task scheduling follows priority and break-in rules:
+ - Higher priority tasks (0-4, 4=highest) can interrupt lower priority ones
+ - Each priority group supports up to 10 queued tasks
+ - Break-in mode determines if current playback can be interrupted
+ 
+ :param priority: Integer type. Play priority (0-4). Higher value = higher priority.
+ :param breakin: Integer type. Break-in mode. 0: not allowed to break in; 1: allowed to break in.
+ :param mode: Integer type. Play mode (lower 4 bits: encoding mode; higher 4 bits: WTTS mode). See TTS mode table.
+ :param str: String type. The string to be played.
+ :return: Returns an integer value.
+ 0 - Playback started successfully
+ -1 - Playback failed
+ 1 - Added to playback queue (cannot play immediately)
+ -2 - Priority group queue full (not added)
+ """
+
+ def stop(self):
+ """This method stops TTS playback.
+ 
+ :return: 0 indicates success, -1 indicates failure.
+ """
+ 
+ def stopAll(self):
+ """This method stops the entire playback queue.
+ 
+ If TTS or audio is currently playing and there are other contents in the queue, 
+ calling this method will not only stop the current playback but also clear the queue.
+ If currently playing and the playback queue is empty, this method has the same effect as stop().
+ 
+ :return: 0 indicates success, -1 indicates failure.
+ """
+ 
+ def setCallback(self, cb):
+ """This method registers a user callback function to notify TTS playback status.
+ 
+ Do not perform time-consuming or blocking operations in the callback function. 
+ It is recommended to only perform simple and short operations.
+ 
+ :param cb: User callback function, function type. Function prototype:
+ def cb(event):
+ pass
+ 
+ Callback function parameter description:
+ event - Playback status, int type:
+ 2 - Playback started
+ 3 - Playback stopped
+ 4 - Playback completed
+ 
+ :return: 0 indicates success, -1 indicates failure.
+ """
+ 
+ def getVolume(self):
+ """This method gets the current playback volume level.
+ 
+ Volume value range [0 ~ 9], where 0 indicates mute (default is 4).
+ 
+ :return: Integer volume value on success, -1 on failure.
+ """
+ 
+ def setVolume(self, vol):
+ """This method sets the playback volume level.
+ 
+ Volume value should be in the range [0 ~ 9], where 0 indicates mute.
+ 
+ :param vol: Volume level, int type, range [0 ~ 9].
+ :return: 0 indicates success, -1 indicates failure.
+ """
+ 
+ def getSpeed(self):
+ """This method gets the current playback speed.
+ 
+ Speed value range [0 ~ 9], higher values indicate faster speed (default is 4).
+ 
+ :return: Integer speed value on success, -1 on failure.
+ """
+ 
+ def setSpeed(self, speed):
+ """This method sets the TTS playback speed.
+ 
+ Speed value should be in the range [0 ~ 9].
+ 
+ :param speed: Speed value, int type, range [0 ~ 9].
+ :return: 0 indicates success, -1 indicates failure.
+ """
+ 
+ def getState(self):
+ """This method gets the TTS status.
+ 
+ :return: 
+ 0 - No TTS playback currently
+ -1 - TTS is currently playing
+ """

quecpython_stubs/ble.pyi

@@ -546,3 +546,104 @@ def writeCharaDesc(connect_id, handle, data):
  :param data:Bytearray type. Characteristic description data.
  :return:0- Successful execution; -1- Failed execution.
  """
+
+
+def exchangeMtu(self, connect_id, mtu_size):
+ """Send MTU exchange request. 
+ 
+ The MTU exchange request should be initiated by the client side.
+ 
+ :param connect_id: Connection ID, obtained when establishing the connection, integer type.
+ :param mtu_size: MTU size.
+ :return: 0 on success, -1 on failure.
+ """
+
+def smpSetConfig(self, io_cap, auth_req, passkey, timeout):
+ """Configure pairing capabilities.
+ 
+ Pairing method selection process:
+ There are two modes for BLE SMP pairing: Legacy Pairing and Secure Connections Pairing.
+ The specific pairing method is determined through negotiation between the two parties after 
+ exchanging their IO capabilities.
+ 
+ :param io_cap: Device input/output capability, integer type, default 3.
+ Value Meaning
+ 0 Display only, can display PIN code
+ 1 Display only, can only display Yes/No, cannot display PIN code
+ 2 Input only, can input PIN code
+ 3 No input/output capability (default)
+ 4 Both input and output capabilities
+ :param auth_req: Authentication request parameter, integer type, default 9.
+ Bit0 Bit1 Bit2 Bit3
+ 0 No binding after pairing Reserved Disable MITM Use Legacy Pairing
+ 1 Bind after pairing Reserved Enable MITM Use Secure Connections Pairing
+ :param passkey: PIN code to display during pairing, integer type, default 123456.
+ :param timeout: Pairing timeout, in units of 100ms, integer type, default 160.
+ :return: 0 on success, -1 on failure.
+ """
+
+def smpGetConfig(self):
+ """Query pairing capabilities.
+ 
+ :return: On success, returns a tuple (io_cap, auth_req, passkey, timeout). 
+ On failure, returns -1.
+ 
+ io_cap - Device input/output capability, integer type, default 3.
+ Value Meaning
+ 0 Display only, can display PIN code
+ 1 Display only, can only display Yes/No, cannot display PIN code
+ 2 Input only, can input PIN code
+ 3 No input/output capability
+ 4 Both input and output capabilities
+ auth_req - Authentication request parameter, integer type, default 9.
+ Bit0 Bit1 Bit2 Bit3
+ 0 No binding after pairing Reserved Disable MITM Use Legacy Pairing
+ 1 Bind after pairing Reserved Enable MITM Use Secure Connections Pairing
+ passkey - PIN code to display during pairing, integer type, default 123456.
+ timeout - Pairing timeout, in units of 100ms, integer type, default 160.
+ """
+
+def smpStartPair(self, connect_id):
+ """Start the BLE SMP pairing process. 
+ 
+ SMP pairing is initiated by the client, but the server can also use this interface 
+ to notify the client to initiate an SMP pairing request.
+ 
+ :param connect_id: Connection ID, obtained when establishing the connection, integer type.
+ :return: 0 on success, -1 on failure.
+ """
+
+def smpUserConfirm(self, connect_id, pair_operation, pin):
+ """Confirm pairing. 
+ 
+ After receiving a pairing request, confirm whether to accept the pairing.
+ 
+ :param connect_id: Connection ID, obtained when establishing the connection, integer type.
+ :param pair_operation: Pairing operation type, integer type.
+ Value Meaning
+ 0 Cancel pairing (only available during pairing process; will disconnect the BLE connection)
+ 1 Confirm pairing without PIN (for Just Work or Numeric Comparison modes)
+ 2 Confirm pairing with PIN (for Passkey mode)
+ :param pin: PIN code, integer type.
+ :return: 0 on success, -1 on failure.
+ """
+
+def smpGetPairedDevInfo(self):
+ """Get information about paired devices.
+ 
+ :return: On success, returns a list of bytearray objects representing BLE addresses of paired devices.
+ On failure, returns -1.
+ """
+
+def smpRemovePairedDev(self, addr):
+ """Delete information for a specified paired device.
+ 
+ :param addr: BLE address of the device to be deleted, bytearray type (6 bytes).
+ :return: 0 on success, -1 on failure.
+ """
+
+def smpCleanPairedDev(self):
+ """Delete information for all paired devices.
+ 
+ :return: 0 on success, -1 on failure.
+ """

quecpython_stubs/ethernet.pyi

@@ -315,3 +315,23 @@ class YT8512H(object):
  active	bool	Whether NIC is activated. True and False respectively indicate enable and disable, which correspond to set_up and set_down.
  link	bool	Whether the network cable of NIC is connected. True and False respectively indicate the network cable is connected and is not connected.
  """
+
+
+ def speed(self):
+ """Get the current upstream and downstream speed of the network interface.
+ 
+ :return: A tuple containing two integers: (tx_speed, rx_speed) 
+ Parameter Type Description
+ tx int Current data transmission rate in bits per second (bps)
+ rx int Current data reception rate in bits per second (bps)
+ """
+ 
+ def node(self):
+ """Get the list of currently connected terminals to the network interface.
+ 
+ :return: A list of tuples, each containing information about a connected terminal.
+ Parameter Type Description
+ mac bytearray MAC address of the terminal (6 bytes)
+ ip str IP address of the terminal (in string format)
+ time int Connection duration in seconds
+ """

quecpython_stubs/machine.pyi

@@ -849,3 +849,42 @@ class KeyPad(object):
 
  :return: 0 - Successful execution; -1 - Failed execution
  """
+
+
+class OneWire(object):
+ """Single-Wire Bus Communication
+
+ https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.OneWire.html
+
+ This class provides single-wire (1-Wire) communication functionality.
+ Currently only supported on EC200U/EC600U/EG912U/EG915U series modules.
+ """
+ 
+ def __init__(self, GPIO):
+ """
+ Create a OneWire object.
+
+ :param GPIO: int type. The GPIO pin number to use (e.g., OneWire.GPIO19).
+ """
+ 
+ def reset(self):
+ """Reset the bus and check device response
+ 
+ Usage note: This method must be called before any read/write operations.
+ 
+ :return: Integer value. 0 indicates proper response from device, -1 indicates no response.
+ """
+ 
+ def read(self, len):
+ """Read data from the bus
+ 
+ :param len: int type. Length of data to read.
+ :return: bytes object containing the read data.
+ """
+ 
+ def write(self, data):
+ """Write data to the bus
+ 
+ :param data: bytes type. Data to be written.
+ :return: Integer value 0.
+ """

quecpython_stubs/modem.pyi

@@ -40,3 +40,13 @@ def getDevProductId():
 
  :return: If successful, it returns the device manufacture ID in string type. If failed, it returns the integer value -1.
  """
+
+def getDevMAC():
+ """Get Device MAC Address
+ 
+ This method retrieves the device's MAC address.
+ Currently only supported on FCM360W modules.
+ 
+ :return: On success - Returns the device MAC address as a string (format: "XX:XX:XX:XX:XX:XX")
+ On failure - Returns integer -1
+ """