Commissioner
Dieses Modul enthält Funktionen für die Rolle „Thread Commissioner“.
Zusammenfassung
| Aufzählungen | |
|---|---|
| otCommissionerJoinerEvent | enum Definiert ein Joiner-Ereignis auf dem Commissioner.  | 
| otCommissionerState{ | enum Definiert den Staat des Beauftragten.  | 
| otJoinerInfoType{ | enum Definiert einen Joiner-infotyp.  | 
| Typedefs | |
|---|---|
| otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) | typedef void(*Der Pointer wird aufgerufen, wenn der Beauftragte einen Energiebericht erhält.  | 
| otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) | typedef void(*Der Zeiger wird immer dann aufgerufen, wenn sich der Joiner-Status ändert.  | 
| otCommissionerJoinerEvent | typedef Definiert ein Joiner-Ereignis auf dem Commissioner.  | 
| otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) | typedef void(*Pointer wird aufgerufen, wenn der Beauftragte eine Nachricht zu einem PAN-ID-Konflikt erhält.  | 
| otCommissionerState | typedef enum otCommissionerStateDefiniert den Staat des Beauftragten.  | 
| otCommissionerStateCallback)(otCommissionerState aState, void *aContext) | typedef void(*Pointer wird immer dann aufgerufen, wenn sich der Status des Provisioners ändert.  | 
| otCommissioningDataset | typedef struct otCommissioningDatasetStellt ein Inbetriebnahme-Dataset dar.  | 
| otJoinerInfo | typedef struct otJoinerInfoStellt eine Teilnehmerinformationen dar.  | 
| otJoinerInfoType | typedef enum otJoinerInfoTypeDefiniert einen Joiner-infotyp.  | 
| otJoinerPskd | typedef struct otJoinerPskdStellt einen Joiner-PSKd dar.  | 
| otSteeringData | typedef struct otSteeringDataStellt die Lenkdaten dar.  | 
| Funktionen | |
|---|---|
| otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout) | Fügt einen Joiner-Eintrag hinzu.  | 
| otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout) | Fügt einen Joiner-Eintrag mit einem angegebenen Joiner Discerner-Wert hinzu.  | 
| otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress) | Sendet eine Nachricht über den Beginn der Ansage.  | 
| otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext) | Sendet eine Energiescan-Anfragenachricht.  | 
| otCommissionerGetId(otInstance *aInstance) | const char *Gibt die Beauftragte-ID zurück.  | 
| otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner) | Erhalten Sie Informationen zum Joiner an der Position „aIter“.  | 
| otCommissionerGetProvisioningUrl(otInstance *aInstance) | const char *Ruft die Nutzerverwaltungs-URL ab.  | 
| otCommissionerGetSessionId(otInstance *aInstance) | uint16_tGibt die Sitzungs-ID des Auftraggebers zurück.  | 
| otCommissionerGetState(otInstance *aInstance) | Gibt den Bundesstaat des Kommissars zurück.  | 
| otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext) | Es wird eine PAN-ID-Anfragenachricht gesendet.  | 
| otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64) | Entfernt einen Joiner-Eintrag.  | 
| otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner) | Entfernt einen Joiner-Eintrag.  | 
| otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength) | Sendet MGMT_COMMISSIONER_GET.  | 
| otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength) | Sendet MGMT_COMMISSIONER_SET.  | 
| otCommissionerSetId(otInstance *aInstance, const char *aId) | Legt die Auftragskommissions-ID fest.  | 
| otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl) | Legt die Bereitstellungs-URL fest.  | 
| otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext) | Aktiviert die Rolle „Thread Commissioner“.  | 
| otCommissionerStop(otInstance *aInstance) | Deaktiviert die Rolle „Thread Commissioner“.  | 
| Strukturen | |
|---|---|
| otCommissioningDataset | Stellt ein Inbetriebnahme-Dataset dar. | 
| otJoinerInfo | Stellt eine Teilnehmerinformationen dar. | 
| otJoinerPskd | Stellt einen Joiner-PSKd dar. | 
| otSteeringData | Stellt die Lenkdaten dar. | 
Aufzählungen
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Definiert ein Joiner-Ereignis auf dem Commissioner.
otCommissionerState
otCommissionerState
Definiert den Staat des Beauftragten.
| Attribute | |
|---|---|
| OT_COMMISSIONER_STATE_ACTIVE | Die Rolle des Auftraggebers ist aktiv. | 
| OT_COMMISSIONER_STATE_DISABLED | Die Rolle des Auftraggebers ist deaktiviert. | 
| OT_COMMISSIONER_STATE_PETITION | Sie werden derzeit um die Aufnahme als EU-Kommissionsmitglied eingereicht. | 
otJoinerInfoType
otJoinerInfoType
Definiert einen Joiner-infotyp.
| Attribute | |
|---|---|
| OT_JOINER_INFO_TYPE_ANY | Akzeptieren Sie alle Joiner (kein EUI64- oder Discerner-Feld angegeben). | 
| OT_JOINER_INFO_TYPE_DISCERNER | Die Verbindungserkenner ist angegeben ( | 
| OT_JOINER_INFO_TYPE_EUI64 | Joiner EUI-64 ist angegeben ( | 
Typedefs
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Der Pointer wird aufgerufen, wenn der Beauftragte einen Energiebericht erhält.
| Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Der Zeiger wird immer dann aufgerufen, wenn sich der Joiner-Status ändert.
| Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Definiert ein Joiner-Ereignis auf dem Commissioner.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Pointer wird aufgerufen, wenn der Beauftragte eine Nachricht zu einem PAN-ID-Konflikt erhält.
| Details | |||||||
|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||
otCommissionerState
enum otCommissionerState otCommissionerState
Definiert den Staat des Beauftragten.
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Pointer wird immer dann aufgerufen, wenn sich der Status des Provisioners ändert.
| Details | |||||
|---|---|---|---|---|---|
| Parameter | 
 | ||||
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Stellt ein Inbetriebnahme-Dataset dar.
Funktionen
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Fügt einen Joiner-Eintrag hinzu.
| Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||
| Rückgabewerte | 
 | ||||||||
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
Fügt einen Joiner-Eintrag mit einem angegebenen Joiner Discerner-Wert hinzu.
| Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||
| Rückgabewerte | 
 | ||||||||
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Sendet eine Nachricht über den Beginn der Ansage.
| Details | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||||
| Rückgabewerte | 
 | ||||||||||
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
Sendet eine Energiescan-Anfragenachricht.
| Details | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||||||||||
| Rückgabewerte | 
 | ||||||||||||||||
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
Gibt die Beauftragte-ID zurück.
| Details | |||
|---|---|---|---|
| Parameter | 
 | ||
| Rückgabe | Die Auftragsnummer  | ||
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Erhalten Sie Informationen zum Joiner an der Position „aIter“.
| Details | |||||||
|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||
| Rückgabewerte | 
 | ||||||
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Ruft die Nutzerverwaltungs-URL ab.
| Details | |||
|---|---|---|---|
| Parameter | 
 | ||
| Rückgabe | Ein Zeiger auf den URL-String.  | ||
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Gibt die Sitzungs-ID des Auftraggebers zurück.
| Details | |||
|---|---|---|---|
| Parameter | 
 | ||
| Rückgabe | Die aktuelle Sitzungs-ID des Auftraggebers.  | ||
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
Gibt den Bundesstaat des Kommissars zurück.
| Details | |||||||
|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||
| Rückgabewerte | 
 | ||||||
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
Es wird eine PAN-ID-Anfragenachricht gesendet.
| Details | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||||||
| Rückgabewerte | 
 | ||||||||||||
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Entfernt einen Joiner-Eintrag.
| Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||
| Rückgabewerte | 
 | ||||||||
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Entfernt einen Joiner-Eintrag.
| Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||
| Rückgabewerte | 
 | ||||||||
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Sendet MGMT_COMMISSIONER_GET.
| Details | |||||||
|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||
| Rückgabewerte | 
 | ||||||
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
Sendet MGMT_COMMISSIONER_SET.
| Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||
| Rückgabewerte | 
 | ||||||||
otCommissionerSetId
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
Legt die Auftragskommissions-ID fest.
| Details | |||||||
|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||
| Rückgabewerte | 
 | ||||||
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Legt die Bereitstellungs-URL fest.
| Details | |||||
|---|---|---|---|---|---|
| Parameter | 
 | ||||
| Rückgabewerte | 
 | ||||
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Aktiviert die Rolle „Thread Commissioner“.
| Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameter | 
 | ||||||||
| Rückgabewerte | 
 | ||||||||
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Deaktiviert die Rolle „Thread Commissioner“.
| Details | |||||
|---|---|---|---|---|---|
| Parameter | 
 | ||||
| Rückgabewerte | 
 | ||||
Makros
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
Maximale Größe der Passphrase für die Inbetriebnahme
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
Mindestgröße der Passphrase für die Inbetriebnahme
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Maximale Stringlänge eines Joiner-PSKd (ohne Null-Zeichen).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Maximale Größe (Anzahl der Zeichen) im Nutzerverwaltungs-URL-String (Null-Zeichen sind ausgeschlossen).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Maximale Länge für Steuerungsdaten (Byte)
Ressourcen
OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen finden Sie unter Ressourcen. Dort können Sie auch einen Beitrag zu unserer Dokumentation leisten.