Joiner

Esse módulo inclui funções para o papel Combinador de linhas de execução.

Resumo

Enumerações
otJoinerState enum
Define o estado do Combinador.

Typedefs
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
O ponteiro é chamado para notificar a conclusão de uma operação de agrupamento.
otJoinerDiscerner typedef
Representa um separador de combinador.
otJoinerState typedef
Define o estado do Combinador.

remotas
otJoinerGetDiscerner(otInstance *aInstance)
Recebe o separador do Combinador.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Recebe o ID do Combinador.
otJoinerGetState(otInstance *aInstance)
Recebe o estado do Combinador.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Define o discriminador do Combinador.
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
Ativa o papel Unificador de linhas de execução.
otJoinerStateToString(otJoinerState aState)
const char *
Converte determinado valor de enumeração do estado do joiner em uma string legível.
otJoinerStop(otInstance *aInstance)
void
Desativa o papel Unificador de linhas de execução.

Estruturas
otJoinerDiscerner

Representa um separador de combinador.

Enumerações

otJoinerState

 otJoinerState

Define o estado do Combinador.

Typedefs

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

O ponteiro é chamado para notificar a conclusão de uma operação de agrupamento.

Detalhes
Parâmetros
[in] aError
OT_ERROR_NONE se o processo de participação for bem-sucedido. OT_ERROR_SECURITY se o processo de participação falhar devido às credenciais de segurança. OT_ERROR_NOT_FOUND se nenhuma rede acessível for descoberta. OT_ERROR_RESPONSE_TIMEOUT se uma resposta expirou.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Representa um separador de combinador.

otJoinerState

enum otJoinerState otJoinerState

Define o estado do Combinador.

remotas

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Recebe o separador do Combinador.

Para mais informações, consulte otJoinerSetDiscerner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para a instância do OpenThread.
Retorna
Um ponteiro para o "Discerner do Combinador" ou "NULL", se nenhum estiver definido.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Recebe o ID do Combinador.

Se um Discernador de Combinador não estiver definido, o ID do Joiner será os primeiros 64 bits do resultado da computação de SHA-256 em vez do IEEE EUI-64 atribuído de fábrica. Caso contrário, o ID do Combinador é calculado a partir do valor do Identificador do Combinador.

O ID do Joiner também é usado como o endereço estendido IEEE 802.15.4 do dispositivo durante o processo de comissionamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para a instância do OpenThread.
Retorna
Um ponteiro para o ID do Combinador.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Recebe o estado do Combinador.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O estado do combinador.

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Define o discriminador do Combinador.

O Discerner do Combinador é usado para calcular o ID do Combinador durante o processo de comissionamento da linha de execução. Para mais informações, consulte otJoinerGetId.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para a instância do OpenThread.
[in] aDiscerner
Apontador para um separador de separador. Se NULL limpa qualquer discernimento definido anteriormente.
Valores de retorno
OT_ERROR_NONE
O Discerner do Combinador foi atualizado.
OT_ERROR_INVALID_ARGS
aDiscerner não é válido (o comprimento especificado não está dentro do intervalo válido).
OT_ERROR_INVALID_STATE
Há um processo de participação em andamento, portanto não foi possível alterar o Seletor de participantes.

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

Ativa o papel Unificador de linhas de execução.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPskd
Um ponteiro para o PSKd.
[in] aProvisioningUrl
Um ponteiro para o URL de provisionamento (pode ser NULL).
[in] aVendorName
Um ponteiro para o nome do fornecedor (pode ser NULL).
[in] aVendorModel
Um ponteiro para o modelo do fornecedor (pode ser NULL).
[in] aVendorSwVersion
Um ponteiro para a versão do software do fornecedor (pode ser NULL).
[in] aVendorData
Um ponteiro para os dados do fornecedor (pode ser NULL).
[in] aCallback
Um ponteiro para uma função que é chamada quando a operação de junção é concluída.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
O papel de Combinador foi iniciado.
OT_ERROR_BUSY
A tentativa anterior ainda está em andamento.
OT_ERROR_INVALID_ARGS
aPskd ou aProvisioningUrl é inválido.
OT_ERROR_INVALID_STATE
A pilha IPv6 não está ativada ou a pilha Thread está totalmente ativada.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Converte determinado valor de enumeração do estado do joiner em uma string legível.

Detalhes
Parâmetros
[in] aState
O estado do combinador.
Retorna
Uma representação de string legível de aState.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Desativa o papel Unificador de linhas de execução.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.

Macros

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Comprimento máximo de um separador do combinador em bits.

Recursos

Os tópicos de Referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.