Phiên bản

Mô-đun này bao gồm các chức năng điều khiển Phiên bản OpenThread.

Tóm lược

Bảng 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, OT_CHANGED_ACTIVE_DATASET = 1 << 28, OT_CHANGED_PENDING_DATASET = 1 << 29 }	enum Việc liệt kê này xác định các cờ được truyền như một phần của `otStateChangedCallback` .

Bảng 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,
 OT_CHANGED_ACTIVE_DATASET = 1 << 28,
 OT_CHANGED_PENDING_DATASET = 1 << 29
 }

enum

Việc 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` Kiểu 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 các thay đổi cấu hình hoặc trạng thái nhất định 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 lấy chuỗi phiên bản OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Chức năng này sẽ 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, sau đó kích hoạt thiết lập lại nền tảng.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Chức năng 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 phiên bản tĩnh đơn của thư viện OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Hàm này cho biết thể hiện 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 lệnh gọi lại để cho biết khi 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 cấu hình hoặc trạng thái nhất định thay đổi trong OpenThread.

Bảng kê

enum ẩn danh

 anonymous enum

Việc 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_ACTIVE_DATASET`	Đã thay đổi Tập dữ liệu Hoạt động.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Trình quản lý kênh Kênh chủ đề mới đang chờ xử lý đã thay đổi.
`OT_CHANGED_COMMISSIONER_STATE`	Bang ủy viên đã 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ý đị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 tham gia đã thay đổi.
`OT_CHANGED_MASTER_KEY`	Khóa chính đã thay đổi.
`OT_CHANGED_PENDING_DATASET`	Tập dữ liệu hoạt động đang chờ xử lý đã 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`	Đã thay đổi cấu hình Bộ định tuyến đường trục 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`	Kênh mạng chủ đề đã thay đổi.
`OT_CHANGED_THREAD_CHILD_ADDED`	Con đã được thêm vào.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Con đã bị xóa.
`OT_CHANGED_THREAD_EXT_PANID`	Đã thay đổi ID PAN mở rộng của mạng luồng.
`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-cục bộ đã thay đổi.
`OT_CHANGED_THREAD_NETDATA`	Dữ liệu Mạng Chủ đề đã thay đổi.
`OT_CHANGED_THREAD_NETIF_STATE`	Trạng thái giao diện mạng luồng đã thay đổi.
`OT_CHANGED_THREAD_NETWORK_NAME`	Tên mạng luồng đã thay đổi.
`OT_CHANGED_THREAD_PANID`	Id PAN của mạng chuỗi đã 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 đã bị xóa.
`OT_CHANGED_THREAD_ROLE`	Đã thay đổi vai trò (bị vô hiệu hóa, tách rời, trẻ em, bộ định tuyến, lãnh đạo).

Typedefs

otChangedFlags

uint32_t otChangedFlags

Kiểu 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_* .

otInstance

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ỏ chức năng này được gọi để thông báo những thay đổi cấu hình hoặc trạng thái nhất định trong OpenThread.

Chi tiết

Thông 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`	Một con trỏ đến ngữ 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ỏ đến một phiên bản OpenThread.

Lợi nhuận

Một con trỏ đến phiên bản radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

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

Chi tiết
Lợi nhuận	Một con trỏ đến phiên bản OpenThread.

otInstanceErasePersistingInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Chức năng này sẽ 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ỏ đến một phiên bản OpenThread.

Giá trị trả lại

`OT_ERROR_NONE`	Tất cả thông tin / trạng thái liên tục đã được 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, 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ỏ đến một phiên bản OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Chức năng 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ỏ đến một phiên bả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 lệnh 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 đến 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`	Trên đầu vào, kích thước của aInstanceBuffer. Trên đầu ra, nếu không đủ dung lượng cho otInstance, thì số byte cần thiết cho otInstance.

Lợi nhuận

Một con 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 phiên bản tĩnh đơn của thư viện OpenThread.

Hàm này khởi tạo 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 bất kỳ lệnh gọi nào khác đến 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
Lợi nhuận	Một con trỏ đến phiên bản OpenThread duy nhất.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

Phiên bản đượ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 nhiều trường hợp). Một lệnh gọi tiếp theo tới otInstanceFinalize() khiến phiên bản được coi là chưa được khởi tạo.

Chi tiết

Thông số

[in] aInstance

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

Lợi nhuận

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

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ỏ đến một phiên bản OpenThread.

otRemoveStateChangeCallback

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

Hàm này loại bỏ một lệnh gọi lại để cho biết khi 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ỏ đến một phiên bản OpenThread.
`[in] aCallback`	Một con trỏ đến một hàm được gọi với cấu hình hoặc trạng thái thay đổi nhất định.
`[in] aContext`	Một con 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 cuộc gọi lại để chỉ ra khi 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ỏ đến một phiên bản OpenThread.
`[in] aCallback`	Một con trỏ đến một hàm được gọi với cấu hình hoặc trạng thái thay đổi nhất định.
`[in] aContext`	Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.

Giá trị trả lại

`OT_ERROR_NONE`	Đã thêm lệnh gọi lại vào danh sách các lệnh 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 lệnh gọi lại do hạn chế về tài nguyên.