--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.__init__.html Mon Feb 13 17:49:52 2023 +0100 @@ -0,0 +1,179 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.Devices.__init__</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.Devices.__init__</h1> + +<p> +Package containing the device interface modules and device specific dialogs. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>FirmwareGithubUrls</td></tr><tr><td>IgnoredBoards</td></tr><tr><td>SupportedBoards</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#getDevice">getDevice</a></td> +<td>Public method to instantiate a specific MicroPython device interface.</td> +</tr> +<tr> +<td><a href="#getDeviceIcon">getDeviceIcon</a></td> +<td>Function to get the icon for the given board.</td> +</tr> +<tr> +<td><a href="#getFoundDevices">getFoundDevices</a></td> +<td>Function to check the serial ports for supported MicroPython devices.</td> +</tr> +<tr> +<td><a href="#getSupportedDevices">getSupportedDevices</a></td> +<td>Function to get a list of supported MicroPython devices.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="getDevice" ID="getDevice"></a> +<h2>getDevice</h2> +<b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid, boardName="", serialNumber=""</i>) + +<p> + Public method to instantiate a specific MicroPython device interface. +</p> +<dl> + +<dt><i>deviceType</i> (str)</dt> +<dd> +type of the device interface +</dd> +<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> +<dd> +reference to the main MicroPython widget +</dd> +<dt><i>vid</i> (int)</dt> +<dd> +vendor ID (only used for deviceType 'generic') +</dd> +<dt><i>pid</i> (int)</dt> +<dd> +product ID (only used for deviceType 'generic') +</dd> +<dt><i>boardName</i> (str (optional))</dt> +<dd> +name of the board (defaults to "") +</dd> +<dt><i>serialNumber</i> (str (optional))</dt> +<dd> +serial number of the board (defaults to "") +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated device interface +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +BaseDevice +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getDeviceIcon" ID="getDeviceIcon"></a> +<h2>getDeviceIcon</h2> +<b>getDeviceIcon</b>(<i>boardName, iconFormat=True</i>) + +<p> + Function to get the icon for the given board. +</p> +<dl> + +<dt><i>boardName</i> (str)</dt> +<dd> +name of the board +</dd> +<dt><i>iconFormat</i> (bool)</dt> +<dd> +flag indicating to get an icon or a pixmap +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +icon for the board (iconFormat == True) or + a pixmap (iconFormat == False) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QIcon or QPixmap +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getFoundDevices" ID="getFoundDevices"></a> +<h2>getFoundDevices</h2> +<b>getFoundDevices</b>(<i></i>) + +<p> + Function to check the serial ports for supported MicroPython devices. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a list of tuples with the board type, the port + description, a description, the serial port it is connected at, the + VID and PID for known device types, a list of tuples with VID, PID + and description for unknown devices and a list of tuples with VID, + PID, description and port name for ports with missing VID or PID +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of tuples of (str, str, str, str, int, int), + list of tuples of (int, int, str), + list of tuples of (int, int, str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getSupportedDevices" ID="getSupportedDevices"></a> +<h2>getSupportedDevices</h2> +<b>getSupportedDevices</b>(<i></i>) + +<p> + Function to get a list of supported MicroPython devices. +</p> +<dl> +<dt>Return:</dt> +<dd> +set of tuples with the board type and description +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +set of tuples of (str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file