ST
/
example-IDW01M1-mbed-Cloud-connect
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
README.md@11:d7295caf706a, 2018-02-14 (annotated)
- Committer:
- MarceloSalazar
- Date:
- Wed Feb 14 13:22:50 2018 +0000
- Revision:
- 11:d7295caf706a
- Parent:
- 9:f965dcece9b5
Simplified mbed_app.json config
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| MarceloSalazar |
8:2dc39d9489de | 1 | # Simple Mbed Cloud Client application |
| MarceloSalazar |
8:2dc39d9489de | 2 | |
| MarceloSalazar |
8:2dc39d9489de | 3 | ### Overview |
| MarceloSalazar |
8:2dc39d9489de | 4 | |
| MarceloSalazar |
8:2dc39d9489de | 5 | This is a reference application for platform vendors. It demonstrates how to create a simple Mbed Cloud Client application that can connect to Mbed Cloud, register resources and get ready to receive a firmware update. |
| MarceloSalazar |
8:2dc39d9489de | 6 | |
| MarceloSalazar |
8:2dc39d9489de | 7 | It's intenteded to be forked and customized to add platform specific features (sensors, actuators) and configure the connectivity and storage to work **out-of-the-box**. |
| MarceloSalazar |
8:2dc39d9489de | 8 | The Simple Mbed Cloud Client application is intended to work in **developer mode** only. For production considerations, please read the following [document]. |
| MarceloSalazar |
8:2dc39d9489de | 9 | |
| MarceloSalazar |
8:2dc39d9489de | 10 | ### Setup process |
| MarceloSalazar |
8:2dc39d9489de | 11 | |
| MarceloSalazar |
8:2dc39d9489de | 12 | This is a summary of the process for developers to get started and get a device connected to Mbed Cloud. |
| MarceloSalazar |
8:2dc39d9489de | 13 | |
| MarceloSalazar |
8:2dc39d9489de | 14 | #### Mbed Online IDE |
| MarceloSalazar |
8:2dc39d9489de | 15 | |
| MarceloSalazar |
8:2dc39d9489de | 16 | - Import application into the Online IDE |
| MarceloSalazar |
8:2dc39d9489de | 17 | - Add API key to stablish connection to Mbed Cloud |
| MarceloSalazar |
8:2dc39d9489de | 18 | - Install developer certificate |
| MarceloSalazar |
8:2dc39d9489de | 19 | - Compile & program |
| MarceloSalazar |
8:2dc39d9489de | 20 | |
| MarceloSalazar |
8:2dc39d9489de | 21 | #### Mbed CLI tools |
| MarceloSalazar |
8:2dc39d9489de | 22 | |
| MarceloSalazar |
8:2dc39d9489de | 23 | - Import application in developer's desktop: |
| MarceloSalazar |
8:2dc39d9489de | 24 | |
| MarceloSalazar |
8:2dc39d9489de | 25 | ``` |
| MarceloSalazar |
8:2dc39d9489de | 26 | mbed import https://github.com/ARMmbed/simple-mbed-cloud-client-example |
| MarceloSalazar |
8:2dc39d9489de | 27 | cd simple-mbed-cloud-client-example |
| MarceloSalazar |
8:2dc39d9489de | 28 | ``` |
| MarceloSalazar |
8:2dc39d9489de | 29 | - Download developer certificate from Mbed Cloud |
| MarceloSalazar |
8:2dc39d9489de | 30 | |
| MarceloSalazar |
8:2dc39d9489de | 31 | - Compile & program |
| MarceloSalazar |
8:2dc39d9489de | 32 | |
| MarceloSalazar |
8:2dc39d9489de | 33 | ``` |
| MarceloSalazar |
8:2dc39d9489de | 34 | mbed compile -t <toolchain> -m <target> -c -f |
| MarceloSalazar |
8:2dc39d9489de | 35 | ``` |
| MarceloSalazar |
8:2dc39d9489de | 36 | |
| MarceloSalazar |
8:2dc39d9489de | 37 | ### Porting to a new platform |
| MarceloSalazar |
8:2dc39d9489de | 38 | |
| MarceloSalazar |
8:2dc39d9489de | 39 | The hardware requirements for Mbed OS platforms to support Mbed Cloud Client as shown [here]. |
| MarceloSalazar |
8:2dc39d9489de | 40 | This template application works with the [FRDM-K64F](https://os.mbed.com/platforms/FRDM-K64F/) platform by default. |
| MarceloSalazar |
8:2dc39d9489de | 41 | |
| MarceloSalazar |
8:2dc39d9489de | 42 | However, adding a new platform requires the following: |
| MarceloSalazar |
8:2dc39d9489de | 43 | |
| MarceloSalazar |
8:2dc39d9489de | 44 | - Fork the template and create an example application for your platform in https://os.mbed.com |
| MarceloSalazar |
8:2dc39d9489de | 45 | - Modify `mbed_app.json` with corresponding addresses to match your platform memory map. |
| MarceloSalazar |
8:2dc39d9489de | 46 | |
| MarceloSalazar |
8:2dc39d9489de | 47 | ``` |
| MarceloSalazar |
8:2dc39d9489de | 48 | "K64F": { |
| MarceloSalazar |
8:2dc39d9489de | 49 | "target.mbed_app_start": "0x00020400", |
| MarceloSalazar |
8:2dc39d9489de | 50 | "update-client.application-details": "0x00020000", |
| MarceloSalazar |
8:2dc39d9489de | 51 | "update-client.bootloader-details": "0x172e4" |
| MarceloSalazar |
8:2dc39d9489de | 52 | } |
| MarceloSalazar |
8:2dc39d9489de | 53 | ``` |
| MarceloSalazar |
8:2dc39d9489de | 54 | - [Optional] Change connectivity interface. By default uses Ethernet. See lines [xxx]. |
| MarceloSalazar |
8:2dc39d9489de | 55 | - [Optional] Change the filesystem and/or the block device for storage. By default uses FAT filesystem over SD card. See lines [xxx]. |
| MarceloSalazar |
8:2dc39d9489de | 56 | - Create a [bootloader binary](TBD) according to addresses specified in `mbed_app.json`. The booloader has to use the same storage configuration specified in the application. |
| MarceloSalazar |
8:2dc39d9489de | 57 | |
| MarceloSalazar |
8:2dc39d9489de | 58 | ### Known issues |
| MarceloSalazar |
8:2dc39d9489de | 59 | |
| MarceloSalazar |
8:2dc39d9489de | 60 | None. |
| MarceloSalazar |
8:2dc39d9489de | 61 |
