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
Typedefs | |
---|---|
otChangedFlags | typedefuint32_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 | typedefstruct otInstance Cấu trúc này đại diện cho cấu trúc thể hiện OpenThread. |
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) | typedefvoid(* 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) | 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) | Hàm này khởi tạo thư viện OpenThread. |
otInstanceInitSingle (void) | 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) | 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
.
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_*
.
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ố |
|
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ố |
| ||
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ố |
| ||||
Giá trị trả lại |
|
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ố |
|
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ố |
|
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ố |
| ||||
Lợi nhuận | Một con trỏ đến phiên bản OpenThread mới. |
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ố |
| ||
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ố |
|
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ố |
|
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ố |
| ||||||
Giá trị trả lại |
|