# Joiner

# Joiner

This module includes configuration variables for the Joiner.

## Summary

| ### Macros ||
|---|---|
| `https://openthread.io/reference/config/group/config-joiner#group__config-joiner_1ga705b04b1fa84aca4535cc735e37ad69b 0` | Define as 1 to enable including Joiner Advertisement TLV during discovery scan by the Joiner. |
| `https://openthread.io/reference/config/group/config-joiner#group__config-joiner_1ga4cdffae428e38c2c1f85be4b93dc7f32 3` | The maximum number of Joiner Router candidates to track per network (Extended PAN ID) by the Joiner/Seeker. |
| `https://openthread.io/reference/config/group/config-joiner#group__config-joiner_1gaac8e8532024b3ab56f396f75cc6865c2 0` | Define to 1 to enable Joiner support. |
| `https://openthread.io/reference/config/group/config-joiner#group__config-joiner_1ga2e753be365a73aceab5639d2eda69090 16` | The maximum number of Joiner Router candidates that can be tracked by the Joiner/Seeker. |
| `https://openthread.io/reference/config/group/config-joiner#group__config-joiner_1ga76a720a074df854a895c921c419e2eeb OPENTHREAD_CONFIG_JOINER_ENABLE` | Define as 1 to enable Seeker functionality and `otSeeker` APIs. |

## Macros

### OPENTHREAD_CONFIG_JOINER_ADV_EXPERIMENTAL_ENABLE

```
 OPENTHREAD_CONFIG_JOINER_ADV_EXPERIMENTAL_ENABLE 0
```
Define as 1 to enable including Joiner Advertisement TLV during discovery scan by the Joiner.

This is an experimental feature. It is not part of the Thread specification. See `otThreadSetJoinerAdvertisement` for more details.

### OPENTHREAD_CONFIG_JOINER_CANDIDATES_PER_NETWORK

```
 OPENTHREAD_CONFIG_JOINER_CANDIDATES_PER_NETWORK 3
```
The maximum number of Joiner Router candidates to track per network (Extended PAN ID) by the Joiner/Seeker.

### OPENTHREAD_CONFIG_JOINER_ENABLE

```
 OPENTHREAD_CONFIG_JOINER_ENABLE 0
```
Define to 1 to enable Joiner support.

### OPENTHREAD_CONFIG_JOINER_MAX_CANDIDATES

```
 OPENTHREAD_CONFIG_JOINER_MAX_CANDIDATES 16
```
The maximum number of Joiner Router candidates that can be tracked by the Joiner/Seeker.

### OPENTHREAD_CONFIG_SEEKER_ENABLE

```
 OPENTHREAD_CONFIG_SEEKER_ENABLE OPENTHREAD_CONFIG_JOINER_ENABLE
```
Define as 1 to enable Seeker functionality and `otSeeker` APIs.

The Seeker is a part of the Thread MeshCoP process. It is responsible for discovering nearby Joiner Router candidates, prioritizing them, and iterating through the list to select the best candidate for connection. It also operates as a sub-system of the `Joiner`, delegating control to the next layer to enable the implementation of alternative and custom joining protocols.

## Resources

OpenThread API Reference topics originate from the source code, available
on [GitHub](https://github.com/openthread/openthread/tree/main/include/openthread).
For more information, or to contribute to our documentation, refer to
[Resources](https://openthread.io/resources).