mirrors/micropython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/cmodules: Fix example to globally define MODULE_EXAMPLE_ENABLED.

Browse Source 
MODULE_EXAMPLE_ENABLED must be globally defined for the module to be seen
and referenced by all parts of the code.
This commit is contained in:
Daniel O'Connor 2019-04-13 21:27:22 +09:30 committed by Damien George
parent 194d6b6788
commit fd58136d6b
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/develop/cmodules.rst
View File

@ -71,8 +71,6 @@ Directory::
#include "py/runtime.h" #include "py/runtime.h"
#include "py/builtin.h" #include "py/builtin.h"
#define MODULE_EXAMPLE_ENABLED (1)
// This is the function which will be called from Python as example.add_ints(a, b). // This is the function which will be called from Python as example.add_ints(a, b).
STATIC mp_obj_t example_add_ints(mp_obj_t a_obj, mp_obj_t b_obj) { STATIC mp_obj_t example_add_ints(mp_obj_t a_obj, mp_obj_t b_obj) {
// Extract the ints from the micropython input objects // Extract the ints from the micropython input objects
@ -119,6 +117,14 @@ Directory::
# This is not actually needed in this example. # This is not actually needed in this example.
CFLAGS_USERMOD += -I$(EXAMPLE_MOD_DIR) CFLAGS_USERMOD += -I$(EXAMPLE_MOD_DIR)
Finally you will need to modify the ``mpconfigboard.h`` for your board
to tell the build process to include the new module by adding the
following
.. code-block:: c
#define MODULE_EXAMPLE_ENABLED (1)
Compiling the cmodule into MicroPython Compiling the cmodule into MicroPython
-------------------------------------- --------------------------------------