NXP / Mbed OS pelion-example-frdm

Mbed OS and Pelion Device Management example for FRDM-K64F and FRDM-K66F boards

Dependencies:   FXAS21002 FXOS8700Q

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

  • FRDM-K64F - onboard Ethernet and onboard SD card holder.
  • FRDM-K66F - onboard Ethernet and onboard SD card holder.

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

FRDM-K64F FRDM-K66F

Example functionality

This example showcases the following device functionality:

  • Read onboard FXOS8700Q accelerometer and magnetometer, and report the values as Pelion LWM2M resources (see image below).
  • (FRDM-K66F only) Read onboard FXAS21002 gyroscope and report the values as Pelion LWM2M resources.
  • 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_humidity_reading.png?v=2

Use this example with Mbed CLI

1. Import the application into your desktop:

mbed import https://os.mbed.com/teams/NXP/code/pelion-example-frdm

cd pelion-example-frdm

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.9.x or above.

4. Compile and program:

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

(supported toolchains : GCC_ARM / ARM / IAR)

5. You can connect on a virtual terminal/COM port to the platform using:

mbed sterm -b 115200

This should give you an output similar to:

[BOOT] Mbed Bootloader
[BOOT] ARM: 00000000000000000000
[BOOT] OEM: 00000000000000000000
[BOOT] Layout: 0 8374
[BOOT] Active firmware integrity check:
[BOOT] SHA256: 411F422DE8FF545E2D3C373E87D5328162A129314A655AEC32B9A167DE29177E
[BOOT] Version: 1553606618
[BOOT] Slot 0 is empty
[BOOT] Active firmware up-to-date
[BOOT] Application's start address: 0x10400
[BOOT] Application's jump address: 0x112C1
[BOOT] Application's stack address: 0x20030000
[BOOT] Forwarding to application...


Starting Simple Pelion Device Management Client example
You can hold the user button during boot to format the storage and change the device identity.

Sensors configuration:
FXOS8700Q accelerometer = 0xC7
FXOS8700Q magnetometer  = 0xC7
FXAS21002 gyroscope     = 0xB7

Connecting to the network using the default network interface...
Connected to the network successfully. IP address: 10.2.202.65
Initializing Pelion Device Management Client...
Initialized Pelion Device Management Client. Registering...
Press the user button to increment the LwM2M resource value...

FXOS8700Q mag:    0.312 x,   0.039 y,  -1.625 z [gauss]
FXOS8700Q acc:    0.139 x,  -0.123 y,   4.260 z [g]
FXAS21002 gryo:  13.089 x,  13.089 y,  13.089 z [dps]

bootloader/bootloader_app.json@5:f2123dc31d30, 2019-03-27 (annotated)

Committer:
screamer
Date:
Wed Mar 27 17:49:40 2019 +0000
Revision:
5:f2123dc31d30
Parent:
0:a9d53048f0b6 
Improve inline documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:a9d53048f0b6 1 {
screamer 0:a9d53048f0b6 2 "macros": [
screamer 0:a9d53048f0b6 3 "MBEDTLS_USER_CONFIG_FILE=\"bootloader_mbedtls_user_config.h\"",
screamer 0:a9d53048f0b6 4 "SHOW_PROGRESS_BAR=0",
screamer 0:a9d53048f0b6 5 "MAX_COPY_RETRIES=1",
screamer 0:a9d53048f0b6 6 "MAX_BOOT_RETRIES=3",
screamer 0:a9d53048f0b6 7 "ARM_BOOTLOADER_USE_NVSTORE_ROT=1",
screamer 0:a9d53048f0b6 8 "ARM_UC_USE_PAL_CRYPTO=0",
screamer 0:a9d53048f0b6 9 "ARM_UC_USE_PAL_BLOCKDEVICE=1",
screamer 0:a9d53048f0b6 10 "ARM_UC_PAAL_TRACE_ENABLE=0",
screamer 0:a9d53048f0b6 11 "ARM_UC_PROFILE_MBED_CLOUD_CLIENT=1",
screamer 0:a9d53048f0b6 12 "ARM_UC_FEATURE_CRYPTO_PAL=0",
screamer 0:a9d53048f0b6 13 "ARM_UC_FEATURE_CRYPTO_MBEDTLS=1",
screamer 0:a9d53048f0b6 14 "MBED_CLOUD_CLIENT_UPDATE_STORAGE=ARM_UCP_FLASHIAP_BLOCKDEVICE",
screamer 0:a9d53048f0b6 15 "DEFAULT_MAX_APPLICATION_SIZE=(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - MBED_CONF_APP_APPLICATION_START_ADDRESS - NVSTORE_AREA_1_SIZE - NVSTORE_AREA_2_SIZE)",
screamer 0:a9d53048f0b6 16 "DISABLE_ERROR_DESCRIPTION=1",
screamer 0:a9d53048f0b6 17 "Mutex=PlatformMutex"
screamer 0:a9d53048f0b6 18 ],
screamer 0:a9d53048f0b6 19 "config": {
screamer 0:a9d53048f0b6 20 "application-start-address": {
screamer 0:a9d53048f0b6 21 "help": "Address to the beginning of the active application firmware in flash",
screamer 0:a9d53048f0b6 22 "value": null
screamer 0:a9d53048f0b6 23 },
screamer 0:a9d53048f0b6 24 "application-jump-address": {
screamer 0:a9d53048f0b6 25 "help": "Jump address for running the active application firmware",
screamer 0:a9d53048f0b6 26 "value": null
screamer 0:a9d53048f0b6 27 },
screamer 0:a9d53048f0b6 28 "max-application-size": {
screamer 0:a9d53048f0b6 29 "help": "Maximum size of the active application",
screamer 0:a9d53048f0b6 30 "value": null
screamer 0:a9d53048f0b6 31 },
screamer 0:a9d53048f0b6 32 "flash-start-address": {
screamer 0:a9d53048f0b6 33 "help": "Start address of internal flash. Only used in this config to help the definition of other macros.",
screamer 0:a9d53048f0b6 34 "value": null
screamer 0:a9d53048f0b6 35 },
screamer 0:a9d53048f0b6 36 "flash-size": {
screamer 0:a9d53048f0b6 37 "help": "Total size of internal flash. Only used in this config to help the definition of other macros.",
screamer 0:a9d53048f0b6 38 "value": null
screamer 0:a9d53048f0b6 39 }
screamer 0:a9d53048f0b6 40 },
screamer 0:a9d53048f0b6 41 "target_overrides": {
screamer 0:a9d53048f0b6 42 "*": {
screamer 0:a9d53048f0b6 43 "target.features_remove" : ["LWIP"],
screamer 0:a9d53048f0b6 44 "target.features_add" : ["COMMON_PAL"],
screamer 0:a9d53048f0b6 45 "target.extra_labels_remove" : ["PSA"],
screamer 0:a9d53048f0b6 46 "target.components_remove" : ["FLASHIAP"],
screamer 0:a9d53048f0b6 47 "platform.stdio-baud-rate" : 115200,
screamer 0:a9d53048f0b6 48 "platform.stdio-flush-at-exit" : false
screamer 0:a9d53048f0b6 49 },
screamer 0:a9d53048f0b6 50 "K64F": {
screamer 0:a9d53048f0b6 51 "target.components_add" : ["SD"],
screamer 0:a9d53048f0b6 52 "flash-start-address" : "0x0",
screamer 0:a9d53048f0b6 53 "flash-size" : "(1024*1024)",
screamer 0:a9d53048f0b6 54 "nvstore.area_1_address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(4*1024))",
screamer 0:a9d53048f0b6 55 "nvstore.area_1_size" : "(4*1024)",
screamer 0:a9d53048f0b6 56 "nvstore.area_2_address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(4*1024))",
screamer 0:a9d53048f0b6 57 "nvstore.area_2_size" : "(4*1024)",
screamer 0:a9d53048f0b6 58 "update-client.storage-address" : "(64*1024*1024)",
screamer 0:a9d53048f0b6 59 "update-client.storage-size" : "(2*1024*1024)",
screamer 0:a9d53048f0b6 60 "update-client.storage-locations" : 1,
screamer 0:a9d53048f0b6 61 "update-client.firmware-header-version": "2",
screamer 0:a9d53048f0b6 62 "update-client.application-details": "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)",
screamer 0:a9d53048f0b6 63 "application-start-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 65*1024)",
screamer 0:a9d53048f0b6 64 "max-application-size" : "DEFAULT_MAX_APPLICATION_SIZE"
screamer 0:a9d53048f0b6 65 },
screamer 0:a9d53048f0b6 66 "K66F": {
screamer 0:a9d53048f0b6 67 "target.components_add" : ["SD"],
screamer 0:a9d53048f0b6 68 "flash-start-address" : "0x0",
screamer 0:a9d53048f0b6 69 "flash-size" : "(2048*1024)",
screamer 0:a9d53048f0b6 70 "nvstore.area_1_address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(4*1024))",
screamer 0:a9d53048f0b6 71 "nvstore.area_1_size" : "(4*1024)",
screamer 0:a9d53048f0b6 72 "nvstore.area_2_address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(4*1024))",
screamer 0:a9d53048f0b6 73 "nvstore.area_2_size" : "(4*1024)",
screamer 0:a9d53048f0b6 74 "update-client.storage-address" : "(64*1024*1024)",
screamer 0:a9d53048f0b6 75 "update-client.storage-size" : "(2*1024*1024)",
screamer 0:a9d53048f0b6 76 "update-client.storage-locations" : 1,
screamer 0:a9d53048f0b6 77 "update-client.firmware-header-version": "2",
screamer 0:a9d53048f0b6 78 "update-client.application-details": "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)",
screamer 0:a9d53048f0b6 79 "application-start-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 65*1024)",
screamer 0:a9d53048f0b6 80 "max-application-size" : "DEFAULT_MAX_APPLICATION_SIZE"
screamer 0:a9d53048f0b6 81 }
screamer 0:a9d53048f0b6 82 }
screamer 0:a9d53048f0b6 83 }