--- a/src/eric7/MicroPython/EspDevices.py Wed Jul 13 11:16:20 2022 +0200
+++ b/src/eric7/MicroPython/EspDevices.py Wed Jul 13 14:55:47 2022 +0200
@@ -26,10 +26,11 @@
"""
Class implementing the device for ESP32 and ESP8266 based boards.
"""
+
def __init__(self, microPythonWidget, deviceType, parent=None):
"""
Constructor
-
+
@param microPythonWidget reference to the main MicroPython widget
@type MicroPythonWidget
@param deviceType device type assigned to this device interface
@@ -38,134 +39,129 @@
@type QObject
"""
super().__init__(microPythonWidget, deviceType, parent)
-
+
def setButtons(self):
"""
Public method to enable the supported action buttons.
"""
super().setButtons()
self.microPython.setActionButtons(
- run=True, repl=True, files=True, chart=HAS_QTCHART)
-
+ run=True, repl=True, files=True, chart=HAS_QTCHART
+ )
+
def forceInterrupt(self):
"""
Public method to determine the need for an interrupt when opening the
serial connection.
-
+
@return flag indicating an interrupt is needed
@rtype bool
"""
return True
-
+
def deviceName(self):
"""
Public method to get the name of the device.
-
+
@return name of the device
@rtype str
"""
return self.tr("ESP8266, ESP32")
-
+
def canStartRepl(self):
"""
Public method to determine, if a REPL can be started.
-
+
@return tuple containing a flag indicating it is safe to start a REPL
and a reason why it cannot.
@rtype tuple of (bool, str)
"""
return True, ""
-
+
def canStartPlotter(self):
"""
Public method to determine, if a Plotter can be started.
-
+
@return tuple containing a flag indicating it is safe to start a
Plotter and a reason why it cannot.
@rtype tuple of (bool, str)
"""
return True, ""
-
+
def canRunScript(self):
"""
Public method to determine, if a script can be executed.
-
+
@return tuple containing a flag indicating it is safe to start a
Plotter and a reason why it cannot.
@rtype tuple of (bool, str)
"""
return True, ""
-
+
def runScript(self, script):
"""
Public method to run the given Python script.
-
+
@param script script to be executed
@type str
"""
pythonScript = script.split("\n")
self.sendCommands(pythonScript)
-
+
def canStartFileManager(self):
"""
Public method to determine, if a File Manager can be started.
-
+
@return tuple containing a flag indicating it is safe to start a
File Manager and a reason why it cannot.
@rtype tuple of (bool, str)
"""
return True, ""
-
+
def addDeviceMenuEntries(self, menu):
"""
Public method to add device specific entries to the given menu.
-
+
@param menu reference to the context menu
@type QMenu
"""
connected = self.microPython.isConnected()
-
- act = menu.addAction(self.tr("Erase Flash"),
- self.__eraseFlash)
+
+ act = menu.addAction(self.tr("Erase Flash"), self.__eraseFlash)
act.setEnabled(not connected)
- act = menu.addAction(self.tr("Flash MicroPython Firmware"),
- self.__flashMicroPython)
+ act = menu.addAction(
+ self.tr("Flash MicroPython Firmware"), self.__flashMicroPython
+ )
act.setEnabled(not connected)
menu.addSeparator()
- act = menu.addAction(self.tr("Flash Additional Firmware"),
- self.__flashAddons)
+ act = menu.addAction(self.tr("Flash Additional Firmware"), self.__flashAddons)
act.setEnabled(not connected)
menu.addSeparator()
- act = menu.addAction(self.tr("Backup Firmware"),
- self.__backupFlash)
+ act = menu.addAction(self.tr("Backup Firmware"), self.__backupFlash)
act.setEnabled(not connected)
- act = menu.addAction(self.tr("Restore Firmware"),
- self.__restoreFlash)
+ act = menu.addAction(self.tr("Restore Firmware"), self.__restoreFlash)
act.setEnabled(not connected)
menu.addSeparator()
- act = menu.addAction(self.tr("Show Chip ID"),
- self.__showChipID)
+ act = menu.addAction(self.tr("Show Chip ID"), self.__showChipID)
act.setEnabled(not connected)
- act = menu.addAction(self.tr("Show Flash ID"),
- self.__showFlashID)
+ act = menu.addAction(self.tr("Show Flash ID"), self.__showFlashID)
act.setEnabled(not connected)
- act = menu.addAction(self.tr("Show MAC Address"),
- self.__showMACAddress)
+ act = menu.addAction(self.tr("Show MAC Address"), self.__showMACAddress)
act.setEnabled(not connected)
menu.addSeparator()
act = menu.addAction(self.tr("Reset Device"), self.__resetDevice)
menu.addSeparator()
menu.addAction(self.tr("Install 'esptool.py'"), self.__installEspTool)
-
+
def hasFlashMenuEntry(self):
"""
Public method to check, if the device has its own flash menu entry.
-
+
@return flag indicating a specific flash menu entry
@rtype bool
"""
return True
-
+
@pyqtSlot()
def __eraseFlash(self):
"""
@@ -174,158 +170,187 @@
ok = EricMessageBox.yesNo(
self.microPython,
self.tr("Erase Flash"),
- self.tr("""Shall the flash of the selected device really be"""
- """ erased?"""))
+ self.tr(
+ """Shall the flash of the selected device really be""" """ erased?"""
+ ),
+ )
if ok:
flashArgs = [
"-u",
- "-m", "esptool",
- "--port", self.microPython.getCurrentPort(),
+ "-m",
+ "esptool",
+ "--port",
+ self.microPython.getCurrentPort(),
"erase_flash",
]
- dlg = EricProcessDialog(self.tr("'esptool erase_flash' Output"),
- self.tr("Erase Flash"),
- showProgress=True)
+ dlg = EricProcessDialog(
+ self.tr("'esptool erase_flash' Output"),
+ self.tr("Erase Flash"),
+ showProgress=True,
+ )
res = dlg.startProcess(Globals.getPythonExecutable(), flashArgs)
if res:
dlg.exec()
-
+
@pyqtSlot()
def __flashMicroPython(self):
"""
Private slot to flash a MicroPython firmware to the device.
"""
from .EspFirmwareSelectionDialog import EspFirmwareSelectionDialog
+
dlg = EspFirmwareSelectionDialog()
if dlg.exec() == QDialog.DialogCode.Accepted:
chip, firmware, baudRate, flashMode, flashAddress = dlg.getData()
flashArgs = [
"-u",
- "-m", "esptool",
- "--chip", chip,
- "--port", self.microPython.getCurrentPort(),
+ "-m",
+ "esptool",
+ "--chip",
+ chip,
+ "--port",
+ self.microPython.getCurrentPort(),
]
if baudRate != "115200":
- flashArgs += [
- "--baud", baudRate
- ]
+ flashArgs += ["--baud", baudRate]
flashArgs.append("write_flash")
if flashMode:
- flashArgs += [
- "--flash_mode", flashMode
- ]
+ flashArgs += ["--flash_mode", flashMode]
flashArgs += [
flashAddress,
firmware,
]
- dlg = EricProcessDialog(self.tr("'esptool write_flash' Output"),
- self.tr("Flash MicroPython Firmware"),
- showProgress=True)
+ dlg = EricProcessDialog(
+ self.tr("'esptool write_flash' Output"),
+ self.tr("Flash MicroPython Firmware"),
+ showProgress=True,
+ )
res = dlg.startProcess(Globals.getPythonExecutable(), flashArgs)
if res:
dlg.exec()
-
+
@pyqtSlot()
def __flashAddons(self):
"""
Private slot to flash some additional firmware images.
"""
from .EspFirmwareSelectionDialog import EspFirmwareSelectionDialog
+
dlg = EspFirmwareSelectionDialog(addon=True)
if dlg.exec() == QDialog.DialogCode.Accepted:
chip, firmware, baudRate, flashMode, flashAddress = dlg.getData()
flashArgs = [
"-u",
- "-m", "esptool",
- "--chip", chip,
- "--port", self.microPython.getCurrentPort(),
+ "-m",
+ "esptool",
+ "--chip",
+ chip,
+ "--port",
+ self.microPython.getCurrentPort(),
]
if baudRate != "115200":
- flashArgs += [
- "--baud", baudRate
- ]
+ flashArgs += ["--baud", baudRate]
flashArgs.append("write_flash")
if flashMode:
- flashArgs += [
- "--flash_mode", flashMode
- ]
+ flashArgs += ["--flash_mode", flashMode]
flashArgs += [
flashAddress.lower(),
firmware,
]
- dlg = EricProcessDialog(self.tr("'esptool write_flash' Output"),
- self.tr("Flash Additional Firmware"),
- showProgress=True)
+ dlg = EricProcessDialog(
+ self.tr("'esptool write_flash' Output"),
+ self.tr("Flash Additional Firmware"),
+ showProgress=True,
+ )
res = dlg.startProcess(Globals.getPythonExecutable(), flashArgs)
if res:
dlg.exec()
-
+
@pyqtSlot()
def __backupFlash(self):
"""
Private slot to backup the currently flashed firmware.
"""
- from .EspBackupRestoreFirmwareDialog import (
- EspBackupRestoreFirmwareDialog
- )
+ from .EspBackupRestoreFirmwareDialog import EspBackupRestoreFirmwareDialog
+
dlg = EspBackupRestoreFirmwareDialog(backupMode=True)
if dlg.exec() == QDialog.DialogCode.Accepted:
chip, flashSize, baudRate, flashMode, firmware = dlg.getData()
flashArgs = [
"-u",
- "-m", "esptool",
- "--chip", chip,
- "--port", self.microPython.getCurrentPort(),
- "--baud", baudRate,
+ "-m",
+ "esptool",
+ "--chip",
+ chip,
+ "--port",
+ self.microPython.getCurrentPort(),
+ "--baud",
+ baudRate,
"read_flash",
- "0x0", flashSize,
+ "0x0",
+ flashSize,
firmware,
]
- dlg = EricProcessDialog(self.tr("'esptool read_flash' Output"),
- self.tr("Backup Firmware"),
- showProgress=True)
+ dlg = EricProcessDialog(
+ self.tr("'esptool read_flash' Output"),
+ self.tr("Backup Firmware"),
+ showProgress=True,
+ )
res = dlg.startProcess(Globals.getPythonExecutable(), flashArgs)
if res:
dlg.exec()
-
+
@pyqtSlot()
def __restoreFlash(self):
"""
Private slot to restore a previously saved firmware.
"""
- from .EspBackupRestoreFirmwareDialog import (
- EspBackupRestoreFirmwareDialog
- )
+ from .EspBackupRestoreFirmwareDialog import EspBackupRestoreFirmwareDialog
+
dlg = EspBackupRestoreFirmwareDialog(backupMode=False)
if dlg.exec() == QDialog.DialogCode.Accepted:
chip, flashSize, baudRate, flashMode, firmware = dlg.getData()
flashArgs = [
"-u",
- "-m", "esptool",
- "--chip", chip,
- "--port", self.microPython.getCurrentPort(),
- "--baud", baudRate,
+ "-m",
+ "esptool",
+ "--chip",
+ chip,
+ "--port",
+ self.microPython.getCurrentPort(),
+ "--baud",
+ baudRate,
"write_flash",
]
if flashMode:
- flashArgs.extend([
- "--flash_mode", flashMode,
- ])
+ flashArgs.extend(
+ [
+ "--flash_mode",
+ flashMode,
+ ]
+ )
if bool(flashSize):
- flashArgs.extend([
- "--flash_size", flashSize,
- ])
- flashArgs.extend([
- "0x0",
- firmware,
- ])
- dlg = EricProcessDialog(self.tr("'esptool write_flash' Output"),
- self.tr("Restore Firmware"),
- showProgress=True)
+ flashArgs.extend(
+ [
+ "--flash_size",
+ flashSize,
+ ]
+ )
+ flashArgs.extend(
+ [
+ "0x0",
+ firmware,
+ ]
+ )
+ dlg = EricProcessDialog(
+ self.tr("'esptool write_flash' Output"),
+ self.tr("Restore Firmware"),
+ showProgress=True,
+ )
res = dlg.startProcess(Globals.getPythonExecutable(), flashArgs)
if res:
dlg.exec()
-
+
@pyqtSlot()
def __showChipID(self):
"""
@@ -333,16 +358,19 @@
"""
args = [
"-u",
- "-m", "esptool",
- "--port", self.microPython.getCurrentPort(),
- "chip_id"
+ "-m",
+ "esptool",
+ "--port",
+ self.microPython.getCurrentPort(),
+ "chip_id",
]
- dlg = EricProcessDialog(self.tr("'esptool chip_id' Output"),
- self.tr("Show Chip ID"))
+ dlg = EricProcessDialog(
+ self.tr("'esptool chip_id' Output"), self.tr("Show Chip ID")
+ )
res = dlg.startProcess(Globals.getPythonExecutable(), args)
if res:
dlg.exec()
-
+
@pyqtSlot()
def __showFlashID(self):
"""
@@ -350,16 +378,19 @@
"""
args = [
"-u",
- "-m", "esptool",
- "--port", self.microPython.getCurrentPort(),
- "flash_id"
+ "-m",
+ "esptool",
+ "--port",
+ self.microPython.getCurrentPort(),
+ "flash_id",
]
- dlg = EricProcessDialog(self.tr("'esptool flash_id' Output"),
- self.tr("Show Flash ID"))
+ dlg = EricProcessDialog(
+ self.tr("'esptool flash_id' Output"), self.tr("Show Flash ID")
+ )
res = dlg.startProcess(Globals.getPythonExecutable(), args)
if res:
dlg.exec()
-
+
@pyqtSlot()
def __showMACAddress(self):
"""
@@ -367,63 +398,69 @@
"""
args = [
"-u",
- "-m", "esptool",
- "--port", self.microPython.getCurrentPort(),
- "read_mac"
+ "-m",
+ "esptool",
+ "--port",
+ self.microPython.getCurrentPort(),
+ "read_mac",
]
- dlg = EricProcessDialog(self.tr("'esptool read_mac' Output"),
- self.tr("Show MAC Address"))
+ dlg = EricProcessDialog(
+ self.tr("'esptool read_mac' Output"), self.tr("Show MAC Address")
+ )
res = dlg.startProcess(Globals.getPythonExecutable(), args)
if res:
dlg.exec()
-
+
@pyqtSlot()
def __resetDevice(self):
"""
Private slot to reset the connected device.
"""
if self.microPython.isConnected():
- self.microPython.commandsInterface().execute([
- "import machine",
- "machine.reset()",
- ])
+ self.microPython.commandsInterface().execute(
+ [
+ "import machine",
+ "machine.reset()",
+ ]
+ )
else:
# perform a reset via esptool using flash_id command ignoring
# the output
args = [
"-u",
- "-m", "esptool",
- "--port", self.microPython.getCurrentPort(),
- "flash_id"
+ "-m",
+ "esptool",
+ "--port",
+ self.microPython.getCurrentPort(),
+ "flash_id",
]
proc = QProcess()
proc.start(Globals.getPythonExecutable(), args)
procStarted = proc.waitForStarted(10000)
if procStarted:
proc.waitForFinished(10000)
-
+
@pyqtSlot()
def __installEspTool(self):
"""
Private slot to install the esptool package via pip.
"""
pip = ericApp().getObject("Pip")
- pip.installPackages(["esptool"],
- interpreter=Globals.getPythonExecutable())
-
+ pip.installPackages(["esptool"], interpreter=Globals.getPythonExecutable())
+
def getDocumentationUrl(self):
"""
Public method to get the device documentation URL.
-
+
@return documentation URL of the device
@rtype str
"""
return Preferences.getMicroPython("MicroPythonDocuUrl")
-
+
def getFirmwareUrl(self):
"""
Public method to get the device firmware download URL.
-
+
@return firmware download URL of the device
@rtype str
"""
