MicroPython

https://docs.micropython.org/en/latest/
Admin
MicroPython is a lean and efficient implementation of Python 3 designed to run on microcontrollers...
Tokens:691,211
Snippets:5,352
Trust Score:9.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Package from GitHub

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Installs a package from a specified branch of a GitHub repository to the device.

```bash
mpremote mip install github:org/repo@branch
```

--------------------------------

### Install Package from Micropython-Lib

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Installs a package from the micropython-lib repository to the device.

```bash
mpremote mip install aioble
```

--------------------------------

### Install Package from GitLab

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Installs a package from a specified branch of a GitLab repository to the device.

```bash
mpremote mip install gitlab:org/repo@branch
```

--------------------------------

### Mount Local Directory and Enter REPL

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Mounts the current local directory to '/remote' on the device and starts a REPL session using the mounted directory as the working directory.

```bash
mpremote mount .
```

--------------------------------

### Copy Multiple Files and Enter REPL

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Copies multiple local files to the device and then enters the REPL.

```bash
mpremote cp a.py b.py : + repl
```

--------------------------------

### Connect and Execute Command

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Connects to a device and executes a specific command, such as listing files.

```bash
mpremote a1 ls
```

--------------------------------

### Mount and Inject File on Key Press

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Mounts a local directory and executes the content of a local file in the REPL when a specific key combination (Ctrl-K) is pressed after resetting the interpreter state.

```bash
mpremote mount app repl --inject-file demo.py
```

--------------------------------

### Hard Reset and Bootloader

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Performs a hard reset on the device, waits for it to become available, and then enters the bootloader.

```bash
mpremote reset sleep 0.5 bootloader
```

--------------------------------

### Copy File, Soft Reset, and REPL

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Updates a file on the device, performs a soft reset to restart the program, and then enters the REPL to monitor output.

```bash
mpremote cp utils/driver.py :utils/driver.py + soft-reset repl
```

--------------------------------

### Mount Directory and Execute Local Script

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Mounts a local directory and executes a local script without copying it to the device's filesystem.

```bash
mpremote mount app run test.py
```

--------------------------------

### Mount Local Directory and Execute Script

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Mounts the current local directory and then executes a script from the mounted directory.

```bash
mpremote mount . exec "import demo"
```

--------------------------------

### Copy File and Execute Script

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Updates a file on the device and then executes a local script on the device without copying it.

```bash
mpremote cp utils/driver.py :utils/driver.py + run test.py
```

--------------------------------

### Resume Execution and Soft Reset

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Connects to a device without a soft reset, executes a function, and then performs a soft reset.

```bash
mpremote resume exec "print_state_info()" soft-reset
```

--------------------------------

### Mount and Inject Code on Key Press

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Mounts the current local directory and injects code into the REPL when a specific key combination (Ctrl-J) is pressed after resetting the interpreter state.

```bash
mpremote mount . repl --inject-code "import demo"
```

--------------------------------

### Copy File and Execute Remote Script

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Updates a file on the device and then executes a script already present on the device.

```bash
mpremote cp utils/driver.py :utils/driver.py + exec "import app"
```

--------------------------------

### Copy Directory Recursively

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Recursively copies a local directory to the device.

```bash
mpremote cp -r utils/ :utils/
```

--------------------------------

### Evaluate Expressions on Different Devices

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Evaluates expressions on different devices sequentially, printing each result.

```bash
mpremote a0 eval 1/2 a1 eval 3/4
```

--------------------------------

### Execute Python Command

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Runs a Python command on the device and displays its output. This is similar to typing the command directly in the REPL.

```bash
mpremote exec "import micropython; micropython.mem_info()"
```

--------------------------------

### Copy Local File to Remote

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Copies a local file to the MicroPython device's root directory.

```bash
mpremote cp main.py :
```

--------------------------------

### Evaluate Expressions

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Evaluates multiple Python expressions sequentially on the device and prints their results.

```bash
mpremote eval 1/2 eval 3/4
```

--------------------------------

### Copy Remote File Locally

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Copies a file from the MicroPython device to the local current directory.

```bash
mpremote cp :main.py .
```

--------------------------------

### Copy File on Remote Device

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Copies a file from one location to another on the MicroPython device.

```bash
mpremote cp :a.py :b.py
```

--------------------------------

### Display Remote File Content

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Displays the content of a file located on the MicroPython device.

```bash
mpremote cat boot.py
```

--------------------------------

### Edit Remote File

Source: https://docs.micropython.org/en/latest/reference/mpremote.html

Opens a remote file on the MicroPython device for editing using the local system's default editor.

```bash
mpremote edit utils/driver.py
```
Tokens:
Raw