Aditya Mehrotra / CAN_TEST

N/A

Dependencies:   mbed-dev

README.md@1:b0bdde8aa220, 2021-03-09 (annotated)

Committer:
adimmit
Date:
Tue Mar 09 20:37:49 2021 +0000
Revision:
1:b0bdde8aa220
Parent:
0:a043c98470ae 
added support for CAN3 fixed MBED library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
adimmit 0:a043c98470ae 1 ![](./resources/official_armmbed_example_badge.png)
adimmit 0:a043c98470ae 2 # Blinky Mbed OS example
adimmit 0:a043c98470ae 3
adimmit 0:a043c98470ae 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/).
adimmit 0:a043c98470ae 5
adimmit 0:a043c98470ae 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).
adimmit 0:a043c98470ae 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).)
adimmit 0:a043c98470ae 8
adimmit 0:a043c98470ae 9 1. [Install Mbed CLI](https://os.mbed.com/docs/mbed-os/latest/quick-start/offline-with-mbed-cli.html).
adimmit 0:a043c98470ae 10
adimmit 0:a043c98470ae 11 1. Clone this repository on your system, and change the current directory to where the project was cloned:
adimmit 0:a043c98470ae 12
adimmit 0:a043c98470ae 13 ```bash
adimmit 0:a043c98470ae 14 $ git clone git@github.com:armmbed/mbed-os-example-blinky && cd mbed-os-example-blinky
adimmit 0:a043c98470ae 15 ```
adimmit 0:a043c98470ae 16
adimmit 0:a043c98470ae 17 Alternatively, you can download the example project with Arm Mbed CLI using the `import` subcommand:
adimmit 0:a043c98470ae 18
adimmit 0:a043c98470ae 19 ```bash
adimmit 0:a043c98470ae 20 $ mbed import mbed-os-example-blinky && cd mbed-os-example-blinky
adimmit 0:a043c98470ae 21 ```
adimmit 0:a043c98470ae 22
adimmit 0:a043c98470ae 23
adimmit 0:a043c98470ae 24 ## Application functionality
adimmit 0:a043c98470ae 25
adimmit 0:a043c98470ae 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.
adimmit 0:a043c98470ae 27
adimmit 0:a043c98470ae 28 ## Building and running
adimmit 0:a043c98470ae 29
adimmit 0:a043c98470ae 30 1. Connect a USB cable between the USB port on the board and the host computer.
adimmit 0:a043c98470ae 31 2. <a name="build_cmd"></a> Run the following command to build the example project and program the microcontroller flash memory:
adimmit 0:a043c98470ae 32 ```bash
adimmit 0:a043c98470ae 33 $ mbed compile -m <TARGET> -t <TOOLCHAIN> --flash
adimmit 0:a043c98470ae 34 ```
adimmit 0:a043c98470ae 35 The binary is located at `./BUILD/<TARGET>/<TOOLCHAIN>/mbed-os-example-blinky.bin`.
adimmit 0:a043c98470ae 36
adimmit 0:a043c98470ae 37 Alternatively, you can manually copy the binary to the board, which you mount on the host computer over USB.
adimmit 0:a043c98470ae 38
adimmit 0:a043c98470ae 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:
adimmit 0:a043c98470ae 40
adimmit 0:a043c98470ae 41 ```bash
adimmit 0:a043c98470ae 42 $ mbed compile -S
adimmit 0:a043c98470ae 43 ```
adimmit 0:a043c98470ae 44
adimmit 0:a043c98470ae 45 ## Expected output
adimmit 0:a043c98470ae 46 The LED on your target turns on and off every 500 milliseconds.
adimmit 0:a043c98470ae 47
adimmit 0:a043c98470ae 48
adimmit 0:a043c98470ae 49 ## Troubleshooting
adimmit 0:a043c98470ae 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.
adimmit 0:a043c98470ae 51
adimmit 0:a043c98470ae 52 ## Related Links
adimmit 0:a043c98470ae 53
adimmit 0:a043c98470ae 54 * [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html).
adimmit 0:a043c98470ae 55 * [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html).
adimmit 0:a043c98470ae 56 * [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html).
adimmit 0:a043c98470ae 57 * [Mbed OS bare metal](https://os.mbed.com/docs/mbed-os/latest/reference/mbed-os-bare-metal.html).
adimmit 0:a043c98470ae 58 * [Mbed boards](https://os.mbed.com/platforms/).
adimmit 0:a043c98470ae 59
adimmit 0:a043c98470ae 60 ### License and contributions
adimmit 0:a043c98470ae 61
adimmit 0:a043c98470ae 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.
adimmit 0:a043c98470ae 63
adimmit 0:a043c98470ae 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.