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)

drivers/storage/MySystemStorage.cpp@0:ea30ba97a865, 2018-12-10 (annotated)

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:ea30ba97a865 1 /*
screamer 0:ea30ba97a865 2 * Copyright (c) 2018 ARM Limited. All rights reserved.
screamer 0:ea30ba97a865 3 * SPDX-License-Identifier: Apache-2.0
screamer 0:ea30ba97a865 4 * Licensed under the Apache License, Version 2.0 (the License); you may
screamer 0:ea30ba97a865 5 * not use this file except in compliance with the License.
screamer 0:ea30ba97a865 6 * You may obtain a copy of the License at
screamer 0:ea30ba97a865 7 *
screamer 0:ea30ba97a865 8 * http://www.apache.org/licenses/LICENSE-2.0
screamer 0:ea30ba97a865 9 *
screamer 0:ea30ba97a865 10 * Unless required by applicable law or agreed to in writing, software
screamer 0:ea30ba97a865 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
screamer 0:ea30ba97a865 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:ea30ba97a865 13 * See the License for the specific language governing permissions and
screamer 0:ea30ba97a865 14 * limitations under the License.
screamer 0:ea30ba97a865 15 */
screamer 0:ea30ba97a865 16 #include "BlockDevice.h"
screamer 0:ea30ba97a865 17 #include "FileSystem.h"
screamer 0:ea30ba97a865 18 #include "FATFileSystem.h"
screamer 0:ea30ba97a865 19 #include "LittleFileSystem.h"
screamer 0:ea30ba97a865 20
screamer 0:ea30ba97a865 21 #if COMPONENT_SPIF
screamer 0:ea30ba97a865 22 #include "SPIFBlockDevice.h"
screamer 0:ea30ba97a865 23 #endif
screamer 0:ea30ba97a865 24
screamer 0:ea30ba97a865 25 #if COMPONENT_QSPIF
screamer 0:ea30ba97a865 26 #include "QSPIFBlockDevice.h"
screamer 0:ea30ba97a865 27 #endif
screamer 0:ea30ba97a865 28
screamer 0:ea30ba97a865 29 #if COMPONENT_DATAFLASH
screamer 0:ea30ba97a865 30 #include "DataFlashBlockDevice.h"
screamer 0:ea30ba97a865 31 #endif
screamer 0:ea30ba97a865 32
screamer 0:ea30ba97a865 33 #if COMPONENT_SD
screamer 0:ea30ba97a865 34 #include "SDBlockDevice.h"
screamer 0:ea30ba97a865 35 #endif
screamer 0:ea30ba97a865 36
screamer 0:ea30ba97a865 37 #if COMPONENT_FLASHIAP
screamer 0:ea30ba97a865 38 #include "FlashIAPBlockDevice.h"
screamer 0:ea30ba97a865 39 #endif
screamer 0:ea30ba97a865 40
screamer 0:ea30ba97a865 41 #if COMPONENT_NUSD
screamer 0:ea30ba97a865 42 #include "NuSDBlockDevice.h"
screamer 0:ea30ba97a865 43 #endif
screamer 0:ea30ba97a865 44
screamer 0:ea30ba97a865 45 using namespace mbed;
screamer 0:ea30ba97a865 46
screamer 0:ea30ba97a865 47 // Align a value to a specified size.
screamer 0:ea30ba97a865 48 // Parameters :
screamer 0:ea30ba97a865 49 // val - [IN] Value.
screamer 0:ea30ba97a865 50 // size - [IN] Size.
screamer 0:ea30ba97a865 51 // Return : Aligned value.
screamer 0:ea30ba97a865 52 static inline uint32_t align_up(uint32_t val, uint32_t size)
screamer 0:ea30ba97a865 53 {
screamer 0:ea30ba97a865 54 return (((val - 1) / size) + 1) * size;
screamer 0:ea30ba97a865 55 }
screamer 0:ea30ba97a865 56
screamer 0:ea30ba97a865 57 BlockDevice *BlockDevice::get_default_instance()
screamer 0:ea30ba97a865 58 {
screamer 0:ea30ba97a865 59 #if COMPONENT_SPIF
screamer 0:ea30ba97a865 60
screamer 0:ea30ba97a865 61 static SPIFBlockDevice default_bd(
screamer 0:ea30ba97a865 62 MBED_CONF_SPIF_DRIVER_SPI_MOSI,
screamer 0:ea30ba97a865 63 MBED_CONF_SPIF_DRIVER_SPI_MISO,
screamer 0:ea30ba97a865 64 MBED_CONF_SPIF_DRIVER_SPI_CLK,
screamer 0:ea30ba97a865 65 MBED_CONF_SPIF_DRIVER_SPI_CS,
screamer 0:ea30ba97a865 66 MBED_CONF_SPIF_DRIVER_SPI_FREQ
screamer 0:ea30ba97a865 67 );
screamer 0:ea30ba97a865 68
screamer 0:ea30ba97a865 69 return &default_bd;
screamer 0:ea30ba97a865 70
screamer 0:ea30ba97a865 71 #elif COMPONENT_QSPIF
screamer 0:ea30ba97a865 72
screamer 0:ea30ba97a865 73 static QSPIFBlockDevice default_bd(
screamer 0:ea30ba97a865 74 MBED_CONF_QSPIF_QSPI_IO0,
screamer 0:ea30ba97a865 75 MBED_CONF_QSPIF_QSPI_IO1,
screamer 0:ea30ba97a865 76 MBED_CONF_QSPIF_QSPI_IO2,
screamer 0:ea30ba97a865 77 MBED_CONF_QSPIF_QSPI_IO3,
screamer 0:ea30ba97a865 78 MBED_CONF_QSPIF_QSPI_SCK,
screamer 0:ea30ba97a865 79 MBED_CONF_QSPIF_QSPI_CSN,
screamer 0:ea30ba97a865 80 MBED_CONF_QSPIF_QSPI_POLARITY_MODE,
screamer 0:ea30ba97a865 81 MBED_CONF_QSPIF_QSPI_FREQ
screamer 0:ea30ba97a865 82 );
screamer 0:ea30ba97a865 83
screamer 0:ea30ba97a865 84 return &default_bd;
screamer 0:ea30ba97a865 85
screamer 0:ea30ba97a865 86 #elif COMPONENT_DATAFLASH
screamer 0:ea30ba97a865 87
screamer 0:ea30ba97a865 88 static DataFlashBlockDevice default_bd(
screamer 0:ea30ba97a865 89 MBED_CONF_DATAFLASH_SPI_MOSI,
screamer 0:ea30ba97a865 90 MBED_CONF_DATAFLASH_SPI_MISO,
screamer 0:ea30ba97a865 91 MBED_CONF_DATAFLASH_SPI_CLK,
screamer 0:ea30ba97a865 92 MBED_CONF_DATAFLASH_SPI_CS
screamer 0:ea30ba97a865 93 );
screamer 0:ea30ba97a865 94
screamer 0:ea30ba97a865 95 return &default_bd;
screamer 0:ea30ba97a865 96
screamer 0:ea30ba97a865 97 #elif COMPONENT_SD
screamer 0:ea30ba97a865 98
screamer 0:ea30ba97a865 99 static SDBlockDevice default_bd(
screamer 0:ea30ba97a865 100 MBED_CONF_SD_SPI_MOSI,
screamer 0:ea30ba97a865 101 MBED_CONF_SD_SPI_MISO,
screamer 0:ea30ba97a865 102 MBED_CONF_SD_SPI_CLK,
screamer 0:ea30ba97a865 103 MBED_CONF_SD_SPI_CS
screamer 0:ea30ba97a865 104 );
screamer 0:ea30ba97a865 105
screamer 0:ea30ba97a865 106 return &default_bd;
screamer 0:ea30ba97a865 107
screamer 0:ea30ba97a865 108 #elif COMPONENT_NUSD
screamer 0:ea30ba97a865 109
screamer 0:ea30ba97a865 110 static NuSDBlockDevice default_bd;
screamer 0:ea30ba97a865 111
screamer 0:ea30ba97a865 112 return &default_bd;
screamer 0:ea30ba97a865 113
screamer 0:ea30ba97a865 114 #elif COMPONENT_FLASHIAP
screamer 0:ea30ba97a865 115
screamer 0:ea30ba97a865 116 #if (MBED_CONF_FLASHIAP_BLOCK_DEVICE_SIZE == 0) && (MBED_CONF_FLASHIAP_BLOCK_DEVICE_BASE_ADDRESS == 0xFFFFFFFF)
screamer 0:ea30ba97a865 117
screamer 0:ea30ba97a865 118 size_t flash_size;
screamer 0:ea30ba97a865 119 uint32_t start_address;
screamer 0:ea30ba97a865 120 uint32_t bottom_address;
screamer 0:ea30ba97a865 121 FlashIAP flash;
screamer 0:ea30ba97a865 122
screamer 0:ea30ba97a865 123 int ret = flash.init();
screamer 0:ea30ba97a865 124 if (ret != 0) {
screamer 0:ea30ba97a865 125 return 0;
screamer 0:ea30ba97a865 126 }
screamer 0:ea30ba97a865 127
screamer 0:ea30ba97a865 128 //Find the start of first sector after text area
screamer 0:ea30ba97a865 129 bottom_address = align_up(FLASHIAP_ROM_END, flash.get_sector_size(FLASHIAP_ROM_END));
screamer 0:ea30ba97a865 130 start_address = flash.get_flash_start();
screamer 0:ea30ba97a865 131 flash_size = flash.get_flash_size();
screamer 0:ea30ba97a865 132
screamer 0:ea30ba97a865 133 ret = flash.deinit();
screamer 0:ea30ba97a865 134
screamer 0:ea30ba97a865 135 static FlashIAPBlockDevice default_bd(bottom_address, start_address + flash_size - bottom_address);
screamer 0:ea30ba97a865 136
screamer 0:ea30ba97a865 137 #else
screamer 0:ea30ba97a865 138
screamer 0:ea30ba97a865 139 static FlashIAPBlockDevice default_bd;
screamer 0:ea30ba97a865 140
screamer 0:ea30ba97a865 141 #endif
screamer 0:ea30ba97a865 142
screamer 0:ea30ba97a865 143 return &default_bd;
screamer 0:ea30ba97a865 144
screamer 0:ea30ba97a865 145 #else
screamer 0:ea30ba97a865 146
screamer 0:ea30ba97a865 147 return NULL;
screamer 0:ea30ba97a865 148
screamer 0:ea30ba97a865 149 #endif
screamer 0:ea30ba97a865 150
screamer 0:ea30ba97a865 151 }
screamer 0:ea30ba97a865 152
screamer 0:ea30ba97a865 153 FileSystem *FileSystem::get_default_instance()
screamer 0:ea30ba97a865 154 {
screamer 0:ea30ba97a865 155 #if COMPONENT_SPIF || COMPONENT_QSPIF || COMPONENT_DATAFLASH || COMPONENT_NUSD
screamer 0:ea30ba97a865 156
screamer 0:ea30ba97a865 157 static LittleFileSystem flash("flash", BlockDevice::get_default_instance());
screamer 0:ea30ba97a865 158 flash.set_as_default();
screamer 0:ea30ba97a865 159
screamer 0:ea30ba97a865 160 return &flash;
screamer 0:ea30ba97a865 161
screamer 0:ea30ba97a865 162 #elif COMPONENT_SD
screamer 0:ea30ba97a865 163
screamer 0:ea30ba97a865 164 static FATFileSystem sdcard("sd", BlockDevice::get_default_instance());
screamer 0:ea30ba97a865 165 sdcard.set_as_default();
screamer 0:ea30ba97a865 166
screamer 0:ea30ba97a865 167 return &sdcard;
screamer 0:ea30ba97a865 168
screamer 0:ea30ba97a865 169 #elif COMPONENT_FLASHIAP
screamer 0:ea30ba97a865 170
screamer 0:ea30ba97a865 171 static LittleFileSystem flash("flash", BlockDevice::get_default_instance());
screamer 0:ea30ba97a865 172 flash.set_as_default();
screamer 0:ea30ba97a865 173
screamer 0:ea30ba97a865 174 return &flash;
screamer 0:ea30ba97a865 175
screamer 0:ea30ba97a865 176 #else
screamer 0:ea30ba97a865 177
screamer 0:ea30ba97a865 178 return NULL;
screamer 0:ea30ba97a865 179
screamer 0:ea30ba97a865 180 #endif
screamer 0:ea30ba97a865 181
screamer 0:ea30ba97a865 182 }