Contoh: Menggunakan perintah untuk mengontrol mode kemudi kendaraan (AWS CLI)

Buat sumber daya perintah untuk operasi mode kemudi

Buat perintah yang ingin Anda kirim ke perangkat Anda menggunakan create-command CLI. Dalam contoh ini, tentukan:

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" }
      }
    ]'

Output berikut menunjukkan respon sampel dari CLI, di mana ap-south-1 dan 123456789012 merupakan contoh dari Wilayah AWS dan Akun AWS ID.

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

Untuk contoh tambahan tentang penggunaan perintah ini, lihatBuat sumber daya perintah.

Ambil informasi tentang perintah

Jalankan perintah berikut untuk mengambil informasi tentang perintah, di mana command-id ID perintah dalam output create-command operasi dari atas.

aws iot get-command --command-id TurnOffSteeringMode

Menjalankan perintah ini menghasilkan respons berikut. Anda akan melihat waktu ketika perintah dibuat dan kapan terakhir diperbarui, parameter apa pun yang Anda tentukan, dan apakah perintah tersedia untuk dijalankan pada perangkat.

{
    "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
}

Untuk contoh tambahan tentang penggunaan perintah ini, lihatMengambil informasi tentang perintah.

Mulai eksekusi perintah

Jalankan perintah berikut untuk mulai menjalankan perintah, di command-arn mana perintah ARN dalam output operasi dari get-command atas. target-arnIni adalah ARN dari perangkat target tempat Anda menjalankan perintah, misalnya,. myVehicle

Dalam contoh ini, karena Anda memberikan nilai default untuk parameter saat membuat perintah, start-command-execution CLI dapat menggunakan nilai-nilai ini saat menjalankan perintah. Anda juga dapat memilih untuk mengganti nilai default dengan menentukan nilai yang berbeda untuk parameter saat menggunakan 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

Menjalankan perintah ini mengembalikan ID eksekusi perintah. Anda dapat menggunakan ID ini untuk menanyakan status eksekusi perintah, detail, dan riwayat eksekusi perintah.

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

Untuk contoh tambahan tentang penggunaan CLI, lihat. Kirim perintah (AWS CLI)

Mengambil informasi tentang eksekusi perintah

Jalankan perintah berikut untuk mengambil informasi tentang perintah yang Anda jalankan pada perangkat target. Tentukanexecution-id, yang Anda peroleh sebagai output start-command-execution operasi dari atas, dantarget-arn, yang merupakan ARN perangkat yang Anda targetkan.

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

Menjalankan perintah ini mengembalikan informasi tentang eksekusi perintah, status eksekusi, waktu ketika mulai mengeksekusi, dan waktu ketika itu selesai. Misalnya, respons berikut menunjukkan bahwa eksekusi perintah berhasil pada perangkat target dan mode kemudi dimatikan.

{
    "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" }
    }' 
}

(Opsional) Menghilangkan sumber daya perintah

Jalankan perintah berikut untuk menghentikan perintah, di command-id mana ID perintah dalam output get-command operasi dari atas.

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

Menjalankan perintah ini mengembalikan output yang menunjukkan perintah telah usang. Anda juga dapat menggunakan CLI untuk mengembalikan perintah.

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

Hapus perintah

Jalankan perintah berikut untuk menghapus perintah, yang ditentukan olehcommand-id.

aws iot delete-command --command-id TurnOffSteeringMode

Jika permintaan penghapusan berhasil, Anda akan melihat HTTP statusCode 202 atau 204 tergantung pada apakah Anda menandai perintah untuk penghentian dan kapan itu tidak digunakan lagi. Untuk informasi lebih lanjut dan contoh, lihat Hapus sumber daya perintah.

Anda dapat menggunakan get-command CLI untuk memverifikasi bahwa perintah telah dihapus dari akun Anda.

(Opsional) Hapus eksekusi perintah

Secara default, semua eksekusi perintah akan dihapus dalam enam bulan sejak tanggal Anda membuatnya. Anda dapat melihat informasi ini menggunakan timeToLive parameter dari GetCommandExecution API.

Atau, jika eksekusi perintah Anda telah menjadi terminal, seperti ketika status eksekusi Anda adalah salah satuSUCCEEDED,FAILED, atauREJECTED, Anda dapat menghapus eksekusi perintah. Jalankan perintah berikut untuk menghapus eksekusi, di mana execution-id ID Eksekusi dalam output get-command-execution operasi dari atas.

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

Anda dapat menggunakan get-command-execution CLI untuk memverifikasi bahwa eksekusi perintah telah dihapus dari akun Anda.