Skip to content

Latest commit

 

History

History
88 lines (76 loc) · 3.81 KB

iot-hub-linux-gateway-sdk-get-started.md

File metadata and controls

88 lines (76 loc) · 3.81 KB
title description services documentationcenter author manager editor ms.assetid ms.service ms.devlang ms.topic ms.tgt_pltfrm ms.workload ms.date ms.author
Get started with the Azure IoT Gateway SDK (Linux) | Microsoft Docs
How to build a gateway on a Linux machine and learn about key concepts in the Azure IoT Gateway SDK such as modules and JSON configuration files.
iot-hub
chipalost
timlt
cf537bdd-2352-4bb1-96cd-a283fcd3d6cf
iot-hub
cpp
get-started-article
na
na
11/23/2016
andbuc

Get started with the Azure IoT Gateway SDK (Linux)

[!INCLUDE iot-hub-gateway-sdk-getstarted-selector]

How to build the sample

Before you get started, you must set up your development environment for working with the SDK on Linux.

  1. Open a shell.
  2. Navigate to the root folder in your local copy of the azure-iot-gateway-sdk repository.
  3. Run the tools/build.sh --skip-unittests script. This script uses the cmake utility to create a folder called build in the root folder of your local copy of the azure-iot-gateway-sdk repository and generate a makefile. The script then builds the solution, skipping unit tests. Remove the --skip-unittests parameter if you want to build and run the unit tests.

Note

Every time you run the build.sh script, it deletes and then recreates the build folder in the root folder of your local copy of the azure-iot-gateway-sdk repository.

How to run the sample

  1. The build.sh script generates its output in the build folder in your local copy of the azure-iot-gateway-sdk repository. This includes the two modules used in this sample.

    The build script places liblogger.so in the build/modules/logger/ folder and libhello_world.so in the build/modules/hello_world/ folder. Use these paths for the module path value as shown in the JSON settings file below.

  2. 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.

    [!NOTE] The module paths are relative to the current working directory from where the hello_world_sample executable is launched, not the directory where the executable is located. The sample JSON configuration file defaults to writing 'log.txt' in your current working directory.

    {
    "modules" :
    [
        {
          "name" : "logger",
          "loader": {
            "name": "native",
            "entrypoint": {
              "module.path": "./modules/logger/liblogger.so"
            }
          },
          "args" : {"filename":"log.txt"}
        },
        {
            "name" : "hello_world",
          "loader": {
            "name": "native",
            "entrypoint": {
              "module.path": "./modules/hello_world/libhello_world.so"
            }
          },
            "args" : null
        }
    ],
    "links": 
    [
        {
            "source": "hello_world",
            "sink": "logger"
        }
    ]
}

  3. Navigate to azure-iot-gateway-sdk/build folder.

  4. Run the following command:

    ./samples/hello_world/hello_world_sample ./../samples/hello_world/src/hello_world_lin.json

[!INCLUDE iot-hub-gateway-sdk-getstarted-code]