You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/extmods.md
+5-1Lines changed: 5 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -42,6 +42,10 @@ You can now compile the firmware with `make` as usual. The build system will fin
42
42
43
43
After this is flashed to the device, the module in the example will be available in lua as `helloworld`.
44
44
45
+
### Updating to the latest code
46
+
47
+
If your external module entry in `extmods.ini` points to a branch, e.g., `master`, you can update your local version to the latest code anytime by simply running `make extmod-update`.
48
+
45
49
### Temporarily disabling an external module
46
50
47
51
If you want to stop compiling and including a module in the build for any reason, without having to remove the entry from `extmods.ini`, simply add a `disabled=true` entry in the module section and run `make extmod-update`.
@@ -75,7 +79,7 @@ Note that the second one points to a different branch, `dev`. Both modules will
75
79
To write your own external module do the following:
76
80
77
81
1. Create an empty repository in your favorite remote, GitHub, BitBucket, GitLab, etc, or fork the helloworld example.
78
-
2. Create an entry in `extmods.ini` as explained above. For modules that you author, it is recommended to use an updateable git URL in SSH format, such as `git@github.com:espore-ide/nodemcu-module-helloworld.git`.
82
+
2. Create an entry in `extmods.ini` as explained above, with the `url=` key pointing to your repository. For modules that you author, it is recommended to use an updateable git URL in SSH format, such as `git@github.com:espore-ide/nodemcu-module-helloworld.git`.
79
83
3. Run `make extmod-update`
80
84
81
85
You can now change to `components/modules/external/your_module` and begin work. Since that is your own repository, you can work normally, commit, create branches, etc.
0 commit comments