Maxim Integrated / MAXREFDES1265

Firmware for MAXREFES1265

Dependencies:   max32625pico SerialInterface maxim-dev USBDevice

README.md@0:4a433af35131, 2020-05-05 (annotated)

Committer:
venkik
Date:
Tue May 05 16:39:00 2020 +0000
Revision:
0:4a433af35131
Final MAXREFDES1265 design

Who changed what in which revision?

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