Tập dữ liệu hoạt động

Bao gồm các hàm cho API Tập dữ liệu hoạt động.

Tóm tắt

Chỉ đối với các bản dựng FTD, Trình cập nhật tập dữ liệu sẽ cung cấp các hàm để quản lý việc cập nhật tập dữ liệu.

Đối với các bản dựng FTD và MTD, API Tập dữ liệu hoạt động bao gồm các chức năng để quản lý các tập dữ liệu Đang hoạt động và Đang chờ xử lý cũng như các TLV tập dữ liệu.

Bảng liệt kê

otMeshcopTlvType{
  OT_MESHCOP_TLV_CHANNEL = 0,
  OT_MESHCOP_TLV_PANID = 1,
  OT_MESHCOP_TLV_EXTPANID = 2,
  OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4,
  OT_MESHCOP_TLV_NETWORKKEY = 5,
  OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
  OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8,
  OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
  OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
  OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12,
  OT_MESHCOP_TLV_GET = 13,
  OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
  OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
  OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17,
  OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
  OT_MESHCOP_TLV_JOINER_IID = 19,
  OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
  OT_MESHCOP_TLV_PROVISIONING_URL = 32,
  OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
  OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
  OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
  OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
  OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
  OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
  OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52,
  OT_MESHCOP_TLV_CHANNELMASK = 53,
  OT_MESHCOP_TLV_COUNT = 54,
  OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56,
  OT_MESHCOP_TLV_ENERGY_LIST = 57,
  OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
  OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
  OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
}
enum
Đại diện cho các loại TLV của gridcop.

Typedef

otChannelMask typedef
uint32_t
Đại diện cho Mặt nạ kênh.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Con trỏ được gọi khi nhận được phản hồi cho một yêu cầu MGMT_set hoặc hết thời gian chờ.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
Con trỏ hàm gọi lại này được gọi khi một yêu cầu cập nhật Tập dữ liệu kết thúc, báo cáo trạng thái thành công hay không thành công của yêu cầu cập nhật Tập dữ liệu.
otExtendedPanId typedef
Đại diện cho mã PAN mở rộng.
otMeshLocalPrefix typedef
Đại diện cho một Tiền tố cục bộ dạng lưới.
otMeshcopTlvType typedef
Đại diện cho các loại TLV của gridcop.
otNetworkKey typedef
struct otNetworkKey
Đại diện cho khoá mạng dạng chuỗi.
otNetworkKeyRef typedef
Loại dữ liệu này biểu thị KeyRef cho NetworkKey.
otNetworkName typedef
struct otNetworkName
Đại diện cho tên mạng.
otOperationalDataset typedef
Đại diện cho Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.
otOperationalDatasetComponents typedef
Thể hiện sự hiện diện của nhiều thành phần trong Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.
otOperationalDatasetTlvs typedef
Đại diện cho Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.
otPskc typedef
struct otPskc
Đại diện cho PSKc.
otPskcRef typedef
Loại dữ liệu này biểu thị KeyRef cho PSKc.
otSecurityPolicy typedef
Trình bày chính sách bảo mật.
otTimestamp typedef
struct otTimestamp
Đại diện cho thành phần dấu thời gian của Tập dữ liệu luồng.

Biến

OT_TOOL_PACKED_END

Hàm

otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Chuyển đổi một Tập dữ liệu hoạt động cho trước thành otOperationalDatasetTlvs.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Chỉ đối với FTD, hãy tạo một Tập dữ liệu hoạt động mới để sử dụng khi tạo mạng mới.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Tạo PSKc từ một cụm mật khẩu, tên mạng và mã PAN mở rộng nhất định.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Lấy Tập dữ liệu hoạt động đang hoạt động.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Lấy Tập dữ liệu hoạt động đang hoạt động.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Chỉ đối với FTD, sẽ có bộ tính giờ trì hoãn tối thiểu.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Lấy tập dữ liệu về hoạt động đang chờ xử lý.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Lấy tập dữ liệu về hoạt động đang chờ xử lý.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Cho biết liệu mạng hợp lệ có hiện diện trong Tập dữ liệu hoạt động đang hoạt động hay không.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Phân tích cú pháp Tập dữ liệu hoạt động từ một otOperationalDatasetTlvs nhất định.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Gửi MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Gửi MGMT_ACTIVE_Set.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Gửi MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Gửi MGMT_PENDING_Set.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Thiết lập Tập dữ liệu hoạt động đang hoạt động.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Thiết lập Tập dữ liệu hoạt động đang hoạt động.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Chỉ đặt một bộ hẹn giờ trễ tối thiểu (chỉ đối với FTD).
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Thiết lập Tập dữ liệu hoạt động đang chờ xử lý.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Thiết lập Tập dữ liệu hoạt động đang chờ xử lý.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Cập nhật một Tập dữ liệu hoạt động nhất định.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Huỷ một yêu cầu cập nhật Tập dữ liệu hoạt động đang diễn ra (nếu có).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Cho biết liệu có yêu cầu cập nhật Tập dữ liệu hoạt động nào đang diễn ra hay không.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Yêu cầu cập nhật Tập dữ liệu hoạt động.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Đặt một thực thể otNetworkName từ một chuỗi C có điểm cuối rỗng đã cho.

Cấu trúc

otExtendedPanId

Đại diện cho mã PAN mở rộng.

otNetworkKey

Đại diện cho khoá mạng dạng chuỗi.

otNetworkName

Đại diện cho tên mạng.

otOperationalDataset

Đại diện cho Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.

otOperationalDatasetComponents

Thể hiện sự hiện diện của nhiều thành phần trong Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.

otOperationalDatasetTlvs

Đại diện cho Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.

otPskc

Đại diện cho PSKc.

otSecurityPolicy

Trình bày chính sách bảo mật.

otTimestamp

Đại diện cho thành phần dấu thời gian của Tập dữ liệu luồng.

Bảng liệt kê

otMeshcopTlvType

 otMeshcopTlvType

Đại diện cho các loại TLV của gridcop.

Thuộc tính
OT_MESHCOP_TLV_ACTIVETIMESTAMP

TLV dấu thời gian hoạt động của gridcop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Bộ định vị tác nhân biên giới TLV

OT_MESHCOP_TLV_CHANNEL

TLV kênh gridcop

OT_MESHCOP_TLV_CHANNELMASK

TLV Mặt nạ kênh gridcop

OT_MESHCOP_TLV_COMMISSIONER_ID

Mã TLV của networkcop

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

TLV Cổng UDP của gridcop

OT_MESHCOP_TLV_COMM_SESSION_ID

Mã phiên uỷ viên networkcop TLV

OT_MESHCOP_TLV_COUNT

TLV Số lượng gridcop

OT_MESHCOP_TLV_DELAYTIMER

TLV về thời gian trễ của networkcop

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV của yêu cầu khám phá networkcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV của Phản hồi khám phá networkcop

OT_MESHCOP_TLV_ENERGY_LIST

Bản tóm tắt về Danh sách năng lượng của gridcop

OT_MESHCOP_TLV_EXTPANID

TLV Mã kéo dài của gridcop

OT_MESHCOP_TLV_GET

gridcop Lấy TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV địa chỉ IPv6 của gridcop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV về quảng cáo tham gia networkcop

OT_MESHCOP_TLV_JOINER_DTLS

TLV đóng gói DTLS cho lướicop

OT_MESHCOP_TLV_JOINER_IID

TLV Joiner IID của gridcop

OT_MESHCOP_TLV_JOINER_RLOC

Bộ định vị bộ định tuyến networkcop TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Bộ định tuyến ghép nối networkcop KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

TLV Cổng UDP của gridcop

OT_MESHCOP_TLV_MESHLOCALPREFIX

TLV Tiền tố cục bộ lưới của networkcop

OT_MESHCOP_TLV_NETWORKKEY

TLV Khoá mạng networkcop

OT_MESHCOP_TLV_NETWORKNAME

TLV Tên mạng gridcop

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV trình tự khoá mạng networkcop

OT_MESHCOP_TLV_PANID

Mã TLV của gridcop

OT_MESHCOP_TLV_PENDINGTIMESTAMP

TLV dấu thời gian đang chờ xử lý của gridcop

OT_MESHCOP_TLV_PERIOD

TLV Khoảng thời gian gridcop

OT_MESHCOP_TLV_PROVISIONING_URL

TLV URL cấp phép gridcop

OT_MESHCOP_TLV_PSKC

networkcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

TLV Thời lượng quét gridcop

OT_MESHCOP_TLV_SECURITYPOLICY

Tóm tắt chính sách bảo mật của networkcop

OT_MESHCOP_TLV_STATE

TLV của trạng thái networkcop

OT_MESHCOP_TLV_STEERING_DATA

TLV Dữ liệu chỉ đạo của gridcop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV đóng gói UDP của lướicop

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Bản tóm tắt về dữ liệu của nhà cung cấp networkcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Mô hình nhà cung cấp networkcop

OT_MESHCOP_TLV_VENDOR_NAME_TLV

TLV Tên nhà cung cấp gridcop

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

TLV Phiên bản ngăn xếp của nhà cung cấp networkcop

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

TLV của nhà cung cấp gridcop phiên bản SW

Typedef

otChannelMask

uint32_t otChannelMask

Đại diện cho Mặt nạ kênh.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

Con trỏ được gọi khi nhận được phản hồi cho một yêu cầu MGMT_set hoặc hết thời gian chờ.

Thông tin chi tiết
Các tham số
[in] aResult
Kết quả của hoạt động.
[in] aContext
Con trỏ đến ngữ cảnh dành riêng cho ứng dụng.
Giá trị trả về
OT_ERROR_NONE
Yêu cầu đã được lãnh đạo chấp nhận.
OT_ERROR_REJECTED
Người lãnh đạo đã từ chối yêu cầu.
OT_ERROR_PARSE
Đã xảy ra lỗi trong khi phân tích cú pháp phản hồi.
OT_ERROR_ABORT
Yêu cầu đã được ứng dụng ngang hàng đặt lại.
OT_ERROR_RESPONSE_TIMEOUT
Không nhận được phản hồi hoặc xác nhận trong khoảng thời gian chờ.

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

Con trỏ hàm gọi lại này được gọi khi một yêu cầu cập nhật Tập dữ liệu kết thúc, báo cáo trạng thái thành công hay không thành công của yêu cầu cập nhật Tập dữ liệu.

Có sẵn khi bạn bật OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Thông tin chi tiết
Các tham số
[in] aError
Trạng thái lỗi. OT_ERROR_NONE cho biết đã cập nhật Tập dữ liệu thành công. OT_ERROR_INVALID_STATE cho biết lỗi do trạng thái không hợp lệ (MLE đang bị tắt). OT_ERROR_ALREADY cho biết lỗi do một thiết bị khác trong mạng yêu cầu cập nhật Tập dữ liệu xung đột.
[in] aContext
Con trỏ đến ngữ cảnh tuỳ ý (do người dùng cung cấp trong otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Đại diện cho mã PAN mở rộng.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Đại diện cho một Tiền tố cục bộ dạng lưới.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Đại diện cho các loại TLV của gridcop.

otNetworkKey

struct otNetworkKey otNetworkKey

Đại diện cho khoá mạng dạng chuỗi.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Loại dữ liệu này biểu thị KeyRef cho NetworkKey.

Tham chiếu đến khoá

otNetworkName

struct otNetworkName otNetworkName

Đại diện cho tên mạng.

otNetworkName là một chuỗi C có điểm kết thúc rỗng (tức là Mảng ký tự m8 PHẢI kết thúc bằng ký tự rỗng \0).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Đại diện cho Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.

Các thành phần trong Tập dữ liệu là không bắt buộc. Cấu trúc mComponents chỉ định thành phần nào sẽ có trong Tập dữ liệu.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Thể hiện sự hiện diện của nhiều thành phần trong Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Đại diện cho Tập dữ liệu hoạt động đang hoạt động hoặc đang chờ xử lý.

Tập dữ liệu hoạt động được TLV mã hoá theo chỉ định của Thread.

otPskc

struct otPskc otPskc

Đại diện cho PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Loại dữ liệu này biểu thị KeyRef cho PSKc.

Tham chiếu đến khoá

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Trình bày chính sách bảo mật.

otTimestamp

struct otTimestamp otTimestamp

Đại diện cho thành phần dấu thời gian của Tập dữ liệu luồng.

Biến

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Hàm

otDatasetConvertToTlvs

otError otDatasetConvertToTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

Chuyển đổi một Tập dữ liệu hoạt động cho trước thành otOperationalDatasetTlvs.

Thông tin chi tiết
Thông số
[in] aDataset
Một tập dữ liệu hoạt động cần chuyển đổi sang TLV.
[out] aDatasetTlvs
Một con trỏ đến các TLV của tập dữ liệu để trả về kết quả.
Giá trị trả về
OT_ERROR_NONE
Đã chuyển đổi thành công aDataset và cập nhật aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDataset không hợp lệ, không chứa dấu thời gian đang hoạt động hoặc đang chờ xử lý.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Chỉ đối với FTD, hãy tạo một Tập dữ liệu hoạt động mới để sử dụng khi tạo mạng mới.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[out] aDataset
Tập dữ liệu hoạt động.
Giá trị trả về
OT_ERROR_NONE
Đã tạo thành công Tập dữ liệu hoạt động mới.
OT_ERROR_FAILED
Không thể tạo giá trị ngẫu nhiên cho các thông số mới.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

Tạo PSKc từ một cụm mật khẩu, tên mạng và mã PAN mở rộng nhất định.

PSKc được dùng để thiết lập Phiên họp Uỷ viên.

Thông tin chi tiết
Thông số
[in] aPassPhrase
Cụm mật khẩu phí hoa hồng.
[in] aNetworkName
Tên mạng để tính toán PSKc.
[in] aExtPanId
Mã PAN mở rộng để tính toán PSKc.
[out] aPskc
Con trỏ đến biến để xuất PSKc được tạo.
Giá trị trả về
OT_ERROR_NONE
Tạo thành công PSKc.
OT_ERROR_INVALID_ARGS
Nếu có bất kỳ đối số đầu vào nào không hợp lệ.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Lấy Tập dữ liệu hoạt động đang hoạt động.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[out] aDataset
Con trỏ đến vị trí sẽ đặt Tập dữ liệu hoạt động đang hoạt động.
Giá trị trả về
OT_ERROR_NONE
Đã truy xuất thành công Tập dữ liệu hoạt động đang hoạt động.
OT_ERROR_NOT_FOUND
Không có giá trị tương ứng trong kho cài đặt.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Lấy Tập dữ liệu hoạt động đang hoạt động.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[out] aDataset
Con trỏ đến vị trí sẽ đặt Tập dữ liệu hoạt động đang hoạt động.
Giá trị trả về
OT_ERROR_NONE
Đã truy xuất thành công Tập dữ liệu hoạt động đang hoạt động.
OT_ERROR_NOT_FOUND
Không có giá trị tương ứng trong kho cài đặt.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Chỉ đối với FTD, sẽ có bộ tính giờ trì hoãn tối thiểu.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
Giá trị trả về
the
giá trị của bộ tính giờ trì hoãn tối thiểu (tính bằng mili giây).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Lấy tập dữ liệu về hoạt động đang chờ xử lý.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[out] aDataset
Con trỏ đến vị trí sẽ đặt Tập dữ liệu hoạt động đang chờ xử lý.
Giá trị trả về
OT_ERROR_NONE
Đã truy xuất thành công Tập dữ liệu hoạt động đang chờ xử lý.
OT_ERROR_NOT_FOUND
Không có giá trị tương ứng trong kho cài đặt.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Lấy tập dữ liệu về hoạt động đang chờ xử lý.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[out] aDataset
Con trỏ đến vị trí sẽ đặt Tập dữ liệu hoạt động đang chờ xử lý.
Giá trị trả về
OT_ERROR_NONE
Đã truy xuất thành công Tập dữ liệu hoạt động đang chờ xử lý.
OT_ERROR_NOT_FOUND
Không có giá trị tương ứng trong kho cài đặt.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Cho biết liệu mạng hợp lệ có hiện diện trong Tập dữ liệu hoạt động đang hoạt động hay không.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
Trả về
TRUE nếu mạng hợp lệ có trong Tập dữ liệu hoạt động đang hoạt động, nếu không sẽ là FALSE.

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

Phân tích cú pháp Tập dữ liệu hoạt động từ một otOperationalDatasetTlvs nhất định.

Thông tin chi tiết
Thông số
[in] aDatasetTlvs
Con trỏ đến các TLV của tập dữ liệu.
[out] aDataset
Con trỏ đến vị trí đặt tập dữ liệu.
Giá trị trả về
OT_ERROR_NONE
Đã đặt thành công aDataset từ aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDatasetTlvs không hợp lệ.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Gửi MGMT_ACTIVE_GET.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDatasetComponents
Con trỏ đến cấu trúc Thành phần tập dữ liệu chỉ định thành phần nào cần yêu cầu.
[in] aTlvTypes
Con trỏ đến mảng chứa các loại TLV thô bổ sung được yêu cầu.
[in] aLength
Độ dài của aTlvTypes.
[in] aAddress
Con trỏ tới đích IPv6, nếu giá trị là NULL, sẽ sử dụng Leader ALOC làm mặc định.
Giá trị trả về
OT_ERROR_NONE
Gửi thành công lệnh tập dữ liệu networkcop.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ nhớ đệm để gửi.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Gửi MGMT_ACTIVE_Set.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDataset
Con trỏ đến tập dữ liệu hoạt động.
[in] aTlvs
Con trỏ đến các TLV.
[in] aLength
Độ dài của TLV.
[in] aCallback
Con trỏ đến một hàm được gọi khi tiếp nhận phản hồi hoặc hết thời gian chờ.
[in] aContext
Con trỏ đến ngữ cảnh dành riêng cho ứng dụng cho aCallback.
Giá trị trả về
OT_ERROR_NONE
Gửi thành công lệnh tập dữ liệu networkcop.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ nhớ đệm để gửi.
OT_ERROR_BUSY
Có một yêu cầu trước đó đang được xử lý.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Gửi MGMT_PENDING_GET.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDatasetComponents
Con trỏ đến cấu trúc Thành phần tập dữ liệu chỉ định thành phần nào cần yêu cầu.
[in] aTlvTypes
Con trỏ đến mảng chứa các loại TLV thô bổ sung được yêu cầu.
[in] aLength
Độ dài của aTlvTypes.
[in] aAddress
Con trỏ tới đích IPv6, nếu giá trị là NULL, sẽ sử dụng Leader ALOC làm mặc định.
Giá trị trả về
OT_ERROR_NONE
Gửi thành công lệnh tập dữ liệu networkcop.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ nhớ đệm để gửi.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Gửi MGMT_PENDING_Set.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDataset
Con trỏ đến tập dữ liệu hoạt động.
[in] aTlvs
Con trỏ đến các TLV.
[in] aLength
Độ dài của TLV.
[in] aCallback
Con trỏ đến một hàm được gọi khi tiếp nhận phản hồi hoặc hết thời gian chờ.
[in] aContext
Con trỏ đến ngữ cảnh dành riêng cho ứng dụng cho aCallback.
Giá trị trả về
OT_ERROR_NONE
Gửi thành công lệnh tập dữ liệu networkcop.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ nhớ đệm để gửi.
OT_ERROR_BUSY
Có một yêu cầu trước đó đang được xử lý.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Thiết lập Tập dữ liệu hoạt động đang hoạt động.

Nếu tập dữ liệu không bao gồm Dấu thời gian hoạt động, thì tập dữ liệu này chỉ hoàn thành một phần.

Nếu Thread được bật trên một thiết bị có Tập dữ liệu đang hoạt động hoàn chỉnh một phần, thiết bị này sẽ tìm cách đính kèm vào một mạng Thread hiện có bằng cách sử dụng mọi thông tin hiện có trong tập dữ liệu. Bạn chỉ cần có Khoá mạng dạng chuỗi để kết nối với một mạng.

Nếu kênh không có trong tập dữ liệu, thì thiết bị sẽ gửi thông báo MLE thông báo qua các kênh để tìm những kênh lân cận trên các kênh khác.

Nếu thiết bị đã kết nối thành công vào mạng Thread, thì thiết bị sẽ truy xuất toàn bộ tập dữ liệu hoạt động từ mạng mẹ. Lưu ý rằng một thiết bị có khả năng định tuyến sẽ không chuyển sang vai trò Bộ định tuyến hoặc Trưởng nhóm cho đến khi có Tập dữ liệu hoạt động hoàn chỉnh.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDataset
Con trỏ đến Tập dữ liệu hoạt động đang hoạt động.
Giá trị trả về
OT_ERROR_NONE
Đã thiết lập thành công Tập dữ liệu hoạt động đang hoạt động.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ nhớ đệm để đặt Tập dữ liệu hoạt động đang hoạt động.
OT_ERROR_NOT_IMPLEMENTED
Nền tảng này không triển khai chức năng cài đặt.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Thiết lập Tập dữ liệu hoạt động đang hoạt động.

Nếu tập dữ liệu không bao gồm Dấu thời gian hoạt động, thì tập dữ liệu này chỉ hoàn thành một phần.

Nếu Thread được bật trên một thiết bị có Tập dữ liệu đang hoạt động hoàn chỉnh một phần, thiết bị này sẽ tìm cách đính kèm vào một mạng Thread hiện có bằng cách sử dụng mọi thông tin hiện có trong tập dữ liệu. Bạn chỉ cần có Khoá mạng dạng chuỗi để kết nối với một mạng.

Nếu kênh không có trong tập dữ liệu, thì thiết bị sẽ gửi thông báo MLE thông báo qua các kênh để tìm những kênh lân cận trên các kênh khác.

Nếu thiết bị đã kết nối thành công vào mạng Thread, thì thiết bị sẽ truy xuất toàn bộ tập dữ liệu hoạt động từ mạng mẹ. Lưu ý rằng một thiết bị có khả năng định tuyến sẽ không chuyển sang vai trò Bộ định tuyến hoặc Trưởng nhóm cho đến khi có Tập dữ liệu hoạt động hoàn chỉnh.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDataset
Con trỏ đến Tập dữ liệu hoạt động đang hoạt động.
Giá trị trả về
OT_ERROR_NONE
Đã thiết lập thành công Tập dữ liệu hoạt động đang hoạt động.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ nhớ đệm để đặt Tập dữ liệu hoạt động đang hoạt động.
OT_ERROR_NOT_IMPLEMENTED
Nền tảng này không triển khai chức năng cài đặt.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Chỉ đặt một bộ hẹn giờ trễ tối thiểu (chỉ đối với FTD).

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDelayTimerMinimal
Giá trị của bộ tính giờ trì hoãn tối thiểu (tính bằng mili giây).
Giá trị trả về
OT_ERROR_NONE
Đã đặt thành công bộ tính giờ trì hoãn tối thiểu.
OT_ERROR_INVALID_ARGS
Nếu aDelayTimerMinimal không hợp lệ.

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Thiết lập Tập dữ liệu hoạt động đang chờ xử lý.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDataset
Con trỏ đến Tập dữ liệu hoạt động đang chờ xử lý.
Giá trị trả về
OT_ERROR_NONE
Đã thiết lập thành công Tập dữ liệu hoạt động đang chờ xử lý.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ nhớ đệm để đặt Tập dữ liệu hoạt động đang chờ xử lý.
OT_ERROR_NOT_IMPLEMENTED
Nền tảng này không triển khai chức năng cài đặt.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Thiết lập Tập dữ liệu hoạt động đang chờ xử lý.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDataset
Con trỏ đến Tập dữ liệu hoạt động đang chờ xử lý.
Giá trị trả về
OT_ERROR_NONE
Đã thiết lập thành công Tập dữ liệu hoạt động đang chờ xử lý.
OT_ERROR_NO_BUFS
Không đủ dung lượng bộ nhớ đệm để đặt Tập dữ liệu hoạt động đang chờ xử lý.
OT_ERROR_NOT_IMPLEMENTED
Nền tảng này không triển khai chức năng cài đặt.

otDatasetUpdateTlvs

otError otDatasetUpdateTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

Cập nhật một Tập dữ liệu hoạt động nhất định.

aDataset chứa các trường cần cập nhật và giá trị mới của các trường đó.

Thông tin chi tiết
Thông số
[in] aDataset
Chỉ định tập hợp các loại và giá trị cần cập nhật.
[in,out] aDatasetTlvs
Một con trỏ đến các TLV của tập dữ liệu để cập nhật.
Giá trị trả về
OT_ERROR_NONE
Đã cập nhật thành công aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDataset chứa giá trị không hợp lệ.
OT_ERROR_NO_BUFS
Không đủ dung lượng trong aDatasetTlvs để áp dụng bản cập nhật.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Huỷ một yêu cầu cập nhật Tập dữ liệu hoạt động đang diễn ra (nếu có).

Có sẵn khi bạn bật OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Cho biết liệu có yêu cầu cập nhật Tập dữ liệu hoạt động nào đang diễn ra hay không.

Có sẵn khi bạn bật OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Thông tin chi tiết
Thông số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
Giá trị trả về
TRUE
Có một bản cập nhật đang diễn ra.
FALSE
Hiện không có bản cập nhật nào.

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

Yêu cầu cập nhật Tập dữ liệu hoạt động.

Có sẵn khi bạn bật OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

aDataset phải chứa các trường cần cập nhật và giá trị mới của các trường đó. Không được chứa trường Dấu thời gian đang hoạt động hoặc Đang chờ xử lý. Trường Độ trễ là không bắt buộc. Nếu không cung cấp, hệ thống sẽ sử dụng giá trị mặc định (1000 mili giây).

Thông tin chi tiết
Các tham số
[in] aInstance
Con trỏ đến một thực thể OpenThread.
[in] aDataset
Con trỏ đến Tập dữ liệu chứa các trường cần thay đổi.
[in] aCallback
Lệnh gọi lại để cho biết thời điểm kết thúc yêu cầu cập nhật Tập dữ liệu.
[in] aContext
Ngữ cảnh tuỳ ý được truyền đến lệnh gọi lại.
Giá trị trả về
OT_ERROR_NONE
Đã bắt đầu cập nhật tập dữ liệu thành công (aCallback sẽ được gọi khi hoàn tất).
OT_ERROR_INVALID_STATE
Thiết bị đã tắt (MLE bị tắt).
OT_ERROR_INVALID_ARGS
aDataset không hợp lệ (chứa dấu thời gian đang hoạt động hoặc đang chờ xử lý).
OT_ERROR_BUSY
Không thể bắt đầu cập nhật, quá trình cập nhật trước đó đang diễn ra.
OT_ERROR_NO_BUFS
Không thể phân bổ vùng đệm để lưu Tập dữ liệu.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Đặt một thực thể otNetworkName từ một chuỗi C có điểm cuối rỗng đã cho.

aNameString phải tuân theo bộ mã hoá UTF-8 và độ dài Tên mạng không được dài hơn OT_NETWORK_NAME_MAX_SIZE.

Thông tin chi tiết
Các tham số
[out] aNetworkName
Một con trỏ đến otNetworkName cần đặt.
[in] aNameString
Chuỗi tên C.
Giá trị trả về
OT_ERROR_NONE
Đã đặt thành công aNetworkName từ aNameString.
OT_ERROR_INVALID_ARGS
aNameStrng không hợp lệ (quá dài hoặc không tuân theo bộ mã hoá UTF-8).

Macro

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Kênh 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Kênh 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Kênh 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Kênh 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Kênh 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Kênh 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Kênh 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Kênh 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Kênh 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Kênh 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Kênh 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Kênh 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Kênh 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Kênh 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Kênh 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Kênh 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Kênh 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Kênh 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Kênh 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Kênh 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Kênh 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Kênh 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Kênh 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Kênh 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Kênh 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Kênh 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Kích thước của mã PAN của luồng (byte)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Kích thước của Tiền tố cục bộ dạng lưới (byte)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Kích thước của Khoá mạng luồng (byte)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Kích thước tối đa của trường Tên mạng luồng (byte)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Độ dài tối đa của Tập dữ liệu hoạt động tính bằng byte.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Kích thước tối đa của PSKc (byte)

Tài nguyên

Các chủ đề tham khảo API OpenThread bắt nguồn từ mã nguồn, có trên GitHub. Để biết thêm thông tin hoặc để đóng góp cho tài liệu của chúng tôi, hãy tham khảo Tài nguyên.