Mbed OS Device Management example for various ST boards.

DEPRECATED

This example application is not maintained and not recommended. It uses an old version of Mbed OS, Pelion DM and Arm toolchain. It doesn't work with Mbed Studio.

Please use: https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-pelion/

This example is known to work great on the following platforms:

  • DISCO_L475E_IOT01A - onboard WiFI and onboard QSPI flash. Board specific example using onboard sensors is available here.
  • DISCO_F413H - onboard WiFI and onboard QSPI flash.
  • DISCO_F469NI - WizFi310 WiFI shield and onboard QSPI flash (see WiFi shield instructions).
  • DISCO_F746NG - onboard Ethernet and using onboard QSPI flash.
  • DISCO_F769NI - onboard Ethernet and using onboard QSPI flash.
  • DISCO_L496AG - WizFi310 WiFI shield and onboard QSPI flash (see WiFi shield instructions).
  • NUCLEO_F207ZG - onboard Ethernet and wired SD card (SD card wiring instructions).
  • NUCLEO_F412ZG - WizFi310 WiFI shield and SD card shield (see WiFi shield instructions).
  • NUCLEO_F429ZI - onboard Ethernet and wired SD card (SD card wiring instructions).
  • NUCLEO_F746ZG - onboard Ethernet and wired SD card (SD card wiring instructions).
  • NUCLEO_F767ZI - onboard Ethernet and wired SD card (SD card wiring instructions).
  • NUCLEO_L476RG - WizFi310 WiFI shield and SD card shield (see WiFi shield instructions).
  • NUCLEO_L496ZG - WizFi310 WiFI shield and SD card shield (see WiFi shield instructions).
  • NUCLEO_L4R5ZI - WizFi310 WiFI shield and SD card shield (see WiFi shield instructions).

Follow the Quick-Start instructions: https://cloud.mbed.com/quick-start

DISCO_L475E_IOT01A DISCO_F413H DISCO_F746NG NUCLEO_F429ZI, NUCLEO_F767ZI, NUCLEO_F746ZG,NUCLEO_F207ZG

Example functionality

This example showcases the following device functionality:

  • Read ADC temperature and ADC vref, and report them as Pelion LWM2M resources (see image below).
  • On user button click, increment Pelion LWM2M button resource.
  • Allow the user to change the state of the board LED from Pelion LWM2M led_state resource and PUT request.

/media/uploads/screamer/pelion_st_adc_reading.png

SD card wiring

The ST Nucleo family of boards don't have storage onboard and therefore you will need an SD card. A limitation on ST Nucleo 144 boards is that there's a conflict between Ethernet and SPI pins on Arduino D11. Due to this, the SD card must be wired to different SPI bus that doesn't conflict with other functionality. The image below provide instructions on how to wire an SD card to a non-conflicting SPI instance.

/media/uploads/screamer/st_nucleo_144_sd.jpeg?v=4

If you are not a first-time Pelion Device Management user your device's SD card may already have connect and update certificates on it. If this is the case, remove and manually format your micro SD card, flash the binary to the device and then re-insert your micro SD card.

WiFi shield setup/wiring

Some ST Nucleo and Discovery boards don't have IP connectivity option, but bundled with a WiFi shield, they can take benefit of full device management capabilities. See links to reference images below on how to wire WizFI310 WiFi shield and/or SD card shield:

Use this example with Mbed CLI

1. Import the application into your desktop:

mbed import /teams/ST/code/pelion-example-common

cd pelion-example-common

2. Install the CLOUD_SDK_API_KEY

mbed config -G CLOUD_SDK_API_KEY <PELION_DM_API_KEY>

For instructions on how to generate your API key, please see the documentation.

3. Initialize firmware credentials (done once per repository). You can use the following command:

mbed dm init -d "<your company name in Pelion DM>" --model-name "<product model identifier>" -q --force

If above command do not work for your Mbed CLI, please consider upgrading Mbed CLI to version 1.8.x or above.

4. Compile and program:

mbed compile -t <toolchain> -m <TARGET_BOARD>

(supported toolchains : GCC_ARM / ARM / IAR)

Committer:
screamer
Date:
Wed Mar 27 18:17:34 2019 +0000
Revision:
25:d8a84856bd96
Parent:
0:ea30ba97a865
Improve inline documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:ea30ba97a865 1 Apache License
screamer 0:ea30ba97a865 2 Version 2.0, January 2004
screamer 0:ea30ba97a865 3 http://www.apache.org/licenses/
screamer 0:ea30ba97a865 4
screamer 0:ea30ba97a865 5 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
screamer 0:ea30ba97a865 6
screamer 0:ea30ba97a865 7 1. Definitions.
screamer 0:ea30ba97a865 8
screamer 0:ea30ba97a865 9 "License" shall mean the terms and conditions for use, reproduction, and
screamer 0:ea30ba97a865 10 distribution as defined by Sections 1 through 9 of this document.
screamer 0:ea30ba97a865 11
screamer 0:ea30ba97a865 12 "Licensor" shall mean the copyright owner or entity authorized by the copyright
screamer 0:ea30ba97a865 13 owner that is granting the License.
screamer 0:ea30ba97a865 14
screamer 0:ea30ba97a865 15 "Legal Entity" shall mean the union of the acting entity and all other entities
screamer 0:ea30ba97a865 16 that control, are controlled by, or are under common control with that entity.
screamer 0:ea30ba97a865 17 For the purposes of this definition, "control" means (i) the power, direct or
screamer 0:ea30ba97a865 18 indirect, to cause the direction or management of such entity, whether by
screamer 0:ea30ba97a865 19 contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
screamer 0:ea30ba97a865 20 outstanding shares, or (iii) beneficial ownership of such entity.
screamer 0:ea30ba97a865 21
screamer 0:ea30ba97a865 22 "You" (or "Your") shall mean an individual or Legal Entity exercising
screamer 0:ea30ba97a865 23 permissions granted by this License.
screamer 0:ea30ba97a865 24
screamer 0:ea30ba97a865 25 "Source" form shall mean the preferred form for making modifications, including
screamer 0:ea30ba97a865 26 but not limited to software source code, documentation source, and configuration
screamer 0:ea30ba97a865 27 files.
screamer 0:ea30ba97a865 28
screamer 0:ea30ba97a865 29 "Object" form shall mean any form resulting from mechanical transformation or
screamer 0:ea30ba97a865 30 translation of a Source form, including but not limited to compiled object code,
screamer 0:ea30ba97a865 31 generated documentation, and conversions to other media types.
screamer 0:ea30ba97a865 32
screamer 0:ea30ba97a865 33 "Work" shall mean the work of authorship, whether in Source or Object form, made
screamer 0:ea30ba97a865 34 available under the License, as indicated by a copyright notice that is included
screamer 0:ea30ba97a865 35 in or attached to the work (an example is provided in the Appendix below).
screamer 0:ea30ba97a865 36
screamer 0:ea30ba97a865 37 "Derivative Works" shall mean any work, whether in Source or Object form, that
screamer 0:ea30ba97a865 38 is based on (or derived from) the Work and for which the editorial revisions,
screamer 0:ea30ba97a865 39 annotations, elaborations, or other modifications represent, as a whole, an
screamer 0:ea30ba97a865 40 original work of authorship. For the purposes of this License, Derivative Works
screamer 0:ea30ba97a865 41 shall not include works that remain separable from, or merely link (or bind by
screamer 0:ea30ba97a865 42 name) to the interfaces of, the Work and Derivative Works thereof.
screamer 0:ea30ba97a865 43
screamer 0:ea30ba97a865 44 "Contribution" shall mean any work of authorship, including the original version
screamer 0:ea30ba97a865 45 of the Work and any modifications or additions to that Work or Derivative Works
screamer 0:ea30ba97a865 46 thereof, that is intentionally submitted to Licensor for inclusion in the Work
screamer 0:ea30ba97a865 47 by the copyright owner or by an individual or Legal Entity authorized to submit
screamer 0:ea30ba97a865 48 on behalf of the copyright owner. For the purposes of this definition,
screamer 0:ea30ba97a865 49 "submitted" means any form of electronic, verbal, or written communication sent
screamer 0:ea30ba97a865 50 to the Licensor or its representatives, including but not limited to
screamer 0:ea30ba97a865 51 communication on electronic mailing lists, source code control systems, and
screamer 0:ea30ba97a865 52 issue tracking systems that are managed by, or on behalf of, the Licensor for
screamer 0:ea30ba97a865 53 the purpose of discussing and improving the Work, but excluding communication
screamer 0:ea30ba97a865 54 that is conspicuously marked or otherwise designated in writing by the copyright
screamer 0:ea30ba97a865 55 owner as "Not a Contribution."
screamer 0:ea30ba97a865 56
screamer 0:ea30ba97a865 57 "Contributor" shall mean Licensor and any individual or Legal Entity on behalf
screamer 0:ea30ba97a865 58 of whom a Contribution has been received by Licensor and subsequently
screamer 0:ea30ba97a865 59 incorporated within the Work.
screamer 0:ea30ba97a865 60
screamer 0:ea30ba97a865 61 2. Grant of Copyright License.
screamer 0:ea30ba97a865 62
screamer 0:ea30ba97a865 63 Subject to the terms and conditions of this License, each Contributor hereby
screamer 0:ea30ba97a865 64 grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
screamer 0:ea30ba97a865 65 irrevocable copyright license to reproduce, prepare Derivative Works of,
screamer 0:ea30ba97a865 66 publicly display, publicly perform, sublicense, and distribute the Work and such
screamer 0:ea30ba97a865 67 Derivative Works in Source or Object form.
screamer 0:ea30ba97a865 68
screamer 0:ea30ba97a865 69 3. Grant of Patent License.
screamer 0:ea30ba97a865 70
screamer 0:ea30ba97a865 71 Subject to the terms and conditions of this License, each Contributor hereby
screamer 0:ea30ba97a865 72 grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
screamer 0:ea30ba97a865 73 irrevocable (except as stated in this section) patent license to make, have
screamer 0:ea30ba97a865 74 made, use, offer to sell, sell, import, and otherwise transfer the Work, where
screamer 0:ea30ba97a865 75 such license applies only to those patent claims licensable by such Contributor
screamer 0:ea30ba97a865 76 that are necessarily infringed by their Contribution(s) alone or by combination
screamer 0:ea30ba97a865 77 of their Contribution(s) with the Work to which such Contribution(s) was
screamer 0:ea30ba97a865 78 submitted. If You institute patent litigation against any entity (including a
screamer 0:ea30ba97a865 79 cross-claim or counterclaim in a lawsuit) alleging that the Work or a
screamer 0:ea30ba97a865 80 Contribution incorporated within the Work constitutes direct or contributory
screamer 0:ea30ba97a865 81 patent infringement, then any patent licenses granted to You under this License
screamer 0:ea30ba97a865 82 for that Work shall terminate as of the date such litigation is filed.
screamer 0:ea30ba97a865 83
screamer 0:ea30ba97a865 84 4. Redistribution.
screamer 0:ea30ba97a865 85
screamer 0:ea30ba97a865 86 You may reproduce and distribute copies of the Work or Derivative Works thereof
screamer 0:ea30ba97a865 87 in any medium, with or without modifications, and in Source or Object form,
screamer 0:ea30ba97a865 88 provided that You meet the following conditions:
screamer 0:ea30ba97a865 89
screamer 0:ea30ba97a865 90 You must give any other recipients of the Work or Derivative Works a copy of
screamer 0:ea30ba97a865 91 this License; and
screamer 0:ea30ba97a865 92 You must cause any modified files to carry prominent notices stating that You
screamer 0:ea30ba97a865 93 changed the files; and
screamer 0:ea30ba97a865 94 You must retain, in the Source form of any Derivative Works that You distribute,
screamer 0:ea30ba97a865 95 all copyright, patent, trademark, and attribution notices from the Source form
screamer 0:ea30ba97a865 96 of the Work, excluding those notices that do not pertain to any part of the
screamer 0:ea30ba97a865 97 Derivative Works; and
screamer 0:ea30ba97a865 98 If the Work includes a "NOTICE" text file as part of its distribution, then any
screamer 0:ea30ba97a865 99 Derivative Works that You distribute must include a readable copy of the
screamer 0:ea30ba97a865 100 attribution notices contained within such NOTICE file, excluding those notices
screamer 0:ea30ba97a865 101 that do not pertain to any part of the Derivative Works, in at least one of the
screamer 0:ea30ba97a865 102 following places: within a NOTICE text file distributed as part of the
screamer 0:ea30ba97a865 103 Derivative Works; within the Source form or documentation, if provided along
screamer 0:ea30ba97a865 104 with the Derivative Works; or, within a display generated by the Derivative
screamer 0:ea30ba97a865 105 Works, if and wherever such third-party notices normally appear. The contents of
screamer 0:ea30ba97a865 106 the NOTICE file are for informational purposes only and do not modify the
screamer 0:ea30ba97a865 107 License. You may add Your own attribution notices within Derivative Works that
screamer 0:ea30ba97a865 108 You distribute, alongside or as an addendum to the NOTICE text from the Work,
screamer 0:ea30ba97a865 109 provided that such additional attribution notices cannot be construed as
screamer 0:ea30ba97a865 110 modifying the License.
screamer 0:ea30ba97a865 111 You may add Your own copyright statement to Your modifications and may provide
screamer 0:ea30ba97a865 112 additional or different license terms and conditions for use, reproduction, or
screamer 0:ea30ba97a865 113 distribution of Your modifications, or for any such Derivative Works as a whole,
screamer 0:ea30ba97a865 114 provided Your use, reproduction, and distribution of the Work otherwise complies
screamer 0:ea30ba97a865 115 with the conditions stated in this License.
screamer 0:ea30ba97a865 116
screamer 0:ea30ba97a865 117 5. Submission of Contributions.
screamer 0:ea30ba97a865 118
screamer 0:ea30ba97a865 119 Unless You explicitly state otherwise, any Contribution intentionally submitted
screamer 0:ea30ba97a865 120 for inclusion in the Work by You to the Licensor shall be under the terms and
screamer 0:ea30ba97a865 121 conditions of this License, without any additional terms or conditions.
screamer 0:ea30ba97a865 122 Notwithstanding the above, nothing herein shall supersede or modify the terms of
screamer 0:ea30ba97a865 123 any separate license agreement you may have executed with Licensor regarding
screamer 0:ea30ba97a865 124 such Contributions.
screamer 0:ea30ba97a865 125
screamer 0:ea30ba97a865 126 6. Trademarks.
screamer 0:ea30ba97a865 127
screamer 0:ea30ba97a865 128 This License does not grant permission to use the trade names, trademarks,
screamer 0:ea30ba97a865 129 service marks, or product names of the Licensor, except as required for
screamer 0:ea30ba97a865 130 reasonable and customary use in describing the origin of the Work and
screamer 0:ea30ba97a865 131 reproducing the content of the NOTICE file.
screamer 0:ea30ba97a865 132
screamer 0:ea30ba97a865 133 7. Disclaimer of Warranty.
screamer 0:ea30ba97a865 134
screamer 0:ea30ba97a865 135 Unless required by applicable law or agreed to in writing, Licensor provides the
screamer 0:ea30ba97a865 136 Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
screamer 0:ea30ba97a865 137 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
screamer 0:ea30ba97a865 138 including, without limitation, any warranties or conditions of TITLE,
screamer 0:ea30ba97a865 139 NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
screamer 0:ea30ba97a865 140 solely responsible for determining the appropriateness of using or
screamer 0:ea30ba97a865 141 redistributing the Work and assume any risks associated with Your exercise of
screamer 0:ea30ba97a865 142 permissions under this License.
screamer 0:ea30ba97a865 143
screamer 0:ea30ba97a865 144 8. Limitation of Liability.
screamer 0:ea30ba97a865 145
screamer 0:ea30ba97a865 146 In no event and under no legal theory, whether in tort (including negligence),
screamer 0:ea30ba97a865 147 contract, or otherwise, unless required by applicable law (such as deliberate
screamer 0:ea30ba97a865 148 and grossly negligent acts) or agreed to in writing, shall any Contributor be
screamer 0:ea30ba97a865 149 liable to You for damages, including any direct, indirect, special, incidental,
screamer 0:ea30ba97a865 150 or consequential damages of any character arising as a result of this License or
screamer 0:ea30ba97a865 151 out of the use or inability to use the Work (including but not limited to
screamer 0:ea30ba97a865 152 damages for loss of goodwill, work stoppage, computer failure or malfunction, or
screamer 0:ea30ba97a865 153 any and all other commercial damages or losses), even if such Contributor has
screamer 0:ea30ba97a865 154 been advised of the possibility of such damages.
screamer 0:ea30ba97a865 155
screamer 0:ea30ba97a865 156 9. Accepting Warranty or Additional Liability.
screamer 0:ea30ba97a865 157
screamer 0:ea30ba97a865 158 While redistributing the Work or Derivative Works thereof, You may choose to
screamer 0:ea30ba97a865 159 offer, and charge a fee for, acceptance of support, warranty, indemnity, or
screamer 0:ea30ba97a865 160 other liability obligations and/or rights consistent with this License. However,
screamer 0:ea30ba97a865 161 in accepting such obligations, You may act only on Your own behalf and on Your
screamer 0:ea30ba97a865 162 sole responsibility, not on behalf of any other Contributor, and only if You
screamer 0:ea30ba97a865 163 agree to indemnify, defend, and hold each Contributor harmless for any liability
screamer 0:ea30ba97a865 164 incurred by, or claims asserted against, such Contributor by reason of your
screamer 0:ea30ba97a865 165 accepting any such warranty or additional liability.