Tom Minnich / Mbed OS REP_Hexiwear_OLED

Hexiwear based rate of exercise coach

Dependencies:   FXOS8700 Hexi_OLED_SSD1351

Fork of Hexi_Accelero_Magneto_Example by Hexiwear

README.md@4:adea7bcbd995, 2016-10-02 (annotated)

Committer:
tom_minnich
Date:
Sun Oct 02 00:06:34 2016 +0000
Revision:
4:adea7bcbd995
Parent:
0:207337d58f96 
REP Hexiwear OLED version 1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
maclobdell 0:207337d58f96 1 # Getting started with Blinky on mbed OS
maclobdell 0:207337d58f96 2
maclobdell 0:207337d58f96 3 This is a very simple guide, reviewing the steps required to get Blinky working on an mbed OS platform.
maclobdell 0:207337d58f96 4
maclobdell 0:207337d58f96 5 Please install [mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
maclobdell 0:207337d58f96 6
maclobdell 0:207337d58f96 7 ## Get the example application!
maclobdell 0:207337d58f96 8
maclobdell 0:207337d58f96 9 From the command line, import the example:
maclobdell 0:207337d58f96 10
maclobdell 0:207337d58f96 11 ```
maclobdell 0:207337d58f96 12 mbed import mbed-os-example-blinky
maclobdell 0:207337d58f96 13 cd mbed-os-example-blinky
maclobdell 0:207337d58f96 14 ```
maclobdell 0:207337d58f96 15
maclobdell 0:207337d58f96 16 ### Now compile
maclobdell 0:207337d58f96 17
maclobdell 0:207337d58f96 18 Invoke `mbed compile` specifying the name of your platform and your favorite toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the ARM Compiler 5:
maclobdell 0:207337d58f96 19
maclobdell 0:207337d58f96 20 ```
maclobdell 0:207337d58f96 21 mbed compile -m K64F -t ARM
maclobdell 0:207337d58f96 22 ```
maclobdell 0:207337d58f96 23
maclobdell 0:207337d58f96 24 Your PC may take a few minutes to compile your code. At the end you should get the following result:
maclobdell 0:207337d58f96 25
maclobdell 0:207337d58f96 26 ```
maclobdell 0:207337d58f96 27 [snip]
maclobdell 0:207337d58f96 28 +----------------------------+-------+-------+------+
maclobdell 0:207337d58f96 29 | Module | .text | .data | .bss |
maclobdell 0:207337d58f96 30 +----------------------------+-------+-------+------+
maclobdell 0:207337d58f96 31 | Misc | 13939 | 24 | 1372 |
maclobdell 0:207337d58f96 32 | core/hal | 16993 | 96 | 296 |
maclobdell 0:207337d58f96 33 | core/rtos | 7384 | 92 | 4204 |
maclobdell 0:207337d58f96 34 | features/FEATURE_IPV4 | 80 | 0 | 176 |
maclobdell 0:207337d58f96 35 | frameworks/greentea-client | 1830 | 60 | 44 |
maclobdell 0:207337d58f96 36 | frameworks/utest | 2392 | 512 | 292 |
maclobdell 0:207337d58f96 37 | Subtotals | 42618 | 784 | 6384 |
maclobdell 0:207337d58f96 38 +----------------------------+-------+-------+------+
maclobdell 0:207337d58f96 39 Allocated Heap: unknown
maclobdell 0:207337d58f96 40 Allocated Stack: unknown
maclobdell 0:207337d58f96 41 Total Static RAM memory (data + bss): 7168 bytes
maclobdell 0:207337d58f96 42 Total RAM memory (data + bss + heap + stack): 7168 bytes
maclobdell 0:207337d58f96 43 Total Flash memory (text + data + misc): 43402 bytes
maclobdell 0:207337d58f96 44 Image: .\.build\K64F\ARM\mbed-os-example-blinky.bin
maclobdell 0:207337d58f96 45 ```
maclobdell 0:207337d58f96 46
maclobdell 0:207337d58f96 47 ### Program your board
maclobdell 0:207337d58f96 48
maclobdell 0:207337d58f96 49 1. Connect your mbed device to the computer over USB.
maclobdell 0:207337d58f96 50 1. Copy the binary file to the mbed device .
maclobdell 0:207337d58f96 51 1. Press the reset button to start the program.
maclobdell 0:207337d58f96 52
maclobdell 0:207337d58f96 53 You should see the LED of your platform turning on and off.
maclobdell 0:207337d58f96 54
maclobdell 0:207337d58f96 55 Congratulations if you managed to complete this test!
maclobdell 0:207337d58f96 56
maclobdell 0:207337d58f96 57 ## Export the project to Keil MDK and debug your application
maclobdell 0:207337d58f96 58
maclobdell 0:207337d58f96 59 From the command line, run the following command:
maclobdell 0:207337d58f96 60
maclobdell 0:207337d58f96 61 ```
maclobdell 0:207337d58f96 62 mbed export -m K64F -i uvision
maclobdell 0:207337d58f96 63 ```
maclobdell 0:207337d58f96 64
maclobdell 0:207337d58f96 65 You should see the following output:
maclobdell 0:207337d58f96 66
maclobdell 0:207337d58f96 67 ```
maclobdell 0:207337d58f96 68 Successful exports:
maclobdell 0:207337d58f96 69 * K64F::uvision .\projectfiles\uvision_K64F\Unnamed_Project
maclobdell 0:207337d58f96 70 ```
maclobdell 0:207337d58f96 71
maclobdell 0:207337d58f96 72 To debug the application:
maclobdell 0:207337d58f96 73
maclobdell 0:207337d58f96 74 1. Start uVision.
maclobdell 0:207337d58f96 75 1. Import the uVision project generated earlier.
maclobdell 0:207337d58f96 76 1. Compile your application and generate an `.axf` file.
maclobdell 0:207337d58f96 77 1. Make sure uVision is configured to debug over CMSIS-DAP (From the Project menu > Options for Target '...' > Debug tab > Use CMSIS-DAP Debugger).
maclobdell 0:207337d58f96 78 1. Set breakpoints and start a debug session.
maclobdell 0:207337d58f96 79
maclobdell 0:207337d58f96 80 ![Image of uVision](img/uvision.png)
maclobdell 0:207337d58f96 81
maclobdell 0:207337d58f96 82 ## Troubleshooting
maclobdell 0:207337d58f96 83
maclobdell 0:207337d58f96 84 1. Make sure `mbed-cli` is working correctly and its version is greater than `0.8.9`
maclobdell 0:207337d58f96 85
maclobdell 0:207337d58f96 86 ```
maclobdell 0:207337d58f96 87 mbed --version
maclobdell 0:207337d58f96 88 ```
maclobdell 0:207337d58f96 89
maclobdell 0:207337d58f96 90 If not, you can update it easily:
maclobdell 0:207337d58f96 91
maclobdell 0:207337d58f96 92 ```
maclobdell 0:207337d58f96 93 pip install mbed-cli --upgrade
maclobdell 0:207337d58f96 94 ```
maclobdell 0:207337d58f96 95
maclobdell 0:207337d58f96 96 2. If using Keil MDK, make sure you have a license installed. [MDK-Lite](http://www.keil.com/arm/mdk.asp) has a 32KB restriction on code size.