Quickstart: Find available rooms by using Azure Digital Twins

The Azure Digital Twins service allows you to re-create a digital image of your physical environment. You can then get notified by events in your environment and customize your responses to them.

This quickstart uses a pair of .NET samples to digitize an imaginary office building. It shows you how to find available rooms in that building. With Digital Twins, you can associate many sensors with your environment. You also can find out if the air quality of your available room is optimal with the help of a simulated sensor for carbon dioxide. One of the sample applications generates random sensor data to help you visualize this scenario.

The following video summarizes quickstart setup:

Prerequisites

  1. If you don't have an Azure account, create a free account before you begin.

  2. The two console applications you run in this quickstart are written by using C#. Install the .NET Core SDK version 2.1.403 or above on your development machine. If you have the .NET Core SDK installed, verify the current version of C# on your development machine. Run dotnet --version in a command prompt.

  3. Download the sample C# project. Extract the digital-twins-samples-csharp-master.zip archive.

Create a Digital Twins instance

Create a new instance of Digital Twins in the portal by following the steps in this section.

  1. Sign in to the Azure portal.

  2. From the left pane, select Create a resource. Search for digital twins, and select Digital Twins. Select Create to start the deployment process.

    Selections for creating a new Digital Twins instance

  3. In the Digital Twins pane, enter the following information:

    • Resource Name: Create a unique name for your Digital Twins instance.

    • Subscription: Choose the subscription that you want to use to create this Digital Twins instance.

    • Resource group: Select or create a resource group for the Digital Twins instance.

    • Location: Select the closest location to your devices.

      Digital Twins pane with entered information

  4. Review your Digital Twins information, and then select Create. Your Digital Twins instance might take a few minutes to be created. You can monitor the progress in the Notifications pane.

  5. Open the Overview pane of your Digital Twins instance. Note the link under Management API.

    The Management API URL is formatted as https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/swagger. This URL takes you to the Azure Digital Twins REST API documentation that applies to your instance. Read How to use Azure Digital Twins Swagger to learn how to read and use this API documentation.

    Modify the Management API URL to this format https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/api/v1.0/. Your application will use the modified URL as the base URL to access your instance. Copy this modified URL to a temporary file. You'll need this in the next section.

    Management API

Set permissions for your app

This section registers your sample application to Azure Active Directory (Azure AD) so that it can access your Digital Twins instance. If you already have an Azure AD app registration, reuse it for your sample. Make sure that it's configured as described in this section.

Note

This section provides instructions for the new Azure AD app registration. If you still have legacy native app registration, you may use it as long as it's supported. Additionally, if for some reason the new way of app registation is not working in your setup, you may try to create a legacy native AAD app. Read Register your Azure Digital Twins app with Azure Active Directory legacy for more instructions.

  1. In the Azure portal, open Azure Active Directory from the left pane, and then open the App registrations pane. Select the New registration button.

    App registered

  2. Give a friendly name for this app registration in the Name box. Under the Redirect URI (optional) section, choose Public client (mobile & desktop) in the drop-down on the left, and enter https://microsoft.com in the textbox on the right. Select Register.

    Create pane

  3. To make sure that the app is registered as a native app, open the Authentication pane for your app registration, and scroll down in that pane. In the Default client type section, choose Yes for Treat application as a public client.

    Default native

  4. Open the Overview pane of your registered app, and copy the values of following entities to a temporary file. You'll use these values to configure your sample application in the following sections.

    • Application (client) ID
    • Directory (tenant) ID

    Azure Active Directory application ID

  5. Open the API permissions pane for your app registration. Select Add a permission button. In the Request API permissions pane, select the APIs my organization uses tab, and then search for:

    1. Azure Digital Twins. Select the Azure Digital Twins API.

      Search API or Azure Digital Twins

    2. Alternatively, search for Azure Smart Spaces. Select the Azure Smart Spaces Service API.

      Search API for Azure Smart Spaces

    Note

    The exact name that will appear when searched may vary depending on which Azure tenant you belong to.

  6. The selected API shows up as Azure Digital Twins in the same Request API permissions pane. Select the Read (1) drop down, and then select Read.Write checkbox. Select the Add permissions button.

    Add API permissions

  7. Depending on your organization's settings, you might need to take additional steps to grant admin access to this API. Contact your administrator for more information. Once the admin access is approved, the ADMIN CONSENT REQUIRED column in the API permissions pane will show similar to the following for your APIs:

    Add API permissions

Build application

Build the occupancy application by following these steps.

  1. Open a command prompt. Go to the folder where your digital-twins-samples-csharp-master.zip files were extracted.
  2. Run cd occupancy-quickstart/src.
  3. Run dotnet restore.
  4. Edit appSettings.json to update the following variables:
    • ClientId: Enter the Application ID of your Azure AD app registration, noted in the preceding section.
    • Tenant: Enter the Directory ID of your Azure AD tenant, also noted in the previous section.
    • BaseUrl: The Management API URL of your Digital Twins instance is in the format https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/api/v1.0/. Replace the placeholders in this URL with values for your instance from the previous section.

Provision graph

This step provisions your Digital Twins spatial graph with:

  • Several spaces.
  • One device.
  • Two sensors.
  • A custom function.
  • One role assignment.

The spatial graph is provisioned by using the provisionSample.yaml file.

  1. Run dotnet run ProvisionSample.

    Note

    The Device Login Azure CLI tool is used to authenticate the user to Azure AD. The user must enter a given code to authenticate by using the Microsoft login page. After code is entered, follow the steps to authenticate. The user must authenticate when the tool is running.

    Tip

    When you run this step, make sure your variables were copied properly if the following error message appears: EXIT: Unexpected error: The input is not a valid Base-64 string ...

  2. The provisioning step might take a few minutes. It also provisions an IoT Hub within your Digital Twins instance. It loops through until the IoT Hub shows Status=Running.

    Provision sample

  3. At the end of the execution, copy the ConnectionString of the device for use in the device simulator sample. Copy only the string outlined in this image.

    Copy the connection string

    Tip

    You can view and modify your spatial graph using the Azure Digital Twins Graph Viewer.

Send sensor data

Build and run the sensor simulator application by following these steps.

  1. Open a new command prompt. Go to the project you downloaded in the digital-twins-samples-csharp-master folder.

  2. Run cd device-connectivity.

  3. Run dotnet restore.

  4. Edit appsettings.json to update DeviceConnectionString with the previous ConnectionString.

  5. Run dotnet run to start sending sensor data. You see it sent to Digital Twins as shown in the following image.

    Device Connectivity

  6. Let this simulator run so that you can view results side by side with the next step action. This window shows you the simulated sensor data sent to Digital Twins. The next step queries in real time to find available rooms with fresh air.

    Tip

    When you run this step, make sure DeviceConnectionString was copied properly if the following error message appears: EXIT: Unexpected error: The input is not a valid Base-64 string ...

Find available spaces with fresh air

The sensor sample simulates random data values for two sensors. They're motion and carbon dioxide. Available spaces with fresh air are defined in the sample by no presence in the room. They're also defined by a carbon dioxide level under 1,000 ppm. If the condition isn't fulfilled, the space isn't available or the air quality is poor.

  1. Open the command prompt you used to run the previous provisioning step.

  2. Run dotnet run GetAvailableAndFreshSpaces.

  3. Look at this command prompt and the sensor data command prompt side by side.

    One command prompt sends simulated motion and carbon dioxide data to Digital Twins every five seconds. The other command reads the graph in real time to find out available rooms with fresh air based on random simulated data. It displays one of these conditions in near real time based on the sensor data that was sent last:

    • Available rooms with fresh air.

    • Occupied or poor air quality of the room.

      Get available spaces with fresh air

To understand what happened in this quickstart and what APIs were called, open Visual Studio Code with the code workspace project found in digital-twins-samples-csharp. Use the following command:

<path>\occupancy-quickstart\src>code ..\..\digital-twins-samples.code-workspace

The tutorials go deep into the code. They teach you how to modify configuration data and what APIs are called. For more information on Management APIs, go to your Digital Twins Swagger page:

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/swagger
Name Replace with
YOUR_INSTANCE_NAME The name of your Digital Twins instance
YOUR_LOCATION Which server region your instance is hosted on

Or for convenience, browse to Digital Twins Swagger.

Clean up resources

The tutorials go into detail about how to:

  • Build an application for facility managers to increase occupant productivity.
  • Operate the building more efficiently.

To continue to the tutorials, don't clean up the resources created in this quickstart. If you don't plan to continue, delete all the resources created by this quickstart.

  1. Delete the folder that was created when you downloaded the sample repository.

  2. From the menu on the left in the Azure portal, select All resources. Then select your Digital Twins resource. At the top of the All resources pane, select Delete.

    Tip

    If you experienced trouble deleting your Digital Twins instance, a service update has been rolled out with the fix. Please retry deleting your instance.

Next steps

This quickstart used a simple scenario to show how to find rooms with good working conditions. For in-depth analysis of this scenario, see this tutorial: