Menggunakan dan membuat tipe komponen - AWS IoT TwinMaker
Jenis komponen bawaanFitur inti dari jenis AWS IoT TwinMaker komponenMembuat definisi propertiMembuat fungsi

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Menggunakan dan membuat tipe komponen

Topik ini memandu Anda melalui nilai dan struktur yang Anda gunakan untuk membuat tipe AWS IoT TwinMaker komponen. Ini menunjukkan cara membuat objek permintaan yang dapat Anda teruskan ke CreateComponentTypeAPI atau dengan menggunakan editor tipe komponen di AWS IoT TwinMaker konsol.

Komponen menyediakan konteks untuk properti dan data untuk entitas terkait mereka.

Jenis komponen bawaan

Di AWS IoT TwinMaker konsol, saat Anda memilih ruang kerja dan kemudian memilih Jenis komponen di panel kiri, Anda akan melihat jenis komponen berikut.

  • com.amazon.iotsitewise.resourcesync: Jenis komponen yang secara otomatis menyinkronkan aset dan model aset Anda dan mengubahnya menjadi komponen entitas dan tipe komponen. AWS IoT SiteWise AWS IoT TwinMaker Untuk informasi selengkapnya tentang penggunaan sinkronisasi AWS IoT SiteWise aset, lihat Sinkronisasi aset dengan AWS IoT SiteWise.

  • com.amazon.iottwinmaker.alarm.basic: Komponen alarm dasar yang menarik data alarm dari sumber eksternal ke entitas. Komponen ini tidak berisi fungsi yang menghubungkan ke sumber data tertentu. Ini berarti bahwa komponen alarm abstrak dan dapat diwarisi oleh jenis komponen lain yang menentukan sumber data dan fungsi yang membaca dari sumber itu.

  • com.amazon.iottwinmaker.documents: Pemetaan sederhana judul ke URL untuk dokumen yang berisi informasi tentang entitas.

  • com.amazon.iotsitewise.connector.edgevideo: Komponen yang menarik video dari perangkat IoT menggunakan komponen Edge Connector for Kinesis Video Streams ke dalam entitas. AWS IoT Greengrass Komponen Konektor Tepi untuk Kinesis AWS IoT Greengrass Video Streams AWS IoT TwinMaker bukanlah komponen, melainkan komponen bawaan AWS IoT Greengrass yang digunakan secara lokal di perangkat IoT Anda.

  • com.amazon.iotsitewise.connector: Komponen yang menarik data ke dalam entitas. AWS IoT SiteWise

  • com.amazon.iottwinmaker.parameters: Komponen yang menambahkan pasangan nilai kunci statis ke entitas.

  • com.amazon.kvs.video: Komponen yang menarik video dari Kinesis Video Streams ke entitas. AWS IoT TwinMaker

Halaman konsol tipe Component dengan daftar beberapa tipe komponen yang telah ditentukan sebelumnya.

Fitur inti dari jenis AWS IoT TwinMaker komponen

Daftar berikut menjelaskan fitur inti dari jenis komponen.

  • Definisi properti: PropertyDefinitionRequestObjek mendefinisikan properti yang dapat Anda isi di komposer adegan atau dapat diisi dengan data yang ditarik dari sumber data eksternal. Properti statis yang Anda atur disimpan di AWS IoT TwinMaker. Properti deret waktu dan properti lain yang ditarik dari sumber data disimpan secara eksternal.

    Anda menentukan definisi properti di dalam string ke PropertyDefinitionRequest peta. Setiap string harus unik untuk peta.

  • Fungsi: FunctionRequestObjek menentukan fungsi Lambda yang membaca dari dan berpotensi menulis ke sumber data eksternal.

    Tipe komponen yang berisi properti dengan nilai yang disimpan secara eksternal tetapi tidak memiliki fungsi yang sesuai untuk mengambil nilai adalah tipe komponen abstrak. Anda dapat memperluas tipe komponen konkret dari tipe komponen abstrak. Anda tidak dapat menambahkan tipe komponen abstrak ke entitas. Mereka tidak muncul di komposer adegan.

    Anda menentukan fungsi di dalam string untuk FunctionRequest memetakan. String harus menentukan salah satu jenis fungsi standar berikut.

    • dataReader: Fungsi yang menarik data dari sumber eksternal.

    • dataReaderByEntity: Fungsi yang menarik data dari sumber eksternal.

      Bila Anda menggunakan jenis pembaca data ini, operasi GetPropertyValueHistoryAPI hanya mendukung kueri khusus entitas untuk properti dalam tipe komponen ini. (Anda hanya dapat meminta riwayat nilai properti untuk componentName +entityId.)

    • dataReaderByComponentType: Fungsi yang menarik data dari sumber eksternal.

      Saat Anda menggunakan jenis pembaca data ini, operasi GetPropertyValueHistoryAPI hanya mendukung kueri lintas entitas untuk properti dalam tipe komponen ini. (Anda hanya dapat meminta riwayat nilai properti untukcomponentTypeId.)

    • dataWriter: Fungsi yang menulis data ke sumber eksternal.

    • schemaInitializer: Fungsi yang secara otomatis menginisialisasi nilai properti setiap kali Anda membuat entitas yang berisi tipe komponen.

    Salah satu dari tiga jenis fungsi pembaca data diperlukan dalam tipe komponen non-abstrak.

    Untuk contoh fungsi Lambda yang mengimplementasikan komponen telemetri aliran waktu, termasuk alarm, lihat pembaca data di Sampel.AWS IoT TwinMaker

    catatan

    Karena konektor alarm mewarisi dari jenis komponen alarm abstrak, fungsi Lambda harus mengembalikan alarm_key nilainya. Jika Anda tidak mengembalikan nilai ini, Grafana tidak akan mengenalinya sebagai alarm. Ini diperlukan untuk semua komponen yang mengembalikan alarm.

  • Warisan: Jenis komponen mempromosikan penggunaan kembali kode melalui pewarisan. Tipe komponen dapat mewarisi hingga 10 jenis komponen induk.

    Gunakan extendsFrom parameter untuk menentukan tipe komponen dari mana tipe komponen Anda mewarisi properti dan fungsi.

  • isSingleTon: Beberapa komponen berisi properti, seperti koordinat lokasi, yang tidak dapat disertakan lebih dari sekali dalam entitas. Tetapkan nilai isSingleton parameter true untuk menunjukkan bahwa tipe komponen Anda hanya dapat disertakan sekali dalam entitas.

Membuat definisi properti

Tabel berikut menjelaskan parameter dari aPropertyDefinitionRequest.

Parameter

Deskripsi

isExternalId

Boolean yang menentukan apakah properti adalah pengidentifikasi unik (seperti Id AWS IoT SiteWise aset) dari nilai properti yang disimpan secara eksternal.

Nilai default properti ini adalah false.

isStoredExternally

Sebuah Boolean yang menentukan apakah nilai properti disimpan secara eksternal.

Nilai default properti ini adalah false.

isTimeSeries

Boolean yang menentukan apakah properti menyimpan data deret waktu.

Nilai default properti ini adalah false

isRequiredInEntity

Boolean yang menentukan apakah properti harus memiliki nilai dalam entitas yang menggunakan tipe komponen.

dataType

DataTypeObjek yang menentukan tipe data (seperti string, peta, daftar, dan satuan ukuran) dari properti.

defaultValue

Sebuah DataValueobjek yang menentukan nilai default dari properti.

configuration

string-to-string Peta yang menentukan informasi tambahan yang perlu Anda sambungkan ke sumber data eksternal.

Membuat fungsi

Tabel berikut menjelaskan parameter dari aFunctionRequest.

Parameter

Deskripsi

implementedBy

DataConnectorObjek yang menentukan fungsi Lambda yang menghubungkan ke sumber data eksternal.

requiredProperties

Daftar properti yang dibutuhkan fungsi untuk membaca dan menulis ke sumber data eksternal.

scope

Ruang lingkup fungsi. Gunakan Workspace untuk fungsi dengan cakupan yang mencakup seluruh ruang kerja. Gunakan Entity untuk fungsi dengan cakupan yang terbatas pada entitas yang berisi komponen.

Untuk contoh yang menunjukkan cara membuat dan memperluas tipe komponen, lihatContoh jenis komponen.