Sơ thẩm

Mô-đun này bao gồm các chức năng kiểm soát Trường hợp OpenThread.

Tóm lược

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_MASTER_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 }	enum Bảng liệt kê này xác định các cờ được truyền như một phần của `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_MASTER_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 
 }

enum

Bảng liệt kê này xác định các cờ được truyền như một phần của otStateChangedCallback .

Typedefs
`otChangedFlags`	typedef `uint32_t` Loại này đại diện cho 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 thể hiện OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Con trỏ hàm này được gọi để thông báo một số thay đổi cấu hình hoặc trạng thái trong OpenThread.

Chức năng
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Hàm này lấy chuỗi phiên bản radio OpenThread.
`otGetVersionString (void)`	`const char *` Hàm này nhận được chuỗi phiên bản OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Hàm này xóa tất cả thông tin liên tục OpenThread (cài đặt mạng) được lưu trữ trên bộ nhớ không bay hơi.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Phương pháp này xóa tất cả các cài đặt được lưu trữ trên bộ nhớ không bay hơi và sau đó kích hoạt thiết lập lại nền tảng.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Hàm này vô hiệu hóa thư viện OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Hàm này khởi tạo thư viện OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Hàm này khởi tạo thể hiện đơn tĩnh của thư viện OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Hàm này cho biết liệu cá thể đó có hợp lệ / được khởi tạo hay không.
`otInstanceReset ( otInstance *aInstance)`	`void` Phương pháp này kích hoạt thiết lập lại nền tảng.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Hàm này loại bỏ một cuộc gọi lại để cho biết khi nào 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 cuộc gọi lại để cho biết khi nào 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 như một phần của otStateChangedCallback .

Tính chất
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Kênh quản lý mới đang chờ xử lý Kênh chủ đề đã thay đổi.
`OT_CHANGED_COMMISSIONER_STATE`	Ủy viên nhà nước thay đổi.
`OT_CHANGED_IP6_ADDRESS_ADDED`	Địa chỉ IPv6 đã được thêm vào.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	Địa chỉ IPv6 đã bị xóa.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Đăng ký một địa chỉ multicast IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Hủy đăng ký từ một địa chỉ multicast IPv6.
`OT_CHANGED_JOINER_STATE`	Nhà nước tham gia thay đổi.
`OT_CHANGED_MASTER_KEY`	Khóa chủ đã thay đổi.
`OT_CHANGED_PSKC`	PSKc đã thay đổi.
`OT_CHANGED_SECURITY_POLICY`	Chính sách bảo mật đã thay đổi.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Mặt nạ kênh được hỗ trợ thay đổi.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Cấu hình bộ định tuyến đường trục cục bộ đã thay đổi.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Trạng thái Bộ định tuyến đường trục thay đổi.
`OT_CHANGED_THREAD_CHANNEL`	Kênh mạng đã thay đổi.
`OT_CHANGED_THREAD_CHILD_ADDED`	Con đã được thêm vào.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Con đã được gỡ bỏ.
`OT_CHANGED_THREAD_EXT_PANID`	Chủ đề mở rộng mạng PAN ID đã thay đổi.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Trình tự khóa chủ đề đã thay đổi.
`OT_CHANGED_THREAD_LL_ADDR`	Địa chỉ liên kết cục bộ đã thay đổi.
`OT_CHANGED_THREAD_ML_ADDR`	Địa chỉ lưới địa phương đã thay đổi.
`OT_CHANGED_THREAD_NETDATA`	Dữ liệu mạng đã thay đổi.
`OT_CHANGED_THREAD_NETIF_STATE`	Trạng thái giao diện mạng đã thay đổi.
`OT_CHANGED_THREAD_NETWORK_NAME`	Tên mạng đã thay đổi.
`OT_CHANGED_THREAD_PANID`	Chủ đề mạng PAN Id đã thay đổi.
`OT_CHANGED_THREAD_PARTITION_ID`	ID phân vùng đã thay đổi.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC đã được thêm vào.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC đã được gỡ bỏ.
`OT_CHANGED_THREAD_ROLE`	Vai trò (bị vô hiệu hóa, tách rời, con, bộ định tuyến, lãnh đạo) thay đổi.

Typedefs

otChangedFlags

uint32_t otChangedFlags

Loại này đại diện cho 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_* .

tai nạn

struct otInstance otInstance

Cấu trúc này đại diện cho cấu trúc thể hiện OpenThread.

otStateChangedCallback

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

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

Chi tiết

Thông số

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

Chức năng

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Hàm này lấy chuỗi phiên bản radio OpenThread.

Chi tiết

Thông số

[in] aInstance

Một con trỏ tới một thể hiện OpenThread.

Trả về

Một con trỏ tới phiên bản radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

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

Chi tiết
Trả về	Một con trỏ tới phiên bản OpenThread.

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Hàm này xóa tất cả thông tin liên tục OpenThread (cài đặt mạng) được lưu trữ trên bộ nhớ không bay hơi.

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

Chi tiết

Thông số

[in] aInstance

Một con trỏ tới một thể hiện OpenThread.

Giá trị trả về

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

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Phương pháp này xóa tất cả các cài đặt được lưu trữ trên bộ nhớ không bay hơi và sau đó kích hoạt thiết lập lại nền tảng.

Chi tiết

Thông số

[in] aInstance

Một con trỏ tới một thể hiện OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Hàm này vô hiệu hóa thư viện OpenThread.

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

Chi tiết

Thông số

[in] aInstance

Một con trỏ tới một thể hiện OpenThread.

otInstanceInit

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

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

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

Chức năng này khả dụng và chỉ có thể được sử dụng khi hỗ trợ cho nhiều phiên bản OpenThread được bật.

Chi tiết

Thông số

`[in] aInstanceBuffer`	Bộ đệm cho OpenThread để sử dụng để phân bổ cấu trúc otInstance.
`[in,out] aInstanceBufferSize`	Về đầu vào, kích thước của aInstanceBuffer. Trên đầu ra, nếu không đủ không gian cho otInstance, số byte cần thiết cho otInstance.

Trả về

Một con trỏ tới thể hiện OpenThread mới.

Xem thêm:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

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

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

Chức năng này khả dụng và chỉ có thể được sử dụng khi hỗ trợ cho nhiều phiên bản OpenThread bị tắt.

Chi tiết
Trả về	Một con trỏ tới cá thể OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

Ví dụ được coi là hợp lệ nếu nó được mua và khởi tạo bằng cách sử dụng otInstanceInitSingle() (trong trường hợp đơn lẻ) hoặc otInstanceInit() (trong trường hợp đa trường hợp). Một cuộc gọi tiếp theo đến otInstanceFinalize() làm cho cá thể được coi là chưa được khởi tạo.

Chi tiết

Thông số

[in] aInstance

Một con trỏ tới một thể hiện OpenThread.

Trả về

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

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Phương pháp này kích hoạt thiết lập lại nền tảng.

Quá trình đặt lại đảm bảo rằng tất cả trạng thái / thông tin OpenThread (được lưu trữ trong bộ nhớ dễ bay hơi) sẽ bị xóa. Lưu ý rằng otPlatformReset không xóa bất kỳ trạng thái / thông tin liên tục nào được lưu trong bộ nhớ không bay hơi.

Chi tiết

Thông số

[in] aInstance

Một con trỏ tới một thể hiện OpenThread.

otRemoveStateChangeCallback

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

Hàm này loại bỏ một cuộc gọi lại để cho biết khi nào cấu hình hoặc trạng thái nhất định thay đổi trong OpenThread.

Chi tiết

Thông số

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

otInStateChangedCallback

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

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

Chi tiết

Thông số

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

Giá trị trả về

`OT_ERROR_NONE`	Đã thêm cuộc gọi lại vào danh sách các cuộc gọi lại.
`OT_ERROR_ALREADY`	Cuộc gọi lại đã được đăng ký.
`OT_ERROR_NO_BUFS`	Không thể thêm cuộc gọi lại do hạn chế tài nguyên.