@azure/digital-twins-core NPM

Azure Azure Digital Twins Core client library for JavaScript

This package contains an isomorphic SDK for Azure Digital Twins API to provide access to the Azure Digital Twins service for managing twins, models, relationships, etc.

Getting started

Currently supported environments

Node.js version 6.x.x or higher
Browser JavaScript

How to Install

npm install @azure/digital-twins-core

How to use

nodejs - Authentication, client creation and list digitalTwinModels as an example written in TypeScript.

Install @azure/ms-rest-nodeauth

npm install @azure/ms-rest-nodeauth

Sample code

import * as coreHttp from "@azure/core-http";
import * as coreArm from "@azure/core-arm";
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
import {
  AzureDigitalTwinsAPI,
  AzureDigitalTwinsAPIModels,
  AzureDigitalTwinsAPIMappers
} from "@azure/digital-twins-core";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
msRestNodeAuth
  .interactiveLogin()
  .then((creds) => {
    const client = new AzureDigitalTwinsAPI(creds, subscriptionId);
    const dependenciesFor = ["testdependenciesFor"];
    const includeModelDefinition = true;
    const maxItemCount = 1;
    client.digitalTwinModels
      .list(dependenciesFor, includeModelDefinition, maxItemCount)
      .then((result) => {
        console.log("The result is:");
        console.log(result);
      });
  }
  .catch((err) => {
    console.error(err);
  })

browser - Authentication, client creation and list digitalTwinModels as an example written in JavaScript.

Install @azure/ms-rest-browserauth

npm install @azure/ms-rest-browserauth

Sample code

See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.

index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>@azure/digital-twins-core sample</title>
    <script src="node_modules/@azure/core-http/dist/coreHttp.browser.js"></script>
    <script src="node_modules/@azure/core-arm/dist/coreArm.js"></script>
    <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
    <script src="node_modules/@azure/digital-twins-core/dist/digital-twins-core.js"></script>
    <script type="text/javascript">
      const subscriptionId = "<Subscription_Id>";
      const authManager = new msAuth.AuthManager({
        clientId: "<client id for your Azure AD app>",
        tenant: "<optional tenant for your organization>"
      });
      authManager.finalizeLogin().then((res) => {
        if (!res.isLoggedIn) {
          // may cause redirects
          authManager.login();
        }
        const client = new Azure.Digitaltwins.AzureDigitalTwinsAPI(res.creds, subscriptionId);
        const dependenciesFor = ["testdependenciesFor"];
        const includeModelDefinition = true;
        const maxItemCount = 1;
        client.digitalTwinModels
          .list(dependenciesFor, includeModelDefinition, maxItemCount)
          .then((result) => {
            console.log("The result is:");
            console.log(result);
          })
          .catch((err) => {
            console.log("An error occurred:");
            console.error(err);
          });
      });
    </script>
  </head>
  <body></body>
</html

Key concepts

Azure Digital Twins Preview is an Azure IoT service that creates comprehensive models of the physical environment. It can create spatial intelligence graphs to model the relationships and interactions between people, spaces, and devices. You can learn more about Azure Digital Twins by visiting Azure Digital Twins Documentation

Examples

Please take a look at the Readme file in samples directory for detailed examples on how to use this library.

Troubleshooting

Enable logs

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL environment variable to info. Alternatively, logging can be enabled at runtime by calling setLogLevel in the @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.

Next steps

Please take a look at the samples directory for detailed examples on how to use this library.

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

Related projects

Microsoft Azure SDK for Javascript

azure iot digital-twins-core cloud twins node typescript browser isomorphic

@azure/core-auth @azure/core-client @azure/core-paging @azure/core-rest-pipeline @azure/core-tracing @azure/core-util @azure/logger tslib uuid

@everything-registry/sub-chunk-107 @noemarius/nodered-adt-create hc-iotframework-iotservicemanager node-red-contrib-azure-iothub-2-adt @noemarius/nodered-azure-digitaltwins digital-twins-api forge-dataviz-iot-data-modules

2.0.0-alpha.20241031.1

15 days ago

2.0.0-alpha.20241028.1

18 days ago

2.0.0-alpha.20241029.1

17 days ago

2.0.0-alpha.20241030.1

16 days ago

2.0.0-alpha.20241025.1

21 days ago

2.0.0-alpha.20241024.1

22 days ago

2.0.0-alpha.20241023.1

23 days ago

2.0.0-alpha.20241022.1

24 days ago

2.0.0-alpha.20241021.1

25 days ago

2.0.0-alpha.20241017.1

29 days ago

2.0.0-alpha.20241018.1

28 days ago

2.0.0-alpha.20241016.1

1 month ago

2.0.0-alpha.20241015.1

1 month ago

2.0.0-alpha.20241014.1

1 month ago

2.0.0-alpha.20240930.1

2 months ago

2.0.0-alpha.20240927.1

2 months ago

2.0.0-alpha.20241010.1

1 month ago

2.0.0-alpha.20240926.1

2 months ago

2.0.0-alpha.20241003.1

1 month ago

2.0.0-alpha.20241004.1

1 month ago

2.0.0-alpha.20241009.1

1 month ago

2.0.0-alpha.20241001.1

2 months ago

2.0.0-alpha.20241002.1

1 month ago

2.0.0-alpha.20241007.1

1 month ago

2.0.0-alpha.20241011.1

1 month ago

2.0.0-alpha.20240925.1

2 months ago

2.0.0-alpha.20241008.1

1 month ago

2.0.0-alpha.20240924.1

2 months ago

2.0.0-alpha.20240919.1

2 months ago

2.0.0-alpha.20240911.1

2 months ago

2.0.0-alpha.20240829.1

3 months ago

2.0.0-alpha.20240904.1

2 months ago

2.0.0-alpha.20240918.1

2 months ago

2.0.0-alpha.20240910.1

2 months ago

2.0.0-alpha.20240828.1

3 months ago

2.0.0-alpha.20240903.1

2 months ago

2.0.0-alpha.20240917.1

2 months ago

2.0.0-alpha.20240830.1

3 months ago

2.0.0-alpha.20240913.1

2 months ago

2.0.0-alpha.20240827.1

3 months ago

2.0.0-alpha.20240906.1

2 months ago

2.0.0-alpha.20240902.1

2 months ago

2.0.0-alpha.20240916.1

2 months ago

2.0.0-alpha.20240912.1

2 months ago

2.0.0-alpha.20240826.1

3 months ago

2.0.0-alpha.20240905.1

2 months ago

2.0.0-alpha.20240909.1

2 months ago

2.0.0-alpha.20240920.1

2 months ago

2.0.0-alpha.20240813.1

3 months ago

2.0.0-alpha.20240726.1

4 months ago

2.0.0-alpha.20240722.1

4 months ago

2.0.0-alpha.20240806.1

3 months ago

2.0.0-alpha.20240821.1

3 months ago

2.0.0-alpha.20240802.1

4 months ago

2.0.0-alpha.20240718.1

4 months ago

2.0.0-alpha.20240812.1

3 months ago

2.0.0-alpha.20240816.1

3 months ago

2.0.0-alpha.20240723.1

4 months ago

2.0.0-alpha.20240809.1

3 months ago

2.0.0-alpha.20240820.1

3 months ago

2.0.0-alpha.20240801.1

4 months ago

2.0.0-alpha.20240730.1

4 months ago

2.0.0-alpha.20240805.1

3 months ago

2.0.0-alpha.20240719.1

4 months ago

2.0.0-alpha.20240819.1

3 months ago

2.0.0-alpha.20240815.1

3 months ago

2.0.0-alpha.20240724.1

4 months ago

2.0.0-alpha.20240808.1

3 months ago

2.0.0-alpha.20240823.1

3 months ago

2.0.0-alpha.20240731.1

4 months ago

2.0.0-alpha.20240716.2

4 months ago

2.0.0-alpha.20240814.1

3 months ago

2.0.0-alpha.20240725.1

4 months ago

2.0.0-alpha.20240729.1

4 months ago

2.0.0-alpha.20240807.1

3 months ago

2.0.0-alpha.20240822.1

3 months ago

2.0.0-alpha.20240717.1

4 months ago

2.0.0-alpha.20240514.1

6 months ago

2.0.0-alpha.20240513.1

6 months ago

2.0.0-alpha.20240510.1

6 months ago

2.0.0-alpha.20240509.1

6 months ago

2.0.0-alpha.20240508.1

6 months ago

2.0.0-alpha.20240507.2

6 months ago

2.0.0-alpha.20240503.1

7 months ago

2.0.0-alpha.20240501.1

7 months ago

2.0.0-alpha.20240502.1

7 months ago

2.0.0-alpha.20240430.1

7 months ago

2.0.0-alpha.20240429.1

7 months ago

2.0.0-alpha.20240426.1

7 months ago

2.0.0-alpha.20240425.1

7 months ago

2.0.0-alpha.20240424.1

7 months ago

2.0.0-alpha.20240423.1

7 months ago

2.0.0-alpha.20240422.1

7 months ago

2.0.0-alpha.20240419.1

7 months ago

2.0.0-alpha.20240418.1

7 months ago

2.0.0-alpha.20240417.1

7 months ago

2.0.0-alpha.20240416.1

7 months ago

2.0.0-alpha.20240415.1

7 months ago

2.0.0-alpha.20240412.1

7 months ago

2.0.0-alpha.20240410.1

7 months ago

2.0.0-alpha.20240403.1

8 months ago

2.0.0-alpha.20240322.1

8 months ago

2.0.0-alpha.20240308.1

8 months ago

2.0.0-alpha.20240202.1

10 months ago

2.0.0-alpha.20240126.1

10 months ago

2.0.0-alpha.20240117.1

10 months ago

2.0.0-alpha.20240112.1

10 months ago

2.0.0-alpha.20240111.1

10 months ago

2.0.0-alpha.20231207.1

11 months ago

2.0.0-alpha.20231107.1

1 year ago

2.0.0-alpha.20231120.1

12 months ago

2.0.0-alpha.20231031.1

1 year ago

2.0.0-alpha.20231102.2

1 year ago

2.0.0-alpha.20231024.1

1 year ago

2.0.0-alpha.20230824.1

1 year ago

2.0.0-alpha.20230926.1

1 year ago

2.0.0-alpha.20230922.1

1 year ago

2.0.0-alpha.20231023.1

1 year ago

2.0.0-alpha.20230929.1

1 year ago

2.0.0-alpha.20231010.1

1 year ago

2.0.0-alpha.20230727.2

1 year ago

2.0.0-alpha.20230419.1

2 years ago

2.0.0-alpha.20230306.1

2 years ago

2.0.0-alpha.20230310.2

2 years ago

2.0.0-alpha.20230307.1

2 years ago

2.0.0-alpha.20230320.1

2 years ago

2.0.0-alpha.20230203.1

2 years ago

2.0.0-alpha.20230126.1

2 years ago

2.0.0-alpha.20230127.1

2 years ago

2.0.0-alpha.20230111.2

2 years ago

2.0.0-alpha.20230117.2

2 years ago

1.1.1-alpha.20221017.1

2 years ago

1.1.1-alpha.20221107.1

2 years ago

1.1.1-alpha.20220926.1

2 years ago

1.1.1-alpha.20220919.1

2 years ago

1.1.0-alpha.20220719.4

2 years ago

1.1.1-alpha.20220729.2

2 years ago

1.1.0-alpha.20220524.1

2 years ago

1.1.0

2 years ago

1.1.0-alpha.20220627.2

2 years ago

1.1.0-alpha.20220722.1

2 years ago

1.1.0-alpha.20220720.1

2 years ago

1.1.0-alpha.20220520.1

2 years ago

1.1.0-alpha.20220516.1

3 years ago

1.1.0-alpha.20220517.1

3 years ago

1.1.0-alpha.20220322.1

3 years ago

1.1.0-beta.1

3 years ago

1.1.0-alpha.20220407.1

3 years ago

1.1.0-alpha.20220307.2

3 years ago

1.1.0-alpha.20220315.1

3 years ago

1.1.0-alpha.20220421.2

3 years ago

1.1.0-alpha.20220406.1

3 years ago

1.1.0-alpha.20220104.2

3 years ago

1.1.0-alpha.20211209.2

3 years ago

1.1.0-alpha.20220222.2

3 years ago

1.1.0-alpha.20211214.2

3 years ago

1.1.0-alpha.20220131.1

3 years ago

1.1.0-alpha.20211103.1

3 years ago

1.1.0-alpha.20210930.1

3 years ago

1.1.0-alpha.20210915.1

3 years ago

1.1.0-alpha.20210901.1

3 years ago

1.1.0-alpha.20210826.1

3 years ago

1.1.0-alpha.20210827.1

3 years ago

1.1.0-alpha.20210819.1

3 years ago

1.1.0-alpha.20210816.1

3 years ago

1.1.0-alpha.20210805.1

3 years ago

1.1.0-alpha.20210716.1

3 years ago

1.1.0-alpha.20210715.1

3 years ago

1.1.0-alpha.20210713.1

3 years ago

1.1.0-alpha.20210701.1

3 years ago

1.1.0-alpha.20210629.2

3 years ago

1.0.4-alpha.20210628.1

3 years ago

1.0.4-alpha.20210624.1

3 years ago

1.0.4-alpha.20210623.1

3 years ago

1.0.4-alpha.20210621.1

3 years ago

1.0.4-alpha.20210611.1

3 years ago

1.0.4-alpha.20210609.1

3 years ago

1.0.4-alpha.20210427.1

4 years ago

1.0.4-alpha.20210517.1

4 years ago

1.0.4-alpha.20210504.1

4 years ago

1.0.4-alpha.20210409.1

4 years ago

1.0.4-alpha.20210407.1

4 years ago

1.0.4-alpha.20210406.1

4 years ago

1.0.4-alpha.20210330.1

4 years ago

1.0.4-alpha.20210323.1

4 years ago

1.0.4-alpha.20210322.1

4 years ago

1.0.4-alpha.20210318.1

4 years ago

1.0.4-alpha.20210316.1

4 years ago

1.0.4-alpha.20210311.1

4 years ago

1.0.4-alpha.20210304.1

4 years ago

1.0.4-alpha.20210303.1

4 years ago

1.0.4-alpha.20210301.1

4 years ago

1.0.4-alpha.20210226.1

4 years ago

1.0.4-alpha.20210217.1

4 years ago

1.0.4-alpha.20210208.1

4 years ago

1.0.4-alpha.20210204.1

4 years ago

1.0.4-alpha.20210201.1

4 years ago

1.0.4-alpha.20210122.1

4 years ago

1.0.2

4 years ago

1.0.3

4 years ago

1.0.3-alpha.20210115.5

4 years ago

1.0.2-alpha.20210114.2

4 years ago

1.0.1

4 years ago

1.0.1-alpha.20210113.2

4 years ago

1.0.0-alpha.20210107.1

4 years ago

1.0.0-alpha.20210105.1

4 years ago

1.0.0-alpha.20201224.1

4 years ago

1.0.0-alpha.20201218.1

4 years ago

1.0.0-alpha.20201215.1

4 years ago

1.0.0-alpha.20201211.1

4 years ago

1.0.0-alpha.20201109.1

4 years ago

1.0.0-alpha.20201103.1

4 years ago

1.0.0

4 years ago

1.0.0-alpha.20201030.1

4 years ago

1.0.0-preview.2

4 years ago

1.0.0-alpha.20201023.2

4 years ago

1.0.0-alpha.20201022.2

4 years ago