Link Mentah

Modul ini mencakup fungsi yang mengontrol konfigurasi lapisan link mentah.

Ringkasan

Typedef
otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi) typedef
void(*
Pointer pada penerimaan {i>frame<i} IEEE 802.15.4.
otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError) typedef
void(*
Pointer pada penerimaan {i>frame<i} IEEE 802.15.4.
otLinkRawTransmitDone)(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError) typedef
void(*
Pointer pada penerimaan {i>frame<i} IEEE 802.15.4.

Fungsi
otLinkRawEnergyScan(otInstance *aInstance, uint8_t aScanChannel, uint16_t aScanDuration, otLinkRawEnergyScanDone aCallback)
Memulai urutan pemindaian energi di radio.
otLinkRawGetCaps(otInstance *aInstance)
Mendapatkan kemampuan radio.
otLinkRawGetPromiscuous(otInstance *aInstance)
bool
Mendapatkan status mode {i>promiscuous<i}.
otLinkRawGetRadioTime(otInstance *aInstance)
uint64_t
Mendapatkan waktu platform saat ini (lebar 64bit) chip radio.
otLinkRawGetRssi(otInstance *aInstance)
int8_t
Dapatkan pengukuran RSSI terbaru.
otLinkRawGetTransmitBuffer(otInstance *aInstance)
Radio bertransisi dari Mengirim ke Menerima.
otLinkRawIsEnabled(otInstance *aInstance)
bool
Menunjukkan apakah lapisan link mentah diaktifkan atau tidak.
otLinkRawReceive(otInstance *aInstance)
Mengalihkan radio dari Tidur ke Menerima.
otLinkRawSetMacFrameCounter(otInstance *aInstance, uint32_t aMacFrameCounter)
Menetapkan nilai penghitung frame MAC saat ini.
otLinkRawSetMacFrameCounterIfLarger(otInstance *aInstance, uint32_t aMacFrameCounter)
Menetapkan nilai penghitung frame MAC saat ini hanya jika nilai baru lebih besar dari nilai saat ini.
otLinkRawSetMacKey(otInstance *aInstance, uint8_t aKeyIdMode, uint8_t aKeyId, const otMacKey *aPrevKey, const otMacKey *aCurrKey, const otMacKey *aNextKey)
Perbarui kunci MAC dan indeks kunci.
otLinkRawSetPromiscuous(otInstance *aInstance, bool aEnable)
Mengaktifkan atau menonaktifkan mode {i>promiscuous<i}.
otLinkRawSetReceiveDone(otInstance *aInstance, otLinkRawReceiveDone aCallback)
Mengaktifkan/menonaktifkan lapisan link raw.
otLinkRawSetShortAddress(otInstance *aInstance, uint16_t aShortAddress)
Setel Alamat Singkat untuk pemfilteran alamat.
otLinkRawSleep(otInstance *aInstance)
Mengalihkan radio dari Terima ke Tidur.
otLinkRawSrcMatchAddExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)
Menambahkan alamat yang diperluas ke tabel pencocokan sumber.
otLinkRawSrcMatchAddShortEntry(otInstance *aInstance, uint16_t aShortAddress)
Menambahkan alamat pendek ke tabel pencocokan sumber.
otLinkRawSrcMatchClearExtEntries(otInstance *aInstance)
Menghapus semua alamat yang diperluas dari tabel pencocokan sumber.
otLinkRawSrcMatchClearExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)
Menghapus alamat yang diperluas ke tabel pencocokan sumber radio.
otLinkRawSrcMatchClearShortEntries(otInstance *aInstance)
Menghapus semua alamat singkat dari tabel pencocokan sumber.
otLinkRawSrcMatchClearShortEntry(otInstance *aInstance, uint16_t aShortAddress)
Menghapus alamat singkat ke tabel pencocokan sumber.
otLinkRawSrcMatchEnable(otInstance *aInstance, bool aEnable)
Aktifkan/Nonaktifkan pencocokan sumber untuk frame tertunda.
otLinkRawTransmit(otInstance *aInstance, otLinkRawTransmitDone aCallback)
Memulai urutan transmisi di radio.

Typedef

otLinkRawEnergyScanDone

void(* otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi)

Pointer pada penerimaan {i>frame<i} IEEE 802.15.4.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnergyScanMaxRssi
RSSI maksimum yang ditemukan pada saluran yang dipindai.

otLinkRawReceiveDone

void(* otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError)

Pointer pada penerimaan {i>frame<i} IEEE 802.15.4.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aFrame
Pointer ke frame yang diterima atau NULL jika operasi terima dibatalkan.
[in] aError
OT_ERROR_NONE saat berhasil menerima frame. OT_ERROR_ABORT saat penerimaan dibatalkan dan frame tidak diterima.

otLinkRawTransmitDone

void(* otLinkRawTransmitDone)(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError)

Pointer pada penerimaan {i>frame<i} IEEE 802.15.4.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aFrame
Pointer ke frame yang ditransmisikan.
[in] aAckFrame
Pointer ke frame ACK.
[in] aError
OT_ERROR_NONE saat frame ditransmisikan. OT_ERROR_NO_ACK saat frame ditransmisikan, tetapi tidak ada ACK yang diterima OT_ERROR_CHANNEL_ACCESS_FAILURE saat transmisi tidak dapat terjadi karena aktivitas di saluran. OT_ERROR_ABORT saat transmisi dibatalkan karena alasan lain.

Fungsi

otLinkRawEnergyScan

otError otLinkRawEnergyScan(
  otInstance *aInstance,
  uint8_t aScanChannel,
  uint16_t aScanDuration,
  otLinkRawEnergyScanDone aCallback
)

Memulai urutan pemindaian energi di radio.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aScanChannel
Saluran tempat pemindaian energi aktif.
[in] aScanDuration
Durasi, dalam milidetik, untuk saluran yang akan dipindai.
[in] aCallback
Pointer ke fungsi yang dipanggil setelah penyelesaian saluran yang dipindai.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memulai pemindaian saluran.
OT_ERROR_BUSY
Radio sedang melakukan pemindaian energi.
OT_ERROR_NOT_IMPLEMENTED
Radio tidak mendukung pemindaian energi.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawGetCaps

otRadioCaps otLinkRawGetCaps(
  otInstance *aInstance
)

Mendapatkan kemampuan radio.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Vektor bit kemampuan radio. Tumpukan mengaktifkan atau menonaktifkan beberapa fungsi berdasarkan nilai ini.

otLinkRawGetPromiscuous

bool otLinkRawGetPromiscuous(
  otInstance *aInstance
)

Mendapatkan status mode {i>promiscuous<i}.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
true
Mode {i>promiscuous<i} diaktifkan.
false
Mode {i>promiscuous<i} dinonaktifkan.

otLinkRawGetRadioTime

uint64_t otLinkRawGetRadioTime(
  otInstance *aInstance
)

Mendapatkan waktu platform saat ini (lebar 64bit) chip radio.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Waktu radio saat ini dalam mikrodetik.

otLinkRawGetRssi

int8_t otLinkRawGetRssi(
  otInstance *aInstance
)

Dapatkan pengukuran RSSI terbaru.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
RSSI dalam dBm jika valid. 127 jika RSSI tidak valid.

otLinkRawGetTransmitBuffer

otRadioFrame * otLinkRawGetTransmitBuffer(
  otInstance *aInstance
)

Radio bertransisi dari Mengirim ke Menerima.

Menampilkan pointer ke buffering transmisi.

Pemanggil membentuk frame IEEE 802.15.4 dalam buffer ini, kemudian memanggil otLinkRawTransmit() untuk meminta transmisi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke buffering transmisi atau NULL jika lapisan link mentah tidak diaktifkan.

otLinkRawIsEnabled

bool otLinkRawIsEnabled(
  otInstance *aInstance
)

Menunjukkan apakah lapisan link mentah diaktifkan atau tidak.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
true
Lapisan link raw diaktifkan.
false
Lapisan link raw dinonaktifkan.

otLinkRawReceive

otError otLinkRawReceive(
  otInstance *aInstance
)

Mengalihkan radio dari Tidur ke Menerima.

Nyalakan radio.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil bertransisi ke Accept.
OT_ERROR_INVALID_STATE
Radio dinonaktifkan atau ditransmisikan.

otLinkRawSetMacFrameCounter

otError otLinkRawSetMacFrameCounter(
  otInstance *aInstance,
  uint32_t aMacFrameCounter
)

Menetapkan nilai penghitung frame MAC saat ini.

Selalu menetapkan penghitung MAC ke nilai baru yang diberikan aMacFrameCounter, apa pun nilai saat ini.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMacFrameCounter
Nilai penghitung {i>frame<i} MAC.
Nilai Pengembalian
OT_ERROR_NONE
Jika berhasil.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSetMacFrameCounterIfLarger

otError otLinkRawSetMacFrameCounterIfLarger(
  otInstance *aInstance,
  uint32_t aMacFrameCounter
)

Menetapkan nilai penghitung frame MAC saat ini hanya jika nilai baru lebih besar dari nilai saat ini.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMacFrameCounter
Nilai penghitung {i>frame<i} MAC.
Nilai Pengembalian
OT_ERROR_NONE
Jika berhasil.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSetMacKey

otError otLinkRawSetMacKey(
  otInstance *aInstance,
  uint8_t aKeyIdMode,
  uint8_t aKeyId,
  const otMacKey *aPrevKey,
  const otMacKey *aCurrKey,
  const otMacKey *aNextKey
)

Perbarui kunci MAC dan indeks kunci.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aKeyIdMode
Mode ID tombol.
[in] aKeyId
Indeks kunci.
[in] aPrevKey
Tombol MAC sebelumnya.
[in] aCurrKey
Tombol MAC saat ini.
[in] aNextKey
Tombol MAC berikutnya.
Nilai Pengembalian
OT_ERROR_NONE
Jika berhasil.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSetPromiscuous

otError otLinkRawSetPromiscuous(
  otInstance *aInstance,
  bool aEnable
)

Mengaktifkan atau menonaktifkan mode {i>promiscuous<i}.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnable
Nilai untuk mengaktifkan atau menonaktifkan mode {i>promiscuous<i}.
Nilai Pengembalian
OT_ERROR_NONE
Jika berhasil.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSetReceiveDone

otError otLinkRawSetReceiveDone(
  otInstance *aInstance,
  otLinkRawReceiveDone aCallback
)

Mengaktifkan/menonaktifkan lapisan link raw.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Penunjuk ke fungsi yang dipanggil saat menerima {i>frame<i} IEEE 802.15.4. NULL untuk menonaktifkan lapisan raw-link.
Nilai Pengembalian
OT_ERROR_FAILED
Radio tidak dapat diaktifkan/dinonaktifkan.
OT_ERROR_INVALID_STATE
Jika antarmuka IPv6 OpenThread sudah diaktifkan.
OT_ERROR_NONE
Jika status pengaktifan berhasil ditetapkan.

otLinkRawSetShortAddress

otError otLinkRawSetShortAddress(
  otInstance *aInstance,
  uint16_t aShortAddress
)

Setel Alamat Singkat untuk pemfilteran alamat.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aShortAddress
Alamat Singkat IEEE 802.15.4.
Nilai Pengembalian
OT_ERROR_NONE
Jika berhasil.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSleep

otError otLinkRawSleep(
  otInstance *aInstance
)

Mengalihkan radio dari Terima ke Tidur.

Matikan radio.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil dialihkan ke Tidur.
OT_ERROR_BUSY
Radio sedang ditransmisikan
OT_ERROR_INVALID_STATE
Radio dinonaktifkan

otLinkRawSrcMatchAddExtEntry

otError otLinkRawSrcMatchAddExtEntry(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Menambahkan alamat yang diperluas ke tabel pencocokan sumber.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aExtAddress
Alamat lengkap yang akan ditambahkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menambahkan alamat yang diperluas ke tabel pencocokan sumber.
OT_ERROR_NO_BUFS
Tidak ada entri yang tersedia di tabel pencocokan sumber.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSrcMatchAddShortEntry

otError otLinkRawSrcMatchAddShortEntry(
  otInstance *aInstance,
  uint16_t aShortAddress
)

Menambahkan alamat pendek ke tabel pencocokan sumber.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aShortAddress
Alamat singkat yang akan ditambahkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menambahkan alamat singkat ke tabel pencocokan sumber.
OT_ERROR_NO_BUFS
Tidak ada entri yang tersedia di tabel pencocokan sumber.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSrcMatchClearExtEntries

otError otLinkRawSrcMatchClearExtEntries(
  otInstance *aInstance
)

Menghapus semua alamat yang diperluas dari tabel pencocokan sumber.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_ERROR_NONE
Jika berhasil.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSrcMatchClearExtEntry

otError otLinkRawSrcMatchClearExtEntry(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Menghapus alamat yang diperluas ke tabel pencocokan sumber radio.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aExtAddress
Alamat lengkap yang akan dihapus.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menghapus alamat yang diperluas dari tabel pencocokan sumber.
OT_ERROR_NO_ADDRESS
Alamat yang diperluas tidak ada dalam tabel pencocokan sumber.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSrcMatchClearShortEntries

otError otLinkRawSrcMatchClearShortEntries(
  otInstance *aInstance
)

Menghapus semua alamat singkat dari tabel pencocokan sumber.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_ERROR_NONE
Jika berhasil.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSrcMatchClearShortEntry

otError otLinkRawSrcMatchClearShortEntry(
  otInstance *aInstance,
  uint16_t aShortAddress
)

Menghapus alamat singkat ke tabel pencocokan sumber.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aShortAddress
Alamat singkat yang akan dihapus.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menghapus alamat singkat dari tabel pencocokan sumber.
OT_ERROR_NO_ADDRESS
Alamat singkat tidak ada dalam tabel pencocokan sumber.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawSrcMatchEnable

otError otLinkRawSrcMatchEnable(
  otInstance *aInstance,
  bool aEnable
)

Aktifkan/Nonaktifkan pencocokan sumber untuk frame tertunda.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnable
Mengaktifkan/menonaktifkan pencocokan sumber untuk frame tertunda.
Nilai Pengembalian
OT_ERROR_NONE
Jika berhasil.
OT_ERROR_INVALID_STATE
Jika lapisan link mentah tidak diaktifkan.

otLinkRawTransmit

otError otLinkRawTransmit(
  otInstance *aInstance,
  otLinkRawTransmitDone aCallback
)

Memulai urutan transmisi di radio.

Pemanggil harus membentuk frame IEEE 802.15.4 di buffer yang disediakan oleh otLinkRawGetTransmitBuffer() sebelum meminta transmisi. Saluran dan daya pancar juga disertakan dalam struktur otRadioFrame.

Urutan transmisi terdiri dari:

  1. Mengalihkan radio ke Transmit dari Accept.
  2. Mengirimkan PSDU pada saluran yang diberikan dan pada daya pancar yang diberikan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke fungsi yang dipanggil setelah transmisi selesai.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil bertransisi ke Transmit.
OT_ERROR_INVALID_STATE
Radio tidak dalam status Terima.

Referensi

Topik Referensi OpenThread API berasal dari kode sumber yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk berkontribusi pada dokumentasi kami, lihat Referensi.