Merging develop to main

README.md

@@ -1,4 +1,80 @@
-# Arduino MicroPython Lab
+# Arduino Lab for MicroPython
 
-A lightweight editor for MicroPython supporting connection with a board, code upload, file transfer, interactive REPL shell.
+Arduino Lab for MicroPython is an Integrated Development Environment (IDE) for MicroPython.
+
+## Features
+- MicroPython's Read Eval Print Loop (REPL)
+	- Enter paste mode
+	- Enter raw repl
+	- Software reset
+- File system management (Disk and MicroPython File System)
+	- Create
+	- Rename
+	- Remove
+	- Upload
+	- Download
+- Text editor with Python syntax highlight
+- Code execution controls
+	- Run what's on text editor
+	- Stop (keyboard interrupt)
+	- Soft reset
+
+## Technical
+
+Arduino Lab for MicroPython is an [Electron](https://www.electronjs.org/) app that has its main purpose to communicate over serial with a microprocessor running [MicroPython](https://micropython.org/). All Electron code is at `/index.js`.
+
+All operations over serial are abstracted and packaged on `/micropython.js` which is an attempt of porting `pyboard.py`. The port has its [own repository](https://github.com/murilopolese/micropython.js) but for the sake of simplicity and transparency, `micropython.js` is committed as source code.
+
+The User Interface (UI) source code stays inside `/ui` folder and is completely independent of the Electron code.
+
+The communication between interface and Electron app is accomplished by using the methods and events specified by `/preload.js`.
+
+## Folder structure
+
+At the root of the repository you will find:
+
+- `/.github`: Github's workflow configuration.
+- `/build_resources`: Icons and other assets used during the build process.
+- `/scripts`: Scripts executed during the build process.
+- `/ui`: Available user interfaces.
+- `/index.js`: Main Electron code.
+- `/micropython.js`: Serial connection abstraction.
+- `/preload.js`: Creates Disk and Serial APIs on Electron's main process and exposes it to Electron's renderer process (context bridge).
+
+## Arduino UI
+
+Default UI is a [choo-choo](https://github.com/choojs/choo) app. It has pre-built dependencies so no build process is required for the interface.
+
+The dependencies and source code are included manually in the `/ui/arduino/index.html` file.
+
+The app is a standard [choo-choo](https://github.com/choojs/choo) app and it has:
+
+- `/ui/arduino/app.js`: A router deciding which view to load.
+- `/ui/arduino/components`: HTML templates and components.
+- `/ui/arduino/store.js`: A "store" that handles events emitted by the views, change the app state and orchestrate re-rendering.
+- `/ui/arduino/libs`: Prebuilt dependencies.
+
+It can be useful to learn more about [Choo](https://github.com/choojs/choo) or the [Elm Architecture](https://guide.elm-lang.org/architecture/).
+
+## Disk and Serial API
+
+In order for the UI code to be independent of Electron code, there is an API defined at `/preload.js` that describes all the allowed operations.
+
+There are 2 main operation "channels": Serial communication and local Filesystem operations. Both channels offer methods that always return promises and are used mostly through [`async`/`await`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function).
+
+While the serial communication is mediated by `/micropython.js`, the local filesystem operations are done through Electron's `ipcRenderer` calls. The handlers for these calls are defined at `/index.js`
+
+## Running Arduino Lab for MicroPython from source code
+
+1. Clone this repository: `git clone https://github.com/arduino/MicroPython_Lab.git`
+2. Navigate to repository folder: `cd MicroPython_Lab`
+3. Install dependencies: `npm install`
+4. Run dev mode: `npm run dev`
+
+Some changes on the Electron code will require reopening the app but all UI changes will only require refreshing the window (ctrl-r/cmd-r).
+
+
+## Trademarks
+
+"Python" and the Python Logo are trademarks of the Python Software Foundation.
 

index.js

@@ -1,30 +1,45 @@
-const { app, BrowserWindow, ipcMain, dialog } = require('electron')
+const { app, BrowserWindow, Menu, ipcMain, dialog } = require('electron')
 const path = require('path')
 const fs = require('fs')
+const join = require('path').join
+const openAboutWindow = require('about-window').default
 
 let win = null // main window
 
+// HELPERS
 async function openFolderDialog() {
   // https://stackoverflow.com/questions/46027287/electron-open-folder-dialog
   let dir = await dialog.showOpenDialog(win, { properties: [ 'openDirectory' ] })
   return dir.filePaths[0] || null
 }
 
+function listFolder(folder) {
+  files = fs.readdirSync(path.resolve(folder))
+  // Filter out directories
+  files = files.filter(f => {
+    let filePath = path.resolve(folder, f)
+    return !fs.lstatSync(filePath).isDirectory()
+  })
+  return files
+}
+
+// LOCAL FILE SYSTEM ACCESS
 ipcMain.handle('open-folder', async (event) => {
   console.log('ipcMain', 'open-folder')
   const folder = await openFolderDialog()
   let files = []
   if (folder) {
-    files = fs.readdirSync(path.resolve(folder))
-    // Filter out directories
-    files = files.filter(f => {
-      let filePath = path.resolve(folder, f)
-      return !fs.lstatSync(filePath).isDirectory()
-    })
+    files = listFolder(folder)
   }
   return { folder, files }
 })
 
+ipcMain.handle('list-files', async (event, folder) => {
+  console.log('ipcMain', 'list-files', folder)
+  if (!folder) return []
+  return listFolder(folder)
+})
+
 ipcMain.handle('load-file', (event, folder, filename) => {
   console.log('ipcMain', 'load-file', folder, filename )
   let filePath = path.resolve(folder, filename)
@@ -40,6 +55,7 @@ ipcMain.handle('save-file', (event, folder, filename, content) => {
 })
 
 ipcMain.handle('update-folder', (event, folder) => {
+  console.log('ipcMain', 'update-folder', folder)
   let files = fs.readdirSync(path.resolve(folder))
   // Filter out directories
   files = files.filter(f => {
@@ -64,6 +80,7 @@ ipcMain.handle('rename-file', (event, folder, filename, newFilename) => {
   return newFilename
 })
 
+// START APP
 function createWindow () {
   // Create the browser window.
   win = new BrowserWindow({
@@ -77,7 +94,146 @@ function createWindow () {
     }
   })
   // and load the index.html of the app.
-  win.loadFile('ui/blank/index.html')
+  win.loadFile('ui/arduino/index.html')
 }
 
+// TODO: Loading splash screen
+
+const isMac = process.platform === 'darwin'
+const isDev = !app.isPackaged
+const template = [
+  ...(isMac ? [{
+    label: app.name,
+    submenu: [
+      { role: 'about'},
+      { type: 'separator' },
+      { role: 'services' },
+      { type: 'separator' },
+      { role: 'hide' },
+      { role: 'hideOthers' },
+      { role: 'unhide' },
+      { type: 'separator' },
+      { role: 'quit' }
+    ]
+  }] : []),
+  {
+    label: 'File',
+    submenu: [
+      isMac ? { role: 'close' } : { role: 'quit' }
+    ]
+  },
+  {
+    label: 'Edit',
+    submenu: [
+      { role: 'undo' },
+      { role: 'redo' },
+      { type: 'separator' },
+      { role: 'cut' },
+      { role: 'copy' },
+      { role: 'paste' },
+      ...(isMac ? [
+        { role: 'pasteAndMatchStyle' },
+        { role: 'selectAll' },
+        { type: 'separator' },
+        {
+          label: 'Speech',
+          submenu: [
+            { role: 'startSpeaking' },
+            { role: 'stopSpeaking' }
+          ]
+        }
+      ] : [
+        { type: 'separator' },
+        { role: 'selectAll' }
+      ])
+    ]
+  },
+  {
+    label: 'View',
+    submenu: [
+      { role: 'reload' },
+      { type: 'separator' },
+      { role: 'resetZoom' },
+      { role: 'zoomIn' },
+      { role: 'zoomOut' },
+      { type: 'separator' },
+      { role: 'togglefullscreen' },
+      ...(isDev ? [
+        { type: 'separator' },
+        { role: 'toggleDevTools' }, 
+      ]:[
+      ])
+    ]
+  },
+  {
+    label: 'Window',
+    submenu: [
+      { role: 'minimize' },
+      { role: 'zoom' },
+      ...(isMac ? [
+        { type: 'separator' },
+        { role: 'front' },
+        { type: 'separator' },
+        { role: 'window' }
+      ] : [
+        { role: 'close' }
+      ])
+    ]
+  },
+  {
+    role: 'help',
+    submenu: [
+      {
+        label: 'Learn More',
+        click: async () => {
+          const { shell } = require('electron')
+          await shell.openExternal('https://github.com/arduino/MicroPython_Lab')
+        }
+      },
+      {
+        label: 'Report an issue',
+        click: async () => {
+          const { shell } = require('electron')
+          await shell.openExternal('https://github.com/arduino/MicroPython_Lab/issues')
+        }
+      },
+      {
+        label:'Info about this app',
+        click: () => {
+            openAboutWindow({
+                icon_path: join(__dirname, 'ui/arduino/assets/about_image.png'),
+                css_path: join(__dirname, 'ui/arduino/about.css'),
+                copyright: '© Arduino SA 2022',
+                package_json_dir: __dirname,
+                bug_report_url: "https://github.com/arduino/MicroPython_Lab/issues",
+                bug_link_text: "report an issue",
+                homepage: "https://labs.arduino.cc",
+                use_version_info: false,
+                win_options: {
+                    parent: win,
+                    modal: true,
+                },
+                show_close_button: 'Close',
+            })
+          }
+      },
+    ]
+  }
+]
+
+const menu = Menu.buildFromTemplate(template)
+
+app.setAboutPanelOptions({
+  applicationName: app.name,
+  applicationVersion: app.getVersion(),
+  copyright: app.copyright,
+  credits: '(See "Info about this app" in the Help menu)',
+  authors: ['Arduino'],
+  website: 'https://arduino.cc',
+  iconPath: path.join(__dirname, '../assets/image.png'),
+})
+
+Menu.setApplicationMenu(menu)
+
+
 app.whenReady().then(createWindow)