eric6.MicroPython.CircuitPythonDevices

Module implementing the device interface class for CircuitPython boards.

Global Attributes

None

Classes

CircuitPythonDevice

Class implementing the device for CircuitPython boards.

Functions

None

CircuitPythonDevice

Class implementing the device for CircuitPython boards.

Derived from

MicroPythonDevice

Class Attributes

DeviceVolumeName

Class Methods

None

Methods

CircuitPythonDevice	Constructor
__deviceVolumeMounted	Private method to check, if the device volume is mounted.
__flashCircuitPython	Private slot to flash a CircuitPython firmware to the device.
__installLibraryFiles	Private slot to install Python files into the onboard library.
addDeviceMenuEntries	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.
deviceName	Public method to get the name of the device.
forceInterrupt	Public method to determine the need for an interrupt when opening the serial connection.
getDocumentationUrl	Public method to get the device documentation URL.
getFirmwareUrl	Public method to get the device firmware download URL.
getWorkspace	Public method to get the workspace directory.
runScript	Public method to run the given Python script.
setButtons	Public method to enable the supported action buttons.
supportsLocalFileAccess	Public method to indicate file access via a local directory.

Static Methods

None

CircuitPythonDevice (Constructor)

CircuitPythonDevice(microPythonWidget, parent=None)

Constructor

microPythonWidget (MicroPythonWidget): reference to the main MicroPython widget
parent (QObject): reference to the parent object

CircuitPythonDevice.__deviceVolumeMounted

__deviceVolumeMounted()

Private method to check, if the device volume is mounted.

Returns:: flag indicated a mounted device

Return Type:: bool

CircuitPythonDevice.__flashCircuitPython

__flashCircuitPython()

Private slot to flash a CircuitPython firmware to the device.

CircuitPythonDevice.__installLibraryFiles

__installLibraryFiles()

Private slot to install Python files into the onboard library.

CircuitPythonDevice.addDeviceMenuEntries

addDeviceMenuEntries(menu)

Public method to add device specific entries to the given menu.

menu (QMenu): reference to the context menu

CircuitPythonDevice.canRunScript

canRunScript()

Public method to determine, if a script can be executed.

Returns:: tuple containing a flag indicating it is safe to start a Plotter and a reason why it cannot.

Return Type:: tuple of (bool, str)

CircuitPythonDevice.canStartFileManager

canStartFileManager()

Public method to determine, if a File Manager can be started.

Returns:: tuple containing a flag indicating it is safe to start a File Manager and a reason why it cannot.

Return Type:: tuple of (bool, str)

CircuitPythonDevice.canStartPlotter

canStartPlotter()

Public method to determine, if a Plotter can be started.

Returns:: tuple containing a flag indicating it is safe to start a Plotter and a reason why it cannot.

Return Type:: tuple of (bool, str)

CircuitPythonDevice.canStartRepl

canStartRepl()

Public method to determine, if a REPL can be started.

Returns:: tuple containing a flag indicating it is safe to start a REPL and a reason why it cannot.

Return Type:: tuple of (bool, str)

CircuitPythonDevice.deviceName

deviceName()

Public method to get the name of the device.

Returns:: name of the device

Return Type:: str

CircuitPythonDevice.forceInterrupt

forceInterrupt()

Public method to determine the need for an interrupt when opening the serial connection.

Returns:: flag indicating an interrupt is needed

Return Type:: bool

CircuitPythonDevice.getDocumentationUrl

getDocumentationUrl()

Public method to get the device documentation URL.

Returns:: documentation URL of the device

Return Type:: str

CircuitPythonDevice.getFirmwareUrl

getFirmwareUrl()

Public method to get the device firmware download URL.

Returns:: firmware download URL of the device

Return Type:: str

CircuitPythonDevice.getWorkspace

getWorkspace(silent=False)

Public method to get the workspace directory.

silent (bool): flag indicating silent operations

Returns:: workspace directory used for saving files

Return Type:: str

CircuitPythonDevice.runScript

runScript(script)

Public method to run the given Python script.

script (str): script to be executed

CircuitPythonDevice.setButtons

setButtons()

Public method to enable the supported action buttons.

CircuitPythonDevice.supportsLocalFileAccess

supportsLocalFileAccess()

Public method to indicate file access via a local directory.

Returns:: flag indicating file access via local directory

Return Type:: bool

Home ⌂Doc Index ◂Up ▴