Dela via

Azure Model Parser-klientbibliotek för JavaScript – version 1.0.0-beta.2

  • Artikel

Använd det här biblioteket för att parsa dina DTDL-modeller och verifiera att deras struktur överensstämmer med DTDL-specifikationen.

DTDL (Digital Twin Definition Language) definierar ett JSON-LD-baserat schema för att skapa digital tvilling-modeller. Allt eftersom DTDL-specifikationen utvecklas kommer den här parsern att uppdateras i enlighet med detta. En viktig egenskap hos Azure Digital Twins är möjligheten att definiera din egen vokabulär och skapa en tvillinggraf i de självdefinierade villkoren för din verksamhet. Den här funktionen tillhandahålls via modeller som tillhandahålls av användaren. Du kan se modeller som substantiv i en beskrivning av din värld.

Läs mer om DTDL här.

Komma igång

Miljöer som stöds för närvarande

Mer information finns i vår supportpolicy .

Förutsättningar

Inga.

Installera @azure/dtdl-parser-paketet

Installera Digital Twins Model Parser-klientbiblioteket för JavaScript med npm:

npm install @azure/dtdl-parser

Få åtkomst till den offentliga DTDL-modelllagringsplatsen

Om du inte redan har skrivit en DTDL-modell kan du komma åt den fullständiga lagringsplatsen för offentligt tillgängliga DTDL-modeller här: Github: Lagringsplats för IoT-Plug and Play modeller med DTDL

Stöd för webbläsare

JavaScript-paket

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Viktiga begrepp

DTDL-parser

DTDL (Digital Twins Definition Language) definierar ett kontrakt för att interagera med modeller av Digital Twin Plug and Plan-enheter. DTDL-parsern är en langauge parser som delvis är handskriven, delvis genererad baserat på en DTDL-schemadefinition, som kan verifiera om en sträng som tillhandahålls till den överensstämmer med DTDL langauge-definitioner.

Du kan lära dig mer om DTDL för modeller genom att läsa "Lär dig mer om tvillingmodeller och hur du definierar dem i (Azure Digital Twins](https://docs.microsoft.com/azure/digital-twins/concepts-models)

Exempel

Parsa en DTDL-modell

Om du vill parsa en DTDL-exempelmodell börjar du antingen med en som du redan har skrivit eller använder en som finns i den offentliga DTDL-databasen. Nu ska vi hämta en exempelmodell från modelllagringsplatsen:

// example.js
async function main() {
  const client = new ModelsRepositoryClient();
  const dtmi = "dtmi:com:example:TemperatureController;1";
  const models = await client.getModels(dtmi);

  const modelParser = createParser(ModelParsingOption.PermitAnyTopLevelElement);
  modelParser.options = ModelParsingOption.PermitAnyTopLevelElement;
  Object.entries(models).forEach(([key, value]) => {
    console.log(`dtmi: ${key}`);
    const modelDict = await modelParser.parse([value]);
    Object.entries(modelDict).forEach(([key2, value2]) => {
      console.log(key2);
    });
  });
}

main().catch((err) => {
  console.error("The sample encountered an error:", err); 
});

Felsökning

Loggning

Obs! Det här paketet stöder för närvarande inte Azure-loggning, men kommer att ha stöd av GA-versionen.

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg över HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Loggning kan också aktiveras vid körning genom att anropa setLogLevel i @azure/logger:

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

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokumentationen om @azure-/loggningspaket.

Nästa steg

Ta en titt på exempelkatalogen för detaljerade exempel som visar hur du använder klientbiblioteken.

Bidra

Om du vill bidra till det här biblioteket kan du läsa bidragsguiden om du vill veta mer om hur du skapar och testar koden.

Visningar