Skip to content
This repository has been archived by the owner on Oct 12, 2023. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'origin/master' into 2016-12-16-release
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-buckley committed Dec 16, 2016
2 parents fd855f2 + 92be574 commit 42a84de
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 10 deletions.
4 changes: 2 additions & 2 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -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 [iot-gateway-sdk](http://stackoverflow.com/questions/tagged/iot-gateway-sdk) tag.
section and Stack Overflow, especially the [azure-iot-gateway-sdk](http://stackoverflow.com/questions/tagged/azure-iot-gateway-sdk) tag.

----------

Expand Down Expand Up @@ -47,4 +47,4 @@ Your module's documentation must be discoverable from the page at this URL.

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.

**Note**: We reserve the right to remove a module's entry from the table if it hasn't been updated in a while.
**Note**: We reserve the right to remove a module's entry from the table if it hasn't been updated in a while.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
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 [[email protected]](mailto:[email protected]) with any additional questions or comments

# Azure IoT Gateway SDK
Using this SDK, developers write applications that enable gateway-connected devices to
communicate with Azure IoT Hub. Such applications use a collection of **modules** to aggregate
and transform data, process commands, or perform any number of related tasks. Modules
communicate with one another via a message broker. Developers can choose from available modules
or write their own to create gateways tailored to any scenario.
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
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.

Visit http://azure.com/iotdev to learn more about developing applications for Azure IoT.
In the image below an existing device has been connected to the cloud using edge intelligence. The
on-premises gateway not only preforms protocol adaptation which allows the device to send data to the
cloud, it also filters the data so that only the most important information is uploaded.

![](doc/media/READMEDiagram.png)

Using existing modules from the Azure IoT Gateway SDK 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.

## SDK Modules
The following modules are available in this repository:
Expand All @@ -26,7 +37,7 @@ Other people are creating modules for the gateway SDK too! See the **More inform
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 | 2016-11-02 |
>| Modbus | https://github.com/Azure/iot-gateway-modbus | 2016-11-18 |
>| OPC-UA Client | https://github.com/Azure/iot-gateway-opc-ua | 2016-11-18 |
We'd love to feature your module here! See our [Contribution guidelines](Contributing.md) for
Expand Down
Binary file added doc/media/READMEDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion samples/hello_world/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Linux

Windows

- From a Developer Command for VS2015 run `build.cmd`. `build.cmd` produces a folder called `build` in the root repo folder. This is where the two module dlls and executable used in this sample are built.
- `build.cmd` produces a folder called `build` in the root repo folder. This is where the two module dlls and executable used in this sample are built.
> Note: The logger module is built as `\modules\logger\Debug\logger.dll`. The hello world module is built as `\modules\hello_world\Debug\hello_world.dll`. The sample exe is built as `\samples\hello_world\Debug\hello_world_sample.exe`.
- The hello_world_sample process takes the path to a JSON configuration file as an argument in the command line. An example JSON file has been provided as part of the repo at `azure-iot-gateway-sdk\samples\hello_world\src\hello_world_win.json' and is copied below. It will work as is unless you have modified the build script to place modules or sample executables in non-default locations.
Expand Down

0 comments on commit 42a84de

Please sign in to comment.