Module implementing the device interface class for CircuitPython boards.
None |
CircuitPythonDevice | Class implementing the device for CircuitPython boards. |
createDevice | Function to instantiate a MicroPython device object. |
Class implementing the device for CircuitPython boards.
DeviceVolumeName |
None |
CircuitPythonDevice | Constructor |
__aboutToShowLibraryMenu | Private slot to populate the 'Library Management' menu. |
__activateBootloader | Private slot to switch the board into 'bootloader' mode. |
__activateUF2Boot | Private slot to switch the board into 'UF2 Boot' mode. |
__cpyVersionResponse | Private slot handling the response of the latest version request. |
__createCPyMenu | Private method to create the CircuitPython submenu. |
__createFlashMenus | Private method to create the various menus to flash a CircuitPython firmware. |
__deviceVolumeMounted | Private method to check, if the device volume is mounted. |
__esp32EraseFlash | Private slot to erase the flash of an ESP32 device. |
__esp32FlashAddons | Private slot to flash additional firmware to an ESP32 device. |
__esp32FlashPython | Private slot to flash a MicroPython or CircuitPython firmware to an ESP32 device. |
__findDeviceDirectories | Private method to find the device directories associated with the current board name. |
__findWorkspace | Private method to find the workspace directory. |
__flashCircuitPython | Private slot to flash a CircuitPython firmware to a device supporting UF2. |
__installLibraryFiles | Private slot to install Python files into the onboard library. |
__modifySettings | Private method to modify the 'settings.toml' file as of CircuitPython 8.0.0. |
__resetDevice | Private slot to reset the connected device. |
__selectDeviceVolume | Private slot to select the mounted device volume, if it could not be found automatically. |
__showTeensyFlashInstructions | Private slot to show a message box because Teensy does not support the UF2 bootloader yet. |
__startTeensyLoader | Private slot to start the 'Teensy Loader' application. |
activateBluetoothInterface | Public method to activate the Bluetooth interface. |
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. |
checkInternet | Public method to check, if the internet can be reached. |
checkInternetViaLan | Public method to check, if the internet can be reached (LAN variant). |
connectToLan | Public method to connect the connected device to the LAN. |
connectWifi | Public method to connect a device to a WiFi network. |
deactivateBluetoothInterface | Public method to deactivate the Bluetooth interface. |
deactivateEthernet | Public method to deactivate the Ethernet interface of the connected device. |
deactivateInterface | Public method to deactivate a given WiFi interface of the connected device. |
deviceName | Public method to get the name of the device. |
disconnectFromLan | Public method to disconnect from the LAN. |
disconnectWifi | Public method to disconnect a device from the WiFi network. |
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. |
getDownloadMenuEntries | Public method to retrieve the entries for the downloads menu. |
getEthernetStatus | Public method to get Ethernet status data of the connected board. |
getWifiData | Public method to get data related to the current WiFi status. |
getWorkspace | Public method to get the workspace directory. |
hasBluetooth | Public method to check the availability of Bluetooth. |
hasEthernet | Public method to check the availability of Ethernet. |
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. |
isLanConnected | Public method to check the LAN connection status. |
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. |
removeLanAutoConnect | Public method to remove the saved IPv4 parameters 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. |
setWorkspace | Public method to set the device workspace directory. |
showCircuitPythonVersions | Public slot to show the CircuitPython version of a connected device and the latest available one (from Github). |
startAccessPoint | Public method to start the access point interface. |
stopAccessPoint | Public method to stop the access point interface. |
supportsLocalFileAccess | Public method to indicate file access via a local directory. |
writeCredentials | Public method to write the given credentials to the connected device and modify the start script to connect automatically. |
writeLanAutoConnect | Public method to generate a script and associated configuration to connect the device to the LAN during boot time. |
None |
Constructor
Private slot to populate the 'Library Management' menu.
Private slot to switch the board into 'bootloader' mode.
Private slot to switch the board into 'UF2 Boot' mode.
Private slot handling the response of the latest version request.
Private method to create the CircuitPython submenu.
Private method to create the various menus to flash a CircuitPython firmware.
Private method to check, if the device volume is mounted.
Private slot to erase the flash of an ESP32 device.
Private slot to flash additional firmware to an ESP32 device.
Private slot to flash a MicroPython or CircuitPython firmware to an ESP32 device.
Private method to find the device directories associated with the current board name.
Private method to find the workspace directory.
Private slot to flash a CircuitPython firmware to a device supporting UF2.
Private slot to install Python files into the onboard library.
Private method to modify the 'settings.toml' file as of CircuitPython 8.0.0.
Private slot to reset the connected device.
Private slot to select the mounted device volume, if it could not be found automatically.
Private slot to show a message box because Teensy does not support the UF2 bootloader yet.
Private slot to start the 'Teensy Loader' application.
Note: The application must be accessible via the application search path.
Public method to activate the Bluetooth interface.
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 check, if the internet can be reached (LAN variant).
Public method to connect the connected device to the LAN.
Note: The MAC address of the interface is configured with the WIZ
Public method to connect a device to a WiFi network.
Public method to deactivate the Bluetooth interface.
Public method to deactivate the Ethernet interface of the connected device.
Public method to deactivate a given WiFi interface of the connected device.
Note: With CircuitPython it is not possible to deactivate the station and access point interfaces separately.
Public method to get the name of the device.
Public method to disconnect from the LAN.
Public method to disconnect a device from the WiFi network.
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 retrieve the entries for the downloads menu.
Public method to get Ethernet status data of the connected board.
Public method to get data related to the current WiFi status.
Public method to get the workspace directory.
Public method to check the availability of Bluetooth.
Public method to check the availability of Ethernet.
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 the LAN connection status.
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 remove the saved IPv4 parameters from the connected device.
Note: This disables the LAN auto-connect feature.
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.
Public method to set the time to the network time retrieved from an NTP server.
Public method to set the device workspace directory.
Public slot to show the CircuitPython version of a connected device and the latest available one (from Github).
Public method to start the access point interface.
Public method to stop the access point interface.
Public method to indicate file access via a local directory.
Public method to write the given credentials to the connected device and modify the start script to connect automatically.
Public method to generate a script and associated configuration to connect the device to the LAN during boot time.
Function to instantiate a MicroPython device object.