Bộ định tuyến/Người lãnh đạo
Mô-đun này bao gồm các chức năng dành cho Bộ định tuyến và Người lãnh đạo luồng.
Tóm tắt
Bảng liệt kê |
|
---|---|
otCacheEntryState
|
enum Xác định trạng thái nhập bộ nhớ đệm EID. |
otNeighborTableEvent{
|
enum Xác định các hằng số dùng trong otNeighborTableCallback để cho biết những thay đổi trong bảng lân cận. |
otPowerSupply{
|
enum Biểu thị thuộc tính của nguồn điện trên thiết bị. |
Typedef |
|
---|---|
otCacheEntryInfo
|
typedefstruct otCacheEntryInfo
Đại diện cho một mục nhập bộ nhớ đệm EID. |
otCacheEntryIterator
|
typedefstruct otCacheEntryIterator
Đại diện cho một trình lặp dùng để lặp lại thông qua các mục nhập trong bảng bộ nhớ đệm EID. |
otCacheEntryState
|
typedefenum otCacheEntryState
Xác định trạng thái nhập bộ nhớ đệm EID. |
otChildIp6AddressIterator
|
typedefuint16_t
Dùng để lặp lại các địa chỉ IPv6 của mục nhập Con trong luồng. |
otDeviceProperties
|
typedefstruct otDeviceProperties
Đại diện cho các thuộc tính thiết bị dùng để tính trọng số trưởng cục bộ trên một thiết bị. |
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
|
typedefvoid(*
Con trỏ được gọi để thông báo rằng có thay đổi trong bảng lân cận. |
Hàm |
|
---|---|
otThreadBecomeLeader(otInstance *aInstance)
|
Trở thành người lãnh đạo và bắt đầu phân vùng mới.
|
otThreadBecomeRouter(otInstance *aInstance)
|
Nỗ lực trở thành một bộ định tuyến.
|
otThreadGetAdvertisementTrickleIntervalMax(otInstance *aInstance)
|
uint32_t
Nhận giá trị Tối đa hoá khoảng thời gian hiện tại mà bộ tính giờ quảng cáo nhỏ giọt sử dụng.
|
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
|
Nhận thông tin chẩn đoán cho một Cấp độ con đính kèm theo Mã con hoặc RLOC16.
|
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
|
Hàm này giữ lại thông tin chẩn đoán cho một Con được đính kèm theo chỉ mục bảng nội bộ.
|
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
|
Lấy địa chỉ IPv6 tiếp theo (bằng cách sử dụng trình lặp) cho một thành phần con cụ thể.
|
otThreadGetChildRouterLinks(otInstance *aInstance)
|
uint8_t
Lấy tham số MLE_CHILD_routeR_LINKS dùng trong vai trò REED.
|
otThreadGetContextIdReuseDelay(otInstance *aInstance)
|
uint32_t
Truy cập thông số CONTEXT_ID_REUSE_ mìn dùng trong vai trò Trưởng nhóm.
|
otThreadGetDeviceProperties(otInstance *aInstance)
|
const otDeviceProperties *
Lấy các thuộc tính hiện tại của thiết bị.
|
otThreadGetJoinerUdpPort(otInstance *aInstance)
|
uint16_t
Lấy cổng UDP của Joiner.
|
otThreadGetLocalLeaderWeight(otInstance *aInstance)
|
uint8_t
Lấy Trọng số người lãnh đạo luồng dùng khi làm việc ở vai trò Trưởng nhóm.
|
otThreadGetMaxAllowedChildren(otInstance *aInstance)
|
uint16_t
Lấy số lượng trẻ em tối đa hiện được cho phép.
|
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
|
uint8_t
Nhận số lượng địa chỉ IP tối đa mà mỗi thành phần con MTD có thể đăng ký trên thiết bị này với vai trò là cấp độ gốc.
|
otThreadGetMaxRouterId(otInstance *aInstance)
|
uint8_t
Hàm trả về mã nhận dạng bộ định tuyến tối đa được cho phép.
|
otThreadGetNetworkIdTimeout(otInstance *aInstance)
|
uint8_t
Lấy tham số
NETWORK_ID_TIMEOUT . |
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
|
Lấy mục nhập bộ nhớ đệm EID tiếp theo (bằng một trình lặp).
|
otThreadGetNextHopAndPathCost(otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost)
|
void
Nhận chi phí bước tiếp theo và lộ trình tới một đích đến RLOC16 nhất định.
|
otThreadGetParentPriority(otInstance *aInstance)
|
int8_t
Nhận mức độ ưu tiên của cha mẹ đã chỉ định.
|
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
|
uint32_t
Lấy mã phân vùng người lãnh đạo luồng ưu tiên khi làm việc ở vai trò Trưởng nhóm.
|
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
|
void
Nhận luồng PSKc.
|
otThreadGetPskcRef(otInstance *aInstance)
|
Lấy thông tin tham chiếu khoá đến luồng PSKc được lưu trữ.
|
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
|
uint8_t
Lấy tham số tệp RouteR_DOWN {/1} dùng để dùng trong vai trò Bộ định tuyến.
|
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
|
void
Lấy phạm vi mã bộ định tuyến được phép gán cho các nút trong mạng luồng.
|
otThreadGetRouterIdSequence(otInstance *aInstance)
|
uint8_t
Nhận Trình tự mã bộ định tuyến hiện tại.
|
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
|
Hàm này giữ lại thông tin chẩn đoán cho một Bộ định tuyến luồng nhất định.
|
otThreadGetRouterSelectionJitter(otInstance *aInstance)
|
uint8_t
Lấy tham số RouteR_SELECTION_JITTER dùng trong vai trò REED/Bộ định tuyến.
|
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
|
uint8_t
Lấy tham số RouteR_UPGRADE_ nếm thử trong vai trò REED.
|
otThreadIsRouterEligible(otInstance *aInstance)
|
bool
Cho biết thiết bị có đủ điều kiện để sử dụng bộ định tuyến hay không.
|
otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId)
|
bool
Cho biết liệu Mã bộ định tuyến hiện có được phân bổ hay không.
|
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
|
void
Đăng ký một hàm callback bảng lân cận.
|
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
|
Giải phóng Mã bộ định tuyến mà thiết bị đã phân bổ ở vai trò Trưởng nhóm.
|
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
|
void
Thiết lập liệu thiết bị có được uỷ quyền bằng CCM hay không.
|
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)
|
Đặt tham số MLE_CHILD_RouteR_LINKS dùng trong vai trò REED.
|
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
|
void
Đặt thông số CONTEXT_ID_REUSE_ chịu lượt nhấp cho vai trò Người lãnh đạo.
|
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)
|
void
Đặt thuộc tính thiết bị mà sau đó được dùng để xác định và đặt Trọng số người lãnh đạo.
|
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
|
Thiết lập Cổng UDP của Joiner.
|
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
|
void
Đặt Trọng số người lãnh đạo luồng được dùng khi hoạt động ở vai trò Trưởng nhóm.
|
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
|
Đặt số lượng phần tử con tối đa hiện được cho phép.
|
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
|
Thiết lập hoặc khôi phục số lượng địa chỉ IP tối đa mà mỗi thành phần con MTD có thể đăng ký với thiết bị này với tư cách là cấp độ gốc.
|
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
|
void
Đặt tham số
NETWORK_ID_TIMEOUT . |
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
|
Đặt mức độ ưu tiên chính.
|
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
|
void
Đặt mã phân vùng người lãnh đạo luồng mà bạn muốn dùng khi làm việc ở vai trò Trưởng nhóm.
|
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
|
Đặt mã bộ định tuyến mà bạn muốn.
|
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
|
Thiết lập Thread PSKc.
|
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
|
Đặt Giá trị tham chiếu chính thành luồng PSKc.
|
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
|
void
Đặt tham số routeR_DOWNGrade_ những, thành viên trong vai trò Trưởng nhóm.
|
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
|
Thiết lập xem thiết bị có đủ điều kiện cho bộ định tuyến hay không.
|
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
|
Đặt phạm vi mã bộ định tuyến được phép gán cho các nút trong mạng chuỗi.
|
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
|
void
Đặt tham số RouteR_SELECTION_JITTER dùng trong vai trò REED/Bộ định tuyến.
|
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
|
void
Đặt tham số routeR_UPGRADE_ những vào vai trò Trưởng nhóm.
|
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
Thiết lập dữ liệu lái xe ngoài băng tần.
|
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
|
void
Thiết lập xem có bật ngưỡng phiên bản TLV cho định tuyến (trường thực tế ảo) của Chính sách bảo mật hay không.
|
Cấu trúc |
|
---|---|
otCacheEntryInfo |
Đại diện cho một mục nhập bộ nhớ đệm EID. |
otCacheEntryIterator |
Đại diện cho một trình lặp dùng để lặp lại thông qua các mục nhập trong bảng bộ nhớ đệm EID. |
otChildInfo |
Lưu giữ thông tin chẩn đoán cho một thành phần con của Thread. |
otDeviceProperties |
Đại diện cho các thuộc tính thiết bị dùng để tính trọng số trưởng cục bộ trên một thiết bị. |
otNeighborTableEntryInfo |
Đại diện cho thông tin mục nhập trong bảng lân cận (con hoặc bộ định tuyến) và dùng làm tham số trong lệnh gọi lại |
Bảng liệt kê
otCacheEntryState
otCacheEntryState
Xác định trạng thái nhập bộ nhớ đệm EID.
otNeighborTableEvent
otNeighborTableEvent
Xác định các hằng số dùng trong otNeighborTableCallback
để cho biết những thay đổi trong bảng lân cận.
Thuộc tính | |
---|---|
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED
|
Đang thêm một trẻ. |
OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED
|
Đã thay đổi chế độ hiện có của trẻ. |
OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED
|
Một trẻ đang bị xoá. |
OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED
|
Đang thêm một bộ định tuyến. |
OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
|
Đang xoá một bộ định tuyến. |
otPowerSupply
otPowerSupply
Biểu thị thuộc tính của nguồn điện trên thiết bị.
Dữ liệu này được dùng làm thuộc tính trong otDeviceProperties
để tính trọng số biến thể dẫn đầu.
Thuộc tính | |
---|---|
OT_POWER_SUPPLY_BATTERY
|
Chạy bằng pin. |
OT_POWER_SUPPLY_EXTERNAL
|
Cấp nguồn bên ngoài (chạy chính). |
OT_POWER_SUPPLY_EXTERNAL_STABLE
|
Nguồn điện bên ngoài ổn định nhờ ắc quy dự phòng hoặc bộ lưu điện (UPS). |
OT_POWER_SUPPLY_EXTERNAL_UNSTABLE
|
Nguồn điện bên ngoài có khả năng không ổn định (ví dụ: bóng đèn được cấp nguồn qua công tắc). |
Typedef
otCacheEntryIterator
struct otCacheEntryIterator otCacheEntryIterator
Đại diện cho một trình lặp dùng để lặp lại thông qua các mục nhập trong bảng bộ nhớ đệm EID.
Để khởi tạo biến lặp và bắt đầu từ mục đầu tiên trong bảng bộ nhớ đệm, hãy đặt tất cả các trường của mục nhập trong cấu trúc thành 0 (ví dụ: memset
biến lặp thành 0).
otChildIp6AddressIterator
uint16_t otChildIp6AddressIterator
Dùng để lặp lại các địa chỉ IPv6 của mục nhập Con trong luồng.
otDeviceProperties
struct otDeviceProperties otDeviceProperties
Đại diện cho các thuộc tính thiết bị dùng để tính trọng số trưởng cục bộ trên một thiết bị.
Các tham số này được đặt dựa trên khả năng của thiết bị, cho dù thiết bị có chức năng như bộ định tuyến biên hay cấu hình nguồn điện của thiết bị, v.v.
mIsUnstable
cho biết độ ổn định hoạt động của thiết bị và được xác định thông qua một cơ chế dành riêng cho nhà cung cấp. Nó có thể bao gồm các trường hợp sau:
- Trong nội bộ thiết bị, phát hiện thấy thiết bị mất nguồn điện bên ngoài thường xuyên hơn bình thường. Những gì thông thường là do nhà cung cấp xác định.
- Trong nội bộ thiết bị, phát hiện thấy thiết bị khởi động lại thường xuyên hơn bình thường. Những gì thông thường là do nhà cung cấp xác định.
otNeighborTableCallback
void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)
Con trỏ được gọi để thông báo rằng có thay đổi trong bảng lân cận.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
Hàm
otThreadBecomeLeader
otError otThreadBecomeLeader( otInstance *aInstance )
Trở thành người lãnh đạo và bắt đầu phân vùng mới.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Giá trị trả về |
|
otThreadBecomeRouter
otError otThreadBecomeRouter( otInstance *aInstance )
Nỗ lực trở thành một bộ định tuyến.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Giá trị trả về |
|
otThreadGetAdvertisementTrickleIntervalMax
uint32_t otThreadGetAdvertisementTrickleIntervalMax( otInstance *aInstance )
Nhận giá trị Tối đa hoá khoảng thời gian hiện tại mà bộ tính giờ quảng cáo nhỏ giọt sử dụng.
API này yêu cầu phải có OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
và chỉ dành cho mục đích kiểm thử.
Thông tin chi tiết | |
---|---|
Trả về |
Bộ tính giờ nhỏ giọt trong khoảng thời gian của quảng cáo tính bằng mili giây.
|
otThreadGetChildInfoById
otError otThreadGetChildInfoById( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo )
Nhận thông tin chẩn đoán cho một Cấp độ con đính kèm theo Mã con hoặc RLOC16.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Giá trị trả về |
|
otThreadGetChildInfoByIndex
otError otThreadGetChildInfoByIndex( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo )
Hàm này giữ lại thông tin chẩn đoán cho một Con được đính kèm theo chỉ mục bảng nội bộ.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otGetMaxAllowedChildren
otThreadGetChildNextIp6Address
otError otThreadGetChildNextIp6Address( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress )
Lấy địa chỉ IPv6 tiếp theo (bằng cách sử dụng trình lặp) cho một thành phần con cụ thể.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otThreadGetChildInfoByIndex
otThreadGetChildRouterLinks
uint8_t otThreadGetChildRouterLinks( otInstance *aInstance )
Lấy tham số MLE_CHILD_routeR_LINKS dùng trong vai trò REED.
Tham số này chỉ định số lượng bộ định tuyến lân cận tối đa mà thiết bị (dưới dạng FED) sẽ cố gắng thiết lập liên kết.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Giá trị MLE_CHILD_routeR_LINKS.
|
otThreadSetChildRouterLinks
otThreadGetContextIdReuseDelay
uint32_t otThreadGetContextIdReuseDelay( otInstance *aInstance )
Truy cập thông số CONTEXT_ID_REUSE_ mìn dùng trong vai trò Trưởng nhóm.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Giá trị CONTEXT_ID_REUSE_TIMESTAMP.
|
otThreadSetContextIdReuseDelay
otThreadGetDeviceProperties
const otDeviceProperties * otThreadGetDeviceProperties( otInstance *aInstance )
Lấy các thuộc tính hiện tại của thiết bị.
Cần có OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE
.
Thông tin chi tiết | |
---|---|
Trả về |
Thuộc tính thiết bị
otDeviceProperties . |
otThreadGetJoinerUdpPort
uint16_t otThreadGetJoinerUdpPort( otInstance *aInstance )
Lấy cổng UDP của Joiner.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Số Cổng UDP của Joiner.
|
otThreadSetJoinerUdpPort
otThreadGetLocalLeaderWeight
uint8_t otThreadGetLocalLeaderWeight( otInstance *aInstance )
Lấy Trọng số người lãnh đạo luồng dùng khi làm việc ở vai trò Trưởng nhóm.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Giá trị trọng số của người dẫn đầu Thread.
|
otThreadSetLeaderWeight
otThreadSetDeviceProperties
otThreadGetMaxAllowedChildren
uint16_t otThreadGetMaxAllowedChildren( otInstance *aInstance )
Lấy số lượng trẻ em tối đa hiện được cho phép.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Số lượng trẻ em tối đa hiện được cho phép.
|
otThreadSetMaxAllowedChildren
otThreadGetMaxChildIpAddresses
uint8_t otThreadGetMaxChildIpAddresses( otInstance *aInstance )
Nhận số lượng địa chỉ IP tối đa mà mỗi thành phần con MTD có thể đăng ký trên thiết bị này với vai trò là cấp độ gốc.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Số địa chỉ IP tối đa mà mỗi thành phần con MTD có thể đăng ký trên thiết bị này với tư cách là cấp độ gốc.
|
otThreadSetMaxChildIpAddresses
otThreadGetMaxRouterId
uint8_t otThreadGetMaxRouterId( otInstance *aInstance )
Hàm trả về mã nhận dạng bộ định tuyến tối đa được cho phép.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Mã bộ định tuyến tối đa được cho phép.
|
otThreadGetNetworkIdTimeout
uint8_t otThreadGetNetworkIdTimeout( otInstance *aInstance )
Lấy tham số NETWORK_ID_TIMEOUT
.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Giá trị
NETWORK_ID_TIMEOUT . |
otThreadSetNetworkIdTimeout
otThreadGetNextCacheEntry
otError otThreadGetNextCacheEntry( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator )
Lấy mục nhập bộ nhớ đệm EID tiếp theo (bằng một trình lặp).
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Giá trị trả về |
|
otThreadGetNextHopAndPathCost
void otThreadGetNextHopAndPathCost( otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost )
Nhận chi phí bước tiếp theo và lộ trình tới một đích đến RLOC16 nhất định.
Có thể dùng với aNextHopRloc16
hoặc aPathCost
có giá trị là NULL (Rỗng) cho biết phương thức gọi không muốn nhận giá trị.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Các tham số |
|
otThreadGetParentPriority
int8_t otThreadGetParentPriority( otInstance *aInstance )
Nhận mức độ ưu tiên của cha mẹ đã chỉ định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Giá trị ưu tiên gốc đã chỉ định, -2 có nghĩa là chưa chỉ định.
|
otThreadSetParentPriority
otThreadGetPreferredLeaderPartitionId
uint32_t otThreadGetPreferredLeaderPartitionId( otInstance *aInstance )
Lấy mã phân vùng người lãnh đạo luồng ưu tiên khi làm việc ở vai trò Trưởng nhóm.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Giá trị mã phân vùng của người dẫn luồng.
|
otThreadGetPskc
void otThreadGetPskc( otInstance *aInstance, otPskc *aPskc )
Nhận luồng PSKc.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
otThreadSetPskc
otThreadGetPskcRef
otPskcRef otThreadGetPskcRef( otInstance *aInstance )
Lấy thông tin tham chiếu khoá đến luồng PSKc được lưu trữ.
Yêu cầu bật tính năng thời gian xây dựng OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Thông tin tham chiếu chính đến PSKc
|
otThreadSetPskcRef
otThreadGetRouterDowngradeThreshold
uint8_t otThreadGetRouterDowngradeThreshold( otInstance *aInstance )
Lấy tham số tệp RouteR_DOWN {/1} dùng để dùng trong vai trò Bộ định tuyến.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Giá trị RouteR_DOWNGrade_CAMPAIGN.
|
otThreadSetRouterDowngradeThreshold
otThreadGetRouterIdRange
void otThreadGetRouterIdRange( otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId )
Lấy phạm vi mã bộ định tuyến được phép gán cho các nút trong mạng luồng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
otThreadSetRouterIdRange
otThreadGetRouterIdSequence
uint8_t otThreadGetRouterIdSequence( otInstance *aInstance )
Nhận Trình tự mã bộ định tuyến hiện tại.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Trình tự mã nhận dạng bộ định tuyến.
|
otThreadGetRouterInfo
otError otThreadGetRouterInfo( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo )
Hàm này giữ lại thông tin chẩn đoán cho một Bộ định tuyến luồng nhất định.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadGetRouterSelectionJitter
uint8_t otThreadGetRouterSelectionJitter( otInstance *aInstance )
Lấy tham số RouteR_SELECTION_JITTER dùng trong vai trò REED/Bộ định tuyến.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Giá trị routeR_SELECTION_JITTER.
|
otThreadSetRouterSelectionJitter
otThreadGetRouterUpgradeThreshold
uint8_t otThreadGetRouterUpgradeThreshold( otInstance *aInstance )
Lấy tham số RouteR_UPGRADE_ nếm thử trong vai trò REED.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Giá trị lineR_UPGRADE_CAMPAIGN.
|
otThreadSetRouterUpgradeThreshold
otThreadIsRouterEligible
bool otThreadIsRouterEligible( otInstance *aInstance )
Cho biết thiết bị có đủ điều kiện để sử dụng bộ định tuyến hay không.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadIsRouterIdAllocated
bool otThreadIsRouterIdAllocated( otInstance *aInstance, uint8_t aRouterId )
Cho biết liệu Mã bộ định tuyến hiện có được phân bổ hay không.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadRegisterNeighborTableCallback
void otThreadRegisterNeighborTableCallback( otInstance *aInstance, otNeighborTableCallback aCallback )
Đăng ký một hàm callback bảng lân cận.
Lệnh gọi lại được cung cấp (nếu không phải là NULL) sẽ được gọi khi có thay đổi trong bảng lân cận (ví dụ: một mục con hoặc mục nhập lân cận của bộ định tuyến đang được thêm/xoá hoặc chế độ của thành phần con hiện có bị thay đổi).
Các lệnh gọi tiếp theo đối với phương thức này sẽ ghi đè lệnh gọi lại trước đó. Xin lưu ý rằng lệnh gọi lại này được gọi trong khi bảng lân cận/bảng con đang được cập nhật và luôn trước otStateChangedCallback
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadReleaseRouterId
otError otThreadReleaseRouterId( otInstance *aInstance, uint8_t aRouterId )
Giải phóng Mã bộ định tuyến mà thiết bị đã phân bổ ở vai trò Trưởng nhóm.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otThreadSetCcmEnabled
void otThreadSetCcmEnabled( otInstance *aInstance, bool aEnabled )
Thiết lập liệu thiết bị có được uỷ quyền bằng CCM hay không.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadSetChildRouterLinks
otError otThreadSetChildRouterLinks( otInstance *aInstance, uint8_t aChildRouterLinks )
Đặt tham số MLE_CHILD_RouteR_LINKS dùng trong vai trò REED.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetChildRouterLinks
otThreadSetContextIdReuseDelay
void otThreadSetContextIdReuseDelay( otInstance *aInstance, uint32_t aDelay )
Đặt thông số CONTEXT_ID_REUSE_ chịu lượt nhấp cho vai trò Người lãnh đạo.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetContextIdReuseDelay
otThreadSetDeviceProperties
void otThreadSetDeviceProperties( otInstance *aInstance, const otDeviceProperties *aDeviceProperties )
Đặt thuộc tính thiết bị mà sau đó được dùng để xác định và đặt Trọng số người lãnh đạo.
Cần có OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadSetJoinerUdpPort
otError otThreadSetJoinerUdpPort( otInstance *aInstance, uint16_t aJoinerUdpPort )
Thiết lập Cổng UDP của Joiner.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetJoinerUdpPort
otThreadSetLocalLeaderWeight
void otThreadSetLocalLeaderWeight( otInstance *aInstance, uint8_t aWeight )
Đặt Trọng số người lãnh đạo luồng được dùng khi hoạt động ở vai trò Trưởng nhóm.
Đặt trực tiếp Trọng số cho người lãnh đạo thành giá trị mới, thay thế giá trị trước đó (có thể được xác định từ otDeviceProperties
hiện tại).
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetLeaderWeight
otThreadSetMaxAllowedChildren
otError otThreadSetMaxAllowedChildren( otInstance *aInstance, uint16_t aMaxChildren )
Đặt số lượng phần tử con tối đa hiện được cho phép.
Bạn chỉ có thể đặt thông số này khi đã ngừng hoạt động của giao thức Thread.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadGetMaxAllowedChildren
otThreadSetMaxChildIpAddresses
otError otThreadSetMaxChildIpAddresses( otInstance *aInstance, uint8_t aMaxIpAddresses )
Thiết lập hoặc khôi phục số lượng địa chỉ IP tối đa mà mỗi thành phần con MTD có thể đăng ký với thiết bị này với tư cách là cấp độ gốc.
Truyền 0
để xoá chế độ cài đặt và khôi phục chế độ mặc định.
Có sẵn khi bạn bật OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetMaxChildIpAddresses
otThreadSetNetworkIdTimeout
void otThreadSetNetworkIdTimeout( otInstance *aInstance, uint8_t aTimeout )
Đặt tham số NETWORK_ID_TIMEOUT
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetNetworkIdTimeout
otThreadSetParentPriority
otError otThreadSetParentPriority( otInstance *aInstance, int8_t aParentPriority )
Đặt mức độ ưu tiên chính.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetParentPriority
otThreadSetPreferredLeaderPartitionId
void otThreadSetPreferredLeaderPartitionId( otInstance *aInstance, uint32_t aPartitionId )
Đặt mã phân vùng người lãnh đạo luồng mà bạn muốn dùng khi làm việc ở vai trò Trưởng nhóm.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadSetPreferredRouterId
otError otThreadSetPreferredRouterId( otInstance *aInstance, uint8_t aRouterId )
Đặt mã bộ định tuyến mà bạn muốn.
Khi trở thành bộ định tuyến/lãnh đạo, nút cố gắng sử dụng Mã bộ định tuyến này. Nếu mã bộ định tuyến ưu tiên chưa được thiết lập hoặc không dùng được, thì mã bộ định tuyến được tạo ngẫu nhiên sẽ được chọn. Bạn chỉ có thể đặt thuộc tính này khi vai trò thiết bị được tách rời hoặc vô hiệu hoá.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadSetPskc
otError otThreadSetPskc( otInstance *aInstance, const otPskc *aPskc )
Thiết lập Thread PSKc.
Sẽ chỉ thành công khi tắt giao thức Thread. Lệnh gọi thành công hàm này cũng sẽ vô hiệu hoá Tập dữ liệu hoạt động đang hoạt động và đang chờ xử lý trong bộ nhớ bất biến.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetPskc
otThreadSetPskcRef
otError otThreadSetPskcRef( otInstance *aInstance, otPskcRef aKeyRef )
Đặt Giá trị tham chiếu chính thành luồng PSKc.
Yêu cầu bật tính năng thời gian xây dựng OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
.
Sẽ chỉ thành công khi tắt giao thức Thread. Sau khi thành công, thao tác này cũng sẽ vô hiệu hoá Tập dữ liệu hoạt động đang hoạt động và đang chờ xử lý trong bộ nhớ bất biến.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetPskcRef
otThreadSetRouterDowngradeThreshold
void otThreadSetRouterDowngradeThreshold( otInstance *aInstance, uint8_t aThreshold )
Đặt tham số routeR_DOWNGrade_ những, thành viên trong vai trò Trưởng nhóm.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetRouterDowngradeThreshold
otThreadSetRouterEligible
otError otThreadSetRouterEligible( otInstance *aInstance, bool aEligible )
Thiết lập xem thiết bị có đủ điều kiện cho bộ định tuyến hay không.
Nếu aEligible
sai và thiết bị đang hoạt động như một bộ định tuyến, thì lệnh gọi này sẽ khiến thiết bị tách ra và tìm cách kết nối lại với tư cách là trẻ.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadSetRouterIdRange
otError otThreadSetRouterIdRange( otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId )
Đặt phạm vi mã bộ định tuyến được phép gán cho các nút trong mạng chuỗi.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadGetRouterIdRange
otThreadSetRouterSelectionJitter
void otThreadSetRouterSelectionJitter( otInstance *aInstance, uint8_t aRouterJitter )
Đặt tham số RouteR_SELECTION_JITTER dùng trong vai trò REED/Bộ định tuyến.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetRouterSelectionJitter
otThreadSetRouterUpgradeThreshold
void otThreadSetRouterUpgradeThreshold( otInstance *aInstance, uint8_t aThreshold )
Đặt tham số routeR_UPGRADE_ những vào vai trò Trưởng nhóm.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetRouterUpgradeThreshold
otThreadSetSteeringData
void otThreadSetSteeringData( otInstance *aInstance, const otExtAddress *aExtAddress )
Thiết lập dữ liệu lái xe ngoài băng tần.
Bạn phải đặt tuỳ chọn cấu hình OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE
để bật chế độ cài đặt dữ liệu lái xe ngoài băng tần.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadSetThreadVersionCheckEnabled
void otThreadSetThreadVersionCheckEnabled( otInstance *aInstance, bool aEnabled )
Thiết lập xem có bật ngưỡng phiên bản TLV cho định tuyến (trường thực tế ảo) của Chính sách bảo mật hay không.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
Macro
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0
Trình khởi tạo cho otChildIP6AddressIterator.
Tài nguyên
Các chủ đề tham khảo API OpenThread bắt nguồn từ mã nguồn, có 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.