Merge pull request #387 from forGGe/g378_migrate_blinky

Merge blinky examples and update docs

Author: forGGe

doc/sphinx/source/examples/blinky.rst

@@ -0,0 +1,76 @@
+.. _theCore_blinky:
+
+Simple LED blink example
+------------------------
+
+:Location:          https://github.com/theCore-embedded/example_blinky
+:External HW:       none
+
+This example flashes available LEDs on supported boards, one by one.
+
+Supported targets (boards)
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
++---------------------+--------------------------+-----------------------------------+
+|     Target name     |    Configuration file    |            Description            |
++=====================+==========================+===================================+
+| stm32f4_disc        | stm32f4_discovery.json   | STM32F4 discovery board           |
++---------------------+--------------------------+-----------------------------------+
+| tiva_tm4c_launchpad | tiva_tm4c_launchpad.json | TM4C123G LaunchPad Evaluation Kit |
++---------------------+--------------------------+-----------------------------------+
+
+Wiring
+~~~~~~
+
+No special wiring is required. Just connect the board to the powered USB port.
+
+Building
+~~~~~~~~
+
+#. Install theCore (this may take a while)::
+
+        pip3 install tcore
+        tcore bootstrap
+
+#. Download this example::
+
+        tcore init --remote https://github.com/theCore-embedded/example_blinky
+
+#. Step into the project directory::
+
+        cd example_blinky
+
+#. Compile:
+
+   * For STM32 Discovery board::
+
+        cd example_blinky
+        tcore compile --target stm32f4_disc
+
+   * For Tiva TM4C LaunchPad::
+
+        tcore compile --target tiva_tm4c_launchpad
+
+Running
+~~~~~~~
+
+#. Connect your board.
+
+#. Run:
+
+   * For TivaC launchpad::
+
+        tcore --sudo flash
+
+   * For old STM32F407G-DISC boards, with STLINK/V2::
+
+        tcore --sudo flash
+
+   * For new STM32F407G-DISC1 boards, with STLINK/V2.1::
+
+        tcore --sudo flash --debugger-config stlink-v2.1
+
+Expected output
+~~~~~~~~~~~~~~~
+
+On-board LEDs will blink with the different (RGB) colors.

doc/sphinx/source/examples/index.rst

@@ -7,13 +7,12 @@ Examples
   :maxdepth: 2
   :includehidden:
 
+  blinky
   hello-world-host
   stm32f4-discovery-htu21d-sensor
   stm32f4-discovery-cs43l22
   stm32f4-discovery-exti
-  stm32f4-discovery-blink
   stm32f4-discovery-bluetooth-hm10
-  ti-tm4c123g-launchpad-blink
   ti-tm4c123g-sdcard-fatfs-sdspi
 
 theCore examples are organized in a form of separate projects that can be

doc/sphinx/source/examples/stm32f4-discovery-blink.rst

@@ -3,11 +3,17 @@
 STM32F4 discovery audio example with CS43L22 audio DAC
 ------------------------------------------------------
 
-:Location:          ``examples/cs43l22_audio``
-:Target:            STM32F4 Discovery board
+:Location:          https://github.com/theCore-embedded/example_cs43l22_audio
 :External HW:       UART-to-USB converter attached to the USART3, headphones
-:Toolchain:         GNU arm-none-eabi v.5.2 or newer
-:Additional SW:     openocd, minicom
+
+Supported targets (boards)
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
++---------------------+--------------------------+-----------------------------------+
+|     Target name     |    Configuration file    |            Description            |
++=====================+==========================+===================================+
+| stm32f4_disc        | stm32f4_discovery.json   | STM32F4 discovery board           |
++---------------------+--------------------------+-----------------------------------+
 
 Wiring
 ~~~~~~
@@ -83,7 +89,7 @@ Firmware will be flashed via ``openocd`` debugger and ``flash`` command.
 
    ::
 
-     tcore flash --sudo --debuger-config stlink-v2.1
+     tcore flash --sudo --debugger-config stlink-v2.1
 
    See :ref:`theCore_SudoOpenOCD_Nix` section to get insight why ``which openocd``
    is important.
@@ -105,13 +111,6 @@ In ``minicom`` you should be able to see::
   Welcome to theCore
   Playing audio sample...
 
-
 In headphones you should hear cool 8-bit sound.
 
-Target JSON config for the audio example
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. literalinclude:: ../../../../examples/cs43l22_audio/stm32f4_cs43l22.json
-
-
 .. _such as this: http://www.geekfactory.mx/wp-content/uploads/2013/06/converdidor_usb_ttl_rs232_pl_2303hx_01.jpg

doc/sphinx/source/examples/stm32f4-discovery-cs43l22.rst

@@ -50,7 +50,7 @@ Available examples
 ~~~~~~~~~~~~~~~~~~
 
 * :ref:`theCore_TM4C_FATFS_SDSPI`
-* :ref:`theCore_TM4C_Blinky`
+* :ref:`theCore_blinky`
 
 Periphery overview
 ~~~~~~~~~~~~~~~~~~

doc/sphinx/source/examples/ti-tm4c123g-launchpad-blink.rst

@@ -70,19 +70,6 @@ ExternalProject_Add(stm32f4_hm10_example
         BUILD_ALWAYS 1 # Allows to rebuild external project if its files changes
         INSTALL_COMMAND echo "Install isn't required, skipping...")
 
-################################################################################
-# TM4C Led example.
-################################################################################
-
-ExternalProject_Add(tm4c_led_example
-        SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/tm4c_led
-        CMAKE_ARGS
-            -DTHECORE_BUILD_THIRDPARTY_DIR=${THECORE_BUILD_THIRDPARTY_DIR}
-            -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-            -DCMAKE_TOOLCHAIN_FILE=${ARM_CM4_GNU_TOOLCHAIN}
-        BUILD_ALWAYS 1 # Allows to rebuild external project if its files changes
-        INSTALL_COMMAND echo "Install isn't required, skipping...")
-
 ################################################################################
 # TM4C FATFS over SDSPI example
 ################################################################################