Google은 흑인 공동체를 위한 인종적 평등을 추구하기 위해 노력하고 있습니다. 자세히 알아보기

위원

이 모듈에는 스레드 커미셔너 역할에 대한 기능이 포함되어 있습니다.

요약

열거

otCommissionerJoinerEvent 열거
이 열거형은 커미셔너에 대한 조이너 이벤트를 정의합니다.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}
열거
이 열거형은 커미셔너 상태를 정의합니다.
otJoinerInfoType {
OT_JOINER_INFO_TYPE_ANY = 0,
OT_JOINER_INFO_TYPE_EUI64 = 1,
OT_JOINER_INFO_TYPE_DISCERNER = 2
}
열거
이 열거는 조이너 정보 유형을 정의합니다.

형식 정의

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) 형식 정의
void(*
이 함수 포인터는 커미셔너가 에너지 보고서를 수신할 때 호출됩니다.
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) 형식 정의
void(*
이 함수 포인터는 조이너 상태가 변경될 때마다 호출됩니다.
otCommissionerJoinerEvent 형식 정의
이 열거는 커미셔너에 대한 조이너 이벤트를 정의합니다.
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) 형식 정의
void(*
이 기능 포인터는 커미셔너가 PAN ID 충돌 메시지를 수신할 때 호출됩니다.
otCommissionerState 형식 정의
이 열거형은 커미셔너 상태를 정의합니다.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) 형식 정의
void(*
이 함수 포인터는 커미셔너 상태가 변경될 때마다 호출됩니다.
otCommissioningDataset 형식 정의
이 구조는 시운전 데이터 세트를 나타냅니다.
otJoinerInfo 형식 정의
struct otJoinerInfo
이 구조는 Joiner 정보를 나타냅니다.
otJoinerInfoType 형식 정의
이 열거는 조이너 정보 유형을 정의합니다.
otJoinerPskd 형식 정의
struct otJoinerPskd
이 구조는 Joiner PSKd를 나타냅니다.
otSteeringData 형식 정의
이 구조는 스티어링 데이터를 나타냅니다.

기능

otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
이 기능은 Joiner 항목을 추가합니다.
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
이 함수는 주어진 Joiner Discerner 값으로 Joiner 항목을 추가합니다.
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)
이 기능은 에너지 스캔 쿼리 메시지를 보냅니다.
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
이 메서드는 Iterator 위치에서 조이너 정보를 가져옵니다.
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)
이 기능은 Joiner 항목을 제거합니다.
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
이 기능은 Joiner 항목을 제거합니다.
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을 보냅니다.
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl)
이 함수는 프로비저닝 URL을 설정합니다.
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
이 기능은 스레드 커미셔너 역할을 활성화합니다.
otCommissionerStop ( otInstance *aInstance)
이 기능은 스레드 커미셔너 역할을 비활성화합니다.

구조체

otCommissioningDataset

이 구조는 시운전 데이터 세트를 나타냅니다.

otJoinerInfo

이 구조는 Joiner 정보를 나타냅니다.

otJoinerPskd

이 구조는 Joiner 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

모든 Joiner를 수락합니다(EUI64 또는 Discerner가 지정되지 않음).

OT_JOINER_INFO_TYPE_DISCERNER

소목 감찰은 (지정 mSharedId.mDiscerner 에서 otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

소목 EUI-64 (지정 mSharedId.mEui64otJoinerInfo ).

형식 정의

otCommissionerEnergyReportCallback

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

이 함수 포인터는 커미셔너가 에너지 보고서를 수신할 때 호출됩니다.

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

otCommissionerJoiner콜백

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

이 함수 포인터는 조이너 상태가 변경될 때마다 호출됩니다.

세부
매개변수
[in] aEvent
결합자 이벤트 유형입니다.
[in] aJoinerInfo
Joiner 정보에 대한 포인터입니다.
[in] aJoinerId
Joiner 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] aChannelMask
채널 마스크 값입니다.
[in] aEnergyList
에너지 측정 목록에 대한 포인터입니다.
[in] aEnergyListLength
항목의 수 aEnergyListLength .
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

이 구조는 시운전 데이터 세트를 나타냅니다.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

이 구조는 Joiner 정보를 나타냅니다.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

이 열거는 조이너 정보 유형을 정의합니다.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

이 구조는 Joiner PSKd를 나타냅니다.

otSteeringData

struct otSteeringData otSteeringData

이 구조는 스티어링 데이터를 나타냅니다.

기능

otCommissionerAddJoiner

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

이 기능은 Joiner 항목을 추가합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aEui64
Joiner의 IEEE EUI-64에 대한 포인터 또는 모든 Joiner에 대한 NULL입니다.
[in] aPskd
PSKd에 대한 포인터입니다.
[in] aTimeout
조이너가 자동으로 제거되는 시간(초)입니다.
반환 값
OT_ERROR_NONE
Joiner를 성공적으로 추가했습니다.
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 값으로 Joiner 항목을 추가합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aDiscerner
Joiner Discerner에 대한 포인터입니다.
[in] aPskd
PSKd에 대한 포인터입니다.
[in] aTimeout
조이너가 자동으로 제거되는 시간(초)입니다.
반환 값
OT_ERROR_NONE
Joiner를 성공적으로 추가했습니다.
OT_ERROR_NO_BUFS
조이너를 추가하는 데 사용할 수 있는 버퍼가 없습니다.
OT_ERROR_INVALID_ARGS
aDiscerner 또는 aPskd 유효하지 않습니다.
OT_ERROR_INVALID_STATE
위원은 활동하지 않습니다.

otCommissioner 발표 시작

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
알림 시작 메시지를 대기열에 넣었습니다.
OT_ERROR_NO_BUFS
시작 알림 메시지를 생성하기 위한 버퍼가 충분하지 않습니다.
OT_ERROR_INVALID_STATE
위원은 활동하지 않습니다.

otCommissioner에너지스캔

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
Energy Report 메시지 수신 시 호출되는 함수에 대한 포인터입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
에너지 스캔 쿼리 메시지를 성공적으로 대기열에 넣었습니다.
OT_ERROR_NO_BUFS
에너지 스캔 쿼리 메시지를 생성하기 위한 버퍼가 충분하지 않습니다.
OT_ERROR_INVALID_STATE
위원은 활동하지 않습니다.

otCommissionerGetNextJoinerInfo

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

이 메서드는 Iterator 위치에서 조이너 정보를 가져옵니다.

세부
매개변수
[in] aInstance
인스턴스에 대한 포인터입니다.
[in,out] aIterator
Joiner Info 반복자 컨텍스트에 대한 포인터입니다.
[out] aJoiner
Joiner 정보에 대한 참조입니다.
반환 값
OT_ERROR_NONE
Joiner 정보를 성공적으로 가져옵니다.
OT_ERROR_NOT_FOUND
다음 Joiner를 찾을 수 없습니다.

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
위원은 활동하지 않습니다.

otCommissionerJoiner 제거

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

이 기능은 Joiner 항목을 제거합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aEui64
Joiner의 IEEE EUI-64에 대한 포인터 또는 모든 Joiner에 대한 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
)

이 기능은 Joiner 항목을 제거합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aEui64
Joiner Discerner에 대한 포인터입니다.
반환 값
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
위원은 활동하지 않습니다.

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
장치가 현재 네트워크에 연결되어 있지 않습니다.

otCommissioner중지

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

Joiner PSKd의 최대 문자열 길이(null char 포함하지 않음).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

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

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

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