Création de modèles de composants

Utilisez des modèles de AWS IoT SiteWise composants pour définir des sous-assemblages auxquels vous pouvez faire référence à partir de modèles de ressources ou d'autres modèles de composants. De cette façon, vous pouvez réutiliser la définition du composant dans plusieurs autres modèles, ou plusieurs fois dans le même modèle.

Le processus de définition d'un modèle de composant est très similaire à celui d'un modèle d'actif. Tout comme un modèle d'actif, un modèle de composant possède un nom, une description et des propriétés d'actif. Toutefois, les modèles de composants ne peuvent pas inclure de définitions de hiérarchie des actifs, car les modèles de composants eux-mêmes ne peuvent pas être utilisés pour créer directement des actifs. Les modèles de composants ne peuvent pas non plus définir d'alarmes.

Par exemple, vous pouvez définir un composant pour un servomoteur avec des propriétés de température du moteur, de température du codeur et de résistance d'isolement. Vous pouvez ensuite définir un modèle d'actif pour les équipements contenant des servomoteurs, tels qu'une CNC machine.

Note

• Nous vous recommandons de modéliser votre opération en commençant par les nœuds de niveau inférieur. Par exemple, créez le composant de votre servomoteur avant de créer le modèle d'équipement de votre CNC machine. Les modèles d'actifs contiennent des références à des modèles de composants existants.

• Vous ne pouvez pas créer un actif directement à partir d'un modèle de composant. Pour créer un actif qui utilise votre composant, vous devez créer un modèle d'actif pour votre actif. Ensuite, vous créez un modèle composite personnalisé qui fait référence à votre composant. Pour plus d'informations sur la création de modèles d'actifs, voir Création de modèles d'actifs Pour plus d'informations sur la création de modèles composites personnalisés, voirCréation de modèles composites personnalisés (composants).

Les sections suivantes décrivent comment utiliser le pour AWS IoT SiteWise API créer des modèles de composants.

Création d'un modèle de composant (AWS CLI)

Vous pouvez utiliser le AWS Command Line Interface (AWS CLI) pour créer un modèle de composant.

Utilisez cette CreateAssetModelopération pour créer un modèle de composant avec des propriétés. Cette opération attend une charge utile dont la structure est la suivante :

{
  "assetModelType": "COMPONENT_MODEL",
  "assetModelName": "String",
  "assetModelDescription": "String",
  "assetModelProperties": Array of AssetModelProperty,
}

Pour créer un modèle de composant (AWS CLI)

1. Créez un fichier appelé, component-model-payload.json puis copiez l'JSONobjet suivant dans le fichier :

   {
     "assetModelType": "COMPONENT_MODEL",
     "assetModelName": "",
     "assetModelDescription": "",
     "assetModelProperties": [
   
     ]
   }

2. Utilisez votre éditeur de JSON texte préféré pour modifier le component-model-payload.json fichier comme suit :

   1. Entrez un nom (assetModelName) pour le modèle de composant, tel que Servo Motor ouServo Motor Model. Ce nom doit être unique pour tous les modèles d'actifs et modèles de composants de votre compte Région AWS.

   2. (Facultatif) Entrez un ID externe (assetModelExternalId) pour le modèle de composant. Il s'agit d'un identifiant défini par l'utilisateur. Pour plus d’informations, consultez Objets de référence avec interface externe IDs dans le Guide de l’utilisateur AWS IoT SiteWise .

   3. (Facultatif) Saisissez une description (assetModelDescription) pour le modèle de ressource ou supprimez la paire clé-valeur assetModelDescription.

   4. (Facultatif) Définissez les propriétés des actifs (assetModelProperties) pour le modèle de composant. Pour de plus amples informations, veuillez consulter Définir les propriétés des données.

   5. (Facultatif) Ajoutez des balises (tags) pour le modèle de ressource. Pour de plus amples informations, veuillez consulter Marquez vos AWS IoT SiteWise ressources.

3. Exécutez la commande suivante pour créer un modèle de composant à partir de la définition du JSON fichier.

   aws iotsitewise create-asset-model --cli-input-json file://component-model-payload.json

   L'opération renvoie une réponse contenant ce à quoi vous assetModelId faites référence lorsque vous ajoutez une référence à votre modèle de composant dans un modèle d'actif ou un autre modèle de composant. La réponse contient également l'état du modèle (assetModelStatus.state), qui est initialement CREATING. L'état du modèle de composant est maintenu CREATING jusqu'à ce que les modifications se propagent.

   Note

   Le processus de création de modèles de composants peut prendre jusqu'à quelques minutes pour les modèles complexes. Pour vérifier l'état actuel de votre modèle de composant, utilisez l'DescribeAssetModelopération en spécifiant leassetModelId. Une fois que le statut du modèle de composant est ACTIVE défini, vous pouvez ajouter des références à votre modèle de composant dans des modèles d'actifs ou d'autres modèles de composants. Pour de plus amples informations, veuillez consulter État des ressources et des modèles.

4. (Facultatif) Créez des modèles composites personnalisés pour votre modèle de composant. Avec les modèles composites personnalisés, vous pouvez regrouper les propriétés au sein du modèle ou inclure un sous-assemblage en faisant référence à un autre modèle de composant. Pour de plus amples informations, veuillez consulter Création de modèles composites personnalisés (composants).

Exemple de modèle de composant

Cette section contient un exemple de définition de modèle de composant que vous pouvez utiliser pour créer un modèle de composant avec le AWS CLI et AWS IoT SiteWise SDKs. Ce modèle de composant représente un servomoteur qui peut être utilisé dans un autre équipement, tel qu'une CNC machine.

Rubriques

• Modèle de composant du servomoteur

Modèle de composant du servomoteur

Le modèle de composant suivant représente un servomoteur qui peut être utilisé dans des équipements tels que CNC des machines. Le servomoteur fournit diverses mesures, telles que les températures et la résistance électrique. Ces mesures sont disponibles sous forme de propriétés sur des actifs créés à partir de modèles d'actifs faisant référence au modèle de composant du servomoteur.

{
    "assetModelName": "ServoMotor",
    "assetModelType": "COMPONENT_MODEL",
    "assetModelProperties": [
        {
            "dataType": "DOUBLE",
            "name": "Servo Motor Temperature",
            "type": {
            "measurement": {}
            },
            "unit": "Celsius"
        },
        {
            "dataType": "DOUBLE",
            "name": "Spindle speed",
            "type": {
            "measurement": {}
            },
            "unit": "rpm"
        }
    ]
}