src/eric7/Documentation/Source/eric7.MicroPython.Devices.__init__.html

branch
eric7
changeset 10479
856476537696
parent 9756
9854647c8c5c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MicroPython.Devices.__init__</h1> 9 <h1>eric7.MicroPython.Devices.__init__</h1>
10
11 <p> 10 <p>
12 Package containing the device interface modules and device specific dialogs. 11 Package containing the device interface modules and device specific dialogs.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>FirmwareGithubUrls</td></tr>
17 <tr><td>IgnoredBoards</td></tr>
18 <tr><td>SupportedBoards</td></tr>
19 </table>
15 20
16 <table>
17 <tr><td>FirmwareGithubUrls</td></tr><tr><td>IgnoredBoards</td></tr><tr><td>SupportedBoards</td></tr>
18 </table>
19 <h3>Classes</h3> 21 <h3>Classes</h3>
20
21 <table> 22 <table>
22 <tr><td>None</td></tr> 23 <tr><td>None</td></tr>
23 </table> 24 </table>
25
24 <h3>Functions</h3> 26 <h3>Functions</h3>
25
26 <table> 27 <table>
27
28 <tr> 28 <tr>
29 <td><a href="#getDevice">getDevice</a></td> 29 <td><a href="#getDevice">getDevice</a></td>
30 <td>Public method to instantiate a specific MicroPython device interface.</td> 30 <td>Public method to instantiate a specific MicroPython device interface.</td>
31 </tr> 31 </tr>
32 <tr> 32 <tr>
40 <tr> 40 <tr>
41 <td><a href="#getSupportedDevices">getSupportedDevices</a></td> 41 <td><a href="#getSupportedDevices">getSupportedDevices</a></td>
42 <td>Function to get a list of supported MicroPython devices.</td> 42 <td>Function to get a list of supported MicroPython devices.</td>
43 </tr> 43 </tr>
44 </table> 44 </table>
45
45 <hr /> 46 <hr />
46 <hr /> 47 <hr />
47 <a NAME="getDevice" ID="getDevice"></a> 48 <a NAME="getDevice" ID="getDevice"></a>
48 <h2>getDevice</h2> 49 <h2>getDevice</h2>
49 <b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid, boardName="", serialNumber=""</i>) 50 <b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid, boardName="", serialNumber=""</i>)
50
51 <p> 51 <p>
52 Public method to instantiate a specific MicroPython device interface. 52 Public method to instantiate a specific MicroPython device interface.
53 </p> 53 </p>
54
54 <dl> 55 <dl>
55 56
56 <dt><i>deviceType</i> (str)</dt> 57 <dt><i>deviceType</i> (str)</dt>
57 <dd> 58 <dd>
58 type of the device interface 59 type of the device interface
94 <hr /> 95 <hr />
95 <hr /> 96 <hr />
96 <a NAME="getDeviceIcon" ID="getDeviceIcon"></a> 97 <a NAME="getDeviceIcon" ID="getDeviceIcon"></a>
97 <h2>getDeviceIcon</h2> 98 <h2>getDeviceIcon</h2>
98 <b>getDeviceIcon</b>(<i>boardName, iconFormat=True</i>) 99 <b>getDeviceIcon</b>(<i>boardName, iconFormat=True</i>)
99
100 <p> 100 <p>
101 Function to get the icon for the given board. 101 Function to get the icon for the given board.
102 </p> 102 </p>
103
103 <dl> 104 <dl>
104 105
105 <dt><i>boardName</i> (str)</dt> 106 <dt><i>boardName</i> (str)</dt>
106 <dd> 107 <dd>
107 name of the board 108 name of the board
128 <hr /> 129 <hr />
129 <hr /> 130 <hr />
130 <a NAME="getFoundDevices" ID="getFoundDevices"></a> 131 <a NAME="getFoundDevices" ID="getFoundDevices"></a>
131 <h2>getFoundDevices</h2> 132 <h2>getFoundDevices</h2>
132 <b>getFoundDevices</b>(<i></i>) 133 <b>getFoundDevices</b>(<i></i>)
133
134 <p> 134 <p>
135 Function to check the serial ports for supported MicroPython devices. 135 Function to check the serial ports for supported MicroPython devices.
136 </p> 136 </p>
137
137 <dl> 138 <dl>
138 <dt>Return:</dt> 139 <dt>Return:</dt>
139 <dd> 140 <dd>
140 tuple containing a list of tuples with the board type, the port 141 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 description, a description, the serial port it is connected at, the
156 <hr /> 157 <hr />
157 <hr /> 158 <hr />
158 <a NAME="getSupportedDevices" ID="getSupportedDevices"></a> 159 <a NAME="getSupportedDevices" ID="getSupportedDevices"></a>
159 <h2>getSupportedDevices</h2> 160 <h2>getSupportedDevices</h2>
160 <b>getSupportedDevices</b>(<i></i>) 161 <b>getSupportedDevices</b>(<i></i>)
161
162 <p> 162 <p>
163 Function to get a list of supported MicroPython devices. 163 Function to get a list of supported MicroPython devices.
164 </p> 164 </p>
165
165 <dl> 166 <dl>
166 <dt>Return:</dt> 167 <dt>Return:</dt>
167 <dd> 168 <dd>
168 set of tuples with the board type and description 169 set of tuples with the board type and description
169 </dd> 170 </dd>

eric ide

mercurial