Merge pull request #186 from valeros/feature/platformio_20

Add example with creating especial platform in documentation
2015-04-27 16:31:06 +01:00
parent c14b436aec 1033e827c0
commit 3657891833
1 changed files with 115 additions and 0 deletions
--- a/docs/librarymanager/creating.rst
+++ b/docs/librarymanager/creating.rst
@ -134,3 +134,118 @@ The registration requirements:

 Now, you can :ref:`register <cmd_lib_register>` your library and allow others
 to :ref:`install <cmd_lib_install>` it.
+
+Examples
+--------
+
+Create :ref:`platform_ststm32` based platform which uses GDB for uploading
+
+First of all, we need to create new folder ``platforms`` :ref:`projectconf_pio_home_dir` and copy there two files:
+
+1. Platform manifest file ``ststm32gdb.py`` with the next content:
+
+.. code-block:: python
+
+    import os
+
+    from platformio.platforms.ststm32 import Ststm32Platform
+
+
+    class Ststm32gdbPlatform(Ststm32Platform):
+
+        """
+        ST STM32 using GDB as uploader
+
+        http://www.st.com/web/en/catalog/mmc/FM141/SC1169?sc=stm32
+        """
+
+        def get_build_script(self):
+
+            return os.path.join(
+                os.path.dirname(os.path.realpath(__file__)),
+                "ststm32gdb-builder.py"
+            )
+
+2. Build script file ``ststm32gdb-builder.py`` with the next content:
+
+.. code-block:: python
+
+    """
+        Builder for ST STM32 Series ARM microcontrollers with GDB upload.
+    """
+
+    from os.path import join
+
+    from SCons.Script import (COMMAND_LINE_TARGETS, AlwaysBuild, Default,
+                              DefaultEnvironment, SConscript)
+
+
+    env = DefaultEnvironment()
+
+    SConscript(env.subst(join("$PIOBUILDER_DIR", "scripts", "basearm.py")))
+
+    env.Replace(
+        UPLOADER=join(
+            "$PIOPACKAGES_DIR", "toolchain-gccarmnoneeabi",
+            "bin", "arm-none-eabi-gdb"
+        ),
+        UPLOADERFLAGS=[
+            join("$BUILD_DIR", "firmware.elf"),
+            "-batch",
+            "-x", join("$PROJECT_DIR", "upload.gdb")
+        ],
+
+        UPLOADCMD="$UPLOADER $UPLOADERFLAGS"
+    )
+
+    env.Append(
+        CPPDEFINES=[
+            "${BOARD_OPTIONS['build']['variant'].upper()}"
+        ],
+
+        LINKFLAGS=[
+            "-nostartfiles",
+            "-nostdlib"
+        ]
+    )
+
+    #
+    # Target: Build executable and linkable firmware
+    #
+
+    target_elf = env.BuildFirmware()
+
+    #
+    # Target: Build the .bin file
+    #
+
+    if "uploadlazy" in COMMAND_LINE_TARGETS:
+        target_firm = join("$BUILD_DIR", "firmware.bin")
+    else:
+        target_firm = env.ElfToBin(join("$BUILD_DIR", "firmware"), target_elf)
+
+    #
+    # Target: Print binary size
+    #
+
+    target_size = env.Alias("size", target_elf, "$SIZEPRINTCMD")
+    AlwaysBuild(target_size)
+
+    #
+    # Target: Upload by default .bin file
+    #
+
+    upload = env.Alias(
+        ["upload", "uploadlazy"], target_firm, "$UPLOADCMD")
+    AlwaysBuild(upload)
+
+    #
+    # Target: Define targets
+    #
+
+    Default([target_firm, target_size])
+
+You should see ststm32gdb platform in ``platformio search`` command output.
+Now, you can install new platform via :ref:`platformio install ststm32gdb <cmd_install>` command.
+
+For more detailed information how to use this platform please follow to `issue 175 <https://github.com/platformio/platformio/issues/175>`_