Pengaturan orientasi hub

Selesaikan langkah-langkah pengaturan ini untuk setiap perangkat hub sebelum Anda memulai proses orientasi penyediaan armada. Bagian ini menjelaskan cara membuat hal-hal yang dikelola, mengatur struktur direktori, dan mengonfigurasi sertifikat yang diperlukan.

Langkah 1: Daftarkan titik akhir kustom

Buat titik akhir komunikasi khusus yang digunakan perangkat Anda untuk bertukar data dengan integrasi terkelola. Titik akhir ini menetapkan titik koneksi aman untuk semua device-to-cloud pesan, termasuk perintah perangkat, pembaruan status, dan pemberitahuan.

Untuk mendaftarkan titik akhir

• Gunakan RegisterCustomEndpointAPI untuk membuat titik akhir untuk komunikasi device-to-managed integrasi.

  RegisterCustomEndpointMinta contoh

  aws iot-managed-integrations register-custom-endpoint  
  

  Tanggapan:

  {
    [ACCOUNT-PREFIX]-ats.iot.AWS-REGION.amazonaws.com
  }

  catatan

  Simpan alamat titik akhir. Anda akan membutuhkannya untuk komunikasi perangkat masa depan.

  Untuk mengembalikan informasi titik akhir, gunakan GetCustomEndpoint API.

  Untuk informasi selengkapnya, lihat RegisterCustomEndpointAPI dan GetCustomEndpointAPI di Panduan Referensi API integrasi terkelola.

Langkah 2: Buat profil penyediaan

Profil penyediaan berisi kredensi keamanan dan setelan konfigurasi yang dibutuhkan perangkat Anda untuk terhubung ke integrasi terkelola.

Untuk membuat profil penyediaan armada

• Panggil CreateProvisioningProfileAPI untuk menghasilkan yang berikut:

  • Template penyediaan yang mendefinisikan setelan koneksi perangkat

  • Sertifikat klaim dan kunci pribadi untuk otentikasi perangkat

  penting

  Simpan sertifikat klaim, kunci pribadi, dan ID templat dengan aman. Anda akan memerlukan kredensil ini ke perangkat onboard untuk integrasi terkelola. Jika Anda kehilangan kredensil ini, Anda harus membuat profil penyediaan baru.

CreateProvisioningProfilecontoh permintaan

aws iot-managed-integrations create-provisioning-profile \
    --provisioning-type FLEET_PROVISIONING \
    --name PROFILE_NAME  

Tanggapan:

{
"Arn":"arn:aws:iotmanagedintegrations:AWS-REGION:ACCOUNT-ID:provisioning-profile/PROFILE-ID",
    "ClaimCertificate":
  "-----BEGIN CERTIFICATE-----
  MIICiTCCAfICCQD6m7.....w3rrszlaEXAMPLE=
  -----END CERTIFICATE-----",
    "ClaimCertificatePrivateKey":
  "-----BEGIN RSA PRIVATE KEY-----
  MIICiTCCAfICCQ...3rrszlaEXAMPLE=
 -----END RSA PRIVATE KEY-----",
    "Id": "PROFILE-ID",
    "PROFILE-NAME",
         "ProvisioningType": "FLEET_PROVISIONING"
}

Langkah 3: Buat hal yang dikelola (penyediaan armada)

Gunakan CreateManagedThing API untuk membuat hal terkelola untuk perangkat hub Anda. Setiap hub membutuhkan hal yang dikelola sendiri dengan materi otentikasi yang unik. Untuk informasi selengkapnya, lihat CreateManagedThingAPI dalam Referensi API integrasi terkelola.

Saat Anda membuat hal yang dikelola, tentukan parameter ini:

• Role: Tetapkan nilai ini keCONTROLLER.

• AuthenticationMaterial: Sertakan bidang berikut.

  • SN: Nomor seri unik untuk perangkat ini

  • UPC: Kode produk universal untuk perangkat ini

• Owner: Pengidentifikasi pemilik untuk hal yang dikelola ini.

penting

Setiap perangkat harus memiliki nomor seri unik (SN) dalam materi otentikasi.

CreateManagedThingContoh permintaan:

{ 
 "Role": "CONTROLLER",
 "Owner": "ThingOwner1",
 "AuthenticationMaterialType": "WIFI_SETUP_QR_BAR_CODE",
 "AuthenticationMaterial": "SN:123456789524;UPC:829576019524"
}

Untuk informasi selengkapnya, lihat CreateManagedThingReferensi API integrasi terkelola.

(Opsional) Dapatkan hal yang dikelola

Hal ProvisioningStatus yang Anda kelola harus UNCLAIMED sebelum Anda dapat melanjutkan. Gunakan GetManagedThing API untuk memverifikasi bahwa hal terkelola Anda ada dan siap untuk disediakan. Untuk informasi selengkapnya, lihat GetManagedThingReferensi API integrasi terkelola.

Langkah 4: Buat struktur direktori

Buat direktori untuk file konfigurasi dan sertifikat Anda. Secara default, proses orientasi hub menggunakan file. /data/aws/iotmi/config/iotmi_config.json

Anda dapat menentukan jalur kustom untuk sertifikat dan kunci pribadi dalam file konfigurasi. Panduan ini menggunakan jalur default/data/aws/iotmi/certs.

mkdir -p /data/aws/iotmi/config
mkdir -p /data/aws/iotmi/certs

/data/
    aws/
        iotmi/
            config/
            certs/

Langkah 5: Tambahkan bahan otentikasi ke perangkat hub

Salin sertifikat dan kunci ke perangkat hub Anda, lalu buat file konfigurasi khusus perangkat. File-file ini membangun komunikasi yang aman antara hub Anda dan integrasi terkelola selama proses penyediaan.

Untuk menyalin sertifikat klaim dan kunci

• Salin file autentikasi ini dari respons CreateProvisioningProfile API Anda ke perangkat hub Anda:

  • claim_cert.pem: Sertifikat klaim (umum untuk semua perangkat)

  • claim_pk.key: Kunci pribadi untuk sertifikat klaim

  Tempatkan kedua file di /data/aws/iotmi/certs direktori.

  penting

  Saat menyimpan sertifikat dan kunci pribadi dalam format PEM, pastikan pemformatan yang tepat dengan menangani karakter baris baru dengan benar. Untuk file yang dikodekan PEM, karakter baris baru (\n) harus diganti dengan pemisah baris yang sebenarnya, karena hanya menyimpan baris baru yang lolos tidak akan diambil dengan benar nanti.

  catatan

  Jika Anda menggunakan penyimpanan aman, simpan kredensional ini di lokasi penyimpanan aman Anda alih-alih sistem file. Untuk informasi selengkapnya, lihat Buat handler sertifikat khusus untuk penyimpanan aman.

Langkah 6: Buat file konfigurasi perangkat

Buat file konfigurasi yang berisi pengenal perangkat unik, lokasi sertifikat, dan pengaturan penyediaan. SDK menggunakan file ini selama orientasi hub untuk mengautentikasi perangkat Anda, mengelola status penyediaan, dan menyimpan setelan koneksi.

catatan

Setiap perangkat hub memerlukan file konfigurasinya sendiri dengan nilai khusus perangkat yang unik.

Gunakan prosedur berikut untuk membuat atau memodifikasi file konfigurasi Anda, dan salin ke hub.

• Membuat atau memodifikasi file konfigurasi (penyediaan armada).

  Konfigurasikan bidang wajib ini dalam file konfigurasi perangkat:

  • Jalur sertifikat

    1. iot_claim_cert_path: Lokasi sertifikat klaim Anda (claim_cert.pem)

    2. iot_claim_pk_path: Lokasi kunci pribadi Anda (claim_pk.key)

    3. Gunakan SECURE_STORAGE untuk kedua bidang saat menerapkan Secure Storage Cert Handler

  • Pengaturan koneksi

    1. fp_template_name: ProvisioningProfile Nama dari sebelumnya.

    2. endpoint_url: URL titik akhir integrasi terkelola Anda dari respons RegisterCustomEndpoint API (sama untuk semua perangkat di Wilayah).

  • Pengidentifikasi perangkat

    1. SN: Nomor seri perangkat yang cocok dengan panggilan CreateManagedThing API Anda (unik per perangkat)

    2. UPCKode produk universal dari panggilan CreateManagedThing API Anda (sama untuk semua perangkat produk ini)

  {
      "ro": {
          "iot_provisioning_method": "FLEET_PROVISIONING",
          "iot_claim_cert_path": "<SPECIFY_THIS_FIELD>",
          "iot_claim_pk_path": "<SPECIFY_THIS_FIELD>",
          "fp_template_name": "<SPECIFY_THIS_FIELD>",        
          "endpoint_url": "<SPECIFY_THIS_FIELD>",
          "SN": "<SPECIFY_THIS_FIELD>",
          "UPC": "<SPECIFY_THIS_FIELD>"        
      },
      "rw": {
          "iot_provisioning_state": "NOT_PROVISIONED"
      }
  }

Isi file konfigurasi

Tinjau isi iotmi_config.json file.

Daftar Isi

Kunci	Nilai	Ditambahkan oleh pelanggan?	Catatan
iot_provisioning_method	FLEET_PROVISIONING	Ya	Tentukan metode penyediaan yang ingin Anda gunakan.
iot_claim_cert_path	Jalur file yang Anda tentukan atauSECURE_STORAGE. Sebagai contoh, /data/aws/iotmi/certs/claim_cert.pem.	Ya	Tentukan jalur file yang ingin Anda gunakan atauSECURE_STORAGE.
iot_claim_pk_path	Jalur file yang Anda tentukan atauSECURE_STORAGE. Sebagai contoh, /data/aws/iotmi/certs/claim_pk.pem.	Ya	Tentukan jalur file yang ingin Anda gunakan atauSECURE_STORAGE.
fp_template_name	Nama template penyediaan armada harus sama dengan nama ProvisioningProfile yang digunakan sebelumnya.	Ya	Sama dengan nama ProvisioningProfile yang digunakan sebelumnya
endpoint_url	URL endpoint untuk integrasi terkelola.	Ya	Perangkat Anda menggunakan URL ini untuk terhubung ke cloud integrasi terkelola. Untuk mendapatkan informasi ini, gunakan RegisterCustomEndpointAPI.
SN	Nomor seri perangkat. Misalnya, AIDACKCEVSQ6C2EXAMPLE.	Ya	Anda harus memberikan informasi unik ini untuk setiap perangkat.
UPC	Kode produk universal perangkat. Misalnya, 841667145075.	Ya	Anda harus memberikan informasi ini untuk perangkat.
managed_thing_id	ID dari hal yang dikelola.	Tidak	Informasi ini ditambahkan kemudian oleh proses orientasi setelah penyediaan hub.
iot_provisioning_state	Status penyediaan.	Ya	Status penyediaan harus ditetapkan sebagai. NOT_PROVISIONED
iot_permanent_cert_path	Jalur sertifikat IoT. Misalnya, /data/aws/iotmi/iot_cert.pem.	Tidak	Informasi ini ditambahkan kemudian oleh proses orientasi setelah penyediaan hub.
iot_permanent_pk_path	Jalur file kunci pribadi IoT. Misalnya, /data/aws/iotmi/iot_pk.pem.	Tidak	Informasi ini ditambahkan kemudian oleh proses orientasi setelah penyediaan hub.
client_id	ID klien yang akan digunakan untuk koneksi MQTT.	Tidak	Informasi ini ditambahkan kemudian oleh proses orientasi setelah penyediaan hub, agar komponen lain dapat dikonsumsi.
event_manager_upper_bound	Nilai default adalah 500	Tidak	Informasi ini ditambahkan kemudian oleh proses orientasi setelah penyediaan hub, agar komponen lain dapat dikonsumsi.

Langkah 7: Salin file konfigurasi ke hub Anda

Salin file konfigurasi Anda ke /data/aws/iotmi/config atau jalur direktori kustom Anda. Anda akan memberikan jalur ini ke HubOnboarding biner selama proses orientasi.

Untuk penyediaan armada

/data/
    aws/
        iotmi/
            config/
                iotmi_config.json
            certs/
                claim_cert.pem
                claim_pk.key