162 <tr> |
162 <tr> |
163 <td><a href="#RP2040Device.hasFlashMenuEntry">hasFlashMenuEntry</a></td> |
163 <td><a href="#RP2040Device.hasFlashMenuEntry">hasFlashMenuEntry</a></td> |
164 <td>Public method to check, if the device has its own flash menu entry.</td> |
164 <td>Public method to check, if the device has its own flash menu entry.</td> |
165 </tr> |
165 </tr> |
166 <tr> |
166 <tr> |
|
167 <td><a href="#RP2040Device.hasNetworkTime">hasNetworkTime</a></td> |
|
168 <td>Public method to check the availability of network time functions.</td> |
|
169 </tr> |
|
170 <tr> |
167 <td><a href="#RP2040Device.hasWifi">hasWifi</a></td> |
171 <td><a href="#RP2040Device.hasWifi">hasWifi</a></td> |
168 <td>Public method to check the availability of WiFi.</td> |
172 <td>Public method to check the availability of WiFi.</td> |
169 </tr> |
173 </tr> |
170 <tr> |
174 <tr> |
171 <td><a href="#RP2040Device.removeCredentials">removeCredentials</a></td> |
175 <td><a href="#RP2040Device.removeCredentials">removeCredentials</a></td> |
180 <td>Public method to scan for available WiFi networks.</td> |
184 <td>Public method to scan for available WiFi networks.</td> |
181 </tr> |
185 </tr> |
182 <tr> |
186 <tr> |
183 <td><a href="#RP2040Device.setButtons">setButtons</a></td> |
187 <td><a href="#RP2040Device.setButtons">setButtons</a></td> |
184 <td>Public method to enable the supported action buttons.</td> |
188 <td>Public method to enable the supported action buttons.</td> |
|
189 </tr> |
|
190 <tr> |
|
191 <td><a href="#RP2040Device.setNetworkTime">setNetworkTime</a></td> |
|
192 <td>Public method to set the time to the network time retrieved from an NTP server.</td> |
185 </tr> |
193 </tr> |
186 <tr> |
194 <tr> |
187 <td><a href="#RP2040Device.startAccessPoint">startAccessPoint</a></td> |
195 <td><a href="#RP2040Device.startAccessPoint">startAccessPoint</a></td> |
188 <td>Public method to start the access point interface.</td> |
196 <td>Public method to start the access point interface.</td> |
189 </tr> |
197 </tr> |
659 <dt>Return Type:</dt> |
667 <dt>Return Type:</dt> |
660 <dd> |
668 <dd> |
661 bool |
669 bool |
662 </dd> |
670 </dd> |
663 </dl> |
671 </dl> |
|
672 <a NAME="RP2040Device.hasNetworkTime" ID="RP2040Device.hasNetworkTime"></a> |
|
673 <h4>RP2040Device.hasNetworkTime</h4> |
|
674 <b>hasNetworkTime</b>(<i></i>) |
|
675 |
|
676 <p> |
|
677 Public method to check the availability of network time functions. |
|
678 </p> |
|
679 <dl> |
|
680 <dt>Return:</dt> |
|
681 <dd> |
|
682 flag indicating the availability of network time functions |
|
683 </dd> |
|
684 </dl> |
|
685 <dl> |
|
686 <dt>Return Type:</dt> |
|
687 <dd> |
|
688 bool |
|
689 </dd> |
|
690 </dl> |
|
691 <dl> |
|
692 |
|
693 <dt>Raises <b>OSError</b>:</dt> |
|
694 <dd> |
|
695 raised to indicate an issue with the device |
|
696 </dd> |
|
697 </dl> |
664 <a NAME="RP2040Device.hasWifi" ID="RP2040Device.hasWifi"></a> |
698 <a NAME="RP2040Device.hasWifi" ID="RP2040Device.hasWifi"></a> |
665 <h4>RP2040Device.hasWifi</h4> |
699 <h4>RP2040Device.hasWifi</h4> |
666 <b>hasWifi</b>(<i></i>) |
700 <b>hasWifi</b>(<i></i>) |
667 |
701 |
668 <p> |
702 <p> |
746 <b>setButtons</b>(<i></i>) |
780 <b>setButtons</b>(<i></i>) |
747 |
781 |
748 <p> |
782 <p> |
749 Public method to enable the supported action buttons. |
783 Public method to enable the supported action buttons. |
750 </p> |
784 </p> |
|
785 <a NAME="RP2040Device.setNetworkTime" ID="RP2040Device.setNetworkTime"></a> |
|
786 <h4>RP2040Device.setNetworkTime</h4> |
|
787 <b>setNetworkTime</b>(<i>server="0.pool.ntp.org", tzOffset=0, timeout=10</i>) |
|
788 |
|
789 <p> |
|
790 Public method to set the time to the network time retrieved from an |
|
791 NTP server. |
|
792 </p> |
|
793 <dl> |
|
794 |
|
795 <dt><i>server</i> (str (optional))</dt> |
|
796 <dd> |
|
797 name of the NTP server to get the network time from |
|
798 (defaults to "0.pool.ntp.org") |
|
799 </dd> |
|
800 <dt><i>tzOffset</i> (int (optional))</dt> |
|
801 <dd> |
|
802 offset with respect to UTC (defaults to 0) |
|
803 </dd> |
|
804 <dt><i>timeout</i> (int)</dt> |
|
805 <dd> |
|
806 maximum time to wait for a server response in seconds |
|
807 (defaults to 10) |
|
808 </dd> |
|
809 </dl> |
|
810 <dl> |
|
811 <dt>Return:</dt> |
|
812 <dd> |
|
813 tuple containing a flag indicating success and an error string |
|
814 </dd> |
|
815 </dl> |
|
816 <dl> |
|
817 <dt>Return Type:</dt> |
|
818 <dd> |
|
819 tuple of (bool, str) |
|
820 </dd> |
|
821 </dl> |
751 <a NAME="RP2040Device.startAccessPoint" ID="RP2040Device.startAccessPoint"></a> |
822 <a NAME="RP2040Device.startAccessPoint" ID="RP2040Device.startAccessPoint"></a> |
752 <h4>RP2040Device.startAccessPoint</h4> |
823 <h4>RP2040Device.startAccessPoint</h4> |
753 <b>startAccessPoint</b>(<i>ssid, security=None, password=None, ifconfig=None</i>) |
824 <b>startAccessPoint</b>(<i>ssid, security=None, password=None, ifconfig=None</i>) |
754 |
825 |
755 <p> |
826 <p> |