Pelion example for WIZnet IoT Shield with BG96 Cat.M1, K6xF board (SK telecom network in Korea)

Dependencies:   FXAS21002 FXOS8700Q

Overview

This document is based on https://os.mbed.com/teams/NXP/code/pelion-example-frdm/ and the code forked Daniel_Lee's BG96_K6xF_pelion-example-frdm repository and added some features. Need a WIZnet IoT Shield BG96 board and development board.

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

/media/uploads/hkjung/wiznetiotshield_bg96_frdm-k64f_separate.png /media/uploads/hkjung/wiznetiotshield_bg96_frdm-k64f_stacking.png

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

Requirement

  1. FRDM-K64F or FRDM-K66F
  2. WIZnet IoT Shield BG96 board
  3. USIM card

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.

1. Import the application into your desktop:

mbed import https://os.mbed.com/users/hkjung/code/BG96_K6xF_pelion-example-frdm/
 
cd BG96_K6xF_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 the above command does 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

6. If successfully connect to cellular networks(SK Telecom) then you can get below message

[BOOT] Mbed Bootloader
[BOOT] ARM: 00000000000000000000
[BOOT] OEM: 00000000000000000000
[BOOT] Layout: 0 83A8
[BOOT] Active firmware integrity check:
[BOOT] SHA256: 76F082FDFF2C0E6C64A76DCF8957773A14B4146629424A0C7F71858788F24521
[BOOT] Version: 1556777151
[BOOT] Slot 0 is empty
[BOOT] Active firmware up-to-date
[BOOT] Application's start address: 0x10400
[BOOT] Application's jump address: 0x10B11
[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

Connecting to the network using the default network interface...
Connected to the network successfully. IP address: 000:000:000:000
Initializing Pelion Device Management Client...
Initialized Pelion Device Management Client. Registering...
Press the user button to increment the LwM2M resource value...
Registered to Pelion Device Management. Endpoint Name: xx Your Endpoint Name xx

FXOS8700Q mag:    0.903 x,  -0.073 y,   0.477 z [gauss]
FXOS8700Q acc:   -1.143 x,  -2.459 y,   3.316 z [g]
Committer:
hkjung
Date:
Thu May 02 06:12:45 2019 +0000
Revision:
8:28b898a501b4
Parent:
7:c249d4c9dcad
Added hardware reset function for WIZnet IoT Shield BG96

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:a9d53048f0b6 1 {
screamer 0:a9d53048f0b6 2 "target_overrides": {
screamer 0:a9d53048f0b6 3 "*": {
Daniel_Lee 7:c249d4c9dcad 4 "target.network-default-interface-type" : "CELLULAR",
screamer 0:a9d53048f0b6 5 "platform.stdio-baud-rate" : 115200,
screamer 0:a9d53048f0b6 6 "platform.stdio-convert-newlines" : true,
screamer 0:a9d53048f0b6 7 "mbed-trace.enable" : null,
Daniel_Lee 7:c249d4c9dcad 8 "target.features_add" : ["LWIP"],
Daniel_Lee 7:c249d4c9dcad 9 "lwip.ipv4-enabled" : false,
Daniel_Lee 7:c249d4c9dcad 10 "lwip.ipv6-enabled" : true,
Daniel_Lee 7:c249d4c9dcad 11 "lwip.ethernet-enabled" : false,
Daniel_Lee 7:c249d4c9dcad 12 "lwip.ppp-enabled" : false,
Daniel_Lee 7:c249d4c9dcad 13 "lwip.tcp-enabled" : true,
Daniel_Lee 7:c249d4c9dcad 14 "platform.default-serial-baud-rate" : 115200,
Daniel_Lee 7:c249d4c9dcad 15 "platform.stdio-buffered-serial" : true,
Daniel_Lee 7:c249d4c9dcad 16 "cellular.debug-at" : false,
Daniel_Lee 7:c249d4c9dcad 17 "nsapi.default-cellular-plmn" : 0,
Daniel_Lee 7:c249d4c9dcad 18 "nsapi.default-cellular-sim-pin" : "\"1234\"",
Daniel_Lee 7:c249d4c9dcad 19 "nsapi.default-cellular-apn" : "\"lte-internet.sktelecom.com\"",
Daniel_Lee 7:c249d4c9dcad 20 "nsapi.default-cellular-username" : 0,
Daniel_Lee 7:c249d4c9dcad 21 "nsapi.default-cellular-password" : 0,
Daniel_Lee 7:c249d4c9dcad 22 "QUECTEL_BG96.tx" : "D1",
Daniel_Lee 7:c249d4c9dcad 23 "QUECTEL_BG96.rx" : "D0",
Daniel_Lee 7:c249d4c9dcad 24 "QUECTEL_BG96.provide-default" : true
screamer 0:a9d53048f0b6 25 },
screamer 0:a9d53048f0b6 26 "K64F": {
screamer 0:a9d53048f0b6 27 "target.components_add" : ["SD"],
screamer 0:a9d53048f0b6 28 "device-management.flash-start-address" : "0x0",
screamer 0:a9d53048f0b6 29 "device-management.flash-size" : "(1024*1024)",
screamer 0:a9d53048f0b6 30 "device-management.sotp-section-1-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(4*1024))",
screamer 0:a9d53048f0b6 31 "device-management.sotp-section-1-size" : "(4*1024)",
screamer 0:a9d53048f0b6 32 "device-management.sotp-section-2-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(4*1024))",
screamer 0:a9d53048f0b6 33 "device-management.sotp-section-2-size" : "(4*1024)",
screamer 0:a9d53048f0b6 34 "update-client.application-details" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)",
screamer 0:a9d53048f0b6 35 "update-client.storage-address" : "(64*1024*1024)",
screamer 0:a9d53048f0b6 36 "update-client.storage-size" : "(2*1024*1024)",
screamer 0:a9d53048f0b6 37 "update-client.storage-locations" : "1",
screamer 0:a9d53048f0b6 38 "target.features_add" : ["BOOTLOADER"],
screamer 0:a9d53048f0b6 39 "target.bootloader_img" : "bootloader/mbed-bootloader-K64F.bin",
screamer 0:a9d53048f0b6 40 "target.header_offset" : "0x10000",
screamer 0:a9d53048f0b6 41 "target.app_offset" : "0x10400",
screamer 0:a9d53048f0b6 42 "button-pressed-state" : 0
screamer 0:a9d53048f0b6 43 },
screamer 0:a9d53048f0b6 44 "K66F": {
screamer 0:a9d53048f0b6 45 "target.components_add" : ["SD"],
screamer 0:a9d53048f0b6 46 "device-management.flash-start-address" : "0x0",
screamer 0:a9d53048f0b6 47 "device-management.flash-size" : "(2048*1024)",
screamer 0:a9d53048f0b6 48 "device-management.sotp-section-1-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(4*1024))",
screamer 0:a9d53048f0b6 49 "device-management.sotp-section-1-size" : "(4*1024)",
screamer 0:a9d53048f0b6 50 "device-management.sotp-section-2-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(4*1024))",
screamer 0:a9d53048f0b6 51 "device-management.sotp-section-2-size" : "(4*1024)",
screamer 0:a9d53048f0b6 52 "update-client.application-details" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)",
screamer 0:a9d53048f0b6 53 "update-client.storage-address" : "(64*1024*1024)",
screamer 0:a9d53048f0b6 54 "update-client.storage-size" : "(2*1024*1024)",
screamer 0:a9d53048f0b6 55 "update-client.storage-locations" : "1",
screamer 0:a9d53048f0b6 56 "target.features_add" : ["BOOTLOADER"],
screamer 0:a9d53048f0b6 57 "target.bootloader_img" : "bootloader/mbed-bootloader-K66F.bin",
screamer 0:a9d53048f0b6 58 "target.header_offset" : "0x10000",
screamer 0:a9d53048f0b6 59 "target.app_offset" : "0x10400",
screamer 0:a9d53048f0b6 60 "button-pressed-state" : 0
screamer 0:a9d53048f0b6 61 }
screamer 0:a9d53048f0b6 62 },
screamer 0:a9d53048f0b6 63 "config": {
screamer 0:a9d53048f0b6 64 "format-storage-layer-on-error": {
screamer 0:a9d53048f0b6 65 "help": "Whether to format the storage layer when it cannot be read - always disable for production devices!",
screamer 0:a9d53048f0b6 66 "value": 1
screamer 0:a9d53048f0b6 67 },
screamer 0:a9d53048f0b6 68 "main-stack-size": {
screamer 0:a9d53048f0b6 69 "value": 6000
screamer 0:a9d53048f0b6 70 },
screamer 0:a9d53048f0b6 71 "use-button": {
screamer 0:a9d53048f0b6 72 "help": "Whether the target has a button",
screamer 0:a9d53048f0b6 73 "macro_name": "USE_BUTTON",
screamer 0:a9d53048f0b6 74 "value": true
screamer 0:a9d53048f0b6 75 },
screamer 0:a9d53048f0b6 76 "button-pressed-state": {
screamer 0:a9d53048f0b6 77 "help": "Value of the button when pressed",
screamer 0:a9d53048f0b6 78 "value": 1
screamer 0:a9d53048f0b6 79 },
screamer 0:a9d53048f0b6 80 "no_led": {
screamer 0:a9d53048f0b6 81 "help": "This flag disables the heartbeat thread in tests. This is useful for platforms that don't have an LED or the LED is used for other functionality like LED on the SPI clockline etc",
screamer 0:a9d53048f0b6 82 "value": null
screamer 0:a9d53048f0b6 83 },
screamer 0:a9d53048f0b6 84 "tests-fs-size": {
screamer 0:a9d53048f0b6 85 "help": "Maximum size of the file system used for tests",
screamer 0:a9d53048f0b6 86 "value": null
screamer 0:a9d53048f0b6 87 }
screamer 0:a9d53048f0b6 88 }
Daniel_Lee 7:c249d4c9dcad 89 }