Création et gestion de commandes - AWS IoT FleetWise
Création d'une ressource de commandeRécupérer des informations sur une commandeRépertorier les commandes de votre compteMettre à jour ou rendre obsolète une ressource de commandeSupprimer une ressource de commande

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création et gestion de commandes

Important

L'accès à certaines FleetWise fonctionnalités de AWS l'IoT est actuellement restreint. Pour de plus amples informations, veuillez consulter AWS Disponibilité des régions et des fonctionnalités dans AWS l'IoT FleetWise.

Vous pouvez configurer des actions à distance réutilisables ou envoyer des instructions immédiates et ponctuelles à vos appareils. Lorsque vous utilisez cette fonctionnalité, vous pouvez spécifier les instructions que vos appareils peuvent exécuter quasiment en temps réel. Une commande vous permet de configurer des actions à distance réutilisables pour votre véhicule cible. Après avoir créé une commande, vous pouvez lancer une exécution de commande qui cible un véhicule spécifique.

Cette rubrique explique comment créer et gérer une ressource de commande à l'aide de l' AWS IoT Core API ou du AWS CLI. Il explique comment effectuer les actions suivantes sur une ressource de commande.

Création d'une ressource de commande

Vous pouvez utiliser le fonctionnement de l'API du plan de CreateCommand AWS IoT Core contrôle ou la FleetWise console AWS IoT pour créer une commande.

Vous pouvez utiliser la FleetWise console AWS IoT pour créer une commande.

Pour créer une commande

  1. Ouvrez la FleetWise console AWS IoT.

  2. Dans le volet de navigation, choisissez Commands.

  3. Choisissez Créer une commande.

  4. Spécifiez un identifiant de commande unique pour vous aider à identifier la commande que vous souhaitez exécuter sur le véhicule.

  5. (Facultatif) Spécifiez un nom d'affichage et une description facultatifs.

  6. (Facultatif) Sélectionnez l'actionneur et la valeur du paramètre par défaut. Les paramètres spécifient les actions que le véhicule cible peut effectuer lors de la réception de la commande. Si vous n'ajoutez pas de paramètres, vous devrez les fournir lors de l'exécution de la commande.

  7. Choisissez un rôle IAM qui accorde les autorisations nécessaires pour générer la charge utile des commandes. Consultez la section Contrôle de l'accès.

  8. Choisissez Créer une commande.

L'exemple suivant montre comment créer une commande avec un paramètre.

Considérations relatives à la création d'une commande

Lorsque vous créez une commande dans AWS IoT FleetWise :

  • Vous devez spécifier celui roleArn qui autorise la création et l'exécution de commandes sur votre véhicule. Pour plus d'informations et sur les exemples de politiques, notamment lorsque les clés KMS sont activées, consultezAccorder AWS IoT Device Management l'autorisation de générer la charge utile pour les commandes avec AWS IoT FleetWise.

  • Vous devez le spécifier AWS-IoT-FleetWise comme espace de noms.

  • Vous pouvez ignorer le mandatory-parameters champ et les spécifier au moment de l'exécution. Vous pouvez également créer une commande avec des paramètres et éventuellement spécifier des valeurs par défaut pour ceux-ci. Si vous avez spécifié des valeurs par défaut, vous pouvez utiliser ces valeurs lors de l'exécution ou les remplacer en spécifiant vos propres valeurs. Pour ces exemples supplémentaires, voirScénarios d'utilisation des commandes.

  • Vous pouvez spécifier jusqu'à trois paires nom-valeur pour le mandatory-parameters champ. Toutefois, lors de l'exécution de la commande sur le véhicule, une seule paire nom-valeur est acceptée, et le name champ doit utiliser le nom complet avec le $actuatorPath. préfixe.

  • Remplacez command-id par un identifiant unique pour la commande. Vous pouvez utiliser l'UUID, les caractères alphanumériques, « - » et « _ ».

  • role-arnRemplacez-le par le rôle IAM qui vous autorise à créer et à exécuter des commandes, par exemple,"arn:aws:iam:accountId:role/FwCommandExecutionRole".

  • (Facultatif) display-name Remplacez-le par un nom convivial pour la commande et description par une description significative de la commande.

  • Remplacez name et value de l'mandatory-parametersobjet par les informations requises pour la commande en cours de création. Le name champ est le nom complet tel que défini dans le catalogue de signaux avec $actuatorPath. comme préfixe. Par exemple, il name peut être $actuatorPath.Vehicle.Chassis.SteeringWheel.HandsOff.HandsOffSteeringMode et value peut être un booléen indiquant un état du mode de direction tel que. {"B": false}

aws iot create-command --command-id command-id \ 
    --role-arn role-arn \
    --description description \
    --display-name display-name \     
    --namespace "AWS-IoT-FleetWise" \
    --mandatory-parameters '[
        {
            "name": name, 
            "value": value
        }
   ]'

L'opération d'CreateCommandAPI renvoie une réponse contenant l'ID et l'ARN (Amazon Resource Name) de la commande.

{
    "commandId": "HandsOffSteeringMode",
    "commandArn": "arn:aws:iot:ap-south-1:123456789012:command/HandsOffSteeringMode"
}

Récupérer des informations sur une commande

Vous pouvez utiliser l'opération API du plan de GetCommand AWS IoT Core contrôle pour récupérer des informations sur une ressource de commande.

Pour obtenir des informations sur une ressource de commande, exécutez la commande suivante. Remplacez command-id par l'identifiant utilisé lors de la création de la commande.

aws iot get-command --command-id command-id

L'opération GetCommand API renvoie une réponse contenant les informations suivantes.

  • L'ID et l'ARN (Amazon Resource Name) de la commande.

  • Date et heure de création et de dernière mise à jour de la commande.

  • État de la commande qui indique si elle est disponible pour fonctionner sur le véhicule.

  • Tous les paramètres que vous avez spécifiés lors de la création de la commande.

{
    "commandId": "HandsOffSteeringMode",
    "commandArn": "arn:aws:iot:ap-south-1:123456789012:command/HandsOffSteeringMode"",
    "namespace": "AWS-IoT-FleetWise",
    "mandatoryParameters":[
        {
            "name": "$actuatorPath.Vehicle.Chassis.SteeringWheel.HandsOff.HandsOffSteeringMode",
            "value": {"B": false }
        }
    ],
    "createdAt": "2024-03-23T11:24:14.919000-07:00",
    "lastUpdatedAt": "2024-03-23T11:24:14.919000-07:00",
    "deprecated": false,
    "pendingDeletion": false
}

Répertorier les commandes de votre compte

Vous pouvez utiliser l'opération API du plan de ListCommands AWS IoT Core contrôle pour répertorier toutes les commandes que vous avez créées dans votre compte.

Pour répertorier les commandes de votre compte, exécutez la commande suivante. Par défaut, l'API renvoie les commandes créées pour les deux espaces de noms. Pour filtrer la liste afin d'afficher uniquement les commandes créées pour AWS IoT FleetWise, exécutez la commande suivante.

Note

Vous pouvez également trier la liste par ordre croissant ou décroissant, ou filtrer la liste pour n'afficher que les commandes ayant un nom de paramètre de commande spécifique.

aws iot list-commands --namespace "AWS-IoT-FleetWise"

L'opération ListCommands API renvoie une réponse contenant les informations suivantes.

  • L'ID et l'ARN (Amazon Resource Name) des commandes.

  • Date et heure de création et de dernière mise à jour de la commande.

  • État des commandes qui indique si les commandes sont disponibles pour être exécutées sur le véhicule.

Mettre à jour ou rendre obsolète une ressource de commande

Vous pouvez utiliser le fonctionnement de l'API du plan de UpdateCommand AWS IoT Core contrôle ou FleetWise la console AWS IoT pour mettre à jour une ressource de commande. Vous pouvez mettre à jour le nom d'affichage et la description d'une commande. Vous pouvez également déprécier une commande si elle n'est pas actuellement utilisée.

Note

Vous ne pouvez pas modifier les informations de l'espace de noms ou les paramètres à utiliser lors de l'exécution de la commande.

Mettre à jour une commande

Pour mettre à jour une commande depuis la console, rendez-vous sur la page Commandes de la FleetWise console AWS IoT et effectuez les étapes suivantes.

  1. Choisissez la commande que vous souhaitez mettre à jour, puis sélectionnez Modifier.

  2. Modifiez les détails de la commande, puis choisissez Enregistrer les modifications.

Déprécier une commande

Pour désactiver une commande depuis la console, rendez-vous sur la page Commandes de la FleetWise console AWS IoT et effectuez les étapes suivantes.

  1. Choisissez la commande que vous souhaitez déprécier, puis choisissez Déprécier.

  2. Confirmez la dépréciation, puis choisissez Déprécier.

Mettre à jour une commande

Pour mettre à jour une ressource de commande, exécutez la commande suivante. command-idRemplacez-le par l'identifiant de la commande que vous souhaitez mettre à jour et fournissez le display-name et mis à jourdescription.

aws iot update-command \ 
    --command-id command-id \ 
    --display-name display-name \ 
    --description description

L'opération UpdateCommand API renvoie la réponse suivante.

{
    "commandId": "HandsOffSteeringMode",
    "deprecated": false,
    "lastUpdatedAt": "2024-05-09T23:16:51.370000-07:00"
}
Déprécier une commande

Vous désapprouvez une commande lorsque vous avez l'intention de ne plus continuer à l'utiliser sur votre appareil ou lorsqu'elle est obsolète. L'exemple suivant montre comment déprécier une commande.

aws iot update-command \ 
    --command-id command-id \ 
    --deprecated

L'opération d'UpdateCommandAPI renvoie une réponse contenant l'ID et l'ARN (Amazon Resource Name) de la commande.

{
    "commandId": "HandsOffSteeringMode",
    "deprecated": true,
    "lastUpdatedAt": "2024-05-09T23:16:51.370000-07:00"
}

Une fois qu'une commande est devenue obsolète, les exécutions de commandes existantes continuent de s'exécuter sur le véhicule jusqu'à ce qu'elles deviennent un terminal. Pour exécuter de nouvelles commandes, vous devez utiliser l'UpdateCommandAPI pour restaurer la commande afin qu'elle soit disponible. Pour plus d'informations sur la dépréciation et la restauration d'une commande, ainsi que sur les considérations associées, consultez la section Dépréciation d'une ressource de commande dans le guide du développeur.AWS IoT Core

Supprimer une ressource de commande

Vous pouvez utiliser le fonctionnement de l'API du plan de DeleteCommand AWS IoT Core contrôle ou FleetWise la console AWS IoT pour supprimer une ressource de commande.

Note

Les actions de suppression sont permanentes et ne peuvent être annulées. La commande sera définitivement supprimée de votre compte.

Pour supprimer une commande de la console, rendez-vous sur la page Commandes de la FleetWise console AWS IoT et effectuez les étapes suivantes.

  1. Choisissez la commande que vous souhaitez supprimer, puis sélectionnez Supprimer.

  2. Confirmez que vous souhaitez supprimer la commande, puis choisissez Supprimer.

Pour supprimer une ressource de commande, exécutez la commande suivante. Remplacez command-id par l'identifiant de la commande que vous souhaitez supprimer. L'exemple suivant montre comment supprimer une ressource de commande.

aws iot delete-command --command-id command-id

Si la demande de suppression aboutit :

  • Si la commande est devenue obsolète pendant une durée supérieure au délai maximum de 24 heures, elle sera immédiatement supprimée et vous verrez un HTTP statusCode de 204.

  • Si la commande n'est pas obsolète, ou si elle l'a été pendant une durée inférieure au délai maximum, la commande sera dans un pending deletion état et vous verrez un HTTP de 202. statusCode La commande sera automatiquement supprimée de votre compte après le délai maximum de 24 heures.