Libreria client di Parser modello di Azure per JavaScript - versione 1.0.0-beta.2
Usare questa libreria per analizzare i modelli DTDL e convalidarne la struttura conforme alla specifica DTDL.
Digital Twin Definition Language (DTDL) definisce uno schema basato su JSON-LD per la creazione di modelli di Gemelli digitali. Man mano che la specifica DTDL evolve, questo parser verrà aggiornato di conseguenza. Una caratteristica chiave di Gemelli digitali di Azure è la possibilità di definire il proprio vocabolario e creare il grafico gemello nei termini auto-definiti dell'azienda. Questa funzionalità viene fornita tramite modelli forniti dall'utente. Puoi pensare ai modelli come i sostantivi in una descrizione del tuo mondo.
Altre informazioni su DTDL sono disponibili qui.
Introduzione
Ambienti attualmente supportati
- Versioni LTS di Node.js
- Ultime versioni di Safari, Chrome, Edge e Firefox.
Per altre informazioni, vedere i criteri di supporto.
Prerequisiti
Nessuno.
Installare il pacchetto @azure/dtdl-parser
Installare la libreria client parser del modello di gemelli digitali per JavaScript con npm
:
npm install @azure/dtdl-parser
Accedere al repository del modello DTDL pubblico
Se non è già stato scritto un modello DTDL, è possibile accedere al repository completo dei modelli DTDL disponibili pubblicamente qui: Github: Repository di modelli di Plug and Play IoT usando DTDL
Supporto browser
JavaScript Bundle
Per usare questa libreria client nel browser, è prima necessario usare un bundler. Per informazioni dettagliate su come eseguire questa operazione, vedere la documentazione di raggruppamento.
Concetti chiave
DTDL Parser
DTDL (Digital Twins Definition Language) definisce un contratto per interagire con i modelli di dispositivi Plug and Plan di Gemelli digitali. Il parser DTDL è un parser langauge parzialmente scritto, parzialmente generato in base a una definizione dello schema DTDL, che può convalidare se una stringa fornita è conforme alle definizioni di langauge DTDL.
Per altre informazioni su DTDL per i modelli, vedere "Informazioni sui modelli gemelli e su come definirli in (Gemelli digitali di Azure](https://docs.microsoft.com/azure/digital-twins/concepts-models)
Esempio
Analizzare un modello DTDL
Per analizzare un modello DTDL di esempio, iniziare con uno già scritto o usarlo nel database DTDL pubblico. Acquisire un modello di esempio dal repository modelli:
// 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);
});
Risoluzione dei problemi
Registrazione
NOTA: questo pacchetto attualmente non supporta La registrazione di Azure, ma avrà il supporto per la versione ga.
L'abilitazione della registrazione consente di individuare informazioni utili sugli errori. Per visualizzare un log di richieste e risposte HTTP, impostare la variabile di ambiente AZURE_LOG_LEVEL
su info
. In alternativa, la registrazione può essere abilitata in fase di esecuzione chiamando setLogLevel
in @azure/logger
:
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
Per istruzioni più dettagliate su come abilitare i log, è possibile esaminare la documentazione del pacchetto @azure/logger.
Passaggi successivi
Esaminare la directory degli esempi per esempi dettagliati che illustrano come usare le librerie client.
Contributo
Per contribuire a questa libreria, leggere la guida ai contributi per altre informazioni su come compilare e testare il codice.
Progetti correlati
Azure SDK for JavaScript