Ejemplo: Uso de comandos para controlar el modo de dirección de un vehículo ()AWS CLI

Cree un recurso de comando para el funcionamiento del modo de dirección

Cree el comando que desee enviar a su dispositivo mediante la create-command CLI. En este ejemplo, especifique:

aws iot create-command \ 
    --command-id TurnOffSteeringMode \ 
    --role-arn "arn:aws:iam:accountId:role/FwCommandExecutionRole" \
    --display-name "Turn off steering mode" \ 
    --namespace AWS-IoT-FleetWise \
    --mandatory-parameters '[
      {
        "name": "$actuatorPath.Vehicle.Chassis.SteeringWheel.TurnOffSteeringMode",
        "defaultValue": { "S": "true" }
      }
    ]'

El siguiente resultado muestra un ejemplo de respuesta de la CLI, donde ap-south-1 y 123456789012 son ejemplos del Cuenta de AWS ID Región de AWS y.

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

Para ver ejemplos adicionales sobre el uso de este comando, consulteCree un recurso de comandos.

Recupere información sobre el comando

Ejecute el siguiente comando para recuperar información sobre el comando, donde command-id aparece el identificador del comando en el resultado de la create-command operación desde arriba.

aws iot get-command --command-id TurnOffSteeringMode

La ejecución de este comando genera la siguiente respuesta. Verá la hora en que se creó el comando y cuándo se actualizó por última vez, los parámetros que especificó y si el comando está disponible para ejecutarse en el dispositivo.

{
    "commandId": "TurnOffSteeringMode",
    "commandArn": "arn:aws:iot:ap-south-1:123456789012:command/TurnOffSteeringMode",
    "namespace": "AWS-IoT-FleetWise",
    "mandatoryParameters":[
        {
            "name": "$actuatorPath.Vehicle.Chassis.SteeringWheel.TurnOffSteeringMode",
            "defaultValue": {"S": "true" }
        }
    ],
    "createdAt": "2024-03-23T00:50:10.095000-07:00",
    "lastUpdatedAt": "2024-03-23T00:50:10.095000-07:00",
    "deprecated": false
}

Para ver ejemplos adicionales sobre el uso de este comando, consulteRecupera información sobre un comando.

Inicie la ejecución del comando

Ejecute el siguiente comando para iniciar la ejecución del comando, donde command-arn aparece el comando ARN en la salida de la get-command operación desde arriba. target-arnEs el ARN del dispositivo de destino para el que está ejecutando el comando, por ejemplo,. myVehicle

En este ejemplo, dado que proporcionó valores predeterminados para los parámetros al crear el comando, la start-command-execution CLI puede usar estos valores al ejecutar el comando. También puede optar por anular el valor predeterminado especificando un valor diferente para los parámetros cuando utilice la CLI.

aws iot-data start-command-execution \    
    --command-arn arn:aws:iot:ap-south-1:123456789012:command/TurnOffSteeringMode \
    --target-arn arn:aws:iot:ap-south-1:123456789012:thing/myVehicle

La ejecución de este comando devuelve un identificador de ejecución del comando. Puede usar este ID para consultar el estado de ejecución del comando, los detalles y el historial de ejecución del comando.

{
    "executionId": "07e4b780-7eca-4ffd-b772-b76358da5542"
}

Para ver ejemplos adicionales sobre el uso de la CLI, consulteEnvía un comando ()AWS CLI.

Recupere información sobre la ejecución del comando

Ejecute el siguiente comando para recuperar información sobre el comando que ejecutó en el dispositivo de destino. Especifica elexecution-id, que obtuviste como resultado de la start-command-execution operación desde arriba, y eltarget-arn, que es el ARN del dispositivo al que te diriges.

aws iot get-command-execution \    
    --execution-id <"07e4b780-7eca-4ffd-b772-b76358da5542"> \ 
    --target-arn arn:aws:iot:us-east-1:<account>:thing/myVehicle

Al ejecutar este comando, se devuelve información sobre la ejecución del comando, el estado de la ejecución, la hora en que comenzó a ejecutarse y la hora en que se completó. Por ejemplo, la siguiente respuesta muestra que la ejecución del comando se realizó correctamente en el dispositivo de destino y que el modo de dirección estaba desactivado.

{
    "executionId": "07e4b780-7eca-4ffd-b772-b76358da5542",
    "commandArn": "arn:aws:iot:ap-south-1:123456789012:command/TurnOffSteeringMode",
    "targetArn": "arn:aws:iot:ap-south-1:123456789012:thing/myVehicle",
    "result": "SUCCEEDED",
     "statusReason": {
        "reasonCode": "65536",
        "reasonDescription": "SUCCESS"
    },
    "result": {
        "KeyName": {
            "S": "",
            "B": true,
            "BIN": null
        }
    },
    "createdAt": "2024-03-23T00:50:10.095000-07:00",
    "completedAt": "2024-03-23T00:50:10.095000-07:00",
    "parameters": '{
         "$actuatorPath.Vehicle.Chassis.SteeringWheel.TurnOffSteeringMode":
         { "S": "true" }
    }' 
}

(Opcional) Elimine el recurso de comandos

Ejecute el siguiente comando para dejarlo obsoleto, donde command-id aparece el identificador del comando que aparece arriba en el resultado de la get-command operación.

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

La ejecución de este comando devuelve un resultado que indica que el comando ha quedado obsoleto. También puede usar la CLI para restaurar el comando.

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

Elimine el comando

Ejecute el siguiente comando para eliminar el comando especificado porcommand-id.

aws iot delete-command --command-id TurnOffSteeringMode

Si la solicitud de eliminación se realiza correctamente, verás un HTTP statusCode de 202 o 204, dependiendo de si marcaste el comando como obsoleto y de cuándo lo hizo. Para obtener más información y un ejemplo, consulte Eliminar un recurso de comandos.

Puede usar la get-command CLI para comprobar que el comando se ha eliminado de su cuenta.

(Opcional) Elimine las ejecuciones de comandos

De forma predeterminada, todas las ejecuciones de comandos se eliminarán en un plazo de seis meses a partir de la fecha en que las haya creado. Puede ver esta información mediante el timeToLive parámetro de la GetCommandExecution API.

Como alternativa, si la ejecución del comando ha pasado a ser terminal, por ejemplo, cuando el estado de ejecución es uno de SUCCEEDEDFAILED, o bienREJECTED, puede eliminar la ejecución del comando. Ejecute el siguiente comando para eliminar la ejecución, donde execution-id aparece el identificador de ejecución que aparece arriba en el resultado de la get-command-execution operación.

aws iot delete-command-execution \ 
            --execution-id "07e4b780-7eca-4ffd-b772-b76358da5542"

Puede usar la get-command-execution CLI para comprobar que la ejecución del comando se ha eliminado de su cuenta.