Module implementing the device interface class for ESP32 and ESP8266 based boards.
None |
EspDevice | Class implementing the device for ESP32 and ESP8266 based boards. |
createDevice | Function to instantiate a MicroPython device object. |
eraseFlash | Slot to erase the device flash memory. |
flashAddonFirmware | Slot to flash some additional firmware images. |
flashPythonFirmware | Slot to flash a MicroPython firmware to the device. |
Class implementing the device for ESP32 and ESP8266 based boards.
None |
None |
EspDevice | Constructor |
__backupFlash | Private slot to backup the currently flashed firmware. |
__createCpyDevice | Private method to create a CircuitPython device interface. |
__createEsp32Submenu | Private method to create the ESP32 submenu. |
__eraseFlash | Private slot to erase the device flash memory. |
__firmwareVersionResponse | Private slot handling the response of the latest version request. |
__flashAddons | Private slot to flash some additional firmware images. |
__flashMicroPython | Private slot to flash a MicroPython firmware to the device. |
__installEspTool | Private slot to install the esptool package via pip. |
__resetCountry | Private slot to reset the country of the connected ESP32 device. |
__resetDevice | Private slot to reset the connected device. |
__restoreFlash | Private slot to restore a previously saved firmware. |
__setCountry | Private slot to configure the country of the connected ESP32 device. |
__showChipID | Private slot to show the ID of the ESP chip. |
__showFirmwareVersions | Private slot to show the firmware version of the connected device and the available firmware version. |
__showFlashID | Private slot to show the ID of the ESP flash chip. |
__showMACAddress | Private slot to show the MAC address of the ESP chip. |
_getSetTimeCode | Protected method to get the device code to set the time. |
activateBluetoothInterface | Public method to activate the Bluetooth interface. |
addDeviceMenuEntries | Public method to add device specific entries to the given menu. |
addDeviceWifiEntries | Public method to add device specific entries to the given menu. |
canRunScript | Public method to determine, if a script can be executed. |
canStartFileManager | Public method to determine, if a File Manager can be started. |
canStartPlotter | Public method to determine, if a Plotter can be started. |
canStartRepl | Public method to determine, if a REPL can be started. |
checkInternet | Public method to check, if the internet can be reached. |
connectWifi | Public method to connect a device to a WiFi network. |
deactivateBluetoothInterface | Public method to deactivate the Bluetooth interface. |
deactivateInterface | Public method to deactivate a given WiFi interface of the connected device. |
deviceName | Public method to get the name of the device. |
disableWebrepl | Public method to write the given WebREPL password to the connected device and modify the start script to start the WebREPL server. |
disconnectWifi | Public method to disconnect a device from the WiFi network. |
enableWebrepl | Public method to write the given WebREPL password to the connected device and modify the start script to start the WebREPL server. |
forceInterrupt | Public method to determine the need for an interrupt when opening the serial connection. |
getBluetoothStatus | Public method to get Bluetooth status data of the connected board. |
getConnectedClients | Public method to get a list of connected clients. |
getDeviceScan | Public method to perform a Bluetooth device scan. |
getDocumentationUrl | Public method to get the device documentation URL. |
getFirmwareUrl | Public method to get the device firmware download URL. |
getWifiData | Public method to get data related to the current WiFi status. |
hasBluetooth | Public method to check the availability of Bluetooth. |
hasFlashMenuEntry | Public method to check, if the device has its own flash menu entry. |
hasNetworkTime | Public method to check the availability of network time functions. |
hasWifi | Public method to check the availability of WiFi. |
hasWifiCountry | Public method to check, if the device has support to set the WiFi country. |
isWifiApConnected | Public method to check the WiFi connection status as access point. |
isWifiClientConnected | Public method to check the WiFi connection status as client. |
removeCredentials | Public method to remove the saved credentials from the connected device. |
runScript | Public method to run the given Python script. |
scanNetworks | Public method to scan for available WiFi networks. |
setButtons | Public method to enable the supported action buttons. |
setConnected | Public method to set the connection state. |
setNetworkTime | Public method to set the time to the network time retrieved from an NTP server. |
startAccessPoint | Public method to start the access point interface. |
stopAccessPoint | Public method to stop the access point interface. |
writeCredentials | Public method to write the given credentials to the connected device and modify the start script to connect automatically. |
None |
Constructor
Private slot to backup the currently flashed firmware.
Private method to create a CircuitPython device interface.
Private method to create the ESP32 submenu.
Private slot to erase the device flash memory.
Private slot handling the response of the latest version request.
Private slot to flash some additional firmware images.
Private slot to flash a MicroPython firmware to the device.
Private slot to install the esptool package via pip.
Private slot to reset the country of the connected ESP32 device.
The country is the two-letter ISO 3166-1 Alpha-2 country code. This method resets it to the default code 'XX' representing the "worldwide" region.
Private slot to reset the connected device.
Private slot to restore a previously saved firmware.
Private slot to configure the country of the connected ESP32 device.
The country is the two-letter ISO 3166-1 Alpha-2 country code.
Private slot to show the ID of the ESP chip.
Private slot to show the firmware version of the connected device and the available firmware version.
Private slot to show the ID of the ESP flash chip.
Private slot to show the MAC address of the ESP chip.
Protected method to get the device code to set the time.
Note: This method must be implemented in the various device specific subclasses.
Public method to activate the Bluetooth interface.
Public method to add device specific entries to the given menu.
Public method to add device specific entries to the given menu.
Public method to determine, if a script can be executed.
Public method to determine, if a File Manager can be started.
Public method to determine, if a Plotter can be started.
Public method to determine, if a REPL can be started.
Public method to check, if the internet can be reached.
Public method to connect a device to a WiFi network.
Public method to deactivate the Bluetooth interface.
Public method to deactivate a given WiFi interface of the connected device.
Public method to get the name of the device.
Public method to write the given WebREPL password to the connected device and modify the start script to start the WebREPL server.
Public method to disconnect a device from the WiFi network.
Public method to write the given WebREPL password to the connected device and modify the start script to start the WebREPL server.
Public method to determine the need for an interrupt when opening the serial connection.
Public method to get Bluetooth status data of the connected board.
Public method to get a list of connected clients.
Public method to perform a Bluetooth device scan.
Public method to get the device documentation URL.
Public method to get the device firmware download URL.
Public method to get data related to the current WiFi status.
Public method to check the availability of Bluetooth.
Public method to check, if the device has its own flash menu entry.
Public method to check the availability of network time functions.
Public method to check the availability of WiFi.
Public method to check, if the device has support to set the WiFi country.
Public method to check the WiFi connection status as access point.
Public method to check the WiFi connection status as client.
Public method to remove the saved credentials from the connected device.
Public method to run the given Python script.
Public method to scan for available WiFi networks.
Public method to enable the supported action buttons.
Public method to set the connection state.
Note: This method can be overwritten to perform actions upon connect or disconnect of the device.
Public method to set the time to the network time retrieved from an NTP server.
Public method to start the access point interface.
Public method to stop the access point interface.
Public method to write the given credentials to the connected device and modify the start script to connect automatically.
Function to instantiate a MicroPython device object.
Slot to erase the device flash memory.
Slot to flash some additional firmware images.
Slot to flash a MicroPython firmware to the device.