Skip to content

Commit 2d7001a

Browse files
authored
Merge pull request #265369 from timlt/move-pnp
[SCOPED] Move PnP files to iot docset
2 parents ebc6c8b + 96bce8f commit 2d7001a

File tree

96 files changed

+259
-177
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+259
-177
lines changed

articles/certification/how-to-test-pnp.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,19 @@ This article shows you how to:
2626
The application code that runs on your IoT Plug and Play must:
2727

2828
- Connect to Azure IoT Hub using the [Device Provisioning Service (DPS)](../iot-dps/about-iot-dps.md).
29-
- Follow the [IoT Plug an Play conventions](../iot-develop/concepts-developer-guide-device.md) to implement of telemetry, properties, and commands.
29+
- Follow the [IoT Plug an Play conventions](../iot/concepts-developer-guide-device.md) to implement of telemetry, properties, and commands.
3030

3131
The application is software that's installed separately from the operating system or is bundled with the operating system in a firmware image that's flashed to the device.
3232

33-
Prior to certifying your device through the certification process for IoT Plug and Play, you will want to validate that the device implementation matches the telemetry, properties and commands defined in the [Digital Twins Definition Language (DTDL)](https://github.com/Azure/opendigitaltwins-dtdl) device model locally prior to submitting to the [Azure IoT Public Model Repository](../iot-develop/concepts-model-repository.md).
33+
Prior to certifying your device through the certification process for IoT Plug and Play, you will want to validate that the device implementation matches the telemetry, properties and commands defined in the [Digital Twins Definition Language (DTDL)](https://github.com/Azure/opendigitaltwins-dtdl) device model locally prior to submitting to the [Azure IoT Public Model Repository](../iot/concepts-model-repository.md).
3434

3535
To meet the certification requirements, your device must:
3636

3737
- Connects to Azure IoT Hub using the [DPS](../iot-dps/about-iot-dps.md).
3838
- Implement of telemetry, properties, or commands following the IoT Plug and Play convention.
3939
- Describe the device interactions with a [DTDL v2](https://aka.ms/dtdl) model.
40-
- Send the model ID during [DPS registration](../iot-develop/concepts-developer-guide-device.md#dps-payload) in the DPS provisioning payload.
41-
- Announce the model ID during the [MQTT connection](../iot-develop/concepts-developer-guide-device.md#model-id-announcement).
40+
- Send the model ID during [DPS registration](../iot/concepts-developer-guide-device.md#dps-payload) in the DPS provisioning payload.
41+
- Announce the model ID during the [MQTT connection](../iot/concepts-developer-guide-device.md#model-id-announcement).
4242

4343
## Test with the Azure IoT Extension CLI
4444

articles/certification/how-to-troubleshoot-pnp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ While running the tests, if you receive a result of `Passed with warnings`, this
3737

3838
## When you need help with the model repository
3939

40-
For IoT Plug and Play issues related to the model repository, refer to [our Docs guidance about the device model repository](../iot-develop/concepts-model-repository.md).
40+
For IoT Plug and Play issues related to the model repository, refer to [our Docs guidance about the device model repository](../iot/concepts-model-repository.md).
4141

4242
## Next steps
4343

articles/certification/program-requirements-pnp.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ IoT Plug and Play enables solution builders to integrate smart devices with thei
2424
Promise of IoT Plug and Play certification are:
2525

2626
1. Defined device models and interfaces are compliant with the [Digital Twin Definition Language](https://github.com/Azure/opendigitaltwins-dtdl)
27-
1. Easy integration with Azure IoT based solutions using the [Digital Twin APIs](../iot-develop/concepts-digital-twin.md) : Azure IoT Hub and Azure IoT Central
27+
1. Easy integration with Azure IoT based solutions using the [Digital Twin APIs](../iot/concepts-digital-twin.md) : Azure IoT Hub and Azure IoT Central
2828
1. Product truth validated through testing telemetry from end point to cloud using DTDL
2929

3030
> [!Note]
@@ -63,7 +63,7 @@ Promise of IoT Plug and Play certification are:
6363
| **OS** | Agnostic |
6464
| **Validation Type** | Automated |
6565
| **Validation** | The [portal workflow](https://certify.azure.com) validates: **1.** Model ID announcement and ensure the device is connected using either the MQTT or MQTT over WebSockets protocol **2.** Models are compliant with the DTDL v2 **3.** Telemetry, properties, and commands are properly implemented and interact between IoT Hub Digital Twin and Device Twin on the device |
66-
| **Resources** | [Public Preview Refresh updates](../iot-develop/overview-iot-plug-and-play.md) |
66+
| **Resources** | [Public Preview Refresh updates](../iot/overview-iot-plug-and-play.md) |
6767

6868
**[Required] Device models are published in public model repository**
6969

@@ -74,7 +74,7 @@ Promise of IoT Plug and Play certification are:
7474
| **OS** | Agnostic |
7575
| **Validation Type** | Automated |
7676
| **Validation** | All device models are required to be published in public repository. Device models are resolved via models available in public repository **1.** User must manually publish the models to the public repository before submitting for the certification. **2.** Note that once the models are published, it is immutable. We strongly recommend publishing only when the models and embedded device code are finalized.*1 *1 User must contact Microsoft support to revoke the models once published to the model repository **3.** [Portal workflow](https://certify.azure.com) checks the existence of the models in the public repository when the device is connected to the certification service |
77-
| **Resources** | [Model repository](../iot-develop/overview-iot-plug-and-play.md) |
77+
| **Resources** | [Model repository](../iot/overview-iot-plug-and-play.md) |
7878

7979

8080
**[If implemented] Device info Interface: The purpose of test is to validate device info interface is implemented properly in the device code**
@@ -86,7 +86,7 @@ Promise of IoT Plug and Play certification are:
8686
| **OS** | Agnostic |
8787
| **Validation Type** | Automated |
8888
| **Validation** | [Portal workflow](https://certify.azure.com) validates the device code implements device info interface **1.** Checks the values are emitted by the device code to IoT Hub **2.** Checks the interface is implemented in the DCM (this implementation will change in DTDL v2) **3.** Checks properties are not write-able (read only) **4.** Checks the schema type is string and/or long and not null |
89-
| **Resources** | [Microsoft defined interface](../iot-develop/overview-iot-plug-and-play.md) |
89+
| **Resources** | [Microsoft defined interface](../iot/overview-iot-plug-and-play.md) |
9090
| **Azure Recommended** | N/A |
9191

9292
**[If implemented] Cloud to device: The purpose of test is to make sure messages can be sent from cloud to devices**

articles/digital-twins/concepts-models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Models for Azure Digital Twins are defined using the Digital Twins Definition La
2929

3030
You can view the full language description for DTDL v3 in GitHub: [DTDL Version 3 Language Description](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v3/DTDL.v3.md). This page includes DTDL reference details and examples to help you get started writing your own DTDL models.
3131

32-
DTDL is based on JSON-LD and is programming-language independent. DTDL isn't exclusive to Azure Digital Twins. It is also used to represent device data in other IoT services such as [IoT Plug and Play](../iot-develop/overview-iot-plug-and-play.md).
32+
DTDL is based on JSON-LD and is programming-language independent. DTDL isn't exclusive to Azure Digital Twins. It is also used to represent device data in other IoT services such as [IoT Plug and Play](../iot/overview-iot-plug-and-play.md).
3333

3434
The rest of this article summarizes how the language is used in Azure Digital Twins.
3535

articles/digital-twins/how-to-parse-models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The capabilities of the parser include:
4141
* Determine whether a model is assignable from another model.
4242

4343
> [!NOTE]
44-
> [IoT Plug and Play](../iot-develop/overview-iot-plug-and-play.md) devices use a small syntax variant to describe their functionality. This syntax variant is a semantically compatible subset of the DTDL that is used in Azure Digital Twins. When using the parser library, you do not need to know which syntax variant was used to create the DTDL for your digital twin. The parser will always, by default, return the same model for both IoT Plug and Play and Azure Digital Twins syntax.
44+
> [IoT Plug and Play](../iot/overview-iot-plug-and-play.md) devices use a small syntax variant to describe their functionality. This syntax variant is a semantically compatible subset of the DTDL that is used in Azure Digital Twins. When using the parser library, you do not need to know which syntax variant was used to create the DTDL for your digital twin. The parser will always, by default, return the same model for both IoT Plug and Play and Azure Digital Twins syntax.
4545
4646
## Code with the parser library
4747

articles/digital-twins/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ In Azure Digital Twins, you define the digital entities that represent the peopl
3838
You can think of these model definitions as a specialized vocabulary to describe your business. For a building management solution, for example, you might define a model that defines a Building type, a Floor type, and an Elevator type. Models are defined in a JSON-like language called [Digital Twins Definition Language (DTDL)](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v3/DTDL.v3.md). In ADT, DTDL models describe types of entities according to their state properties, commands, and relationships. You can design your own model sets from scratch, or get started with a pre-existing set of [DTDL industry ontologies](concepts-ontologies.md) based on common vocabulary for your industry.
3939

4040
>[!TIP]
41-
>Version 2 of DTDL is also used for data models throughout other Azure IoT services, including [IoT Plug and Play](../iot-develop/overview-iot-plug-and-play.md) and [Time Series Insights](../time-series-insights/overview-what-is-tsi.md). This compatibility helps you connect your Azure Digital Twins solution with other parts of the Azure ecosystem.
41+
>Version 2 of DTDL is also used for data models throughout other Azure IoT services, including [IoT Plug and Play](../iot/overview-iot-plug-and-play.md) and [Time Series Insights](../time-series-insights/overview-what-is-tsi.md). This compatibility helps you connect your Azure Digital Twins solution with other parts of the Azure ecosystem.
4242
4343
Once you've defined your data models, use them to create [digital twins](concepts-twins-graph.md) that represent each specific entity in your environment. For example, you might use the Building model definition to create several Building-type twins (Building 1, Building 2, and so on). You can also use the relationships in the model definitions to connect twins to each other, forming a conceptual graph.
4444

articles/iot-central/core/concepts-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ IoT Central can also control devices by calling commands on the device. For exam
6262

6363
The telemetry, properties, and commands that a device implements are collectively known as the device capabilities. You define these capabilities in a model that's shared between the device and the IoT Central application. In IoT Central, this model is part of the device template that defines a specific type of device. To learn more, see [Assign a device to a device template](concepts-device-templates.md#assign-a-device-to-a-device-template).
6464

65-
The [device implementation](tutorial-connect-device.md) should follow the [IoT Plug and Play conventions](../../iot-develop/concepts-convention.md) to ensure that it can communicate with IoT Central. For more information, see the various language [SDKs and samples](../../iot-develop/about-iot-sdks.md).
65+
The [device implementation](tutorial-connect-device.md) should follow the [IoT Plug and Play conventions](../../iot/concepts-convention.md) to ensure that it can communicate with IoT Central. For more information, see the various language [SDKs and samples](../../iot-develop/about-iot-sdks.md).
6666

6767
Devices connect to IoT Central using one the supported protocols: [MQTT, AMQP, or HTTP](../../iot-hub/iot-hub-devguide-protocols.md).
6868

articles/iot-central/core/concepts-device-implementation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ An IoT Central device template includes a _model_ that specifies the behaviors a
2727

2828
Each model has a unique _digital twin model identifier_ (DTMI), such as `dtmi:com:example:Thermostat;1`. When a device connects to IoT Central, it sends the DTMI of the model it implements. IoT Central can then assign the correct device template to the device.
2929

30-
[IoT Plug and Play](../../iot-develop/overview-iot-plug-and-play.md) defines a set of [conventions](../../iot-develop/concepts-convention.md) that a device should follow when it implements a Digital Twin Definition Language (DTDL) model.
30+
[IoT Plug and Play](../../iot/overview-iot-plug-and-play.md) defines a set of [conventions](../../iot/concepts-convention.md) that a device should follow when it implements a Digital Twin Definition Language (DTDL) model.
3131

3232
The [Azure IoT device SDKs](#device-sdks) include support for the IoT Plug and Play conventions.
3333

@@ -51,7 +51,7 @@ A DTDL model can be a _no-component_ or a _multi-component_ model:
5151
> [!TIP]
5252
> You can [import and export a complete device model or individual interface](howto-set-up-template.md#interfaces-and-components) from an IoT Central device template as a DTDL v2 file.
5353
54-
To learn more about device models, see the [IoT Plug and Play modeling guide](../../iot-develop/concepts-modeling-guide.md)
54+
To learn more about device models, see the [IoT Plug and Play modeling guide](../../iot/concepts-modeling-guide.md)
5555

5656
### Conventions
5757

@@ -65,9 +65,9 @@ A device should follow the IoT Plug and Play conventions when it exchanges data
6565
> [!NOTE]
6666
> Currently, IoT Central does not fully support the DTDL **Array** and **Geospatial** data types.
6767
68-
To learn more about the IoT Plug and Play conventions, see [IoT Plug and Play conventions](../../iot-develop/concepts-convention.md).
68+
To learn more about the IoT Plug and Play conventions, see [IoT Plug and Play conventions](../../iot/concepts-convention.md).
6969

70-
To learn more about the format of the JSON messages that a device exchanges with IoT Central, see [Telemetry, property, and command payloads](../../iot-develop/concepts-message-payloads.md).
70+
To learn more about the format of the JSON messages that a device exchanges with IoT Central, see [Telemetry, property, and command payloads](../../iot/concepts-message-payloads.md).
7171

7272
### Device SDKs
7373

articles/iot-central/core/concepts-device-templates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.custom: device-developer
1515

1616
A device template in Azure IoT Central is a blueprint that defines the characteristics and behaviors of a type of device that connects to your application. For example, the device template defines the telemetry that a device sends so that IoT Central can create visualizations that use the correct units and data types.
1717

18-
A solution builder adds device templates to an IoT Central application. A device developer writes the device code that implements the behaviors defined in the device template. To learn more about the data that a device exchanges with IoT Central, see [Telemetry, property, and command payloads](../../iot-develop/concepts-message-payloads.md).
18+
A solution builder adds device templates to an IoT Central application. A device developer writes the device code that implements the behaviors defined in the device template. To learn more about the data that a device exchanges with IoT Central, see [Telemetry, property, and command payloads](../../iot/concepts-message-payloads.md).
1919

2020
A device template includes the following sections:
2121

@@ -88,7 +88,7 @@ The JSON file that defines the device model uses the [Digital Twin Definition La
8888
]
8989
```
9090

91-
To learn more about DTDL models, see the [IoT Plug and Play modeling guide](../../iot-develop/concepts-modeling-guide.md).
91+
To learn more about DTDL models, see the [IoT Plug and Play modeling guide](../../iot/concepts-modeling-guide.md).
9292

9393
> [!NOTE]
9494
> IoT Central defines some extensions to the DTDL v2 language. To learn more, see [IoT Central extension](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/DTDL.iotcentral.v2.md).
@@ -251,4 +251,4 @@ A solution developer creates views that let operators monitor and manage connect
251251

252252
## Next steps
253253

254-
Now that you've learned about device templates, a suggested next step is to read [Telemetry, property, and command payloads](../../iot-develop/concepts-message-payloads.md) to learn more about the data a device exchanges with IoT Central.
254+
Now that you've learned about device templates, a suggested next step is to read [Telemetry, property, and command payloads](../../iot/concepts-message-payloads.md) to learn more about the data a device exchanges with IoT Central.

articles/iot-central/core/concepts-faq-apaas-paas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ So that you can seamlessly migrate devices from your IoT Central applications to
4444

4545
- The device must be an IoT Plug and Play device that uses a [Digital Twins Definition Language (DTDL) V2](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/DTDL.v2.md) model. IoT Central requires all devices to have a DTDL model. These models simplify the interoperability between an IoT PaaS solution and IoT Central.
4646

47-
- The device must follow the [IoT Plug and Play conventions](../../iot-develop/concepts-convention.md).
47+
- The device must follow the [IoT Plug and Play conventions](../../iot/concepts-convention.md).
4848
- IoT Central uses the DPS to provision the devices. The PaaS solution must also use DPS to provision the devices.
4949
- The updatable DPS pattern ensures that the device can move seamlessly between IoT Central applications and the PaaS solution without any downtime.
5050

0 commit comments

Comments
 (0)