can bayar / Mbed OS can_mfcc

sa

Dependencies:   mbed-dsp

README.md@0:540cf00460b2, 2020-04-29 (annotated)

Committer:
magicTurtle866
Date:
Wed Apr 29 19:54:31 2020 +0000
Revision:
0:540cf00460b2
andac bul beni

Who changed what in which revision?

UserRevisionLine numberNew contents of line
magicTurtle866 0:540cf00460b2 1 ![](./resources/official_armmbed_example_badge.png)
magicTurtle866 0:540cf00460b2 2 # Blinky Mbed OS example
magicTurtle866 0:540cf00460b2 3
magicTurtle866 0:540cf00460b2 4 The example project is part of the [Arm Mbed OS Official Examples](https://os.mbed.com/code/) and is the [getting started example for Mbed OS](https://os.mbed.com/docs/mbed-os/v5.14/quick-start/index.html). It contains an application that repeatedly blinks an LED on supported [Mbed boards](https://os.mbed.com/platforms/).
magicTurtle866 0:540cf00460b2 5
magicTurtle866 0:540cf00460b2 6 You can build the project with all supported [Mbed OS build tools](https://os.mbed.com/docs/mbed-os/latest/tools/index.html). However, this example project specifically refers to the command-line interface tool [Arm Mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
magicTurtle866 0:540cf00460b2 7 (Note: To see a rendered example you can import into the Arm Online Compiler, please see our [import quick start](https://os.mbed.com/docs/mbed-os/latest/quick-start/online-with-the-online-compiler.html#importing-the-code).)
magicTurtle866 0:540cf00460b2 8
magicTurtle866 0:540cf00460b2 9 1. [Install Mbed CLI](https://os.mbed.com/docs/mbed-os/latest/quick-start/offline-with-mbed-cli.html).
magicTurtle866 0:540cf00460b2 10
magicTurtle866 0:540cf00460b2 11 1. Clone this repository on your system, and change the current directory to where the project was cloned:
magicTurtle866 0:540cf00460b2 12
magicTurtle866 0:540cf00460b2 13 ```bash
magicTurtle866 0:540cf00460b2 14 $ git clone git@github.com:armmbed/mbed-os-example-blinky && cd mbed-os-example-blinky
magicTurtle866 0:540cf00460b2 15 ```
magicTurtle866 0:540cf00460b2 16
magicTurtle866 0:540cf00460b2 17 Alternatively, you can download the example project with Arm Mbed CLI using the `import` subcommand:
magicTurtle866 0:540cf00460b2 18
magicTurtle866 0:540cf00460b2 19 ```bash
magicTurtle866 0:540cf00460b2 20 $ mbed import mbed-os-example-blinky && cd mbed-os-example-blinky
magicTurtle866 0:540cf00460b2 21 ```
magicTurtle866 0:540cf00460b2 22
magicTurtle866 0:540cf00460b2 23
magicTurtle866 0:540cf00460b2 24 ## Application functionality
magicTurtle866 0:540cf00460b2 25
magicTurtle866 0:540cf00460b2 26 The `main()` function is the single thread in the application. It toggles the state of a digital output connected to an LED on the board.
magicTurtle866 0:540cf00460b2 27
magicTurtle866 0:540cf00460b2 28 ## Building and running
magicTurtle866 0:540cf00460b2 29
magicTurtle866 0:540cf00460b2 30 1. Connect a USB cable between the USB port on the board and the host computer.
magicTurtle866 0:540cf00460b2 31 2. <a name="build_cmd"></a> Run the following command to build the example project and program the microcontroller flash memory:
magicTurtle866 0:540cf00460b2 32 ```bash
magicTurtle866 0:540cf00460b2 33 $ mbed compile -m <TARGET> -t <TOOLCHAIN> --flash
magicTurtle866 0:540cf00460b2 34 ```
magicTurtle866 0:540cf00460b2 35 The binary is located at `./BUILD/<TARGET>/<TOOLCHAIN>/mbed-os-example-blinky.bin`.
magicTurtle866 0:540cf00460b2 36
magicTurtle866 0:540cf00460b2 37 Alternatively, you can manually copy the binary to the board, which you mount on the host computer over USB.
magicTurtle866 0:540cf00460b2 38
magicTurtle866 0:540cf00460b2 39 Depending on the target, you can build the example project with the `GCC_ARM`, `ARM` or `IAR` toolchain. After installing Arm Mbed CLI, run the command below to determine which toolchain supports your target:
magicTurtle866 0:540cf00460b2 40
magicTurtle866 0:540cf00460b2 41 ```bash
magicTurtle866 0:540cf00460b2 42 $ mbed compile -S
magicTurtle866 0:540cf00460b2 43 ```
magicTurtle866 0:540cf00460b2 44
magicTurtle866 0:540cf00460b2 45 ## Expected output
magicTurtle866 0:540cf00460b2 46 The LED on your target turns on and off every 500 milliseconds.
magicTurtle866 0:540cf00460b2 47
magicTurtle866 0:540cf00460b2 48
magicTurtle866 0:540cf00460b2 49 ## Troubleshooting
magicTurtle866 0:540cf00460b2 50 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.
magicTurtle866 0:540cf00460b2 51
magicTurtle866 0:540cf00460b2 52 ## Related Links
magicTurtle866 0:540cf00460b2 53
magicTurtle866 0:540cf00460b2 54 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html).
magicTurtle866 0:540cf00460b2 55 * [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html).
magicTurtle866 0:540cf00460b2 56 * [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html).
magicTurtle866 0:540cf00460b2 57 * [Mbed OS bare metal](https://os.mbed.com/docs/mbed-os/latest/reference/mbed-os-bare-metal.html).
magicTurtle866 0:540cf00460b2 58 * [Mbed boards](https://os.mbed.com/platforms/).
magicTurtle866 0:540cf00460b2 59
magicTurtle866 0:540cf00460b2 60 ### License and contributions
magicTurtle866 0:540cf00460b2 61
magicTurtle866 0:540cf00460b2 62 The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see contributing.md for more info.
magicTurtle866 0:540cf00460b2 63
magicTurtle866 0:540cf00460b2 64 This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.