djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/cmodules: Note the various ways MODULE_EXAMPLE_ENABLED can be set.

Browse Source
This commit is contained in:
Daniel O'Connor 2019-04-15 14:31:15 +09:30 committed by Damien George
parent a6e5846ba7
commit d4e182039f
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/develop/cmodules.rst
View File

@ -117,14 +117,19 @@ 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 Finally you will need to define ``MODULE_EXAMPLE_ENABLED`` to 1. This
to tell the build process to include the new module by adding the can be done by adding ``CFLAGS_EXTRA=-DMODULE_EXAMPLE_ENABLED=1`` to
following the ``make`` command, or editing ``mpconfigport.h`` or
``mpconfigboard.h`` to add
.. code-block:: c .. code-block:: c
#define MODULE_EXAMPLE_ENABLED (1) #define MODULE_EXAMPLE_ENABLED (1)
Note that the exact method depends on the port as they have different
structures. If not done correctly it will compile but importing will
fail to find the module.
Compiling the cmodule into MicroPython Compiling the cmodule into MicroPython
-------------------------------------- --------------------------------------
@ -152,7 +157,7 @@ Building for stm32 port:
.. code-block:: bash .. code-block:: bash
cd my_project/micropython/ports/stm32 cd my_project/micropython/ports/stm32
make USER_C_MODULES=../../../modules all make USER_C_MODULES=../../../modules CFLAGS_EXTRA=-DMODULE_EXAMPLE_ENABLED=1 all
Module usage in MicroPython Module usage in MicroPython