diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f433ee4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributing to Mbed OS + +Mbed OS is an open-source, device software platform for the Internet of Things. Contributions are an important part of the platform, and our goal is to make it as simple as possible to become a contributor. + +To encourage productive collaboration, as well as robust, consistent and maintainable code, we have a set of guidelines for [contributing to Mbed OS](https://os.mbed.com/docs/mbed-os/latest/contributing/index.html). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) 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 + + (d) 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. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..efd595c --- /dev/null +++ b/README.md @@ -0,0 +1,110 @@ +![](./resources/official_armmbed_example_badge.png) + +# Azure IoT Hub example on Mbed OS + +The example project is part of the [Arm Mbed OS Official Examples](https://os.mbed.com/code/). It contains an application that uses the [Microsoft Azure SDK](https://github.com/Azure/azure-iot-sdk-c) to connect to an IoT Hub instance using the MQTT protocol. + +You can build the project with all supported [Mbed OS build tools](https://os.mbed.com/docs/mbed-os/latest/tools/index.html). However, this example project specifically refers to the command-line interface tool [Arm Mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli). +(Note: To see a rendered example you can import into the Arm Online Compiler, please see our [import quick start](https://os.mbed.com/docs/mbed-os/latest/quick-start/online-with-the-online-compiler.html#importing-the-code).) + +## Setting up an Azure IoT Hub account + +Follow Azure IoT Hub's official documentation to + +1. Create a new hub on the Azure portal ([documentation](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal#create-an-iot-hub)). You will need a [_Standard_ tier](https://azure.microsoft.com/en-gb/pricing/details/iot-hub/) hub to enable cloud-to-device messages for this example, and a free option is available in this tier. +1. Register a new device to the hub you have created ([documentation](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal#register-a-new-device-in-the-iot-hub)). Make a copy of the "Primary Connection String" of the device. + +Now the IoT Hub is ready for use in this example. + +## Building this example + +To fetch the example, + +1. Fetch the project and its dependencies + ``` + mbed import mbed-os-example-azure + ``` + Or if you fetched the example with `git clone`, run `mbed deploy` inside the cloned repository. +1. In the example repository you fetched, open [`mbed_app.json`](./mbed_app.json) and set the value of `iothub_connection_string` to the Primary Connection String you [previously copied](#setting-up-the-cloud), keeping any escaped quotes (`\"`). +1. (If you want to use WiFi) set `nsapi.default-wifi-ssid` to your WiFi name and `nsapi.default-wifi-password` to your WiFi password, keeping any escaped quotes (`\"`). + +To compile and run the example, + +1. Connect your development board to your PC with a USB cable. +1. (If you want to use Ethernet) connect the board to an Ethernet cable of your network. +1. Compile, flash and run the example + ``` + mbed compile -m -t -f --sterm --baud 115200 + ``` + For example, `` can be `DISCO_L475VG_IOT01A` and `` can be `GCC_ARM` if you want to use this combination. + +## Expected output + +The example starts by connecting your network interface: +``` +Info: Connecting to the network +Info: Connection success, MAC: +``` + +Then it fetches time from an NTP server, because Azure IoT Hub's Share Access Key requires correct timestamps for connections: +``` +Info: Getting time from the NTP server +Info: Time: Wed Jul22 15:9:41 2020 + +Info: RTC reports Wed Jul22 15:9:41 2020 +``` +**Note**: If it fails to fetch time or the reported time makes no sense (e.g. year 2100), the NTP server might be unreachable for a moment. It is usually enough to reset the board to rerun the example. + +Now it initializes the Azure SDK and starts sending one message every second: +``` +Info: Sending: "10 messages left to send, or until we receive a reply" +Info: Connected to IoT Hub +Info: Message sent successfully +Info: Sending: "9 messages left to send, or until we receive a reply" +Info: Message sent successfully +... +``` + +## Sending cloud-to-device messages + +On the Azure portal, go to the page of your device (i.e. where you [copied the Primary Connection String](#setting-up-the-cloud)), you can send a message to your device using "Message to Device". + +Once the message is received by your device, it prints: +``` +Info: Message received from IoT Hub +Info: Message body: +``` + +## Tracing the IoT Hub client + +To monitor incoming/outgoing IoT Hub events, you can enable tracing by setting `iothub_client_trace` in [`mbed_app.json`](./mbed_app.json) to `true`. This can be useful for debugging issues related to connections or credentials. + +Sample trace for the first message sent: + +``` +Info: Sending: "10 messages left to send, or until we receive a reply" +-> 15:9:43 CONNECT | VER: 4 | KEEPALIVE: 240 | FLAGS: 192 | USERNAME: .azure-devices.net//?api-version=2017-11-08-preview&DeviceClientType=iothubclient%2f1.3.8%20(native%3b%20mbedOS5%3b%20undefined) | PWD: XXXX | CLEAN: 0 +<- 15:9:43 CONNACK | SESSION_PRESENT: true | RETURN_CODE: 0x0 +Info: Connected to IoT Hub +-> 15:9:43 SUBSCRIBE | PACKET_ID: 2 | TOPIC_NAME: devices//messages/devicebound/# | QOS: 1 +-> 15:9:43 PUBLISH | IS_DUP: false | RETAIN: 0 | QOS: DELIVER_AT_LEAST_ONCE | TOPIC_NAME: devices//messages/events/ | PACKET_ID: 3 | PAYLOAD_LEN: 53 +<- 15:9:43 SUBACK | PACKET_ID: 2 | RETURN_CODE: 1 +<- 15:9:43 PUBACK | PACKET_ID: 3 +Info: Message sent successfully +``` + +## Troubleshooting +If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it. + +## Related links +* [Mbed boards](https://os.mbed.com/platforms/) +* [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html). +* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html). +* [Azure IoT Hub](https://azure.microsoft.com/en-gb/services/iot-hub/) +* [Microsoft Azure IoT device SDK for C](https://github.com/Azure/azure-iot-sdk-c/tree/master/iothub_client) + +## License and contributions + +The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. + +This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide. \ No newline at end of file diff --git a/drivers/COMPONENT_wifi_ism43362.lib b/drivers/COMPONENT_wifi_ism43362.lib new file mode 100644 index 0000000..1abfaca --- /dev/null +++ b/drivers/COMPONENT_wifi_ism43362.lib @@ -0,0 +1 @@ +https://github.com/ARMmbed/wifi-ism43362/#9e1851a7fe5e2ffb07533aacc7114df2e73f7784 diff --git a/main.cpp b/main.cpp new file mode 100644 index 0000000..c2183b1 --- /dev/null +++ b/main.cpp @@ -0,0 +1,203 @@ +/* + * Copyright (c) 2020 Arm Limited + * SPDX-License-Identifier: Apache-2.0 + */ + +#include "mbed.h" +#include "rtos/ThisThread.h" +#include "NTPClient.h" + +#include "certs.h" +#include "iothub.h" +#include "iothub_client_options.h" +#include "iothub_device_client.h" +#include "iothub_message.h" +#include "azure_c_shared_utility/shared_util_options.h" +#include "azure_c_shared_utility/threadapi.h" +#include "azure_c_shared_utility/tickcounter.h" +#include "azure_c_shared_utility/xlogging.h" + +#include "iothubtransportmqtt.h" + +/** + * This example sends and receives messages to and from Azure IoT Hub. + * The API usages are based on Azure SDK's official iothub_convenience_sample. + */ + +// Global symbol referenced by the Azure SDK's port for Mbed OS, via "extern" +NetworkInterface *_defaultSystemNetwork; + +static bool message_received = false; + +static void on_connection_status(IOTHUB_CLIENT_CONNECTION_STATUS result, IOTHUB_CLIENT_CONNECTION_STATUS_REASON reason, void* user_context) +{ + if (result == IOTHUB_CLIENT_CONNECTION_AUTHENTICATED) { + LogInfo("Connected to IoT Hub"); + } else { + LogError("Connection failed, reason: %s", MU_ENUM_TO_STRING(IOTHUB_CLIENT_CONNECTION_STATUS_REASON, reason)); + } +} + +static IOTHUBMESSAGE_DISPOSITION_RESULT on_message_received(IOTHUB_MESSAGE_HANDLE message, void* user_context) +{ + LogInfo("Message received from IoT Hub"); + + const unsigned char *data_ptr; + size_t len; + if (IoTHubMessage_GetByteArray(message, &data_ptr, &len) != IOTHUB_MESSAGE_OK) { + LogError("Failed to extract message data, please try again on IoT Hub"); + return IOTHUBMESSAGE_ABANDONED; + } + + message_received = true; + LogInfo("Message body: %s", data_ptr); + return IOTHUBMESSAGE_ACCEPTED; +} + +static void on_message_sent(IOTHUB_CLIENT_CONFIRMATION_RESULT result, void* userContextCallback) +{ + if (result == IOTHUB_CLIENT_CONFIRMATION_OK) { + LogInfo("Message sent successfully"); + } else { + LogInfo("Failed to send message, error: %s", + MU_ENUM_TO_STRING(IOTHUB_CLIENT_CONFIRMATION_RESULT, result)); + } +} + +void demo() { + static const char connection_string[] = MBED_CONF_APP_IOTHUB_CONNECTION_STRING; + bool trace_on = MBED_CONF_APP_IOTHUB_CLIENT_TRACE; + tickcounter_ms_t interval = 100; + IOTHUB_CLIENT_RESULT res; + + LogInfo("Initializing IoT Hub client"); + IoTHub_Init(); + + IOTHUB_DEVICE_CLIENT_HANDLE client_handle = IoTHubDeviceClient_CreateFromConnectionString( + connection_string, + MQTT_Protocol + ); + if (client_handle == nullptr) { + LogError("Failed to create IoT Hub client handle"); + goto cleanup; + } + + // Enable SDK tracing + res = IoTHubDeviceClient_SetOption(client_handle, OPTION_LOG_TRACE, &trace_on); + if (res != IOTHUB_CLIENT_OK) { + LogError("Failed to enable IoT Hub client tracing, error: %d", res); + goto cleanup; + } + + // Enable static CA Certificates defined in the SDK + res = IoTHubDeviceClient_SetOption(client_handle, OPTION_TRUSTED_CERT, certificates); + if (res != IOTHUB_CLIENT_OK) { + LogError("Failed to set trusted certificates, error: %d", res); + goto cleanup; + } + + // Process communication every 100ms + res = IoTHubDeviceClient_SetOption(client_handle, OPTION_DO_WORK_FREQUENCY_IN_MS, &interval); + if (res != IOTHUB_CLIENT_OK) { + LogError("Failed to set communication process frequency, error: %d", res); + goto cleanup; + } + + // set incoming message callback + res = IoTHubDeviceClient_SetMessageCallback(client_handle, on_message_received, nullptr); + if (res != IOTHUB_CLIENT_OK) { + LogError("Failed to set message callback, error: %d", res); + goto cleanup; + } + + // Set connection/disconnection callback + res = IoTHubDeviceClient_SetConnectionStatusCallback(client_handle, on_connection_status, nullptr); + if (res != IOTHUB_CLIENT_OK) { + LogError("Failed to set connection status callback, error: %d", res); + goto cleanup; + } + + // Send ten message to the cloud (one per second) + // or until we receive a message from the cloud + IOTHUB_MESSAGE_HANDLE message_handle; + char message[80]; + for (int i = 0; i < 10; ++i) { + if (message_received) { + // If we have received a message from the cloud, don't send more messeges + break; + } + + sprintf(message, "%d messages left to send, or until we receive a reply", 10 - i); + LogInfo("Sending: \"%s\"", message); + + message_handle = IoTHubMessage_CreateFromString(message); + if (message_handle == nullptr) { + LogError("Failed to create message"); + goto cleanup; + } + + res = IoTHubDeviceClient_SendEventAsync(client_handle, message_handle, on_message_sent, nullptr); + IoTHubMessage_Destroy(message_handle); // message already copied into the SDK + + if (res != IOTHUB_CLIENT_OK) { + LogError("Failed to send message event, error: %d", res); + goto cleanup; + } + + ThisThread::sleep_for(1s); + } + + // If the user didn't manage to send a cloud-to-device message earlier, + // let's wait until we receive one + while (!message_received) { + // Continue to receive messages in the communication thread + // which is internally created and maintained by the Azure SDK. + sleep(); + } + +cleanup: + IoTHubDeviceClient_Destroy(client_handle); + IoTHub_Deinit(); +} + +int main() { + LogInfo("Connecting to the network"); + + _defaultSystemNetwork = NetworkInterface::get_default_instance(); + if (_defaultSystemNetwork == nullptr) { + LogError("No network interface found"); + return -1; + } + + int ret = _defaultSystemNetwork->connect(); + if (ret != 0) { + LogError("Connection error: %d", ret); + return -1; + } + LogInfo("Connection success, MAC: %s", _defaultSystemNetwork->get_mac_address()); + + LogInfo("Getting time from the NTP server"); + + NTPClient ntp(_defaultSystemNetwork); + time_t timestamp = ntp.get_timestamp(); + if (timestamp < 0) { + LogError("Failed to get the current time, error: %ld", timestamp); + return -1; + } + LogInfo("Time: %s", ctime(×tamp)); + + rtc_init(); + rtc_write(timestamp); + time_t rtc_timestamp = rtc_read(); // verify it's been successfully updated + LogInfo("RTC reports %s", ctime(&rtc_timestamp)); + + LogInfo("Starting the Demo"); + demo(); + LogInfo("The demo has ended"); + + while (true) { + sleep(); + } + + return 0; +} diff --git a/mbed-azure-client.lib b/mbed-azure-client.lib new file mode 100644 index 0000000..f918462 --- /dev/null +++ b/mbed-azure-client.lib @@ -0,0 +1 @@ +https://github.com/ARMmbed/mbed-azure-client#c10710ac594a40a5bc5b40381fbbd6b5d1391912 diff --git a/mbed-os.lib b/mbed-os.lib new file mode 100644 index 0000000..25bf85c --- /dev/null +++ b/mbed-os.lib @@ -0,0 +1 @@ +https://github.com/ARMmbed/mbed-os#a2ada74770f043aff3e61e29d164a8e78274fcd4 diff --git a/mbed_app.json b/mbed_app.json new file mode 100644 index 0000000..a3c2065 --- /dev/null +++ b/mbed_app.json @@ -0,0 +1,25 @@ +{ + "config": { + "iothub_connection_string": { + "help": "Azure IoT Hub connection string", + "value": "\"HostName=...;DeviceId=...;SharedAccessKey=...\"" + }, + "iothub_client_trace": { + "help": "Enable IoT Hub Client tracing", + "value": false + } + }, + "target_overrides": { + "*": { + "platform.stdio-convert-newlines": true, + "platform.stdio-baud-rate": 115200 + }, + "DISCO_L475VG_IOT01A": { + "target.components_add": ["wifi_ism43362"], + "target.network-default-interface-type": "WIFI", + "nsapi.default-wifi-security": "WPA_WPA2", + "nsapi.default-wifi-ssid": "\"SSID\"", + "nsapi.default-wifi-password": "\"PASSWORD\"" + } + } +} diff --git a/ntp-client.lib b/ntp-client.lib new file mode 100644 index 0000000..914a266 --- /dev/null +++ b/ntp-client.lib @@ -0,0 +1 @@ +https://github.com/ARMmbed/ntp-client.git#a4ccf62992b9adc5086a9afea08fa4deb2e2fbd7 diff --git a/resources/official_armmbed_example_badge.png b/resources/official_armmbed_example_badge.png new file mode 100644 index 0000000..42ddce2 Binary files /dev/null and b/resources/official_armmbed_example_badge.png differ