Microsoft.DigitalWorkplace.DigitalTwins.Models.Generator 1.0.1

DTDL Model Generator

👁 Build
👁 Release
👁 NuGet

This Digital Twin Definition Language (DTDL) Model Generator parses your DTDL json files and generates C# POCO classes to be used when interacting with the Azure Digital Twins SDK. This is made possible because all of the generated model classes inherit from the ADT-provided BasicDigitalTwin class.

Project Components

• Generator: This is the core aspect of this project (supports .Net 6 or higher) and is the package that's published to NuGet.
• Generator.TemplateProject: This is a template project that serves a couple purposes.
  1. It serves as a holding-ground for our custom, complementary classes that help connect the dots between certain aspects of the generated model classes.
  2. In the event a user of the generator doesn't have their own project destination to place the generated classes, this project serves as a template for the user to start from. Our generator will inject the correct Namespace and Assembly information into the template project based on options passed into the Generator.
• Generator.Tests: This is the test project that we use to test our generator.
• Generator.Tests.Generated: This project is produced when we run unit tests for our generator. Having this here also allows us to run unit tests against the generated models to ensure various functionality (like our custom equality implementations) are working as expected.

ModelGeneratorOptions

• Namespace: The namespace that will be injected into the generated model classes.
• JsonModelsDirectory: The directory that contains the DTDL json files that we'll be parsing.
• OutputDirectory: The directory that the generated model classes will be placed in.
• CopyrightHeader: The header comment that contains copyright information.

Prerequisites

The following are some prerequisites/assumptions to be considered:

For Developers

• .Net 6 must be installed, while building the model generator locally. Backward compatibility is not supported.
• The system should have Git installed as the model generator uses MinVer package which requires Git.

For Users

• The following classes have been copied at the location where model generator assembly is being executed:
  • DateOnlyConverter.cs
  • DurationConverter.cs
  • Extensions.cs
  • MapDateOnlyConverter.cs
  • MapDurationConverter.cs
  • ModelHelper.cs
  • Relationship.cs
  • RelationshipCollection.cs
  • RelationshipEqualityComparer.cs
  • SourceValueAttribute.cs
  • TwinEqualityComparer.cs
  • CloudToDeviceMethodOptions.cs
  • CommandHelper.cs
• The ModelGeneratorOptions property "CopyrightHeader" should have "// " prefix.

Limitations

Model Attributes

Schemas

Usage

using Microsoft.DigitalWorkplace.DigitalTwins.Models.Generator;

//...
var currentDir = Directory.GetCurrentDirectory();
var jsonDir = Path.Combine(currentDir, "TestDtdlModels");
var options = new ModelGeneratorOptions
{
 OutputDirectory = Path.Combine(currentDir, "..", "..", "..", "..", "Generator.Tests.Generated"),
 Namespace = "Generator.Tests.Generated",
 JsonModelsDirectory = jsonDir
};

var generator = new ModelGenerator(options);
await generator.GenerateClassesAsync();

Contributing

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 the Microsoft Contributor License Agreements page.

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.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.

Security

For guidance on reporting security issues, please refer to the section.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.