Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.__init__.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.__init__.html
- branch
- eric7
- changeset 9756
- 9854647c8c5c
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9755:1a09700229e7 | 9756:9854647c8c5c |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.MicroPython.Devices.__init__</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.MicroPython.Devices.__init__</h1> | |
| 10 | |
| 11 <p> | |
| 12 Package containing the device interface modules and device specific dialogs. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>FirmwareGithubUrls</td></tr><tr><td>IgnoredBoards</td></tr><tr><td>SupportedBoards</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#getDevice">getDevice</a></td> | |
| 30 <td>Public method to instantiate a specific MicroPython device interface.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#getDeviceIcon">getDeviceIcon</a></td> | |
| 34 <td>Function to get the icon for the given board.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#getFoundDevices">getFoundDevices</a></td> | |
| 38 <td>Function to check the serial ports for supported MicroPython devices.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#getSupportedDevices">getSupportedDevices</a></td> | |
| 42 <td>Function to get a list of supported MicroPython devices.</td> | |
| 43 </tr> | |
| 44 </table> | |
| 45 <hr /> | |
| 46 <hr /> | |
| 47 <a NAME="getDevice" ID="getDevice"></a> | |
| 48 <h2>getDevice</h2> | |
| 49 <b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid, boardName="", serialNumber=""</i>) | |
| 50 | |
| 51 <p> | |
| 52 Public method to instantiate a specific MicroPython device interface. | |
| 53 </p> | |
| 54 <dl> | |
| 55 | |
| 56 <dt><i>deviceType</i> (str)</dt> | |
| 57 <dd> | |
| 58 type of the device interface | |
| 59 </dd> | |
| 60 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> | |
| 61 <dd> | |
| 62 reference to the main MicroPython widget | |
| 63 </dd> | |
| 64 <dt><i>vid</i> (int)</dt> | |
| 65 <dd> | |
| 66 vendor ID (only used for deviceType 'generic') | |
| 67 </dd> | |
| 68 <dt><i>pid</i> (int)</dt> | |
| 69 <dd> | |
| 70 product ID (only used for deviceType 'generic') | |
| 71 </dd> | |
| 72 <dt><i>boardName</i> (str (optional))</dt> | |
| 73 <dd> | |
| 74 name of the board (defaults to "") | |
| 75 </dd> | |
| 76 <dt><i>serialNumber</i> (str (optional))</dt> | |
| 77 <dd> | |
| 78 serial number of the board (defaults to "") | |
| 79 </dd> | |
| 80 </dl> | |
| 81 <dl> | |
| 82 <dt>Return:</dt> | |
| 83 <dd> | |
| 84 instantiated device interface | |
| 85 </dd> | |
| 86 </dl> | |
| 87 <dl> | |
| 88 <dt>Return Type:</dt> | |
| 89 <dd> | |
| 90 BaseDevice | |
| 91 </dd> | |
| 92 </dl> | |
| 93 <div align="right"><a href="#top">Up</a></div> | |
| 94 <hr /> | |
| 95 <hr /> | |
| 96 <a NAME="getDeviceIcon" ID="getDeviceIcon"></a> | |
| 97 <h2>getDeviceIcon</h2> | |
| 98 <b>getDeviceIcon</b>(<i>boardName, iconFormat=True</i>) | |
| 99 | |
| 100 <p> | |
| 101 Function to get the icon for the given board. | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>boardName</i> (str)</dt> | |
| 106 <dd> | |
| 107 name of the board | |
| 108 </dd> | |
| 109 <dt><i>iconFormat</i> (bool)</dt> | |
| 110 <dd> | |
| 111 flag indicating to get an icon or a pixmap | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <dl> | |
| 115 <dt>Return:</dt> | |
| 116 <dd> | |
| 117 icon for the board (iconFormat == True) or | |
| 118 a pixmap (iconFormat == False) | |
| 119 </dd> | |
| 120 </dl> | |
| 121 <dl> | |
| 122 <dt>Return Type:</dt> | |
| 123 <dd> | |
| 124 QIcon or QPixmap | |
| 125 </dd> | |
| 126 </dl> | |
| 127 <div align="right"><a href="#top">Up</a></div> | |
| 128 <hr /> | |
| 129 <hr /> | |
| 130 <a NAME="getFoundDevices" ID="getFoundDevices"></a> | |
| 131 <h2>getFoundDevices</h2> | |
| 132 <b>getFoundDevices</b>(<i></i>) | |
| 133 | |
| 134 <p> | |
| 135 Function to check the serial ports for supported MicroPython devices. | |
| 136 </p> | |
| 137 <dl> | |
| 138 <dt>Return:</dt> | |
| 139 <dd> | |
| 140 tuple containing a list of tuples with the board type, the port | |
| 141 description, a description, the serial port it is connected at, the | |
| 142 VID and PID for known device types, a list of tuples with VID, PID | |
| 143 and description for unknown devices and a list of tuples with VID, | |
| 144 PID, description and port name for ports with missing VID or PID | |
| 145 </dd> | |
| 146 </dl> | |
| 147 <dl> | |
| 148 <dt>Return Type:</dt> | |
| 149 <dd> | |
| 150 tuple of (list of tuples of (str, str, str, str, int, int), | |
| 151 list of tuples of (int, int, str), | |
| 152 list of tuples of (int, int, str, str) | |
| 153 </dd> | |
| 154 </dl> | |
| 155 <div align="right"><a href="#top">Up</a></div> | |
| 156 <hr /> | |
| 157 <hr /> | |
| 158 <a NAME="getSupportedDevices" ID="getSupportedDevices"></a> | |
| 159 <h2>getSupportedDevices</h2> | |
| 160 <b>getSupportedDevices</b>(<i></i>) | |
| 161 | |
| 162 <p> | |
| 163 Function to get a list of supported MicroPython devices. | |
| 164 </p> | |
| 165 <dl> | |
| 166 <dt>Return:</dt> | |
| 167 <dd> | |
| 168 set of tuples with the board type and description | |
| 169 </dd> | |
| 170 </dl> | |
| 171 <dl> | |
| 172 <dt>Return Type:</dt> | |
| 173 <dd> | |
| 174 set of tuples of (str, str) | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <div align="right"><a href="#top">Up</a></div> | |
| 178 <hr /> | |
| 179 </body></html> |
