협회 회장

이 모듈에는 스레드 커미셔너 역할을 위한 함수가 포함되어 있습니다.

요약

열거
otCommissionerJoinerEvent enum
커미셔너에 대한 가입자 이벤트를 정의합니다.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		enum
위원회 국가를 정의합니다.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		enum
연결자 정보 유형을 정의합니다.

Typedef
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
위원회가 에너지 보고서를 수신하면 포인터가 호출됩니다.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
연결자 상태가 변경될 때마다 포인터가 호출됩니다.
otCommissionerJoinerEvent typedef
커미셔너에 대한 가입자 이벤트를 정의합니다.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
커미셔너가 PAN ID 충돌 메시지를 수신하면 포인터가 호출됩니다.
otCommissionerState typedef
위원회 국가를 정의합니다.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
커미셔너 상태가 변경될 때마다 포인터가 호출됩니다.
otCommissioningDataset typedef
커미셔닝 데이터 세트를 나타냅니다.
otJoinerInfo typedef
struct otJoinerInfo
연결자 정보를 나타냅니다.
otJoinerInfoType typedef
연결자 정보 유형을 정의합니다.
otJoinerPskd typedef
struct otJoinerPskd
연결자 PSKd를 나타냅니다.
otSteeringData typedef
조정 데이터를 나타냅니다.

함수
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
연결자 항목을 추가합니다.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
지정된 Joiner Discerner 값이 있는 연결자 항목을 추가합니다.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Announce Begin 메시지를 전송합니다.
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
에너지 스캔 쿼리 메시지를 보냅니다.
otCommissionerGetId(otInstance *aInstance)
const char *
커미셔너 ID를 반환합니다.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
비행기 위치에서 연결자 정보를 가져옵니다.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
프로비저닝 URL을 가져옵니다.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
커미셔닝 세션 ID를 반환합니다.
otCommissionerGetState(otInstance *aInstance)
커미셔너 주를 반환합니다.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
PAN ID 쿼리 메시지를 전송합니다.
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
연결자 항목을 삭제합니다.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
연결자 항목을 삭제합니다.
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
MGMT_COMMISSIONER_GET을 전송합니다.
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
MGMT_COMMISSIONER_SET을 전송합니다.
otCommissionerSetId(otInstance *aInstance, const char *aId)
커미셔닝 ID를 설정합니다.
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
프로비저닝 URL을 설정합니다.
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
스레드 커미셔너 역할을 사용 설정합니다.
otCommissionerStop(otInstance *aInstance)
스레드 커미셔너 역할을 사용 중지합니다.

구조체
otCommissioningDataset

커미셔닝 데이터 세트를 나타냅니다.

otJoinerInfo

연결자 정보를 나타냅니다.

otJoinerPskd

연결자 PSKd를 나타냅니다.

otSteeringData

조정 데이터를 나타냅니다.

열거형

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

커미셔너에 대한 가입자 이벤트를 정의합니다.

otCommissionerState

 otCommissionerState

위원회 국가를 정의합니다.

속성
OT_COMMISSIONER_STATE_ACTIVE

커미셔너 역할이 활성 상태입니다.

OT_COMMISSIONER_STATE_DISABLED

커미셔너 역할이 사용 중지되었습니다.

OT_COMMISSIONER_STATE_PETITION

현재 위원회가 되고 싶다고 청원하는 중입니다.

otJoinerInfoType

 otJoinerInfoType

연결자 정보 유형을 정의합니다.

속성
OT_JOINER_INFO_TYPE_ANY

모든 연결자를 수락합니다 (EUI64 또는 Discerner를 지정하지 않음).

OT_JOINER_INFO_TYPE_DISCERNER

조인자 Discerner가 지정됩니다 (otJoinerInfo의 mSharedId.mDiscerner).

OT_JOINER_INFO_TYPE_EUI64

연결자 EUI-64가 지정됩니다 (otJoinerInfo의 mSharedId.mEui64).

Typedef

otCommissionerEnergyReportCallback

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

위원회가 에너지 보고서를 수신하면 포인터가 호출됩니다.

세부정보
매개변수
[in] aChannelMask
채널 마스크 값입니다.
[in] aEnergyList
에너지 측정 목록에 대한 포인터입니다.
[in] aEnergyListLength
aEnergyListLength의 항목 수입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otCommissionerJoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

연결자 상태가 변경될 때마다 포인터가 호출됩니다.

세부정보
매개변수
[in] aEvent
연결자 이벤트 유형입니다.
[in] aJoinerInfo
연결자 정보에 대한 포인터입니다.
[in] aJoinerId
연결자 ID에 대한 포인터입니다 (알 수 없는 경우 NULL임).
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

커미셔너에 대한 가입자 이벤트를 정의합니다.

otCommissionerPanIdConflictCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

커미셔너가 PAN ID 충돌 메시지를 수신하면 포인터가 호출됩니다.

세부정보
매개변수
[in] aPanId
PAN ID 값입니다.
[in] aChannelMask
채널 마스크 값입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otCommissionerState

enum otCommissionerState otCommissionerState

위원회 국가를 정의합니다.

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

커미셔너 상태가 변경될 때마다 포인터가 호출됩니다.

세부정보
매개변수
[in] aState
커미셔닝 주입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

커미셔닝 데이터 세트를 나타냅니다.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

연결자 정보를 나타냅니다.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

연결자 정보 유형을 정의합니다.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

연결자 PSKd를 나타냅니다.

otSteeringData

struct otSteeringData otSteeringData

조정 데이터를 나타냅니다.

함수

otCommissionerAddJoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

연결자 항목을 추가합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aEui64
연결자의 IEEE EUI-64에 대한 포인터 또는 모든 연결자의 NULL입니다.
[in] aPskd
PSKd를 가리키는 포인터입니다.
[in] aTimeout
연결자가 자동으로 삭제된 후 경과된 시간(초)입니다.
반환 값
OT_ERROR_NONE
연결자를 추가했습니다.
OT_ERROR_NO_BUFS
연결자를 추가하는 데 사용할 수 있는 버퍼가 없습니다.
OT_ERROR_INVALID_ARGS
aEui64 또는 aPskd이(가) 잘못되었습니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerAddJoinerWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

지정된 Joiner Discerner 값이 있는 연결자 항목을 추가합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aDiscerner
소목 장인을 가리키는 포인터입니다.
[in] aPskd
PSKd를 가리키는 포인터입니다.
[in] aTimeout
연결자가 자동으로 삭제된 후 경과된 시간(초)입니다.
반환 값
OT_ERROR_NONE
연결자를 추가했습니다.
OT_ERROR_NO_BUFS
연결자를 추가하는 데 사용할 수 있는 버퍼가 없습니다.
OT_ERROR_INVALID_ARGS
aDiscerner 또는 aPskd이(가) 잘못되었습니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerAnnounceBegin

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

Announce Begin 메시지를 전송합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aChannelMask
채널 마스크 값입니다.
[in] aCount
채널당 공지사항 메시지 수입니다.
[in] aPeriod
연속된 두 MLE Announce 전송 사이의 시간 (밀리초)입니다.
[in] aAddress
IPv6 대상을 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
Announce Begin 메시지를 큐에 추가했습니다.
OT_ERROR_NO_BUFS
Announce Begin 메시지를 생성할 수 있는 버퍼가 충분하지 않습니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

에너지 스캔 쿼리 메시지를 보냅니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aChannelMask
채널 마스크 값입니다.
[in] aCount
채널당 에너지 측정 횟수입니다.
[in] aPeriod
에너지 측정 사이의 시간 (밀리초)입니다.
[in] aScanDuration
각 에너지 측정의 스캔 시간 (밀리초)입니다.
[in] aAddress
IPv6 대상을 가리키는 포인터입니다.
[in] aCallback
에너지 보고서 메시지를 수신할 때 호출되는 함수에 대한 포인터입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
에너지 스캔 쿼리 메시지를 큐에 추가했습니다.
OT_ERROR_NO_BUFS
에너지 스캔 쿼리 메시지를 생성하기 위한 버퍼가 부족합니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

커미셔너 ID를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
커미셔너 ID입니다.

otCommissionerGetNextJoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

비행기 위치에서 연결자 정보를 가져옵니다.

세부정보
매개변수
[in] aInstance
인스턴스를 가리키는 포인터입니다.
[in,out] aIterator
연결자 정보 반복기 컨텍스트에 대한 포인터입니다.
[out] aJoiner
연결자 정보에 대한 참조입니다.
반환 값
OT_ERROR_NONE
연결자 정보를 가져옵니다.
OT_ERROR_NOT_FOUND
다음 연결자를 찾을 수 없습니다.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

프로비저닝 URL을 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
URL 문자열을 가리키는 포인터입니다.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

커미셔닝 세션 ID를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
현재 감독관 세션 ID입니다.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

커미셔너 주를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환 값
OT_COMMISSIONER_STATE_DISABLED
커미셔닝되지 않음
OT_COMMISSIONER_STATE_PETITION
커미셔닝됨
OT_COMMISSIONER_STATE_ACTIVE
커미셔너가 사용 설정되었습니다.

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

PAN ID 쿼리 메시지를 전송합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aPanId
쿼리할 PAN ID입니다.
[in] aChannelMask
채널 마스크 값입니다.
[in] aAddress
IPv6 대상을 가리키는 포인터입니다.
[in] aCallback
PAN ID 충돌 메시지 수신 시 호출되는 함수에 대한 포인터입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
PAN ID 쿼리 메시지를 큐에 추가했습니다.
OT_ERROR_NO_BUFS
PAN ID 쿼리 메시지를 생성하기 위한 버퍼가 부족합니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerRemoveJoiner

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

연결자 항목을 삭제합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aEui64
연결자의 IEEE EUI-64에 대한 포인터 또는 모든 연결자의 NULL입니다.
반환 값
OT_ERROR_NONE
연결자를 삭제했습니다.
OT_ERROR_NOT_FOUND
aEui64에 의해 지정된 연결자를 찾을 수 없습니다.
OT_ERROR_INVALID_ARGS
aEui64의 형식이 잘못되었습니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerRemoveJoinerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

연결자 항목을 삭제합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aDiscerner
소목 장인을 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
연결자를 삭제했습니다.
OT_ERROR_NOT_FOUND
aEui64에 의해 지정된 연결자를 찾을 수 없습니다.
OT_ERROR_INVALID_ARGS
aDiscerner의 형식이 잘못되었습니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

MGMT_COMMISSIONER_GET을 전송합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aTlvs
TLV를 가리키는 포인터입니다.
[in] aLength
TLV의 길이입니다.
반환 값
OT_ERROR_NONE
Meshcop 데이터 세트 명령어를 전송했습니다.
OT_ERROR_NO_BUFS
전송할 버퍼 공간이 부족합니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

MGMT_COMMISSIONER_SET을 전송합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aDataset
커미셔닝 데이터 세트를 가리키는 포인터입니다.
[in] aTlvs
TLV를 가리키는 포인터입니다.
[in] aLength
TLV의 길이입니다.
반환 값
OT_ERROR_NONE
Meshcop 데이터 세트 명령어를 전송했습니다.
OT_ERROR_NO_BUFS
전송할 버퍼 공간이 부족합니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태가 아닙니다.

otCommissionerSetId

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

커미셔닝 ID를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aId
문자열 문자 배열에 대한 포인터입니다. null로 종료되어야 합니다.
반환 값
OT_ERROR_NONE
커미셔닝된 ID를 설정했습니다.
OT_ERROR_INVALID_ARGS
이름이 너무 깁니다.
OT_ERROR_INVALID_STATE
커미셔너가 활성 상태이며 ID를 변경할 수 없습니다.

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

프로비저닝 URL을 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aProvisioningUrl
프로비저닝 URL에 대한 포인터입니다 (빈 문자열로 설정하는 경우 NULL일 수 있음).
반환 값
OT_ERROR_NONE
프로비저닝 URL을 설정했습니다.
OT_ERROR_INVALID_ARGS
aProvisioningUrl은(는) 잘못된 입력값입니다(너무 김).

otCommissionerStart

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

스레드 커미셔너 역할을 사용 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aStateCallback
커미셔너 상태가 변경될 때 호출되는 함수에 대한 포인터입니다.
[in] aJoinerCallback
조이너 이벤트로 호출되는 함수에 대한 포인터가 발생합니다.
[in] aCallbackContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
커미셔너 서비스를 시작했습니다.
OT_ERROR_ALREADY
커미셔너가 이미 시작되었습니다.
OT_ERROR_INVALID_STATE
기기가 현재 네트워크에 연결되어 있지 않습니다.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

스레드 커미셔너 역할을 사용 중지합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
커미셔너 서비스를 중지했습니다.
OT_ERROR_ALREADY
커미셔너가 이미 중지되었습니다.

매크로

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

커미셔닝 암호의 최대 크기.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

커미셔닝 암호의 최소 크기.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

연결자 PSKd의 최대 문자열 길이 (null 문자는 포함되지 않음)입니다.

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

프로비저닝 URL 문자열의 최대 크기 (문자 수)입니다 (null 문자 제외).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

최대 조정 데이터 길이 (바이트)

자료

OpenThread API 참조 주제는 GitHub에서 제공되는 소스 코드에서 비롯됩니다. 자세한 내용을 알아보거나 문서에 참여하려면 리소스를 참고하세요.