Trang này được dịch bởi Cloud Translation API.

Thực thể

Mô-đun này bao gồm các hàm kiểm soát thực thể OpenThread.

Tóm tắt

Bảng liệt kê
anonymous enum{ OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_NETWORK_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27, OT_CHANGED_ACTIVE_DATASET = 1 << 28, OT_CHANGED_PENDING_DATASET = 1 << 29 }	enum Bảng liệt kê này xác định các cờ được truyền trong `otStateChangedCallback`.

Bảng liệt kê

anonymous enum{
  OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
  OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
  OT_CHANGED_THREAD_ROLE = 1 << 2,
  OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
  OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
  OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
  OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
  OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
  OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
  OT_CHANGED_THREAD_NETDATA = 1 << 9,
  OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
  OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
  OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
  OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
  OT_CHANGED_THREAD_CHANNEL = 1 << 14,
  OT_CHANGED_THREAD_PANID = 1 << 15,
  OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
  OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
  OT_CHANGED_NETWORK_KEY = 1 << 18,
  OT_CHANGED_PSKC = 1 << 19,
  OT_CHANGED_SECURITY_POLICY = 1 << 20,
  OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
  OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
  OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
  OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
  OT_CHANGED_JOINER_STATE = 1 << 27,
  OT_CHANGED_ACTIVE_DATASET = 1 << 28,
  OT_CHANGED_PENDING_DATASET = 1 << 29
}

enum

Bảng liệt kê này xác định các cờ được truyền trong otStateChangedCallback.

Typedef
`otChangedFlags`	typedef `uint32_t` Loại này biểu thị một trường bit cho biết trạng thái/cấu hình cụ thể đã thay đổi.
`otInstance`	typedef `struct otInstance` Cấu trúc này đại diện cho cấu trúc của phiên bản OpenThread.
`otStateChangedCallback)(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Con trỏ hàm này được gọi để thông báo về một số thay đổi về cấu hình hoặc trạng thái trong OpenThread.

Hàm
`otGetRadioVersionString(otInstance *aInstance)`	`const char *` Hàm này nhận chuỗi phiên bản radio OpenThread.
`otGetVersionString(void)`	`const char *` Hàm này nhận chuỗi phiên bản OpenThread.
`otInstanceErasePersistentInfo(otInstance *aInstance)`	`otError` Hàm này xoá tất cả thông tin cố định OpenThread (chế độ cài đặt mạng) được lưu trữ trên bộ nhớ không biến động.
`otInstanceFactoryReset(otInstance *aInstance)`	`void` Xoá mọi chế độ cài đặt lưu trữ trên bộ nhớ không biến động rồi kích hoạt quá trình đặt lại nền tảng.
`otInstanceFinalize(otInstance *aInstance)`	`void` Hàm này sẽ tắt thư viện OpenThread.
`otInstanceGetUptime(otInstance *aInstance)`	`uint64_t` Hàm này trả về thời gian hoạt động hiện tại của bản sao (tính bằng msec).
`otInstanceGetUptimeAsString(otInstance aInstance, char aBuffer, uint16_t aSize)`	`void` Hàm này trả về thời gian hoạt động hiện tại của thực thể dưới dạng chuỗi mà con người có thể đọc được.
`otInstanceInit(void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Hàm này khởi chạy thư viện OpenThread.
`otInstanceInitSingle(void)`	`otInstance *` Hàm này khởi tạo một thực thể tĩnh của thư viện OpenThread.
`otInstanceIsInitialized(otInstance *aInstance)`	`bool` Hàm này cho biết thực thể có hợp lệ/khởi tạo hay không.
`otInstanceReset(otInstance *aInstance)`	`void` Phương thức này kích hoạt quá trình đặt lại nền tảng.
`otInstanceResetRadioStack(otInstance *aInstance)`	`void` Phương thức này sẽ đặt lại các trạng thái nội bộ của ngăn xếp radio OpenThread.
`otRemoveStateChangeCallback(otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Hàm này xoá một lệnh gọi lại để cho biết thời điểm một số cấu hình hoặc trạng thái nhất định thay đổi trong OpenThread.
`otSetStateChangedCallback(otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Hàm này đăng ký một lệnh gọi lại để cho biết thời điểm một số cấu hình hoặc trạng thái nhất định thay đổi trong OpenThread.

Bảng liệt kê

enum ẩn danh

 anonymous enum

Bảng liệt kê này xác định các cờ được truyền trong otStateChangedCallback.

Thuộc tính
`OT_CHANGED_ACTIVE_DATASET`	Tập dữ liệu hoạt động đang hoạt động đã thay đổi.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Đã thay đổi Kênh quản lý kênh mới đang chờ xử lý.
`OT_CHANGED_COMMISSIONER_STATE`	Trạng thái Uỷ viên đã thay đổi.
`OT_CHANGED_IP6_ADDRESS_ADDED`	Thêm địa chỉ IPv6.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	Đã xóa địa chỉ IPv6.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Đã đăng ký địa chỉ phát đa hướng IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Đã hủy đăng ký địa chỉ phát đa hướng IPv6.
`OT_CHANGED_JOINER_STATE`	Trạng thái liên kết đã thay đổi.
`OT_CHANGED_NETWORK_KEY`	Khóa mạng đã thay đổi.
`OT_CHANGED_PENDING_DATASET`	Đã thay đổi tập dữ liệu hoạt động đang chờ xử lý.
`OT_CHANGED_PSKC`	ASSISTc đã thay đổi.
`OT_CHANGED_SECURITY_POLICY`	Đã thay đổi Chính sách bảo mật.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Đã thay đổi mặt nạ kênh được hỗ trợ.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Đã thay đổi cấu hình Bộ định tuyến xương sống cục bộ.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Trạng thái Bộ định tuyến xương sống đã thay đổi.
`OT_CHANGED_THREAD_CHANNEL`	Đã thay đổi kênh mạng chuỗi.
`OT_CHANGED_THREAD_CHILD_ADDED`	Thêm trẻ.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Đã xóa trẻ.
`OT_CHANGED_THREAD_EXT_PANID`	Đã thay đổi mã PAN mở rộng của mạng chuỗi.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Đã thay đổi Trình tự khóa chuỗi.
`OT_CHANGED_THREAD_LL_ADDR`	Địa chỉ đường liên kết tại địa phương đã thay đổi.
`OT_CHANGED_THREAD_ML_ADDR`	Địa chỉ cục bộ lưới đã thay đổi.
`OT_CHANGED_THREAD_NETDATA`	Đã thay đổi dữ liệu mạng chuỗi.
`OT_CHANGED_THREAD_NETIF_STATE`	Trạng thái giao diện mạng chuỗi đã thay đổi.
`OT_CHANGED_THREAD_NETWORK_NAME`	Đã thay đổi tên mạng chuỗi.
`OT_CHANGED_THREAD_PANID`	Đã thay đổi mã PAN của mạng chuỗi.
`OT_CHANGED_THREAD_PARTITION_ID`	Đã thay đổi mã phân vùng.
`OT_CHANGED_THREAD_RLOC_ADDED`	Thêm RVPAID đã được thêm.
`OT_CHANGED_THREAD_RLOC_REMOVED`	Đã xóa RGCP.
`OT_CHANGED_THREAD_ROLE`	Đã thay đổi vai trò (đã tắt, đã tách, con, bộ định tuyến, người lãnh đạo)

Typedef

otChangedflags

uint32_t otChangedFlags

Loại này biểu thị một trường bit cho biết trạng thái/cấu hình cụ thể đã thay đổi.

Xem định nghĩa OT_CHANGED_*.

Phiên bản

struct otInstance otInstance

Cấu trúc này đại diện cho cấu trúc của phiên bản OpenThread.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Con trỏ hàm này được gọi để thông báo về một số thay đổi về cấu hình hoặc trạng thái trong OpenThread.

Thông tin chi tiết

Các tham số

`[in] aFlags`	Một trường bit cho biết trạng thái cụ thể đã thay đổi. Xem định nghĩa `OT_CHANGED_*`.
`[in] aContext`	Con trỏ trỏ đến ngữ cảnh dành riêng cho ứng dụng.

Hàm

Chuỗi otGetRadioVersion

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Hàm này nhận chuỗi phiên bản radio OpenThread.

Thông tin chi tiết

Các tham số

[in] aInstance

Con trỏ trỏ đến một phiên bản OpenThread.

Trả về

Con trỏ trỏ đến phiên bản radio OpenThread.

Chuỗi otGetVersionString

const char * otGetVersionString(
  void
)

Hàm này nhận chuỗi phiên bản OpenThread.

Thông tin chi tiết
Trả về	Con trỏ trỏ đến phiên bản OpenThread.

otInstancedeleteIInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Hàm này xoá tất cả thông tin cố định OpenThread (chế độ cài đặt mạng) được lưu trữ trên bộ nhớ không biến động.

Chỉ xoá thành công nếu thiết bị ở trạng thái/vai trò disabled.

Thông tin chi tiết

Các tham số

[in] aInstance

Con trỏ trỏ đến một phiên bản OpenThread.

Giá trị trả về

`OT_ERROR_NONE`	Đã xóa thành công tất cả thông tin/trạng thái liên tục.
`OT_ERROR_INVALID_STATE`	Thiết bị không ở trạng thái/vai trò `disabled`.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Xoá mọi chế độ cài đặt lưu trữ trên bộ nhớ không biến động rồi kích hoạt quá trình đặt lại nền tảng.

Thông tin chi tiết

Các tham số

[in] aInstance

Con trỏ trỏ đến một phiên bản OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Hàm này sẽ tắt thư viện OpenThread.

Gọi hàm này khi OpenThread không còn được sử dụng.

Thông tin chi tiết

Các tham số

[in] aInstance

Con trỏ trỏ đến một phiên bản OpenThread.

Thời gian hoạt động của phiên bản otInstance

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Hàm này trả về thời gian hoạt động hiện tại của bản sao (tính bằng msec).

Hàm này yêu cầu bật OPENTHREAD_CONFIG_UPTIME_ENABLE.

Thời gian hoạt động được tính bằng số mili giây kể từ khi phiên bản OpenThread được khởi chạy.

Thông tin chi tiết

Các tham số

[in] aInstance

Con trỏ trỏ đến một phiên bản OpenThread.

Trả về

Thời gian hoạt động (số mili giây).

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

Hàm này trả về thời gian hoạt động hiện tại của thực thể dưới dạng chuỗi mà con người có thể đọc được.

Hàm này yêu cầu bật OPENTHREAD_CONFIG_UPTIME_ENABLE.

Chuỗi này tuân theo định dạng ":::" cho giờ, phút, giây và mili giây (nếu thời gian hoạt động ngắn hơn một ngày) hoặc "

d.::." (nếu lâu hơn một ngày).

Nếu chuỗi kết quả không vừa với aBuffer (trong các ký tự aSize), chuỗi sẽ bị cắt bớt nhưng chuỗi đầu ra luôn được kết thúc bằng giá trị rỗng.

Thông tin chi tiết

Các tham số

`[in] aInstance`	Con trỏ trỏ đến một phiên bản OpenThread.
`[out] aBuffer`	Con trỏ trỏ đến một mảng ký tự để xuất chuỗi.
`[in] aSize`	Kích thước của `aBuffer` (tính bằng byte). Bạn nên sử dụng `OT_UPTIME_STRING_SIZE`.

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Hàm này khởi chạy thư viện OpenThread.

Hàm này khởi chạy OpenThread và chuẩn bị cho các lệnh gọi API OpenThread tiếp theo. Hàm này phải được gọi trước mọi lệnh gọi khác đến OpenThread.

Hàm này có sẵn và chỉ dùng được khi bật tính năng hỗ trợ cho nhiều thực thể OpenThread.

Thông tin chi tiết

Các tham số

`[in] aInstanceBuffer`	Vùng đệm mà OpenThread sử dụng để phân bổ cấu trúc otInstance.
`[in,out] aInstanceBufferSize`	Khi nhập, kích thước của aInstanceBuffer. Kết quả đầu ra, nếu không đủ dung lượng cho otInstance, số byte cần thiết cho otInstance.

Trả về

Con trỏ trỏ đến phiên bản OpenThread mới.

Xem thêm:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Hàm này khởi tạo một thực thể tĩnh của thư viện OpenThread.

Hàm này khởi chạy OpenThread và chuẩn bị cho các lệnh gọi API OpenThread tiếp theo. Hàm này phải được gọi trước mọi lệnh gọi khác đến OpenThread.

Hàm này có sẵn và chỉ dùng được khi tính năng hỗ trợ nhiều phiên bản OpenThread bị tắt.

Thông tin chi tiết
Trả về	Con trỏ trỏ đến một phiên bản OpenThread duy nhất.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Hàm này cho biết thực thể có hợp lệ/khởi tạo hay không.

Phiên bản này được coi là hợp lệ nếu được thu thập và khởi chạy bằng cách sử dụng otInstanceInitSingle() (trong trường hợp một thực thể) hoặc otInstanceInit() (trong trường hợp nhiều thực thể). Lệnh gọi tiếp theo tới otInstanceFinalize() khiến thực thể được coi là chưa khởi tạo.

Thông tin chi tiết

Các tham số

[in] aInstance

Con trỏ trỏ đến một phiên bản OpenThread.

Trả về

TRUE nếu phiên bản đã cho hợp lệ/được khởi tạo, nếu không thì là FALSE.

Đặt lại phiên bản

void otInstanceReset(
  otInstance *aInstance
)

Phương thức này kích hoạt quá trình đặt lại nền tảng.

Quá trình đặt lại giúp đảm bảo rằng tất cả thông tin/trạng thái OpenThread (được lưu trữ trong bộ nhớ biến động) sẽ bị xoá. Lưu ý rằng otPlatformReset không xoá bất kỳ trạng thái/thông tin cố định nào được lưu trong bộ nhớ không biến động.

Thông tin chi tiết

Các tham số

[in] aInstance

Con trỏ trỏ đến một phiên bản OpenThread.

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Phương thức này sẽ đặt lại các trạng thái nội bộ của ngăn xếp radio OpenThread.

Các lệnh gọi lại và cấu hình đều được giữ nguyên.

API này chỉ có trong các bản dựng đài phát thanh (OPENTHREAD_RADIO = 1).

Thông tin chi tiết

Các tham số

[in] aInstance

Con trỏ trỏ đến một phiên bản OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Hàm này xoá một lệnh gọi lại để cho biết thời điểm một số cấu hình hoặc trạng thái nhất định thay đổi trong OpenThread.

Thông tin chi tiết

Các tham số

`[in] aInstance`	Con trỏ trỏ đến một phiên bản OpenThread.
`[in] aCallback`	Con trỏ trỏ đến một hàm được gọi với một số thay đổi về cấu hình hoặc trạng thái.
`[in] aContext`	Con trỏ trỏ đến ngữ cảnh dành riêng cho ứng dụng.

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Hàm này đăng ký một lệnh gọi lại để cho biết thời điểm một số cấu hình hoặc trạng thái nhất định thay đổi trong OpenThread.

Thông tin chi tiết

Các tham số

`[in] aInstance`	Con trỏ trỏ đến một phiên bản OpenThread.
`[in] aCallback`	Con trỏ trỏ đến một hàm được gọi với một số thay đổi về cấu hình hoặc trạng thái.
`[in] aContext`	Con trỏ trỏ đến ngữ cảnh dành riêng cho ứng dụng.

Giá trị trả về

`OT_ERROR_NONE`	Thêm hàm gọi lại (callback) vào danh sách các lệnh gọi lại.
`OT_ERROR_ALREADY`	Lệnh gọi lại đã được đăng ký.
`OT_ERROR_NO_BUFS`	Không thể thêm hàm gọi lại do các hạn chế về tài nguyên.

Macro

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Kích thước đề xuất thể hiện chuỗi thời gian hoạt động.

Tài nguyên

Các chủ đề Tham chiếu API OpenThread được tạo từ mã nguồn có sẵn 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.