Skip to content

Commit

Permalink
add link to discussion #1105
Browse files Browse the repository at this point in the history
  • Loading branch information
phoddie committed May 16, 2023
1 parent bd8ac2b commit 2420f19
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions documentation/xs/mods.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Mods - User Installed Extensions
Copyright 2020-2022 Moddable Tech, Inc.<BR>
Revised: June 22, 2022
Copyright 2020-2023 Moddable Tech, Inc.<BR>
Revised: May 16, 2023

Mods are scripts that users can install on their IoT products to add new features and change existing behaviors. A mod is one or more JavaScript modules together with assets like images, audio, and certificates. A mod augments the software of a product without changing the factory installed firmware. To minimize safety, security, and privacy risks, products may sandbox mods using Secure ECMAScript (aka Hardened JavaScript). Mods are a new core feature of the Moddable SDK supported by the XS JavaScript engine.

Expand Down Expand Up @@ -106,7 +106,7 @@ You can use `mcrun` to build and install the mod on a microcontroller by specify
mcrun -d -m -p esp32/moddable_two
```

For `mcrun` to install the mod, a debug build of a mod host must first be installed on the device. The mod host must be a debug build because `mcrun` installs the mod using the xsbug debugger protocol. Mods can also run on a release build of a mod host but must be installed in some other way.
For `mcrun` to install the mod, a debug build of a mod host must first be installed on the device. The mod host must be a debug build because `mcrun` installs the mod using the xsbug debugger protocol. Mods can also run on a release build of a mod host but must be installed in some other way ([this discussion](https://github.com/Moddable-OpenSource/moddable/discussions/1105) shows one way to do this on the ESP32 silicon family).

Once the mod is installed, `mcrun` automatically restarts the microcontroller and connects to xsbug to debug the mod.

Expand Down

0 comments on commit 2420f19

Please sign in to comment.