Skip to content

05 Getting started examples

Jump to bottom
Dave Glover edited this page Dec 2, 2023 · 26 revisions

Getting started with Azure Sphere DevX and RemoteX examples

Clone the EdgeDevX.Examples

For Windows users, you must clone the project into the WSL2 filesystem. Not the Windows filesystem.

  1. Clone the repo

    git clone https://github.com/Azure-Sphere-DevX/EdgeDevX.Examples.git

  2. Initialize and update the repo submodules

    cd EdgeDevX.Examples && git submodule update --init --recursive

Building samples on macOS and Linux

  1. On macOS, build with the Clang compiler.
  2. On Linux, build with the GCC compiler.

Samples

There are six examples in the EdgeDevX.Examples repo:

  1. simple_publish:
    • Demonstrates simple publish message to Azure IoT Hub or IoT Central.
  2. avnet_end_to_end:
    • Demonstrates the use of the EdgeDevX library to publishing data, device twins and direct methods to Azure IoT Services.
  3. avnet_end_to_end_ext:
    • Demonstrates the use of the EdgeDevX library in conjunction with the RemoteX library to publishing data, device twins and direct methods to Azure IoT Services.
    • This example uses the RemoteX library to interaction with an Avnet Azure Sphere device across your network to read sensor data.
    • Update the RemoteX.cmake file with the IP address of your Azure Sphere.
  4. device_twins:
    • Simple example demonstarting the use of device twin bindings and binding functions to Azure IoT Services.
  5. direct_methods:
    • Simple example demonstarting the use of direct method bindings and binding functions with Azure IoT Services.
  6. environment_logger:
    • RemoteX example demonstrating Azure Sphere remote peripheral access to an 8x8 LED panel, reading sensr data from an Avent Azure Sphere dev board and logging data to mutable storage.
    • Update the RemoteX.cmake file with the IP address of your Azure Sphere.
  7. GPIO on Linux:
    • Demostrates using GPIO on Linux.
  8. hello_world:
    • Simple example of using the Azure Sphere RemoteX library. Update the RemoteX.cmake file with the IP address of your Azure Sphere.
  9. openai_functions:
    • Build a conversational intelligent edge device with OpenAI Functions.
  10. Altair 8800 Emulator

Getting started with the EdgeDevX examples

The following steps assumed you are going to run the avnet_end_to_end example from Visual Studio Code

  1. Start Visual Studio Code

  2. If you are using a Linux or macOS computer, then open the avnet_end_to_end folder in the EdgeDevX.Examples folder.

  3. If you are a Windows user, then you cloned the repo into the WSL filesystem. Open the project with using the VS Code Remote WSL extension.

  4. If you cloned the repo to a network connected Linux computer (including a Raspberry Pi), open the project using the VS Code Remote SSL extension.

  5. Open the .vscode/launch.json file and update the args property with your IoT DPS or IoT Central config.

    "args": [ "-s", "ID_SCOPE", "-d", "DEVICE_ID", "-k", "DERIVED_DEVICE_KEY", "-n", "NETWORK_INTERFACE" ],

    The network interface is passed to the dx_azureConnect(&dx_config, dx_config.network_interface, IOT_PLUG_AND_PLAY_MODEL_ID); function in InitPeripheralsAndHandlers function.

    The network interface argument is optional and declares the network interface with an active internet connection, for example, eth0, or wlan0. If the network interface is specified then an end to end network connectivity test to www.msftconnecttest.com is performed no more that once every 3 minutes. This is in line with the Networking_GetInterfaceConnectionStatus function.

  6. If you plan to extent this application to use AzureSphereRemoteX then refer to Intro to Azure Sphere RemoteX.

  7. Press F1, and select CMake: Delete Cache and Reconfigure.

  8. Press F5 to start CMake build and run the project with the debugger.

  9. Press Shift+F5 to start CMake build and run the project without the debugger.

Run the application from the command line

The following is an example of running an IoT Hub/Central EdgeDevX application from the command line and appsing in the ID Scope, device id and device derived id.

  1. Compile the application.

    cd avnet_end_to_end && \
mkdir -p build && \
cmake -B build && \
cmake --build build --config release --target all && \
cd ..

    Note, you can optismise the cmake build process by pss in the jobs argument with a number that matches the number of CPU cores on your computer. The following example optimises cmake for an 8 core CPU.

    cd avnet_end_to_end && \
mkdir -p build && \
cmake -B build && \
time cmake --build build --config release --target all -j 8 && \
cd ..

  2. Run the compiled application.

    See IoT Hub and IoT Central configuration.

    ./build/avnet_end_to_end -s "<YOUR_ID_SCOPE>" -d "<YOUR_DEVICE_ID>" -k "<YOUR_DERIVED_DEVICE_KEY>"

  3. Specifying the network interface

    The network interface argument is optional and declares the network interface with an active internet connection, for example, eth0, or wlan0. If the network interface is specified then an end to end network connectivity test to http://www.msftconnecttest.com is performed no more that once every 3 minutes. This is in line with the Networking_GetInterfaceConnectionStatus function.

    The network interface is passed to the dx_azureConnect(&dx_config, dx_config.network_interface, IOT_PLUG_AND_PLAY_MODEL_ID); function in InitPeripheralsAndHandlers function.

    The following example specifies eth0 as the active internet connection.

    ./build/avnet_end_to_end -s "<YOUR_SCOPE_ID>" -d "<YOUR_DEVICE_ID>" -k "<YOUR_DERIVED_DEVICE_KEY>" -n "eth0"

Network interface tools

You can list the network interfaces on your computer or linux device using the following tool. This will list all the network interfaces on the computer. Look for the adapter with a valid IP address. If you are using WSL then the network interface is eth0.

ifconfig

References

Clone this wiki locally