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

branch
mpy_network
changeset 9871
4a302b8c4d28
parent 9866
0cf5dda5512f
child 9891
e58c3fadcacc
equal deleted inserted replaced
9870:0399d3607829 9871:4a302b8c4d28
209 <tr> 209 <tr>
210 <td><a href="#CircuitPythonDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> 210 <td><a href="#CircuitPythonDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td>
211 <td>Public method to check, if the device has its own flash menu entry.</td> 211 <td>Public method to check, if the device has its own flash menu entry.</td>
212 </tr> 212 </tr>
213 <tr> 213 <tr>
214 <td><a href="#CircuitPythonDevice.hasNetworkTime">hasNetworkTime</a></td>
215 <td>Public method to check the availability of network time functions.</td>
216 </tr>
217 <tr>
214 <td><a href="#CircuitPythonDevice.hasWifi">hasWifi</a></td> 218 <td><a href="#CircuitPythonDevice.hasWifi">hasWifi</a></td>
215 <td>Public method to check the availability of WiFi.</td> 219 <td>Public method to check the availability of WiFi.</td>
216 </tr> 220 </tr>
217 <tr> 221 <tr>
218 <td><a href="#CircuitPythonDevice.removeCredentials">removeCredentials</a></td> 222 <td><a href="#CircuitPythonDevice.removeCredentials">removeCredentials</a></td>
231 <td>Public method to enable the supported action buttons.</td> 235 <td>Public method to enable the supported action buttons.</td>
232 </tr> 236 </tr>
233 <tr> 237 <tr>
234 <td><a href="#CircuitPythonDevice.setConnected">setConnected</a></td> 238 <td><a href="#CircuitPythonDevice.setConnected">setConnected</a></td>
235 <td>Public method to set the connection state.</td> 239 <td>Public method to set the connection state.</td>
240 </tr>
241 <tr>
242 <td><a href="#CircuitPythonDevice.setNetworkTime">setNetworkTime</a></td>
243 <td>Public method to set the time to the network time retrieved from an NTP server.</td>
236 </tr> 244 </tr>
237 <tr> 245 <tr>
238 <td><a href="#CircuitPythonDevice.showCircuitPythonVersions">showCircuitPythonVersions</a></td> 246 <td><a href="#CircuitPythonDevice.showCircuitPythonVersions">showCircuitPythonVersions</a></td>
239 <td>Public slot to show the CircuitPython version of a connected device and the latest available one (from Github).</td> 247 <td>Public slot to show the CircuitPython version of a connected device and the latest available one (from Github).</td>
240 </tr> 248 </tr>
981 <dt>Return Type:</dt> 989 <dt>Return Type:</dt>
982 <dd> 990 <dd>
983 bool 991 bool
984 </dd> 992 </dd>
985 </dl> 993 </dl>
994 <a NAME="CircuitPythonDevice.hasNetworkTime" ID="CircuitPythonDevice.hasNetworkTime"></a>
995 <h4>CircuitPythonDevice.hasNetworkTime</h4>
996 <b>hasNetworkTime</b>(<i></i>)
997
998 <p>
999 Public method to check the availability of network time functions.
1000 </p>
1001 <dl>
1002 <dt>Return:</dt>
1003 <dd>
1004 flag indicating the availability of network time functions
1005 </dd>
1006 </dl>
1007 <dl>
1008 <dt>Return Type:</dt>
1009 <dd>
1010 bool
1011 </dd>
1012 </dl>
1013 <dl>
1014
1015 <dt>Raises <b>OSError</b>:</dt>
1016 <dd>
1017 raised to indicate an issue with the device
1018 </dd>
1019 </dl>
986 <a NAME="CircuitPythonDevice.hasWifi" ID="CircuitPythonDevice.hasWifi"></a> 1020 <a NAME="CircuitPythonDevice.hasWifi" ID="CircuitPythonDevice.hasWifi"></a>
987 <h4>CircuitPythonDevice.hasWifi</h4> 1021 <h4>CircuitPythonDevice.hasWifi</h4>
988 <b>hasWifi</b>(<i></i>) 1022 <b>hasWifi</b>(<i></i>)
989 1023
990 <p> 1024 <p>
1080 <dl> 1114 <dl>
1081 1115
1082 <dt><i>connected</i> (bool)</dt> 1116 <dt><i>connected</i> (bool)</dt>
1083 <dd> 1117 <dd>
1084 connection state 1118 connection state
1119 </dd>
1120 </dl>
1121 <a NAME="CircuitPythonDevice.setNetworkTime" ID="CircuitPythonDevice.setNetworkTime"></a>
1122 <h4>CircuitPythonDevice.setNetworkTime</h4>
1123 <b>setNetworkTime</b>(<i>server="0.pool.ntp.org", tzOffset=0, timeout=10</i>)
1124
1125 <p>
1126 Public method to set the time to the network time retrieved from an
1127 NTP server.
1128 </p>
1129 <dl>
1130
1131 <dt><i>server</i> (str (optional))</dt>
1132 <dd>
1133 name of the NTP server to get the network time from
1134 (defaults to "0.pool.ntp.org")
1135 </dd>
1136 <dt><i>tzOffset</i> (int (optional))</dt>
1137 <dd>
1138 offset with respect to UTC (defaults to 0)
1139 </dd>
1140 <dt><i>timeout</i> (int)</dt>
1141 <dd>
1142 maximum time to wait for a server response in seconds
1143 (defaults to 10)
1144 </dd>
1145 </dl>
1146 <dl>
1147 <dt>Return:</dt>
1148 <dd>
1149 tuple containing a flag indicating success and an error string
1150 </dd>
1151 </dl>
1152 <dl>
1153 <dt>Return Type:</dt>
1154 <dd>
1155 tuple of (bool, str)
1085 </dd> 1156 </dd>
1086 </dl> 1157 </dl>
1087 <a NAME="CircuitPythonDevice.showCircuitPythonVersions" ID="CircuitPythonDevice.showCircuitPythonVersions"></a> 1158 <a NAME="CircuitPythonDevice.showCircuitPythonVersions" ID="CircuitPythonDevice.showCircuitPythonVersions"></a>
1088 <h4>CircuitPythonDevice.showCircuitPythonVersions</h4> 1159 <h4>CircuitPythonDevice.showCircuitPythonVersions</h4>
1089 <b>showCircuitPythonVersions</b>(<i></i>) 1160 <b>showCircuitPythonVersions</b>(<i></i>)

eric ide

mercurial