From d6873e46d4d33260839df50455cd8acdd7238ee8 Mon Sep 17 00:00:00 2001 From: Damon Barry Date: Wed, 10 May 2017 10:35:40 -0700 Subject: [PATCH] Raname Gateway SDK to IoT Edge --- Contributing.md | 18 +++--- License.txt | 2 +- README.md | 62 +++++++++++-------- ThirdPartyNotices.txt | 8 +-- bindings/java/README.md | 2 +- doc/azure_iot_gateway_snap.md | 26 ++++---- doc/devbox_setup.md | 10 +-- doc/docker_how_to.md | 10 +-- samples/azure_functions_sample/README.md | 13 ++-- samples/ble_gateway/README.md | 15 +++-- .../connecting_to_ble_device_on_rpi3.md | 6 +- samples/dotnet_binding_sample/README.md | 10 +-- samples/dotnet_core_managed_gateway/README.md | 6 +- samples/dotnet_core_module_sample/README.md | 8 +-- .../dynamically_add_module_sample/README.md | 6 +- samples/hello_world/README.md | 22 +++---- samples/java_sample/java_devbox_setup.md | 20 +++--- samples/native_module_host_sample/README.md | 2 +- samples/nodejs_simple_sample/README.md | 2 +- samples/proxy_sample/README.md | 2 +- .../simulated_device_cloud_upload/README.md | 2 +- 21 files changed, 130 insertions(+), 122 deletions(-) diff --git a/Contributing.md b/Contributing.md index 89a9f7c6..eca67277 100644 --- a/Contributing.md +++ b/Contributing.md @@ -1,6 +1,6 @@ -The Azure IoT Gateway SDK shares the same [contribution guidelines](https://github.com/Azure/azure-iot-sdks/blob/master/CONTRIBUTING.md) as -the other Azure IoT SDKs. The gateway SDK team also monitors our [GitHub issues](https://github.com/Azure/azure-iot-gateway-sdk/issues) -section and Stack Overflow, especially the [azure-iot-gateway-sdk](http://stackoverflow.com/questions/tagged/azure-iot-gateway-sdk) tag. +Azure IoT Edge shares the same [contribution guidelines](https://github.com/Azure/azure-iot-sdks/blob/master/CONTRIBUTING.md) as +the other Azure IoT SDKs. The Azure IoT Edge team also monitors our [GitHub issues](https://github.com/Azure/azure-iot-gateway-sdk/issues) +section and Stack Overflow, especially the [azure-iot-edge](http://stackoverflow.com/questions/tagged/azure-iot-edge) tag. ---------- @@ -19,7 +19,7 @@ Provide documentation for your module, including: ### Automated tests If your module is available as open-source code, make automated tests available (e.g., published to the module's code repository, with instructions for building and running them) so anyone can confirm that the module behaves as described. The tests must: - Verify domain-specific behavior (e.g. if it's a protocol translation module, does it successfully and accurately translate from protocol A to protocol B?) -- Validate that the module uses the gateway SDK correctly (Note: in the future we'd like to provide an acceptance suite to help you with this part) +- Validate that the module uses Azure IoT Edge correctly (Note: in the future we'd like to provide an acceptance suite to help you with this part) If your module is _not_ available as open-source code, we still recommend automated tests but don't require them. @@ -30,10 +30,10 @@ We recommend that you provide one or more samples, in the form of code or docume Open a [Pull Request](https://github.com/Azure/azure-iot-gateway-sdk/compare) that adds a row about your module to the bottom of the Featured Modules table in our [README](https://github.com/Azure/azure-iot-gateway-sdk/blob/master/README.md), e.g., ``` ->| Name | More information | Targets gateway SDK version | ->|--------------|---------------------------------|-----------------------------| ->| ... | ... | ... | ->| XYZ protocol | http://contoso.com/xyz_protocol | 2016-09-01 | +>| Name | More information | Targets Azure IoT Edge version | +>|--------------|---------------------------------|--------------------------------| +>| ... | ... | ... | +>| XYZ protocol | http://contoso.com/xyz_protocol | 2016-09-01 | ``` #### "More information" field @@ -45,6 +45,6 @@ Your module's documentation must be discoverable from the page at this URL. #### PR Comments -Add comments to the PR to describe how your module meets the requirements listed here. Also describe what steps you've taken to test your module against the gateway version referenced in the **Targets gateway SDK version** field. +Add comments to the PR to describe how your module meets the requirements listed here. Also describe what steps you've taken to test your module against the gateway version referenced in the **Targets Azure IoT Edge version** field. **Note**: We reserve the right to remove a module's entry from the table if it hasn't been updated in a while. diff --git a/License.txt b/License.txt index 7c8bfa17..f6e9da32 100644 --- a/License.txt +++ b/License.txt @@ -1,4 +1,4 @@ -Microsoft Azure IoT Gateway SDK +Microsoft Azure IoT Edge Copyright (c) Microsoft Corporation MIT license diff --git a/README.md b/README.md index 12d28269..1cfe83ee 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments +The Azure IoT Gateway SDK was our first step to enabling edge analytics in IoT solutions. We’re doubling down on, and expanding, this vision as explained in Satya’s Keynote at the Build conference and Sam George’s [blog post](http://blogs.microsoft.com/iot/?p=23040). As part of this evolution, the SDK is becoming an extensible product you can use instead of a set of code you build. To reflect this, we’re changing the name to Azure IoT Edge. -# Azure IoT Gateway SDK +All the important developer concepts are maintained as we continue to improve Azure IoT Edge. Specifically… +- modules remain units compute which can be written in your programming language of choice. +- traditional cloud services and 3rd party business logic can run as a module. +- modules can communicate with each other via declarative message passing. + +This similarity means that existing solutions can evolve with the product! There will be some infrastructural changes. For example: modules will run in Docker containers and the broker used to pass messages between module code will move to a lite version of IoT Hub running locally in a module. The vast majority of this is shielded from both a module developer and gateway developer. + +Sign up [here](https://microsoft.qualtrics.com/jfe/form/SV_0V8Xr8y9c4mHUfb) to be kept up to date about the next generation of Azure IoT Edge features. In the meantime, be sure to check out the great features we just added to Azure IoT Edge, like [development packages](https://azure.microsoft.com/en-us/blog/azure-iot-gateway-sdk-packages/) and an [Azure Stream Analytics module](https://azure.microsoft.com/en-us/blog/announcing-azure-stream-analytics-on-edge-devices-preview/). + + +# Azure IoT Edge IoT scenarios vary drastically between industries and even between customers within the same industry. -The Azure IoT Gateway SDK lets you build IoT solutions tailored to your exact scenario. Connect new +Azure IoT Edge lets you build IoT solutions tailored to your exact scenario. Connect new or existing devices, regardless of protocol. Process the data in an on-premises gateway using the language of your choice (Java, C#, Node.js, or C), before sending it to the cloud. Deploy the solution on hardware that meets your performance needs and runs the operating system of your choice. @@ -13,14 +23,14 @@ cloud, it also filters the data so that only the most important information is u ![](doc/media/READMEDiagram.png) -Using existing modules from the Azure IoT Gateway SDK ecosystem significantly reduces your development +Using existing modules from the Azure IoT Edge ecosystem significantly reduces your development and maintenance costs. Running the gateway on-premises opens up all kinds of scenarios like communicating between devices in real time, operating your IoT solution with an intermittent cloud connection, or enforcing additional security requirements. -Visit https://azure.microsoft.com/en-us/services/iot-hub/iot-gateway-sdk/ to learn more about the Azure IoT Gateway SDK. +Visit [https://azure.microsoft.com/campaigns/iot-edge](https://azure.microsoft.com/campaigns/iot-edge/) to learn more about Azure IoT Edge. -## SDK Modules +## Azure IoT Edge Modules The following modules are available in this repository: >| Name | Description | >|------------------|-------------------------------------------------------------------------| @@ -34,18 +44,18 @@ The following modules are available in this repository: ## Create Modules using Packages The fastest way to setup your development environment to start writing modules is to leverage our packages for Java, C#, and Node.js. Our [sample apps repo](https://github.com/Azure-Samples/azure-iot-gateway-samples/) has quick steps on getting started with these packages: -- [Gateway SDK Maven](https://github.com/Azure-Samples/azure-iot-gateway-samples/#how-to-run-java-modules-windows-10ubuntu-linux-14): With this you will be able to run the Gateway sample app and start writing Java modules. This package contains the Gateway runtime core and links to the module dependencies’ packages for Linux or Windows. -- [Gateway SDK npm](https://www.npmjs.com/package/azure-iot-gateway): With this you will be able to run the Gateway sample app and start writing Node.js modules. This package contains the Gateway runtime core and auto-installs the module dependencies’ packages for Linux or Windows. -- [Gateway SDK NuGet .NET Framework](https://www.nuget.org/packages/Microsoft.Azure.IoT.Gateway.Module): With this you will be able to run the Gateway sample app and write .NET Framework modules on Windows, dependent on [Gateway Core Runtime for Windows](https://www.nuget.org/packages/Microsoft.Azure.Devices.Gateway.Win32/). -- Gateway SDK NuGet .NET Core (coming soon) +- [Azure IoT Edge Maven](https://github.com/Azure-Samples/azure-iot-gateway-samples/#how-to-run-java-modules-windows-10ubuntu-linux-14): With this you will be able to run the Azure IoT Edge sample app and start writing Java modules. This package contains the Azure IoT Edge core and links to the module dependencies’ packages for Linux or Windows. +- [Azure IoT Edge npm](https://www.npmjs.com/package/azure-iot-gateway): With this you will be able to run the Azure IoT Edge sample app and start writing Node.js modules. This package contains the Azure IoT Edge core and auto-installs the module dependencies’ packages for Linux or Windows. +- [Azure IoT Edge NuGet .NET Framework](https://www.nuget.org/packages/Microsoft.Azure.IoT.Gateway.Module): With this you will be able to run the Azure IoT Edge sample app and write .NET Framework modules on Windows, dependent on [Azure IoT Edge Core for Windows](https://www.nuget.org/packages/Microsoft.Azure.Devices.Gateway.Win32/). +- Azure IoT Edge NuGet .NET Core (coming soon) ## Featured Modules -Other people are creating modules for the gateway SDK too! See the **More information** link for +Other people are creating modules for Azure IoT Edge too! See the **More information** link for a module to find out how to get it, who supports it, etc. ->| Name | More information | Targets gateway SDK version | ->|---------------|---------------------------------------------|-----------------------------| ->| Modbus | https://github.com/Azure/iot-gateway-modbus | 2017-01-13 | ->| OPC-UA Client | https://github.com/Azure/iot-gateway-opc-ua | 2016-11-18 | +>| Name | More information | Targets Azure IoT Edge version | +>|---------------|---------------------------------------------|--------------------------------| +>| Modbus | https://github.com/Azure/iot-gateway-modbus | 2017-01-13 | +>| OPC-UA Client | https://github.com/Azure/iot-gateway-opc-ua | 2016-11-18 | >| GZip Compression (NodeJS) | https://github.com/Azure/iot-gateway-compression-gzip-nodejs | 2016-12-16 | >| Proficy Historian | https://github.com/azure-samples/iot-gateway-proficy-historian | 2017-01-13 | >| SQLite        | https://github.com/Azure/iot-gateway-sqlite | 2017-01-13                 | @@ -55,8 +65,7 @@ We'd love to feature your module here! See our [Contribution guidelines](Contrib more info. ## Operating system compatibility -The SDK is designed to be used with a broad range of operating system platforms. The version -of the Azure IoT Gateway SDK has been tested on the following operating systems: +Azure IoT Edge is designed to be used with a broad range of operating system platforms. It has been tested on the following operating systems: - Ubuntu 14.04 - Ubuntu 15.10 @@ -65,37 +74,36 @@ of the Azure IoT Gateway SDK has been tested on the following operating systems: - Wind River 7.0 ## Hardware compatibility -The SDK is designed to be independent from hardware in addition to the operating system. +Azure IoT Edge is designed to be independent from hardware in addition to the operating system. Developers can power their gateways with hardware as constrained as a microcontroller to systems as powerful as a ruggedized server. ## Directory structure ### /doc -This folder contains general documentation for the SDK as well as step by step instructions +This folder contains general documentation for Azure IoT Edge as well as step by step instructions for building and running the samples: General documentation - [Dev box setup](doc/devbox_setup.md) contains instructions for configuring your machine to -build the Azure IoT Gateway SDK as well as instructions for configuring your machine to build +build Azure IoT Edge as well as instructions for configuring your machine to build modules written in Java, Node.js, and .NET. - [Ubuntu Snap Package Walk-through](doc/azure_iot_gateway_snap.md) provides the step-by-step -instructions used to create the Azure IoT Gateway Snap package. The walk-through is a great -starting point, for anyone trying to integrate the Azure IoT Gateway SDK into their own snap +instructions used to create Azure IoT Edge Snap package. The walk-through is a great +starting point for anyone trying to integrate Azure IoT Edge into their own snap package. API documentation can be found [here](http://azure.github.io/azure-iot-gateway-sdk/api_reference/c/html). ### /samples -This folder contains all of the samples for the Azure IoT Gateway SDK. Samples are separated +This folder contains all of the samples for Azure IoT Edge. Samples are separated in their own folders. Step by step instructions for building and running each sample can be found in the README.md file in the root of each sample's folder. Samples include: -- [Hello World](samples/hello_world/README.md) - Learn the basic concepts of the Azure IoT -Gateway SDK by creating a simple gateway that logs a hello world message to a file every 5 seconds. +- [Hello World](samples/hello_world/README.md) - Learn the basic concepts of Azure IoT Edge by creating a simple gateway that logs a hello world message to a file every 5 seconds. - [Simulated Device](samples/simulated_device_cloud_upload/README.md) Send data to IoTHub from a gateway using a simualted device instead of using a real device. - [Real Device](samples/ble_gateway/README.md) - Send data to IoTHub from a real device that could not @@ -104,7 +112,7 @@ connect to the cloud unless it connected through a gateway. This sample uses a B as the end device . ### /modules -This folder contains all of the modules included with the Azure IoT Gateway SDK. Each module +This folder contains all of the modules included with Azure IoT Edge. Each module represents a specific piece of functionality that can be composed into an end to end gateway solution. Details on the implementation of each module can be found in each module's devdoc/ folder. @@ -118,3 +126,5 @@ Details on the implementation of core components can be found in [core/devdoc](c This is the default folder that cmake will place the output from our build scripts. The developer always has the final say about the destinaiton of build output by creating a folder, navigating to it, and then running cmake from there. Detailed instructions are contained in each sample doc. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments \ No newline at end of file diff --git a/ThirdPartyNotices.txt b/ThirdPartyNotices.txt index 6e5277db..6488843e 100644 --- a/ThirdPartyNotices.txt +++ b/ThirdPartyNotices.txt @@ -1,5 +1,5 @@ -Third Party Notices for the Azure IoT Gateway SDK Project -This Microsoft Open Source project is based on or incorporates material from the project(s) listed below (�Third Party OSS�). The original copyright notice and the license under which Microsoft received such Third Party OSS, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party OSS to you under the licensing terms for the Microsoft product or service. Microsoft reserves all other rights not expressly granted, whether by implication, estoppel or otherwise. +Third Party Notices for the Azure IoT Edge Project +This Microsoft Open Source project is based on or incorporates material from the project(s) listed below (�Third Party OSS�). The original copyright notice and the license under which Microsoft received such Third Party OSS, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party OSS to you under the licensing terms for the Microsoft product or service. Microsoft reserves all other rights not expressly granted, whether by implication, estoppel or otherwise. #SensorTag (http://processors.wiki.ti.com/index.php/CC2650_SensorTag_User's_Guide#Data) Creative Commons Attribution-ShareAlike 3.0 THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. @@ -45,13 +45,13 @@ c. If any provision of this License is invalid or unenforceable under applicable d. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent. e. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You. f. The rights granted under, and the subject matter referenced, in this License were drafted utilizing the terminology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961, the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License, such additional rights are deemed to be included in the License; this License is not intended to restrict the license of any rights under applicable law. -This product incorporates copyrighted material from the open source projects listed below (Third Party IP). The license terms of Azure IoT Gateway SDK Project do not apply to the Third Party IP which is licensed to you under its original license terms which are provided below. Microsoft reserves all rights not expressly granted herein, whether by implication, estoppel or otherwise. You may find a copy of the Corresponding Source code, if and as required under the Third Party IP License, at http://3rdpartysource.microsoft.com. You may also obtain a copy of the source code for a period of three years after our last shipment of this product, if and as required under the Third Party IP license, by sending a check or money order for US$5.00 to: +This product incorporates copyrighted material from the open source projects listed below (Third Party IP). The license terms of Azure IoT Edge Project do not apply to the Third Party IP which is licensed to you under its original license terms which are provided below. Microsoft reserves all rights not expressly granted herein, whether by implication, estoppel or otherwise. You may find a copy of the Corresponding Source code, if and as required under the Third Party IP License, at http://3rdpartysource.microsoft.com. You may also obtain a copy of the source code for a period of three years after our last shipment of this product, if and as required under the Third Party IP license, by sending a check or money order for US$5.00 to: Source Code Compliance Team Microsoft Corporation One Microsoft Way Redmond, WA 98052 USA -Please write �source for [Third Party IP]� in the memo line of your payment. +Please write �source for [Third Party IP]� in the memo line of your payment. ------------------------- #GDBus-Glib D-Bus (https://developer.gnome.org/glib/stable/glib.html) GNU Lesser General Public License diff --git a/bindings/java/README.md b/bindings/java/README.md index ba448925..d247116f 100644 --- a/bindings/java/README.md +++ b/bindings/java/README.md @@ -1,6 +1,6 @@ #Java Binding -This document provides everything one might need to use and understand the Java Binding mechanism used by the **Microsoft Azure IoT Gateway SDK**. +This document provides everything one might need to use and understand the Java Binding mechanism used by **Azure IoT Edge**. ##Contents diff --git a/doc/azure_iot_gateway_snap.md b/doc/azure_iot_gateway_snap.md index 5d225bc3..8fd7a8db 100644 --- a/doc/azure_iot_gateway_snap.md +++ b/doc/azure_iot_gateway_snap.md @@ -1,9 +1,9 @@ -Creating the Azure IoT Gateway Snap +Creating the Azure IoT Edge Snap =================================== A "snap" is a self-contained unit, that can be installed on any platform capable of running `snapd`, the Ubuntu Snap Daemon. Snaps can be created manually, but *should* be created using `snapcraft`, a tool used to programmatically generate snaps. -The following document will walk through creating the Azure IoT Gateway snap package. Snap packages have capabilities far beyond those discussed in this document, but the components required to construct the Azure IoT Gateway snap will be covered in detail. +The following document will walk through creating the Azure IoT Edge snap package. Snap packages have capabilities far beyond those discussed in this document, but the components required to construct the Azure IoT Edge snap will be covered in detail. > #### Vocabulary: > @@ -36,7 +36,7 @@ $ sudo apt update && apt install -y snapd snapcraft > If you are not using an Ubuntu image, then see [Ubuntu's documentation](https://snapcraft.io/docs/build-snaps/trusty) for installing the tools on other platforms. -Authoring the Azure IoT Gateway Snap +Authoring the Azure IoT Edge Snap ------------------------------------ To begin, create a folder for the project, then call `snapcraft init` to create the basic snapcraft folder heirarchy and template. @@ -47,14 +47,14 @@ $ cd aziot/ $ snapcraft init ``` -This provides a `snap` folder, containing a basic template for a `snapcraft.yaml` file. All that is required to create a snap package, is to update the data in the template. Below, the template has been updated for the Azure IoT Gateway snap, and now `snapcraft.yaml` looks like the following... +This provides a `snap` folder, containing a basic template for a `snapcraft.yaml` file. All that is required to create a snap package, is to update the data in the template. Below, the template has been updated for the Azure IoT Edge snap, and now `snapcraft.yaml` looks like the following... ```yaml name: azure-iot-gateway version: '2017-04-12' -summary: Azure IoT Gateway for tailored IoT solutions. +summary: Azure IoT Edge for tailored IoT solutions. description: | - The Azure IoT Gateway SDK lets you build IoT solutions tailored + Azure IoT Edge lets you build IoT solutions tailored to your exact scenario. Connect new or existing devices, regardless of protocol. Process the data in an on-premises gateway using the language of your choice (Java, C#, Node.js, @@ -91,7 +91,7 @@ parts: cp samples/hello-world/hello-world-sample $SNAPCRAFT_PART_INSTALL/ ``` -> *NOTE: There are several more "stanzas" (not-shown) that can be used to make up a `snapcraft.yaml`. Here we only cover the stanzas required to produce the Azure IoT Gateway snap.* +> *NOTE: There are several more "stanzas" (not-shown) that can be used to make up a `snapcraft.yaml`. Here we only cover the stanzas required to produce the Azure IoT Edge snap.* > > *To see the source visit the [Azure IoT launchpad.net repository](https://git.launchpad.net/azure-iot-gateway-snap/tree/snap/snapcraft.yaml)* > @@ -118,9 +118,9 @@ version: '2017-04-12' The version is a human readable string for the consumer, it has *NOTHING* to do with actual versioning. Those versions begin at 1 and are monotomically incremented every time a snap package is generated (*note "generated" not "published"*). ```yaml -summary: Azure IoT Gateway for tailored IoT solutions. +summary: Azure IoT Edge for tailored IoT solutions. description: | - The Azure IoT Gateway SDK lets you build IoT solutions tailored + Azure IoT Edge lets you build IoT solutions tailored to your exact scenario. Connect new or existing devices, regardless of protocol. Process the data in an on-premises gateway using the language of your choice (Java, C#, Node.js, @@ -188,13 +188,13 @@ parts: cp samples/hello-world/hello-world-sample $SNAPCRAFT_PART_INSTALL/ ``` -> ***NOTE:** By simply including this "part" in your snap package, the Azure IoT Gateway will be downloaded, built and installed into your snap package.* +> ***NOTE:** By simply including this "part" in your snap package, Azure IoT Edge will be downloaded, built and installed into your snap package.* Now onto the `parts:` stanza of the `snapcraft.yaml`. The first line is an informal name. You can choose anything that helps you remember how this part interacts with your snap; this part is named "azure-iot-gateway-sdk". Snapcraft has the ability to download code from a remote source, as specified by `source:`. As you can see above, snapcraft has been directed to look for the source code at the Azure GitHub repository. Futhermore, a particular tag has been designated for checkout via the `source-tag:` property. -Snapcraft has a large collection of plugins used to build projects from source. In this case, the Azure IoT Gateway is a CMake project, which is supported by Snapcraft. By setting the `plugin:` property to `cmake`, Snapcraft knows how to build this project. +Snapcraft has a large collection of plugins used to build projects from source. In this case, Azure IoT Edge is a CMake project, which is supported by Snapcraft. By setting the `plugin:` property to `cmake`, Snapcraft knows how to build this project. The next two properties, `build-packages` and `stage-packages`, allow you to describe any `.deb` package dependencies. The `build-packages:` property identifies which `.deb` packages are required to "build" the project using. In other words, any packages listed as `build-packages` will be automatically downloaded for anyone trying to "create" this snap. `stage-packages:` calls out which `.deb` packages are required to satisfy the runtime dependencies, or `.deb` packages that need to be shipped* with the snap. @@ -309,8 +309,8 @@ edge '2017-04-17` 1 Now our snap package is available for download! -Downloading and Installing the Azure IoT Gateway ------------------------------------------------- +Downloading and Installing Azure IoT Edge +----------------------------------------- ```bash $ snap install azure-iot-gateway --edge diff --git a/doc/devbox_setup.md b/doc/devbox_setup.md index 12e873e9..095e9e18 100644 --- a/doc/devbox_setup.md +++ b/doc/devbox_setup.md @@ -1,6 +1,6 @@ # Prepare your development environment -This document describes how to prepare your development environment to use the *Microsoft Azure IoT Gateway SDK*. It describes how to prepare a development environment in Windows using Visual Studio and in Linux. +This document describes how to prepare your development environment to use *Azure IoT Edge*. It describes how to prepare a development environment in Windows using Visual Studio and in Linux. - [Set up a Windows development environment](#set-up-a-windows-development-environment) - [Set up a Linux development environment](#set-up-a-linux-development-environment) @@ -9,7 +9,7 @@ This document describes how to prepare your development environment to use the * ## Set up a Windows development environment -This section shows you how to set up a development environment for the Azure IoT Gateway SDK on Windows 10. +This section shows you how to set up a development environment for Azure IoT Edge on Windows 10. 1. Install [Visual Studio 2015 or 2017](https://www.visualstudio.com). You can use the free Community Edition if you meet the licensing requirements. @@ -37,7 +37,7 @@ This section shows you how to set up a development environment for the Azure IoT ## Set up a Linux development environment -This section shows you how to set up a development environment for the Azure IoT Gateway SDK on Ubuntu. +This section shows you how to set up a development environment for Azure IoT Edge on Ubuntu. 1. The following packages are needed and they can be installed with the following commands: @@ -58,7 +58,7 @@ This section shows you how to set up a development environment for the Azure IoT ## Set up cross-compiling for Wind River Linux 7 -This section shows you how to set up a development environment for the Azure IoT Gateway SDK for cross-compiling to Wind River Linux on Ubuntu. +This section shows you how to set up a development environment for the Azure IoT Edge for cross-compiling to Wind River Linux on Ubuntu. 1. Set up the Ubuntu system as described in the previous section: [Setting up a Linux development environment](#set-up-a-linux-development-environment). @@ -72,7 +72,7 @@ This section shows you how to set up a development environment for the Azure IoT 1. By default, the toolchain will install to a directory like: `/opt/windriver/wrlinux/7.0-intel-baytrail-64` -1. Change directory to the Azure IoT Gateway SDK repository. +1. Change directory to the Azure IoT Edge repository. 1. Run the Wind River Linux build script: diff --git a/doc/docker_how_to.md b/doc/docker_how_to.md index 6d0a6ee7..ed0b6fa7 100644 --- a/doc/docker_how_to.md +++ b/doc/docker_how_to.md @@ -2,7 +2,7 @@ ## Overview In `tools/` directory there is a Dockerfile provided that allows you to quickly setup linux environment -for the Gateway project. +for Azure IoT Edge project. ## Building To build the image you need to already have [Docker installed and running](https://www.docker.com/products/docker). You should step into `tools/` @@ -10,7 +10,7 @@ directory and run: ```bash docker build -t azure-iot-gateway . ``` -After a few minutes a reusable image will be created ready to build the Gateway with java and nodejs +After a few minutes a reusable image will be created ready to build Azure IoT Edge with java and nodejs bindings working. There is no need to rebuild the image afterwards as each run will make it's own copy of it. ## Stepping into @@ -18,14 +18,14 @@ If you want to step into the enviorment and work from there the simplest way is `docker run -ti --entrypoint bash azure-iot-gateway` which will create a writeable container from the copy of the azure-iot-gateway image with bash running inside. -In the interactive shell there will be no Gateway source so you need to clone it yourself, but NodeJS will be already +In the interactive shell there will be no Azure IoT Edge source so you need to clone it yourself, but NodeJS will be already build and JDK environment set up. ## Tests -By default the entrypoint of the image is to run unit tests for the Gateway and bindings from the upstream +By default the entrypoint of the image is to run unit tests for Azure IoT Edge and bindings from the upstream repository on `master` branch. Additionally tests are also checked for memory leaks with valgrind. You can easily run the tests with `docker run --rm azure-iot-gateway`. -You can change which repository and branch you want to download and test the Gateway from by overriding +You can change which repository and branch you want to download and test Azure IoT Edge from by overriding `GATEWAY_REPO` and `COMMIT_ID` environment variables with this command: `docker run -e GATEWAY_REPO=http://my.repo.git -e COMMIT_ID=master azure-iot-gateway` diff --git a/samples/azure_functions_sample/README.md b/samples/azure_functions_sample/README.md index f3993565..c915f319 100644 --- a/samples/azure_functions_sample/README.md +++ b/samples/azure_functions_sample/README.md @@ -1,10 +1,10 @@ -Azure Functions Sample for Azure IoT Gateway SDK -================================================ +Azure Functions Sample for Azure IoT Edge +========================================= Overview -------- -This sample showcases how one can build an IoT Gateway that interacts with Azure Functions using the Azure IoT Gateway SDK. +This sample showcases how one can build an IoT gateway that interacts with Azure Functions using Azure IoT Edge. Details about Azure Functions can be found on [Introduction to Azure Functions](https://azure.microsoft.com/en-us/blog/introducing-azure-functions/). The sample contains the following modules: @@ -12,7 +12,7 @@ The sample contains the following modules: 1. Hello World module. A module that sends random data on our gateway bus. 2. Azure Functions module. A module that receives this data and sends to the cloud. More details on this module here [Azure Functions Module](../../modules/azure_functions/devdoc/azure_functions.md) -How does the data flow through the Gateway +How does the data flow through the gateway ------------------------------------------ Here's the journey that a piece of data takes originating from the hello_world module to Azure Functions. @@ -23,9 +23,8 @@ Here's the journey that a piece of data takes originating from the hello_world m Building the sample ------------------- -The sample gets built when you build the SDK by running `tools/build.sh` for Linux or `tools\build.cmd` for windows. The -[devbox setup](../../doc/devbox_setup.md) guide has information on how you can build the -SDK. +The sample gets built when you build Azure IoT Edge by running `tools/build.sh` for Linux or `tools\build.cmd` for windows. The +[devbox setup](../../doc/devbox_setup.md) guide has information on how you can build Azure IoT Edge. Setting up your Azure Functions ------------------------------- diff --git a/samples/ble_gateway/README.md b/samples/ble_gateway/README.md index 1cc81bbd..1d36ea8b 100644 --- a/samples/ble_gateway/README.md +++ b/samples/ble_gateway/README.md @@ -1,11 +1,11 @@ -Bluetooth Low Energy Telemetry Sample for Azure IoT Gateway SDK -=============================================================== +Bluetooth Low Energy Telemetry Sample for Azure IoT Edge +======================================================== Overview -------- -This sample showcases how one can build an IoT Gateway that interacts with a -Bluetooth Low Energy (BLE) device using the Azure IoT Gateway SDK. A more in +This sample showcases how one can build an IoT gateway that interacts with a +Bluetooth Low Energy (BLE) device using Azure IoT Edge. A more in depth [walkthrough](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-gateway-sdk-physical-device) with concept explanations and code snippets can be found on [docs.microsoft.com](https://docs.microsoft.com/en-us/azure/iot-hub/). @@ -22,7 +22,7 @@ The sample contains the following modules: 5. A BLE Printer module that interprets telemetry from the Texas Instruments SensorTag device and prints formatted data to the console. -How does the data flow through the Gateway +How does the data flow through the gateway ------------------------------------------ The telemetry upload data flow pipeline is best described via a block diagram: @@ -66,9 +66,8 @@ Building the sample ------------------- At this point, gateways containing BLE modules are only supported on Linux. The -sample gets built when you build the SDK by running `tools/build.sh`. The -[devbox setup](../../doc/devbox_setup.md) guide has information on how you can build the -SDK. +sample gets built when you build Azure IoT Edge by running `tools/build.sh`. The +[devbox setup](../../doc/devbox_setup.md) guide has information on how you can build Azure IoT Edge. Preparing your BLE device ------------------------- diff --git a/samples/ble_gateway/connecting_to_ble_device_on_rpi3.md b/samples/ble_gateway/connecting_to_ble_device_on_rpi3.md index bffa002c..16705fad 100644 --- a/samples/ble_gateway/connecting_to_ble_device_on_rpi3.md +++ b/samples/ble_gateway/connecting_to_ble_device_on_rpi3.md @@ -1,10 +1,10 @@ -Azure IoT Gateway - Connecting to a Bluetooth Low Energy device on the Raspberry Pi 3 +Azure IoT Edge - Connecting to a Bluetooth Low Energy device on the Raspberry Pi 3 =================================================================================== Overview -------- -As it stands today, the Bluetooth LE (BLE) module that the Azure IoT Gateway SDK +As it stands today, the Bluetooth LE (BLE) module that Azure IoT Edge ships with does not support *discovery* of BLE devices. This is however on the product roadmap. In the meantime, the BLE module is perfectly usable for prototyping solutions by performing some preparatory work as documented here. @@ -138,4 +138,4 @@ Before running the sample, you need to verify that your Raspberry Pi 3 can conne [CHG] Device A0:E6:F8:B5:F6:00 Connected: no ``` -You're now ready to run the BLE Gateway sample on your Raspberry Pi 3. \ No newline at end of file +You're now ready to run the BLE gateway sample on your Raspberry Pi 3. \ No newline at end of file diff --git a/samples/dotnet_binding_sample/README.md b/samples/dotnet_binding_sample/README.md index 7843f2fb..ffea6f75 100644 --- a/samples/dotnet_binding_sample/README.md +++ b/samples/dotnet_binding_sample/README.md @@ -4,7 +4,7 @@ Overview -------- -This sample showcases how one might build modules for IoT Gateway in .NET. +This sample showcases how one might build modules for Azure IoT Edge in .NET. The sample contains: @@ -23,7 +23,7 @@ Prerequisites 1. Setup your Windows development machine. A guide for doing this can be found [here](../../doc/devbox_setup.md). 2. Make sure you have .NET Framework installed. Our current version of the binding was tested and loads modules written in .NET version v4.0.30319. -How does the data flow through the Gateway +How does the data flow through the gateway ------------------------------------------ You can find the diagram for Receiving a message and publishing a message on this flow chart: @@ -33,7 +33,7 @@ You can find the diagram for Receiving a message and publishing a message on thi Building the sample ------------------- At this point, gateways containing .NET modules are only supported on Windows -Desktop. The sample Gateway gets built when you build the SDK by first running +Desktop. The sample gateway gets built when you build Azure IoT Edge by first running ``` tools\build_dotnet.cmd ``` @@ -42,7 +42,7 @@ then running tools\build.cmd --enable-dotnet-binding ``` -The [devbox setup](../../doc/devbox_setup.md) guide has more information on how you can build the SDK. +The [devbox setup](../../doc/devbox_setup.md) guide has more information on how you can build Azure IoT Edge. The `build_dotnet.cmd` script builds the .NET Modules in the solution located here (../bindings/dotnet/dotnet-binding/dotnet-binding.sln). Today the Solution has: @@ -156,7 +156,7 @@ namespace PrinterModule } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Modules may also implement the `IGatewayModuleStart` interface. The Start method is called when the Gateway's Broker is ready for the module to send and receive messages. +Modules may also implement the `IGatewayModuleStart` interface. The Start method is called when the gateway's Broker is ready for the module to send and receive messages. 4. Add your new module on Json configuration: ```json diff --git a/samples/dotnet_core_managed_gateway/README.md b/samples/dotnet_core_managed_gateway/README.md index 4f3506bb..07768308 100644 --- a/samples/dotnet_core_managed_gateway/README.md +++ b/samples/dotnet_core_managed_gateway/README.md @@ -4,7 +4,7 @@ Overview -------- -This sample showcases how one might build an IoT Gateway as a .NET Core Application and still be able to load .NET Core Modules. +This sample showcases how one might build an IoT gateway as a .NET Core Application and still be able to load .NET Core Modules. The sample contains: @@ -25,12 +25,12 @@ Prerequisites Building the sample ------------------- -The sample Gateway gets built when you build the SDK by first running +The sample gateway gets built when you build Azure IoT Edge by first running ``` tools\build.cmd --enable-dotnet-core-binding ``` -The [devbox setup](../../doc/devbox_setup.md) guide has more information on how you can build the SDK. +The [devbox setup](../../doc/devbox_setup.md) guide has more information on how you can build Azure IoT Edge. The `build_dotnet_core.cmd` script builds the .NET Core binding, and the sample sensor and printer modules. Building the solution you will have the following binaries: diff --git a/samples/dotnet_core_module_sample/README.md b/samples/dotnet_core_module_sample/README.md index 2a8f9eb9..0db81740 100644 --- a/samples/dotnet_core_module_sample/README.md +++ b/samples/dotnet_core_module_sample/README.md @@ -4,7 +4,7 @@ Overview -------- -This sample showcases how one might build modules for IoT Gateway in .NET Core. +This sample showcases how one might build modules for IoT gateway in .NET Core. The sample contains: @@ -24,12 +24,12 @@ Prerequisites Building the sample ------------------- -The sample Gateway gets built when you build the SDK by first running +The sample gateway gets built when you build Azure IoT Edge by first running ``` tools\build.cmd --enable-dotnet-core-binding ``` -The [devbox setup](../../doc/devbox_setup.md) guide has more information on how you can build the SDK. +The [devbox setup](../../doc/devbox_setup.md) guide has more information on how you can build Azure IoT Edge. The `build_dotnet_core.cmd` script builds the .NET Core binding, and the sample sensor and printer modules. Building the solution you will have the following binaries: @@ -131,7 +131,7 @@ namespace PrinterModule } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Modules may also implement the `IGatewayModuleStart` interface. The Start method is called when the Gateway's Broker is ready for the module to send and receive messages. +Modules may also implement the `IGatewayModuleStart` interface. The Start method is called when the gateway's Broker is ready for the module to send and receive messages. 4. Add your new module on Json configuration: ```json diff --git a/samples/dynamically_add_module_sample/README.md b/samples/dynamically_add_module_sample/README.md index 130b272d..70839bf7 100644 --- a/samples/dynamically_add_module_sample/README.md +++ b/samples/dynamically_add_module_sample/README.md @@ -1,10 +1,10 @@ -# Azure IoT Gateway SDK - Dynamically Add Module Sample +# Azure IoT Edge - Dynamically Add Module Sample -This document provides a detailed overview of the Dynamically Add Module sample [code](./src) which uses the fundamental components of the Azure IoT Gateway SDK architecture to create a gateway without modules, adding modules (and links) from a JSON file after the gateway is created, starting a gateway, removing a module and destroying a gateway. +This document provides a detailed overview of the Dynamically Add Module sample [code](./src) which uses the fundamental components of Azure IoT Edge architecture to create a gateway without modules, adding modules (and links) from a JSON file after the gateway is created, starting a gateway, removing a module and destroying a gateway. # Dev box setup -A dev box configured with the SDK and necessary libraries is necessary to complete this walkthrough. Please complete the [dev box setup](../../doc/devbox_setup.md) before continuing. +A dev box configured with Azure IoT Edge and necessary libraries is necessary to complete this walkthrough. Please complete the [dev box setup](../../doc/devbox_setup.md) before continuing. # The sample contains: diff --git a/samples/hello_world/README.md b/samples/hello_world/README.md index d8c244db..346c146f 100644 --- a/samples/hello_world/README.md +++ b/samples/hello_world/README.md @@ -1,11 +1,11 @@ -# Azure IoT Gateway SDK - Hello World +# Azure IoT Edge - Hello World -This document provides a detailed overview of the Hello World sample [code](./src) which uses the fundamental components of the Azure IoT Gateway SDK architecture to log a hello world message to a file every 5 seconds. +This document provides a detailed overview of the Hello World sample [code](./src) which uses the fundamental components of Azure IoT Edge architecture to log a hello world message to a file every 5 seconds. # The walkthrough covers 1. **Dev box setup** - steps necessary to build and run the sample -2. **Concepts** - conceptual overview of the components that compose any gateway created with the SDK +2. **Concepts** - conceptual overview of the components that compose any gateway created with Azure IoT Edge 3. **Hello World sample architecture** - describes how the concepts apply to the sample and how the components fit together 4. **Detailed architecture** - detailed view of the Hello World sample's architecture 5. **How to build the sample** @@ -15,23 +15,23 @@ This document provides a detailed overview of the Hello World sample [code](./sr ## Dev box setup -A dev box configured with the SDK and necessary libraries is necessary to complete this walkthrough. Please complete the [dev box setup](../../doc/devbox_setup.md) before continuing. +A dev box configured with Azure IoT Edge and necessary libraries is necessary to complete this walkthrough. Please complete the [dev box setup](../../doc/devbox_setup.md) before continuing. ## Concepts ### Modules -Modules are the brains of a gateway built with the Azure IoT Gateway SDK. Modules exchange data with each other via messages. A module receives a message, performs some action on it, might transform it into a new message, and subsequently publishes it to other modules. There might be modules that only produce new messages and never process incoming messages. A chain of modules can be thought of as a data processing pipeline with a module being nothing more than a chunk of code performing a transformation on the data at one point in that pipeline. +Modules are the brains of a gateway built with Azure IoT Edge. Modules exchange data with each other via messages. A module receives a message, performs some action on it, might transform it into a new message, and subsequently publishes it to other modules. There might be modules that only produce new messages and never process incoming messages. A chain of modules can be thought of as a data processing pipeline with a module being nothing more than a chunk of code performing a transformation on the data at one point in that pipeline. ![](../../doc/media/modules.png) -The SDK contains the following: +Azure IoT Edge contains the following: - prewritten modules which perform common gateway functions - the interfaces needed for a developer to write his own custom modules - the infrastructure necessary to deploy and run a set of modules -The SDK abstracts away operating system dependencies via an abstraction layer in order to allow for gateways to be built on a variety of platforms. +Azure IoT Edge abstracts away operating system dependencies via an abstraction layer in order to allow for gateways to be built on a variety of platforms. ![](../../doc/media/modules_2.png) @@ -243,7 +243,7 @@ Below is an example of typical output that is written to the log file when the H ### Gateway creation -The gateway process needs to be written by the developer. This a program which creates internal infrastructure (e.g. the broker), loads the correct modules, and sets everything up to function correctly. The SDK provides the `Gateway_CreateFromJson` function which allows developers to bootstrap a gateway from a JSON file. +The gateway process needs to be written by the developer. This a program which creates internal infrastructure (e.g. the broker), loads the correct modules, and sets everything up to function correctly. Azure IoT Edge provides the `Gateway_CreateFromJson` function which allows developers to bootstrap a gateway from a JSON file. `Gateway_CreateFromJson` deals with creating internal infrastructure (e.g. the broker), loading modules, and setting everything up to function correctly. All the developer needs to do is provide this function with the path to a JSON file specifying what modules they want loaded and links to guide the broker to send messages to the correct module. The configuration file must be encoded either as ASCII or UTF-8. @@ -355,10 +355,10 @@ int helloWorldThread(void *param) MESSAGE_CONFIG msgConfig; MAP_HANDLE propertiesMap = Map_Create(NULL); - // add a property named "helloWorld" with a value of "from Azure IoT - // Gateway SDK simple sample!" to a set of message properties that + // add a property named "helloWorld" with a value of "from Azure IoT Edge + // simple sample!" to a set of message properties that // will be appended to the message before publishing it. - Map_AddOrUpdate(propertiesMap, "helloWorld", "from Azure IoT Gateway SDK simple sample!") + Map_AddOrUpdate(propertiesMap, "helloWorld", "from Azure IoT Edge simple sample!") // set the content for the message msgConfig.size = strlen(HELLOWORLD_MESSAGE); diff --git a/samples/java_sample/java_devbox_setup.md b/samples/java_sample/java_devbox_setup.md index 9aeb8898..b851c022 100644 --- a/samples/java_sample/java_devbox_setup.md +++ b/samples/java_sample/java_devbox_setup.md @@ -1,16 +1,16 @@ # Prepare your development environment (Java) -This document describes how to prepare your development environment to use the *Microsoft Azure IoT Gateway SDK* for Java module development. +This document describes how to prepare your development environment to use the *Azure IoT Edge* for Java module development. - [Java JDK SE](#installjava) - [Maven 3](#installmaven) -- [Azure IoT Gateway SDK for Java](#installgw) +- [Azure IoT Edge for Java](#installgw) - [Build from source](#installgwsource) - [Application Samples](#samplecode) ## Install Java JDK SE -To use the SDK and run the samples you will need a **32-bit** installation of a **JDK** (it is insufficient to only have the JRE installed). +To use Azure IoT Edge and run the samples you will need a **32-bit** installation of a **JDK** (it is insufficient to only have the JRE installed). ### Windows For downloads and installation instructions go here: http://www.oracle.com/technetwork/java/javase/downloads/index.html @@ -53,7 +53,7 @@ Depending on your Linux distribution, you can install the JDK using *apt-get*, a ## Install Maven -Using **_Maven 3_** is the recommended way to install the interfaces and classes for the Java binding mechanism for the **Microsoft Azure IoT Gateway SDK**. +Using **_Maven 3_** is the recommended way to install the interfaces and classes for the Java binding mechanism for **Azure IoT Edge**. ### Windows For downloads and installation instructions go here: https://maven.apache.org/download.cgi @@ -91,13 +91,13 @@ Ensure that the bin directory shown by the ```which mvn``` command matches one o You can verify that the environment variables necessary to run **_Maven 3_** have been set correctly by running `mvn --version`. -## Install Azure IoT Gateway SDK +## Install Azure IoT Edge -- There are two ways to get the .jar library for the Java module binding for the Microsoft Azure IoT Gateway SDK. You may either download the source code and build on your machine, or include the project as a dependency in your project if your project is a Maven project. Both methods are described below. +- There are two ways to get the .jar library for the Java module binding for Azure IoT Edge. You may either download the source code and build on your machine, or include the project as a dependency in your project if your project is a Maven project. Both methods are described below. -### Build Java binding for the Azure IoT Gateway SDK from sources -- Get a copy of the **Azure IoT Gateway SDK** from GitHub if you have not already done so. You should fetch a copy of the source from the **master** branch of the GitHub repository: +### Build Java binding for Azure IoT Edge from sources +- Get a copy of **Azure IoT Edge** from GitHub if you have not already done so. You should fetch a copy of the source from the **master** branch of the GitHub repository: - When you have obtained a copy of the source, you can build the binding for Java. Open a command prompt and use the following commands for the steps above: @@ -111,7 +111,7 @@ Open a command prompt and use the following commands for the steps above: The compiled JAR file with all dependencies bundled in can then be found at: ``` -{IoT gateway SDK root}/bindings/java/gateway-java-binding/target/gateway-java-binding-{version}.jar +{Azure IoT Edge root}/bindings/java/gateway-java-binding/target/gateway-java-binding-{version}.jar ``` When you're ready to build your own module in Java, include this JAR file in your project to get the interfaces and classes that you need. @@ -119,6 +119,6 @@ When you're ready to build your own module in Java, include this JAR file in you ## Sample applications -This repository contains a sample gateway that includes modules written in Java that illustrate how to write modules in Java and use the Microsoft Azure IoT Gateway SDK. For more information, see the [readme][readme]. +This repository contains a sample gateway that includes modules written in Java that illustrate how to write modules in Java and use Azure IoT Edge. For more information, see the [readme][readme]. [readme]: ./README.md diff --git a/samples/native_module_host_sample/README.md b/samples/native_module_host_sample/README.md index f3d9512c..ba7454cb 100644 --- a/samples/native_module_host_sample/README.md +++ b/samples/native_module_host_sample/README.md @@ -1,4 +1,4 @@ -# Azure IoT Gateway SDK - native module host example +# Azure IoT Edge - native module host example This document provides an overview of the out of process module [code](./src) which allows a native gateway module to run in a separate process. diff --git a/samples/nodejs_simple_sample/README.md b/samples/nodejs_simple_sample/README.md index c3823ab9..975ba6b7 100644 --- a/samples/nodejs_simple_sample/README.md +++ b/samples/nodejs_simple_sample/README.md @@ -1,5 +1,5 @@ # How-To Enable Node JS Module Development -This document describes how to prepare your development environment to use the *Microsoft Azure IoT Gateway SDK* for Node JS module development. +This document describes how to prepare your development environment to use *Azure IoT Edge* for Node JS module development. ## Prerequisites - Install [Node.js](https://nodejs.org/) diff --git a/samples/proxy_sample/README.md b/samples/proxy_sample/README.md index 03e3f7d9..33692340 100644 --- a/samples/proxy_sample/README.md +++ b/samples/proxy_sample/README.md @@ -1,4 +1,4 @@ -# Azure IoT Gateway SDK - out of process proxy module example +# Azure IoT Edge - out of process proxy module example This document provides an overview of the out of process module [code](./src) which allows a module to run in a separate process. diff --git a/samples/simulated_device_cloud_upload/README.md b/samples/simulated_device_cloud_upload/README.md index 1517c780..1836f71e 100644 --- a/samples/simulated_device_cloud_upload/README.md +++ b/samples/simulated_device_cloud_upload/README.md @@ -1,4 +1,4 @@ -# Simulated Device Cloud Upload sample for Azure IoT Gateway SDK +# Simulated Device Cloud Upload sample for Azure IoT Edge These are step by step instructions on how to build and run this sample. A more in depth walkthrough, for both [Linux](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-linux-gateway-sdk-simulated-device) and