Komisarz
Ten moduł obejmuje funkcje na stanowisku komisarza ds. wątków.
Podsumowanie
Wyliczenia |
|
---|---|
otCommissionerJoinerEvent
|
enum | typ wyliczeniowy Definiuje zdarzenie Joiner na komisarzu. |
otCommissionerState{
|
enum | typ wyliczeniowy Definiuje stan komisarza. |
otJoinerInfoType{
|
enum | typ wyliczeniowy Definiuje typ danych złączającego. |
Definicje typów |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany, gdy komisarz otrzyma raport energetyczny. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany za każdym razem, gdy zmieni się stan złączania. |
otCommissionerJoinerEvent
|
typedef Definiuje zdarzenie Joiner na komisarzu. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany, gdy komisarz otrzyma komunikat o konfliktie identyfikatora PAN. |
otCommissionerState
|
typedefenum otCommissionerState
Definiuje stan komisarza. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany za każdym razem, gdy zmienia się stan komisarza. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
Reprezentuje zbiór danych używany na zlecenie. |
otJoinerInfo
|
typedefstruct otJoinerInfo
Reprezentuje łącznika. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
Definiuje typ danych złączającego. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Reprezentuje łącznik PSKd. |
otSteeringData
|
typedefstruct otSteeringData
Reprezentuje dane kierowania. |
Funkcje |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
Dodaje wpis Joiner.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
Dodaje wpis złącza o podanej wartości wspólnego rozróżnienia.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
Wysyła wiadomość o rozpoczęciu ogłoszenia.
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
Wysyła komunikat zapytania skanowania energii.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Zwraca identyfikator komisarza.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
Uzyskuj informacje o złączaniu na pozycji aIterator.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
Pobiera adres URL do obsługi administracyjnej.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
Zwraca identyfikator sesji komisarza.
|
otCommissionerGetState(otInstance *aInstance)
|
Zwraca stan komisarza.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
Wysyła zapytanie o identyfikator PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Usuwa wpis Joiner.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
Usuwa wpis Joiner.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
Wysyła MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
Wysyła MGMT_COMMISSIONER_SET.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
Ustawia identyfikator komisarza.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Ustawia adres URL obsługi administracyjnej.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
Włącza rolę komisarza ds. wątków.
|
otCommissionerStop(otInstance *aInstance)
|
Wyłącza rolę komisarza ds. wątków.
|
Konstrukcja |
|
---|---|
otCommissioningDataset |
Reprezentuje zbiór danych używany na zlecenie. |
otJoinerInfo |
Reprezentuje łącznika. |
otJoinerPskd |
Reprezentuje łącznik PSKd. |
otSteeringData |
Reprezentuje dane kierowania. |
Wyliczenia
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Definiuje zdarzenie Joiner na komisarzu.
otCommissionerState
otCommissionerState
Definiuje stan komisarza.
Właściwości | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
Rola komisarza jest aktywna. |
OT_COMMISSIONER_STATE_DISABLED
|
Rola komisarza jest wyłączona. |
OT_COMMISSIONER_STATE_PETITION
|
Obecnie składasz wniosek o przyznanie komisarza. |
otJoinerInfoType
otJoinerInfoType
Definiuje typ danych złączającego.
Właściwości | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Zaakceptuj dowolny łącznik (nie określono EUI64 ani wyróżniającego). |
OT_JOINER_INFO_TYPE_DISCERNER
|
Określono narzędzie wyróżniające złącza ( |
OT_JOINER_INFO_TYPE_EUI64
|
Określono łącznik EUI-64 ( |
Definicje typów
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Wskaźnik jest wywoływany, gdy komisarz otrzyma raport energetyczny.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Wskaźnik jest wywoływany za każdym razem, gdy zmieni się stan złączania.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Definiuje zdarzenie Joiner na komisarzu.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Wskaźnik jest wywoływany, gdy komisarz otrzyma komunikat o konfliktie identyfikatora PAN.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Wskaźnik jest wywoływany za każdym razem, gdy zmienia się stan komisarza.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Reprezentuje zbiór danych używany na zlecenie.
Funkcje
otCommissionerAddJoiner
otError otCommissionerAddJoiner(
otInstance *aInstance,
const otExtAddress *aEui64,
const char *aPskd,
uint32_t aTimeout
)
Dodaje wpis Joiner.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner(
otInstance *aInstance,
const otJoinerDiscerner *aDiscerner,
const char *aPskd,
uint32_t aTimeout
)
Dodaje wpis złącza o podanej wartości wspólnego rozróżnienia.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin(
otInstance *aInstance,
uint32_t aChannelMask,
uint8_t aCount,
uint16_t aPeriod,
const otIp6Address *aAddress
)
Wysyła wiadomość o rozpoczęciu ogłoszenia.
Szczegóły | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||
Zwracane wartości |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan(
otInstance *aInstance,
uint32_t aChannelMask,
uint8_t aCount,
uint16_t aPeriod,
uint16_t aScanDuration,
const otIp6Address *aAddress,
otCommissionerEnergyReportCallback aCallback,
void *aContext
)
Wysyła komunikat zapytania skanowania energii.
Szczegóły | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||||||||
Zwracane wartości |
|
otCommissionerGetId
const char * otCommissionerGetId(
otInstance *aInstance
)
Zwraca identyfikator komisarza.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Identyfikator komisarza
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo(
otInstance *aInstance,
uint16_t *aIterator,
otJoinerInfo *aJoiner
)
Uzyskuj informacje o złączaniu na pozycji aIterator.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl(
otInstance *aInstance
)
Pobiera adres URL do obsługi administracyjnej.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik do ciągu adresu URL.
|
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId(
otInstance *aInstance
)
Zwraca identyfikator sesji komisarza.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Identyfikator bieżącej sesji komisarza.
|
otCommissionerGetState
otCommissionerState otCommissionerGetState(
otInstance *aInstance
)
Zwraca stan komisarza.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery(
otInstance *aInstance,
uint16_t aPanId,
uint32_t aChannelMask,
const otIp6Address *aAddress,
otCommissionerPanIdConflictCallback aCallback,
void *aContext
)
Wysyła zapytanie o identyfikator PAN.
Szczegóły | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||||
Zwracane wartości |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner(
otInstance *aInstance,
const otExtAddress *aEui64
)
Usuwa wpis Joiner.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner(
otInstance *aInstance,
const otJoinerDiscerner *aDiscerner
)
Usuwa wpis Joiner.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet(
otInstance *aInstance,
const uint8_t *aTlvs,
uint8_t aLength
)
Wysyła MGMT_COMMISSIONER_GET.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet(
otInstance *aInstance,
const otCommissioningDataset *aDataset,
const uint8_t *aTlvs,
uint8_t aLength
)
Wysyła MGMT_COMMISSIONER_SET.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCommissionerSetId
otError otCommissionerSetId(
otInstance *aInstance,
const char *aId
)
Ustawia identyfikator komisarza.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl(
otInstance *aInstance,
const char *aProvisioningUrl
)
Ustawia adres URL obsługi administracyjnej.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
otCommissionerStart
otError otCommissionerStart(
otInstance *aInstance,
otCommissionerStateCallback aStateCallback,
otCommissionerJoinerCallback aJoinerCallback,
void *aCallbackContext
)
Włącza rolę komisarza ds. wątków.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCommissionerStop
otError otCommissionerStop(
otInstance *aInstance
)
Wyłącza rolę komisarza ds. wątków.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
Makra
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
Maksymalny rozmiar hasła na zlecenie.
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
Minimalny rozmiar hasła na potrzeby zlecenia.
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Maksymalna długość ciągu znaków w łączniku PSKd (nie obejmuje znaków null).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Maksymalny rozmiar (liczba znaków) w ciągu znaków adresu URL obsługi administracyjnej (nie obejmuje pustego znaku).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Maksymalna długość danych sterowania (bajty)
Zasoby
Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.