DTDL Editor for Visual Studio Code
The Digital Twin Definition Language (DTDL) is a language for describing models for Plug and Play devices, device digital twins, and logical digital twins. Broadly, modeling enables IoT solutions to provision, use, and configure digital twins of all kinds from multiple sources in a single solution. Using DTDL to describe any digital twin’s abilities enables the IoT platform and IoT solutions to leverage the semantics of each digital twin.
With the DTDL extension for Visual Studio Code , you can read and write documents using DTDL more efficiently taking full advantage of the following key features:
You could use the command palette to create interface from predefined or customized templates.
Intellisense and Syntax validation
This extension could help you with the language syntax (including auto-completion) and also validate the syntax with DTDL v2.
Use Predefined Code Snippets
Besides the basic auto completion, this extension also provides some predefined code snippets to help you develop DTDL efficiently.
Create Your Own Template
Prepare your template file
You could use any DTDL file as a template to develop efficiently. Meanwhile, you could also use these predefined tags to make your template more flexible.
Import your template file
Create Your Own Code Snippets
If you would like to create customized code snippets for VS Code, you could follow Snippets in Visual Studio Code
Contribute Your Templates and Code Snippets to the Community
You could also contribute your templates and code snippets to the DTDL repository.
Once the pull request is approved, your templates and code snippets will be released with next release of DTDL extension.
Error when creating the interface
As default, the extension will get the available templates from [extension installation location]/vsciot-vscode.vscode-dtdl-[extension release version]/templates. But if you delete this folder or all templates files in this folder, you will have an error when creating the interface. In order to fix this issue, you could copy the templates from DTDL repository to your local templates folder manually.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information please see the Code of Conduct FAQ or contact firstname.lastname@example.org with any additional questions or comments.
If you would like to help to build the best IoT experience with IoT Plug and Play, you can reach us directly at Gitter.
VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include Microsoft, Azure, DotNet, AspNet, Xamarin, and our GitHub organizations.
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's Microsoft's definition of a security vulnerability, please report it to us as described below.
Reporting Security Issues
Please do not report security vulnerabilities through public GitHub issues.
Instead, please report them to the Microsoft Security Response Center (MSRC) at https://msrc.microsoft.com/create-report.
If you prefer to submit without logging in, send email to email@example.com. If possible, encrypt your message with our PGP key; please download it from the the Microsoft Security Response Center PGP Key page.
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at microsoft.com/msrc.
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
This information will help us triage your report more quickly.
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our Microsoft Bug Bounty Program page for more details about our active programs.
We prefer all communications to be in English.
Microsoft follows the principle of Coordinated Vulnerability Disclosure.