ST / Mbed OS pelion-example-common

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)

mbed_app.json@0:ea30ba97a865, 2018-12-10 (annotated)

Committer:
screamer
Date:
Mon Dec 10 20:14:17 2018 +0000
Revision:
0:ea30ba97a865
Child:
9:734c08f4e486
Initial revision

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:ea30ba97a865 1 {
screamer 0:ea30ba97a865 2 "macros": [
screamer 0:ea30ba97a865 3 "ARM_UC_USE_PAL_BLOCKDEVICE=1",
screamer 0:ea30ba97a865 4 "MBED_CLOUD_CLIENT_UPDATE_STORAGE=ARM_UCP_FLASHIAP_BLOCKDEVICE",
screamer 0:ea30ba97a865 5 "MBED_CLIENT_USER_CONFIG_FILE=\"mbed_cloud_client_user_config.h\"",
screamer 0:ea30ba97a865 6 "MBED_CLOUD_CLIENT_USER_CONFIG_FILE=\"mbed_cloud_client_user_config.h\"",
screamer 0:ea30ba97a865 7 "PAL_USER_DEFINED_CONFIGURATION=\"sotp_fs_config_MbedOS.h\"",
screamer 0:ea30ba97a865 8 "PAL_FS_MOUNT_POINT_PRIMARY=\"/fs\"",
screamer 0:ea30ba97a865 9 "MBEDTLS_USER_CONFIG_FILE=\"mbedTLSConfig_mbedOS.h\"",
screamer 0:ea30ba97a865 10 "PAL_DTLS_PEER_MIN_TIMEOUT=5000"
screamer 0:ea30ba97a865 11 ],
screamer 0:ea30ba97a865 12 "target_overrides": {
screamer 0:ea30ba97a865 13 "*": {
screamer 0:ea30ba97a865 14 "platform.stdio-baud-rate" : 115200,
screamer 0:ea30ba97a865 15 "platform.stdio-convert-newlines" : true,
screamer 0:ea30ba97a865 16 "update-client.storage-address" : "(1024*1024*64)",
screamer 0:ea30ba97a865 17 "update-client.storage-size" : "(1024*1024*2)",
screamer 0:ea30ba97a865 18 "update-client.storage-locations" : "1",
screamer 0:ea30ba97a865 19 "mbed-trace.enable" : null,
screamer 0:ea30ba97a865 20 "nsapi.default-wifi-security" : "WPA_WPA2",
screamer 0:ea30ba97a865 21 "nsapi.default-wifi-ssid" : "\"\"",
screamer 0:ea30ba97a865 22 "nsapi.default-wifi-password" : "\"\""
screamer 0:ea30ba97a865 23 },
screamer 0:ea30ba97a865 24 "NUCLEO_F429ZI": {
screamer 0:ea30ba97a865 25 "target.features_add" : ["BOOTLOADER"],
screamer 0:ea30ba97a865 26 "target.components_add" : ["SD"],
screamer 0:ea30ba97a865 27 "sd.SPI_MOSI" : "PE_6",
screamer 0:ea30ba97a865 28 "sd.SPI_MISO" : "PE_5",
screamer 0:ea30ba97a865 29 "sd.SPI_CLK" : "PE_2",
screamer 0:ea30ba97a865 30 "sd.SPI_CS" : "PE_4",
screamer 0:ea30ba97a865 31 "flash-start-address" : "0x08000000",
screamer 0:ea30ba97a865 32 "flash-size" : "(2048*1024)",
screamer 0:ea30ba97a865 33 "sotp-section-1-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(128*1024))",
screamer 0:ea30ba97a865 34 "sotp-section-1-size" : "(128*1024)",
screamer 0:ea30ba97a865 35 "sotp-section-2-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(128*1024))",
screamer 0:ea30ba97a865 36 "sotp-section-2-size" : "(128*1024)",
screamer 0:ea30ba97a865 37 "sotp-num-sections" : 2,
screamer 0:ea30ba97a865 38 "target.bootloader_img" : "bootloader/mbed-bootloader-NUCLEO_F429ZI.bin",
screamer 0:ea30ba97a865 39 "target.header_offset" : "0x10000",
screamer 0:ea30ba97a865 40 "target.app_offset" : "0x10400",
screamer 0:ea30ba97a865 41 "update-client.application-details" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)"
screamer 0:ea30ba97a865 42 },
screamer 0:ea30ba97a865 43 "NUCLEO_F767ZI": {
screamer 0:ea30ba97a865 44 "target.features_add" : ["BOOTLOADER"],
screamer 0:ea30ba97a865 45 "target.components_add" : ["SD"],
screamer 0:ea30ba97a865 46 "sd.SPI_MOSI" : "PE_6",
screamer 0:ea30ba97a865 47 "sd.SPI_MISO" : "PE_5",
screamer 0:ea30ba97a865 48 "sd.SPI_CLK" : "PE_2",
screamer 0:ea30ba97a865 49 "sd.SPI_CS" : "PE_4",
screamer 0:ea30ba97a865 50 "flash-start-address" : "0x08000000",
screamer 0:ea30ba97a865 51 "flash-size" : "(2048*1024)",
screamer 0:ea30ba97a865 52 "sotp-section-1-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(256*1024))",
screamer 0:ea30ba97a865 53 "sotp-section-1-size" : "(256*1024)",
screamer 0:ea30ba97a865 54 "sotp-section-2-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(256*1024))",
screamer 0:ea30ba97a865 55 "sotp-section-2-size" : "(256*1024)",
screamer 0:ea30ba97a865 56 "sotp-num-sections" : 2,
screamer 0:ea30ba97a865 57 "target.bootloader_img" : "bootloader/mbed-bootloader-NUCLEO_F767ZI.bin",
screamer 0:ea30ba97a865 58 "target.header_offset" : "0x10000",
screamer 0:ea30ba97a865 59 "target.app_offset" : "0x10400",
screamer 0:ea30ba97a865 60 "update-client.application-details" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)"
screamer 0:ea30ba97a865 61 },
screamer 0:ea30ba97a865 62 "NUCLEO_F746ZG": {
screamer 0:ea30ba97a865 63 "target.features_add" : ["BOOTLOADER"],
screamer 0:ea30ba97a865 64 "target.components_add" : ["SD"],
screamer 0:ea30ba97a865 65 "sd.SPI_MOSI" : "PE_6",
screamer 0:ea30ba97a865 66 "sd.SPI_MISO" : "PE_5",
screamer 0:ea30ba97a865 67 "sd.SPI_CLK" : "PE_2",
screamer 0:ea30ba97a865 68 "sd.SPI_CS" : "PE_4",
screamer 0:ea30ba97a865 69 "flash-start-address" : "0x08000000",
screamer 0:ea30ba97a865 70 "flash-size" : "(1024*1024)",
screamer 0:ea30ba97a865 71 "sotp-section-1-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(256*1024))",
screamer 0:ea30ba97a865 72 "sotp-section-1-size" : "(256*1024)",
screamer 0:ea30ba97a865 73 "sotp-section-2-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(256*1024))",
screamer 0:ea30ba97a865 74 "sotp-section-2-size" : "(256*1024)",
screamer 0:ea30ba97a865 75 "sotp-num-sections" : 2,
screamer 0:ea30ba97a865 76 "target.bootloader_img" : "bootloader/mbed-bootloader-NUCLEO_F746ZG.bin",
screamer 0:ea30ba97a865 77 "target.header_offset" : "0x10000",
screamer 0:ea30ba97a865 78 "target.app_offset" : "0x10400",
screamer 0:ea30ba97a865 79 "update-client.application-details" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)"
screamer 0:ea30ba97a865 80 },
screamer 0:ea30ba97a865 81 "DISCO_L475VG_IOT01A": {
screamer 0:ea30ba97a865 82 "target.features_add" : ["BOOTLOADER"],
screamer 0:ea30ba97a865 83 "target.components_add" : ["QSPIF"],
screamer 0:ea30ba97a865 84 "target.components_remove" : ["FLASHIAP"],
screamer 0:ea30ba97a865 85 "target.extra_labels_add" : ["WIFI_ISM43362"],
screamer 0:ea30ba97a865 86 "target.network-default-interface-type" : "WIFI",
screamer 0:ea30ba97a865 87 "flash-start-address" : "0x08000000",
screamer 0:ea30ba97a865 88 "flash-size" : "(1024*1024)",
screamer 0:ea30ba97a865 89 "sotp-section-1-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(2*1024))",
screamer 0:ea30ba97a865 90 "sotp-section-1-size" : "(2*1024)",
screamer 0:ea30ba97a865 91 "sotp-section-2-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(2*1024))",
screamer 0:ea30ba97a865 92 "sotp-section-2-size" : "(2*1024)",
screamer 0:ea30ba97a865 93 "sotp-num-sections" : 2,
screamer 0:ea30ba97a865 94 "target.bootloader_img" : "bootloader/mbed-bootloader-DISCO_L475VG_IOT01A.bin",
screamer 0:ea30ba97a865 95 "target.header_offset" : "0x10000",
screamer 0:ea30ba97a865 96 "target.app_offset" : "0x10400",
screamer 0:ea30ba97a865 97 "update-client.application-details" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)",
screamer 0:ea30ba97a865 98 "update-client.storage-address" : "(1024*1024*2)",
screamer 0:ea30ba97a865 99 "update-client.storage-size" : "(1024*1024*2)",
screamer 0:ea30ba97a865 100 "update-client.storage-locations" : 1
screamer 0:ea30ba97a865 101 },
screamer 0:ea30ba97a865 102 "DISCO_F413ZH": {
screamer 0:ea30ba97a865 103 "target.features_add" : ["BOOTLOADER"],
screamer 0:ea30ba97a865 104 "target.extra_labels_add" : ["WIFI_ISM43362"],
screamer 0:ea30ba97a865 105 "target.components_add" : ["QSPIF"],
screamer 0:ea30ba97a865 106 "target.network-default-interface-type" : "WIFI",
screamer 0:ea30ba97a865 107 "flash-start-address" : "0x08000000",
screamer 0:ea30ba97a865 108 "flash-size" : "(1536*1024)",
screamer 0:ea30ba97a865 109 "sotp-section-1-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(128*1024))",
screamer 0:ea30ba97a865 110 "sotp-section-1-size" : "(128*1024)",
screamer 0:ea30ba97a865 111 "sotp-section-2-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(128*1024))",
screamer 0:ea30ba97a865 112 "sotp-section-2-size" : "(128*1024)",
screamer 0:ea30ba97a865 113 "sotp-num-sections" : 2,
screamer 0:ea30ba97a865 114 "target.bootloader_img" : "bootloader/mbed-bootloader-DISCO_F413ZH.bin",
screamer 0:ea30ba97a865 115 "target.header_offset" : "0x10000",
screamer 0:ea30ba97a865 116 "target.app_offset" : "0x10400",
screamer 0:ea30ba97a865 117 "update-client.application-details" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)",
screamer 0:ea30ba97a865 118 "update-client.storage-address" : "(1024*1024*2)",
screamer 0:ea30ba97a865 119 "update-client.storage-size" : "(1024*1024*2)",
screamer 0:ea30ba97a865 120 "update-client.storage-locations" : 1
screamer 0:ea30ba97a865 121 }
screamer 0:ea30ba97a865 122 },
screamer 0:ea30ba97a865 123 "config": {
screamer 0:ea30ba97a865 124 "format-storage-layer-on-error": {
screamer 0:ea30ba97a865 125 "help": "Whether to format the storage layer when it cannot be read - always disable for production devices!",
screamer 0:ea30ba97a865 126 "value": 1
screamer 0:ea30ba97a865 127 },
screamer 0:ea30ba97a865 128 "developer-mode": {
screamer 0:ea30ba97a865 129 "help": "Enable Developer mode to skip Factory enrollment",
screamer 0:ea30ba97a865 130 "value": 1
screamer 0:ea30ba97a865 131 },
screamer 0:ea30ba97a865 132 "main-stack-size": {
screamer 0:ea30ba97a865 133 "value": 6000
screamer 0:ea30ba97a865 134 },
screamer 0:ea30ba97a865 135 "flash-start-address": {
screamer 0:ea30ba97a865 136 "help": "Start address of internal flash. Only used in this config to help the definition of other macros.",
screamer 0:ea30ba97a865 137 "value": null
screamer 0:ea30ba97a865 138 },
screamer 0:ea30ba97a865 139 "flash-size": {
screamer 0:ea30ba97a865 140 "help": "Total size of internal flash. Only used in this config to help the definition of other macros.",
screamer 0:ea30ba97a865 141 "value": null
screamer 0:ea30ba97a865 142 },
screamer 0:ea30ba97a865 143 "sotp-section-1-address": {
screamer 0:ea30ba97a865 144 "help": "Flash sector address for SOTP sector 1",
screamer 0:ea30ba97a865 145 "macro_name": "PAL_INTERNAL_FLASH_SECTION_1_ADDRESS",
screamer 0:ea30ba97a865 146 "value": null
screamer 0:ea30ba97a865 147 },
screamer 0:ea30ba97a865 148 "sotp-section-1-size": {
screamer 0:ea30ba97a865 149 "help": "Flash sector size for SOTP sector 1",
screamer 0:ea30ba97a865 150 "macro_name": "PAL_INTERNAL_FLASH_SECTION_1_SIZE",
screamer 0:ea30ba97a865 151 "value": null
screamer 0:ea30ba97a865 152 },
screamer 0:ea30ba97a865 153 "sotp-section-2-address": {
screamer 0:ea30ba97a865 154 "help": "Flash sector address for SOTP sector 2",
screamer 0:ea30ba97a865 155 "macro_name": "PAL_INTERNAL_FLASH_SECTION_2_ADDRESS",
screamer 0:ea30ba97a865 156 "value": null
screamer 0:ea30ba97a865 157 },
screamer 0:ea30ba97a865 158 "sotp-section-2-size": {
screamer 0:ea30ba97a865 159 "help": "Flash sector size for SOTP sector 2",
screamer 0:ea30ba97a865 160 "macro_name": "PAL_INTERNAL_FLASH_SECTION_2_SIZE",
screamer 0:ea30ba97a865 161 "value": null
screamer 0:ea30ba97a865 162 },
screamer 0:ea30ba97a865 163 "sotp-num-sections": {
screamer 0:ea30ba97a865 164 "help": "Number of SOTP sections",
screamer 0:ea30ba97a865 165 "macro_name": "PAL_INT_FLASH_NUM_SECTIONS",
screamer 0:ea30ba97a865 166 "value": null
screamer 0:ea30ba97a865 167 }
screamer 0:ea30ba97a865 168 }
screamer 0:ea30ba97a865 169 }