Specific Pelion ready example using features of Uhuru RAVEN board including Wi-Fi and SPI flash
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:
Uhuru RAVEN over Wi-Fi and using onboard SPI flash.
Follow the Quick-Start instructions: https://cloud.mbed.com/quick-start
Example functionality
This example showcases the following device functionality:
- Allow the user to change the state of the board LED from Pelion LWM2M led_state resource and PUT request.
Use this example with Mbed CLI
1. Import the application into your desktop:
mbed import https://os.mbed.com/teams/Uhuru/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.9.x or above.
Set SSID and password in the mbed_app.json.
"nsapi.default-wifi-ssid" : "\"SSID\"", "nsapi.default-wifi-password" : "\"Password\""
4. Compile and program:
mbed compile -t <toolchain> -m UHURU_RAVEN
(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] INFO: init - verified SFDP Signature and version Successfully [BOOT] DEBUG: Erase Type(A) 1 - Inst: 0xFFh, Size: 4096 [BOOT] INFO: Erase Type 1 - Inst: 0x20h, Size: 4096 [BOOT] DEBUG: Erase Type(A) 2 - Inst: 0xFFh, Size: 32768 [BOOT] INFO: Erase Type 2 - Inst: 0x52h, Size: 32768 [BOOT] DEBUG: Erase Type(A) 3 - Inst: 0xFFh, Size: 65536 [BOOT] INFO: Erase Type 3 - Inst: 0xD8h, Size: 65536 [BOOT] DEBUG: Erase Type(A) 4 - Inst: 0xFFh, Size: 1 [BOOT] INFO: Erase Type 4 - Inst: 0xFFh, Size: 1 [BOOT] Mbed Bootloader [BOOT] ARM: 00000000000000000000 [BOOT] OEM: 00000000000000000000 [BOOT] Layout: 0 80091E0 [BOOT] Active firmware integrity check: [BOOT] SHA256: DC87CF84F7064E58EF0FD011C1768ADFA4803BA1F6758808972680605CBB2C9B [BOOT] Version: 1558427552 [BOOT] INFO Read - Inst: 0x3h [BOOT] Slot 0 is empty [BOOT] Active firmware up-to-date [BOOT] Application's start address: 0x8010400 [BOOT] Application's jump address: 0x80108F9 [BOOT] Application's stack address: 0x20080000 [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. Connecting to the network using the default network interface... Connected to the network successfully. IP address: 192.168.11.20 Initializing Pelion Device Management Client... Initialized Pelion Device Management Client. Registering... Simulating button press every 5 seconds... Registered to Pelion Device Management. Endpoint Name: 016ad986878400000000000100xxxxxx Button clicked 1 times Button clicked 2 times Button clicked 3 times
Revision 0:16957896f9cd, committed 2019-05-21
- Comitter:
- MACRUM
- Date:
- Tue May 21 17:19:38 2019 +0900
- Commit message:
- initial commit
Changed in this revision
diff -r 000000000000 -r 16957896f9cd LICENSE.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/LICENSE.txt Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,165 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, "control" means (i) the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising +permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +"Object" form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +"submitted" means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +2. Grant of Copyright License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +3. Grant of Patent License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +You must give any other recipients of the Work or Derivative Works a copy of +this License; and +You must cause any modified files to carry prominent notices stating that You +changed the files; and +You must retain, in the Source form of any Derivative Works that You distribute, +all copyright, patent, trademark, and attribution notices from the Source form +of the Work, excluding those notices that do not pertain to any part of the +Derivative Works; and +If the Work includes a "NOTICE" text file as part of its distribution, then any +Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices +that do not pertain to any part of the Derivative Works, in at least one of the +following places: within a NOTICE text file distributed as part of the +Derivative Works; within the Source form or documentation, if provided along +with the Derivative Works; or, within a display generated by the Derivative +Works, if and wherever such third-party notices normally appear. The contents of +the NOTICE file are for informational purposes only and do not modify the +License. You may add Your own attribution notices within Derivative Works that +You distribute, alongside or as an addendum to the NOTICE text from the Work, +provided that such additional attribution notices cannot be construed as +modifying the License. +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +5. Submission of Contributions. + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +6. Trademarks. + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +8. Limitation of Liability. + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability.
diff -r 000000000000 -r 16957896f9cd README.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,162 @@ +# Pelion Device Ready example - template application + +(aka Simple Mbed Cloud Client template) + +## Overview + +This is a template application to showcase device management capabilities. It demonstrates how to create a simple application that can connect to the Pelion IoT Platform service, register resources and get ready to receive a firmware update. + +It's intended to be forked and customized to add platform-specific features (such as sensors and actuators) and configure the connectivity and storage to work **out-of-the-box**. The template application works in **developer mode** by default. + +There is a mirror version of the stable (master) template application on [this location](https://os.mbed.com/teams/mbed-os-examples/code/pelion-ready-example) to facilitate the fork and publish on https://os.mbed.com. + +## Board specific example applications + + There are a number of applications that make usage of the Simple Pelion DM Client library. + + The Pelion [Quick-Start](https://cloud.mbed.com/quick-start) is an initiative to support Mbed Partner's platforms while delivering a great User Experience to Mbed Developers. + +## Getting started with the application + +This is a summary of the process for developers to get started and get a device connected to Pelion Device Management. + +### Using Mbed Online IDE + +1. Import the application into the Online IDE. +2. Add the API key to establish connection. +3. Install the developer certificate. +4. Compile and program. + +### Using Mbed CLI + +1. Import the application into your desktop: + + ``` + mbed import https://github.com/ARMmbed/pelion-ready-example + cd pelion-ready-example + ``` + +2. Configure the API key for your Pelion Portal account. + + If you don't have an API key available, then login in [Pelion IoT Platform portal](https://portal.mbedcloud.com/), navigate to 'Access Management', 'API keys' and create a new one. Then specify the API key as global `mbed` configuration: + + ``` + mbed config -G CLOUD_SDK_API_KEY <your-api-key> + ``` + +3. Install the device management certificate: + + ``` + mbed dm init -d "company.com" --model-name "product-model" -q --force + ``` + +4. Compile and program: + + ``` + mbed compile -t <toolchain> -m <target> -f + ``` + +#### Update the application logic + +The template example uses a ticker object to periodically fire a software interrupt to simulate button presses. Let’s say you want to make an actual button press. + +By default, there is a Ticker object, which fires every five seconds and invokes a callback function: + +```cpp +Ticker timer; +timer.attach(eventQueue.event(&fake_button_press), 5.0); +``` + +This callback function changes the `button_res` resource: + +```cpp +void fake_button_press() { + int v = button_res->get_value_int() + 1; + + button_res->set_value(v); + + printf("Simulated button clicked %d times\n", v); +} +``` + +If you want to change this to an actual button, here is how to do it: + +1. Remove: + + ```cpp + Ticker timer; + timer.attach(eventQueue.event(&fake_button_press), 5.0); + ``` + +2. Declare an `InterruptIn` object on the button, and attach the callback function to the `fall` handler: + + ```cpp + InterruptIn btn(BUTTON1); + btn.fall(eventQueue.event(&fake_button_press), 5.0); + ``` + +3. Rename `fake_button_press` to `real_button_press`. + +## Enabling firmware updates + +Mbed OS 5.10 and Mbed CLI 1.9 simplifies the process to enable and perform Firmware Updates. Here is a summary on how to configure the device and verify its correct behaviour. + +For full documentation about bootloaders and firmware update, read the following documents: + +- [Introduccion to bootloaders](https://os.mbed.com/docs/latest/porting/bootloader.html) +- [Creating and using a bootloader](https://os.mbed.com/docs/latest/tutorials/bootloader.html) +- [Bootloader configuration in Mbed OS](https://os.mbed.com/docs/latest/tools/configuring-tools.html) +- [Mbed Bootloader for Pelion Device Management Client](https://github.com/ARMmbed/mbed-bootloader) +- [Updating devices with Arm Mbed CLI](https://os.mbed.com/docs/latest/tools/cli-update.html) + +This is a summary to use Arm Mbed OS managed bootloaders. + +#### Verifying that firmware update works + +Follow these steps to generate a manifest, compile and perform a firmware update of your device: + +1. Configure the API key for your Pelion account. + + If you don't have an API key available, then login in [Pelion IoT Platform portal](https://portal.mbedcloud.com/), navigate to 'Access Management', 'API keys' and create a new one. Then specify the API key as global `mbed` configuration: + + ``` + mbed config -G CLOUD_SDK_API_KEY <your-api-key> + ``` + +2. Initialize the device management feature: + + ``` + mbed dm init -d "company.com" --model-name "product-model" -q --force + ``` + +3. Compile the application, include the firware update credentials generated before, merge with the bootloader and program the device: + + ``` + mbed compile -t <toolchain> -m <target> -c -f + ``` + +4. Open a serial terminal, verify the application boots and is able to register to the Device Management service. Write down the `<endpoint ID>`, as it's required to identify the device to perform a firmware update. + +5. Update the firmware of the device through Mbed CLI: + + ``` + mbed dm update device -D <device ID> -t <toolchain> -m <target> + ``` + + Inspect the logs on the device to see the update progress. It should look similar to: + + ``` + Firmware download requested + Authorization granted + Downloading: [+++- ] 6 % + ``` + + When the download completes, the firmware is verified. If everything is OK, the firmware update is applied, the device reboots and attemps to connect to the Device Management service again. The `<endpoint ID>` should be preserved. + +## Automated testing + +The Simple Pelion Client provides Greentea tests to confirm your platform works as expected. The network and storage configuration is already defined in Mbed OS 5.10, but you may want to override the configuration in `mbed_app.json`. + +For details on Simple Pelion Client testing, refer to the documentation [here](https://github.com/ARMmbed/simple-mbed-cloud-client#testing). + +This template application contains a working application and tests passing for the `K64F` and `K66F` platforms.
diff -r 000000000000 -r 16957896f9cd bootloader/LICENSE --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bootloader/LICENSE Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,49 @@ +Permissive Binary License + +Version 1.0, September 2015 + +Redistribution. Redistribution and use in binary form, without +modification, are permitted provided that the following conditions are +met: + +1) Redistributions must reproduce the above copyright notice and the + following disclaimer in the documentation and/or other materials + provided with the distribution. + +2) Unless to the extent explicitly permitted by law, no reverse + engineering, decompilation, or disassembly of this software is + permitted. + +3) Redistribution as part of a software development kit must include the + accompanying file named "DEPENDENCIES" and any dependencies listed in + that file. + +4) Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +Limited patent license. The copyright holders (and contributors) grant a +worldwide, non-exclusive, no-charge, royalty-free patent license to +make, have made, use, offer to sell, sell, import, and otherwise +transfer this software, where such license applies only to those patent +claims licensable by the copyright holders (and contributors) that are +necessarily infringed by this software. This patent license shall not +apply to any combinations that include this software. No hardware is +licensed hereunder. + +If you institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the software +itself infringes your patent(s), then your rights granted under this +license shall terminate as of the date such litigation is filed. + +DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND +CONTRIBUTORS "AS IS." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT +NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file
diff -r 000000000000 -r 16957896f9cd bootloader/bootloader_app.json --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bootloader/bootloader_app.json Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,71 @@ +{ + "macros": [ + "MBEDTLS_USER_CONFIG_FILE=\"bootloader_mbedtls_user_config.h\"", + "SHOW_PROGRESS_BAR=0", + "MAX_COPY_RETRIES=1", + "MAX_BOOT_RETRIES=3", + "ARM_BOOTLOADER_USE_NVSTORE_ROT=1", + "ARM_UC_USE_PAL_CRYPTO=0", + "ARM_UC_USE_PAL_BLOCKDEVICE=1", + "ARM_UC_PAAL_TRACE_ENABLE=0", + "ARM_UC_PROFILE_MBED_CLOUD_CLIENT=1", + "ARM_UC_FEATURE_CRYPTO_PAL=0", + "ARM_UC_FEATURE_CRYPTO_MBEDTLS=1", + "MBED_CLOUD_CLIENT_UPDATE_STORAGE=ARM_UCP_FLASHIAP_BLOCKDEVICE", + "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)", + "DISABLE_ERROR_DESCRIPTION=1", + "Mutex=PlatformMutex" + ], + "config": { + "application-start-address": { + "help": "Address to the beginning of the active application firmware in flash", + "value": null + }, + "application-jump-address": { + "help": "Jump address for running the active application firmware", + "value": null + }, + "max-application-size": { + "help": "Maximum size of the active application", + "value": null + }, + "flash-start-address": { + "help": "Start address of internal flash. Only used in this config to help the definition of other macros.", + "value": null + }, + "flash-size": { + "help": "Total size of internal flash. Only used in this config to help the definition of other macros.", + "value": null + } + }, + "target_overrides": { + "*": { + "target.features_remove" : ["LWIP"], + "target.features_add" : ["COMMON_PAL"], + "target.extra_labels_remove" : ["PSA"], + "target.components_remove" : ["FLASHIAP"], + "platform.stdio-baud-rate" : 115200, + "platform.stdio-flush-at-exit" : false + }, + "UHURU_RAVEN": { + "target.components_add" : ["SPIF"], + "spif-driver.SPI_MOSI" : "PE_14", + "spif-driver.SPI_MISO" : "PE_13", + "spif-driver.SPI_CLK" : "PE_12", + "spif-driver.SPI_CS" : "PE_11", + "flash-start-address" : "0x08000000", + "flash-size" : "(2048*1024)", + "nvstore.area_1_address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(256*1024))", + "nvstore.area_1_size" : "(256*1024)", + "nvstore.area_2_address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(256*1024))", + "nvstore.area_2_size" : "(256*1024)", + "update-client.storage-address" : "(2*1024*1024)", + "update-client.storage-size" : "(2*1024*1024)", + "update-client.storage-locations" : 1, + "update-client.firmware-header-version": "2", + "update-client.application-details": "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)", + "application-start-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 65*1024)", + "max-application-size" : "DEFAULT_MAX_APPLICATION_SIZE" + } + } +}
diff -r 000000000000 -r 16957896f9cd bootloader/mbed-bootloader-UHURU_RAVEN.bin Binary file bootloader/mbed-bootloader-UHURU_RAVEN.bin has changed
diff -r 000000000000 -r 16957896f9cd drivers/network/COMPONENT_WIFI_ESP32.lib --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/drivers/network/COMPONENT_WIFI_ESP32.lib Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,1 @@ +https://github.com/ARMmbed/esp32-driver/#3b1f972d5c49ae9f8f945e41c5ebcd1ac820b0f0
diff -r 000000000000 -r 16957896f9cd drivers/storage/MySystemStorage.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/drivers/storage/MySystemStorage.cpp Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,182 @@ +/* + * Copyright (c) 2018 ARM Limited. All rights reserved. + * SPDX-License-Identifier: Apache-2.0 + * Licensed under the Apache License, Version 2.0 (the License); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an AS IS BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#include "BlockDevice.h" +#include "FileSystem.h" +#include "FATFileSystem.h" +#include "LittleFileSystem.h" + +#if COMPONENT_SPIF +#include "SPIFBlockDevice.h" +#endif + +#if COMPONENT_QSPIF +#include "QSPIFBlockDevice.h" +#endif + +#if COMPONENT_DATAFLASH +#include "DataFlashBlockDevice.h" +#endif + +#if COMPONENT_SD +#include "SDBlockDevice.h" +#endif + +#if COMPONENT_FLASHIAP +#include "FlashIAPBlockDevice.h" +#endif + +#if COMPONENT_NUSD +#include "NuSDBlockDevice.h" +#endif + +using namespace mbed; + +// Align a value to a specified size. +// Parameters : +// val - [IN] Value. +// size - [IN] Size. +// Return : Aligned value. +static inline uint32_t align_up(uint32_t val, uint32_t size) +{ + return (((val - 1) / size) + 1) * size; +} + +BlockDevice *BlockDevice::get_default_instance() +{ +#if COMPONENT_SPIF + + static SPIFBlockDevice default_bd( + MBED_CONF_SPIF_DRIVER_SPI_MOSI, + MBED_CONF_SPIF_DRIVER_SPI_MISO, + MBED_CONF_SPIF_DRIVER_SPI_CLK, + MBED_CONF_SPIF_DRIVER_SPI_CS, + MBED_CONF_SPIF_DRIVER_SPI_FREQ + ); + + return &default_bd; + +#elif COMPONENT_QSPIF + + static QSPIFBlockDevice default_bd( + MBED_CONF_QSPIF_QSPI_IO0, + MBED_CONF_QSPIF_QSPI_IO1, + MBED_CONF_QSPIF_QSPI_IO2, + MBED_CONF_QSPIF_QSPI_IO3, + MBED_CONF_QSPIF_QSPI_SCK, + MBED_CONF_QSPIF_QSPI_CSN, + MBED_CONF_QSPIF_QSPI_POLARITY_MODE, + MBED_CONF_QSPIF_QSPI_FREQ + ); + + return &default_bd; + +#elif COMPONENT_DATAFLASH + + static DataFlashBlockDevice default_bd( + MBED_CONF_DATAFLASH_SPI_MOSI, + MBED_CONF_DATAFLASH_SPI_MISO, + MBED_CONF_DATAFLASH_SPI_CLK, + MBED_CONF_DATAFLASH_SPI_CS + ); + + return &default_bd; + +#elif COMPONENT_SD + + static SDBlockDevice default_bd( + MBED_CONF_SD_SPI_MOSI, + MBED_CONF_SD_SPI_MISO, + MBED_CONF_SD_SPI_CLK, + MBED_CONF_SD_SPI_CS + ); + + return &default_bd; + +#elif COMPONENT_NUSD + + static NuSDBlockDevice default_bd; + + return &default_bd; + +#elif COMPONENT_FLASHIAP + +#if (MBED_CONF_FLASHIAP_BLOCK_DEVICE_SIZE == 0) && (MBED_CONF_FLASHIAP_BLOCK_DEVICE_BASE_ADDRESS == 0xFFFFFFFF) + + size_t flash_size; + uint32_t start_address; + uint32_t bottom_address; + FlashIAP flash; + + int ret = flash.init(); + if (ret != 0) { + return 0; + } + + //Find the start of first sector after text area + bottom_address = align_up(FLASHIAP_ROM_END, flash.get_sector_size(FLASHIAP_ROM_END)); + start_address = flash.get_flash_start(); + flash_size = flash.get_flash_size(); + + ret = flash.deinit(); + + static FlashIAPBlockDevice default_bd(bottom_address, start_address + flash_size - bottom_address); + +#else + + static FlashIAPBlockDevice default_bd; + +#endif + + return &default_bd; + +#else + + return NULL; + +#endif + +} + +FileSystem *FileSystem::get_default_instance() +{ +#if COMPONENT_SPIF || COMPONENT_QSPIF || COMPONENT_DATAFLASH + + static LittleFileSystem flash("flash", BlockDevice::get_default_instance()); + flash.set_as_default(); + + return &flash; + +#elif COMPONENT_SD || COMPONENT_NUSD + + static FATFileSystem sdcard("sd", BlockDevice::get_default_instance()); + sdcard.set_as_default(); + + return &sdcard; + +#elif COMPONENT_FLASHIAP + + static LittleFileSystem flash("flash", BlockDevice::get_default_instance()); + flash.set_as_default(); + + return &flash; + +#else + + return NULL; + +#endif + +}
diff -r 000000000000 -r 16957896f9cd main.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/main.cpp Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,195 @@ +// ---------------------------------------------------------------------------- +// Copyright 2016-2018 ARM Ltd. +// +// SPDX-License-Identifier: Apache-2.0 +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------- +#ifndef MBED_TEST_MODE + +#include "mbed.h" +#include "simple-mbed-cloud-client.h" +#include "FATFileSystem.h" +#include "LittleFileSystem.h" + +// Default network interface object. Don't forget to change the WiFi SSID/password in mbed_app.json if you're using WiFi. +NetworkInterface *net = NetworkInterface::get_default_instance(); + +// Default block device available on the target board +BlockDevice *bd = BlockDevice::get_default_instance(); + +#if COMPONENT_SD || COMPONENT_NUSD +// Use FATFileSystem for SD card type blockdevices +FATFileSystem fs("fs"); +#else +// Use LittleFileSystem for non-SD block devices to enable wear leveling and other functions +LittleFileSystem fs("fs"); +#endif + +#if USE_BUTTON == 1 +InterruptIn button(BUTTON1); +#endif /* USE_BUTTON */ + +// Default LED to use for PUT/POST example +DigitalOut led(LED1, 0); + +// Declaring pointers for access to Pelion Device Management Client resources outside of main() +MbedCloudClientResource *button_res; +MbedCloudClientResource *led_res; +MbedCloudClientResource *post_res; + +// An event queue is a very useful structure to debounce information between contexts (e.g. ISR and normal threads) +// This is great because things such as network operations are illegal in ISR, so updating a resource in a button's fall() function is not allowed +EventQueue eventQueue; + +/** + * PUT handler - sets the value of the built-in LED + * @param resource The resource that triggered the callback + * @param newValue Updated value for the resource + */ +void put_callback(MbedCloudClientResource *resource, m2m::String newValue) { + printf("PUT received. New value: %s\n", newValue.c_str()); + led = atoi(newValue.c_str()); +} + +/** + * POST handler - prints the content of the payload + * @param resource The resource that triggered the callback + * @param buffer If a body was passed to the POST function, this contains the data. + * Note that the buffer is deallocated after leaving this function, so copy it if you need it longer. + * @param size Size of the body + */ +void post_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) { + printf("POST received (length %u). Payload: ", size); + for (size_t ix = 0; ix < size; ix++) { + printf("%02x ", buffer[ix]); + } + printf("\n"); +} + +/** + * Button handler + * This function will be triggered either by a physical button press or by a ticker every 5 seconds (see below) + */ +void button_press() { + int v = button_res->get_value_int() + 1; + button_res->set_value(v); + printf("Button clicked %d times\n", v); +} + +/** + * Notification callback handler + * @param resource The resource that triggered the callback + * @param status The delivery status of the notification + */ +void button_callback(MbedCloudClientResource *resource, const NoticationDeliveryStatus status) { + printf("Button notification, status %s (%d)\n", MbedCloudClientResource::delivery_status_to_string(status), status); +} + +/** + * Registration callback handler + * @param endpoint Information about the registered endpoint such as the name (so you can find it back in portal) + */ +void registered(const ConnectorClientEndpointInfo *endpoint) { + printf("Registered to Pelion Device Management. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str()); +} + +int main(void) { + printf("\nStarting Simple Pelion Device Management Client example\n"); + + int storage_status = fs.mount(bd); + if (storage_status != 0) { + printf("Storage mounting failed.\n"); + } + +#if USE_BUTTON == 1 + // If the User button is pressed ons start, then format storage. + bool btn_pressed = (button.read() == MBED_CONF_APP_BUTTON_PRESSED_STATE); + if (btn_pressed) { + printf("User button is pushed on start...\n"); + } +#else + bool btn_pressed = false; +#endif /* USE_BUTTON */ + + if (storage_status || btn_pressed) { + printf("Formatting the storage...\n"); + int storage_status = StorageHelper::format(&fs, bd); + if (storage_status != 0) { + printf("ERROR: Failed to reformat the storage (%d).\n", storage_status); + } + } else { + printf("You can hold the user button during boot to format the storage and change the device identity.\n"); + } + + // Connect to the Internet (DHCP is expected to be on) + printf("Connecting to the network using the default network interface...\n"); + net = NetworkInterface::get_default_instance(); + + nsapi_error_t net_status = NSAPI_ERROR_NO_CONNECTION; + while ((net_status = net->connect()) != NSAPI_ERROR_OK) { + printf("Unable to connect to network (%d). Retrying...\n", net_status); + } + + printf("Connected to the network successfully. IP address: %s\n", net->get_ip_address()); + + printf("Initializing Pelion Device Management Client...\n"); + + // SimpleMbedCloudClient handles registering over LwM2M to Pelion Device Management + SimpleMbedCloudClient client(net, bd, &fs); + int client_status = client.init(); + if (client_status != 0) { + printf("Pelion Client initialization failed (%d)\n", client_status); + return -1; + } + + // Creating resources, which can be written or read from the cloud + button_res = client.create_resource("3200/0/5501", "button_count"); + button_res->set_value(0); + button_res->methods(M2MMethod::GET); + button_res->observable(true); + button_res->attach_notification_callback(button_callback); + + led_res = client.create_resource("3201/0/5853", "led_state"); + led_res->set_value(led.read()); + led_res->methods(M2MMethod::GET | M2MMethod::PUT); + led_res->attach_put_callback(put_callback); + + post_res = client.create_resource("3300/0/5605", "execute_function"); + post_res->methods(M2MMethod::POST); + post_res->attach_post_callback(post_callback); + + printf("Initialized Pelion Device Management Client. Registering...\n"); + + // Callback that fires when registering is complete + client.on_registered(®istered); + + // Register with Pelion DM + client.register_and_connect(); + +#if USE_BUTTON == 1 + // The button fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations + button.fall(eventQueue.event(&button_press)); + printf("Press the user button to increment the LwM2M resource value...\n"); +#else + // The timer fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations + Ticker timer; + timer.attach(eventQueue.event(&button_press), 5.0); + printf("Simulating button press every 5 seconds...\n"); +#endif /* USE_BUTTON */ + + // You can easily run the eventQueue in a separate thread if required + eventQueue.dispatch_forever(); +} + +#endif /* MBED_TEST_MODE */
diff -r 000000000000 -r 16957896f9cd mbed-os.lib --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mbed-os.lib Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,1 @@ +https://github.com/ARMmbed/mbed-os/#0f959dbe4749c20416236e4fe1dac5692cbe18ab
diff -r 000000000000 -r 16957896f9cd mbed_app.json --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mbed_app.json Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,69 @@ +{ + "target_overrides": { + "*": { + "target.components_remove" : ["FLASHIAP"], + "platform.stdio-baud-rate" : 115200, + "platform.stdio-convert-newlines" : true, + "mbed-trace.enable" : null, + "mbed-cloud-client.external-sst-support" : null, + "nsapi.default-wifi-security" : "WPA_WPA2", + "nsapi.default-wifi-ssid" : "\"SSID\"", + "nsapi.default-wifi-password" : "\"Password\"" + }, + "UHURU_RAVEN": { + "target.components_add" : ["SPIF", "WIFI_ESP32"], + "spif-driver.SPI_MOSI" : "PE_14", + "spif-driver.SPI_MISO" : "PE_13", + "spif-driver.SPI_CLK" : "PE_12", + "spif-driver.SPI_CS" : "PE_11", + "target.network-default-interface-type" : "WIFI", + "esp32.wifi-debug" : false, + "esp32.wifi-en" : "PB_12", + "esp32.wifi-io0" : "PB_13", + "esp32.wifi-tx" : "PB_14", + "esp32.wifi-rx" : "PB_15", + "esp32.provide-default" : true, + "device-management.flash-start-address" : "0x08000000", + "device-management.flash-size" : "(2048*1024)", + "device-management.sotp-section-1-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 2*(256*1024))", + "device-management.sotp-section-1-size" : "(256*1024)", + "device-management.sotp-section-2-address" : "(MBED_CONF_APP_FLASH_START_ADDRESS + MBED_CONF_APP_FLASH_SIZE - 1*(256*1024))", + "device-management.sotp-section-2-size" : "(256*1024)", + "update-client.application-details" : "(MBED_CONF_APP_FLASH_START_ADDRESS + 64*1024)", + "update-client.storage-address" : "(2*1024*1024)", + "update-client.storage-size" : "(2*1024*1024)", + "update-client.storage-locations" : "1", + "target.features_add" : ["BOOTLOADER"], + "target.bootloader_img" : "bootloader/mbed-bootloader-UHURU_RAVEN.bin", + "target.header_offset" : "0x10000", + "target.app_offset" : "0x10400", + "use-button" : false + } + }, + "config": { + "format-storage-layer-on-error": { + "help": "Whether to format the storage layer when it cannot be read - always disable for production devices!", + "value": 1 + }, + "main-stack-size": { + "value": 6000 + }, + "use-button": { + "help": "Whether the target has a button", + "macro_name": "USE_BUTTON", + "value": true + }, + "button-pressed-state": { + "help": "Value of the button when pressed", + "value": 1 + }, + "no_led": { + "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", + "value": null + }, + "tests-fs-size": { + "help": "Maximum size of the file system used for tests", + "value": null + } + } +}
diff -r 000000000000 -r 16957896f9cd mbed_cloud_dev_credentials.c --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mbed_cloud_dev_credentials.c Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2017 ARM Limited. All rights reserved. + * SPDX-License-Identifier: Apache-2.0 + * Licensed under the Apache License, Version 2.0 (the License); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an AS IS BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#ifndef __MBED_CLOUD_DEV_CREDENTIALS_H__ +#define __MBED_CLOUD_DEV_CREDENTIALS_H__ + +#if MBED_CONF_DEVICE_MANAGEMENT_DEVELOPER_MODE == 1 +#error "Replace mbed_cloud_dev_credentials.c with your own developer cert." +#endif + +#include <inttypes.h> + +const char MBED_CLOUD_DEV_BOOTSTRAP_ENDPOINT_NAME[] = ""; +const char MBED_CLOUD_DEV_ACCOUNT_ID[] = ""; +const char MBED_CLOUD_DEV_BOOTSTRAP_SERVER_URI[] = ""; + +const uint8_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE[] = +{ 0x0 }; + +const uint8_t MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE[] = +{ 0x0 }; + +const uint8_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY[] = +{ 0x0 }; + +const char MBED_CLOUD_DEV_MANUFACTURER[] = "dev_manufacturer"; + +const char MBED_CLOUD_DEV_MODEL_NUMBER[] = "dev_model_num"; + +const char MBED_CLOUD_DEV_SERIAL_NUMBER[] = "0"; + +const char MBED_CLOUD_DEV_DEVICE_TYPE[] = "dev_device_type"; + +const char MBED_CLOUD_DEV_HARDWARE_VERSION[] = "dev_hardware_version"; + +const uint32_t MBED_CLOUD_DEV_MEMORY_TOTAL_KB = 0; +const uint32_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE); +const uint32_t MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE); +const uint32_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY); + +#endif //__MBED_CLOUD_DEV_CREDENTIALS_H__ \ No newline at end of file
diff -r 000000000000 -r 16957896f9cd simple-mbed-cloud-client.lib --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/simple-mbed-cloud-client.lib Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,1 @@ +https://github.com/ARMmbed/simple-mbed-cloud-client/#eadf19d642431cf534c3a70b9c72f97ed5b0dd7c
diff -r 000000000000 -r 16957896f9cd update_default_resources.c --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/update_default_resources.c Tue May 21 17:19:38 2019 +0900 @@ -0,0 +1,41 @@ +// ---------------------------------------------------------------------------- +// Copyright 2016-2017 ARM Ltd. +// +// SPDX-License-Identifier: Apache-2.0 +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------- + +#ifdef MBED_CLOUD_CLIENT_USER_CONFIG_FILE +#include MBED_CLOUD_CLIENT_USER_CONFIG_FILE +#endif + +#include <stdint.h> + +#ifdef MBED_CLOUD_DEV_UPDATE_ID +const uint8_t arm_uc_vendor_id[16] = { "dev_manufacturer" }; +const uint16_t arm_uc_vendor_id_size = sizeof(arm_uc_vendor_id); + +const uint8_t arm_uc_class_id[16] = { "dev_model_number" }; +const uint16_t arm_uc_class_id_size = sizeof(arm_uc_class_id); +#endif + +#ifdef MBED_CLOUD_DEV_UPDATE_CERT +const uint8_t arm_uc_default_fingerprint[32] = { 0 }; +const uint16_t arm_uc_default_fingerprint_size = + sizeof(arm_uc_default_fingerprint); + +const uint8_t arm_uc_default_certificate[1] = { 0 }; +const uint16_t arm_uc_default_certificate_size = + sizeof(arm_uc_default_certificate); +#endif \ No newline at end of file