Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.

Phiên bản

Mô-đun này bao gồm các hàm kiểm soát Phiên bản 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 những cờ được chuyển qua trong otStateChangedCallback.

Typedef

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 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ề trạng thái hoặc cấu hình 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)
Hàm này xóa tất cả thông tin cố định OpenThread (cài đặt mạng) được lưu trữ trên bộ nhớ không thay đổi.
otInstanceFactoryReset(otInstance *aInstance)
void
Phương thức này sẽ xóa tất cả các tùy chọn cài đặt lưu trữ trên bộ nhớ không thay đổi, sau đó kích hoạt quá trình đặt lại nền tảng.
otInstanceFinalize(otInstance *aInstance)
void
Hàm này vô hiệu hóa thư viện OpenThread.
otInstanceGetUptime(otInstance *aInstance)
uint64_t
Hàm này trả về thời gian hoạt động của thực thể hiện tại (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 bản sao dưới dạng một chuỗi mà con người có thể đọc được.
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
Hàm này sẽ chạy thư viện OpenThread.
otInstanceInitSingle(void)
Hàm này sẽ 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 liệu thực thể có hợp lệ/khởi tạo hay không.
otInstanceReset(otInstance *aInstance)
void
Phương thức này sẽ 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 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 xóa một lệnh gọi lại để cho biết khi 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)
Hàm này đăng ký một lệnh gọi lại để cho biết khi 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 những cờ được chuyển qua trong otStateChangedCallback.

Thuộc tính
OT_CHANGED_ACTIVE_DATASET

Đã thay đổi tập dữ liệu hoạt động.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

Đã thay đổi kênh Chuỗi cuộc trò chuyện mới đang chờ xử lý.

OT_CHANGED_COMMISSIONER_STATE

Trạng thái ủy viên đã thay đổi.

OT_CHANGED_IP6_ADDRESS_ADDED

Đã thêm địa chỉ IPv6.

OT_CHANGED_IP6_ADDRESS_REMOVED

Địa chỉ IPv6 đã bị xóa.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

Đã đăng ký một địa chỉ đa hướng IPv6.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

Đã hủy đăng ký một địa chỉ đa hướng IPv6.

OT_CHANGED_JOINER_STATE

Trạng thái của người kết hợp đã 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

Đã thay đổi PSK.

OT_CHANGED_SECURITY_POLICY

Chính sách bảo mật đã thay đổi.

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 của 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

Trẻ em đã bị xóa.

OT_CHANGED_THREAD_EXT_PANID

Đã thay đổi mã PAN mở rộng của mạng chuỗi.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

Chuỗi khóa chuỗi đã thay đổ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ỉ mạng cục bộ đã thay đổi.

OT_CHANGED_THREAD_NETDATA

Đã thay đổi dữ liệu mạng theo chuỗi.

OT_CHANGED_THREAD_NETIF_STATE

Đã thay đổi trạng thái giao diện mạng của chuỗ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 RLAT.

OT_CHANGED_THREAD_RLOC_REMOVED

Đã xóa RLAT.

OT_CHANGED_THREAD_ROLE

Đã thay đổi vai trò (đã tắt, tách khỏi, con, bộ định tuyến, lãnh đạo).

Typedef

otVuiFlags

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 OT_CHANGED_* định nghĩa.

Phiên bản

struct otInstance otInstance

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

otState ấmCallback

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ề trạng thái hoặc cấu hình trong OpenThread.

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

Hàm

otGetRadioVersionString

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 thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.
Trả về
Con trỏ tới phiên bản radio trong OpenThread.

Chuỗi phiên bản otGetVersion

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ỏ tới phiên bản OpenThread.

otInstanceDeleteIInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

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

Thông tin chi tiết
Các thông số
[in] aInstance
Con trỏ tới một thực thể của 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
)

Phương thức này sẽ xóa tất cả các tùy chọn cài đặt lưu trữ trên bộ nhớ không thay đổi, sau đó kích hoạt quá trình đặt lại nền tảng.

Thông tin chi tiết
Các thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.

Cuối cùng

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 nữa.

Thông tin chi tiết
Các thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

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

Chức năng này yêu cầu bật OPENTHREAD_CONFIG_UPTIME_ENABLE.

Thời gian hoạt động được cung cấp dưới dạng số mili giây kể từ khi phiên bản OpenThread được khởi tạo.

Thông tin chi tiết
Các thông số
[in] aInstance
Con trỏ tới một thực thể của 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 bản sao dưới dạng một chuỗi mà con người có thể đọc được.

Chức năng này yêu cầu bật OPENTHREAD_CONFIG_UPTIME_ENABLE.

Chuỗi 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 dài hơn một ngày).

Nếu chuỗi kết quả không vừa với aBuffer (trong aSize ký tự), thì chuỗi sẽ bị cắt bớt nhưng chuỗi được xuất sẽ luôn bị chấm dứt do không có giá trị.

Thông tin chi tiết
Các thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.
[out] aBuffer
Con trỏ tới một mảng ký tự để xuất chuỗi.
[in] aSize
Kích thước aBuffer (tính bằng byte). Khuyên dùng OT_UPTIME_STRING_SIZE.

otInstanceInit

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

Hàm này sẽ 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 khi có các lệnh gọi khác đến OpenThread.

Chức năng này hoạt động và chỉ dùng được khi tính năng hỗ trợ cho nhiều phiên bản OpenThread được bật.

Thông tin chi tiết
Các thông số
[in] aInstanceBuffer
Vùng đệm để OpenThread 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 đủ không gian cho otInstance, thì số byte cần thiết cho otInstance.
Trả về
Con trỏ tới phiên bản OpenThread mới.
Xem thêm:
otInstancefinalize

otInstanceInitsingle

otInstance * otInstanceInitSingle(
  void
)

Hàm này sẽ 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 khi có các lệnh gọi khác đến OpenThread.

Chức năng này hoạt động và chỉ dùng được khi tính năng hỗ trợ cho nhiều phiên bản OpenThread bị tắt.

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

otInstanceIsĐược tạo

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

Bản sao được coi là hợp lệ nếu được thu thập và khởi tạo bằng otInstanceInitSingle() (trong trường hợp đơn lẻ) hoặc otInstanceInit() (trong trường hợp nhiều phiên bản). Lệnh gọi tiếp theo tới otInstanceFinalize() khiến bản sao được coi là chưa khởi tạo.

Thông tin chi tiết
Các thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.
Trả về
TRUE nếu phiên bản đã cho là hợp lệ/khởi tạo, nếu không thì là FALSE.

Đặt lại bản sao

void otInstanceReset(
  otInstance *aInstance
)

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

Quá trình đặt lại đảm bảo xóa tất cả thông tin/trạng thái của OpenThread (lưu trữ trong bộ nhớ dễ thay đổi). Xin lưu ý rằng otPlatformReset không xóa bất kỳ thông tin/trạng thái cố định nào được lưu trong bộ nhớ không thay đổi.

Thông tin chi tiết
Các thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Phương thức này sẽ đặt lại 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 được giữ nguyên.

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

Thông tin chi tiết
Các thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.

otRemoveStateChangeCallback

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

Hàm này xóa một lệnh gọi lại để cho biết khi 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 thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.
[in] aCallback
Con trỏ đến hàm được gọi có một số thay đổi về trạng thái hoặc cấu hình.
[in] aContext
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 lệnh gọi lại để cho biết khi 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 thông số
[in] aInstance
Con trỏ tới một thực thể của OpenThread.
[in] aCallback
Con trỏ đến hàm được gọi có một số thay đổi về trạng thái hoặc cấu hình.
[in] aContext
Con trỏ đến ngữ cảnh dành riêng cho ứng dụng.
Giá trị trả về
OT_ERROR_NONE
Đã thêm lệnh gọi lại vào danh sách lệnh gọi lại.
OT_ERROR_ALREADY
Lệnh gọi lại này đã đượ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.

Macro

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Kích thước nên dùng để biểu thị chuỗi thời gian hoạt động.

Tài nguyên

Các chủ đề về 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 phần Tài nguyên.