Skip to content

Commit 99f3eb7

Browse files
doc: draft dev mode docs
1 parent 66ae2b9 commit 99f3eb7

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

GET_STARTED.md

+23
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,29 @@ Once the project is ready to run, it needs to be uploaded to a device.
3131

3232
---
3333

34+
## Developer mode - Experimental
35+
36+
To speed up development, you can put a project in `development mode`.
37+
38+
In development mode, Pymakr automatically propagates file changes in and restarts the main script.
39+
40+
Dev mode can be configured in `pymakr.json`
41+
```json
42+
{
43+
"onUpdate": "restartScript" | "softRestartDevice" | "hardRestartDevice"
44+
}
45+
```
46+
47+
**onUpdate:** Action to be called once file changes have been propagated.
48+
- **restartScript** Clears the `main.py` module as well as any changed modules. Then imports `boot.py` and `main.py`.
49+
- **softRestartDevice** Performs <kbd>ctrl + d</kbd>
50+
- **hardRestartDevice** Performs `machine.reset()`
51+
52+
#### NOTE
53+
*`machine.sleep` and `machine.deepsleep` do not work in development since they stop the USB connection.*
54+
55+
---
56+
3457
## Hint: Organizing your setup
3558

3659
Having to switch between different tabs can be cumbersome. To solve this, you can drag your devices and projects to the file explorer view.

0 commit comments

Comments
 (0)