# Channel Monitor

# Channel Monitor

This module includes configuration variables for Channel Monitor.

## Summary

| ### Macros ||
|---|---|
| `https://openthread.io/reference/config/group/config-channel-monitor#group__config-channel-monitor_1ga03002be51911db8fe3576a122216e57c 1` | Define to 0 to require the Channel Monitor to be manually started. |
| `https://openthread.io/reference/config/group/config-channel-monitor#group__config-channel-monitor_1gae7758ac2dadbd09b5701348790b81d09 0` | Define to 1 to enable Channel Monitor support. |
| `https://openthread.io/reference/config/group/config-channel-monitor#group__config-channel-monitor_1gadceca2841d1a6d270c195ed77c6d19c0 -75` | The RSSI threshold in dBm used by Channel Monitoring feature. |
| `https://openthread.io/reference/config/group/config-channel-monitor#group__config-channel-monitor_1ga6a8d41cb0ff235debc69fcbba7b3528a 41000` | The sample interval in milliseconds used by Channel Monitoring feature. |
| `https://openthread.io/reference/config/group/config-channel-monitor#group__config-channel-monitor_1ga0e10448a48567ce21426088a2aaad350 960` | The averaging sample window length (in units of channel sample interval) used by Channel Monitoring feature. |

## Macros

### OPENTHREAD_CONFIG_CHANNEL_MONITOR_AUTO_START_ENABLE

```
 OPENTHREAD_CONFIG_CHANNEL_MONITOR_AUTO_START_ENABLE 1
```
Define to 0 to require the Channel Monitor to be manually started.

If enabled, the Channel Monitor will start and stop automatically when the Thread network interface is brought up and down.

Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set).

### OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE

```
 OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 0
```
Define to 1 to enable Channel Monitor support.

### OPENTHREAD_CONFIG_CHANNEL_MONITOR_RSSI_THRESHOLD

```
 OPENTHREAD_CONFIG_CHANNEL_MONITOR_RSSI_THRESHOLD -75
```
The RSSI threshold in dBm used by Channel Monitoring feature.

The RSSI samples are compared with the given threshold. Channel monitoring reports the average rate of RSSI samples that are above this threshold within an observation window (per channel).

It is recommended that this value is set to same value as the CCA threshold used by radio.

Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set).

### OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_INTERVAL

```
 OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_INTERVAL 41000
```
The sample interval in milliseconds used by Channel Monitoring feature.

When enabled, a zero-duration Energy Scan is performed, collecting a single RSSI sample per channel during each interval.

Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set).

### OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW

```
 OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 960
```
The averaging sample window length (in units of channel sample interval) used by Channel Monitoring feature.

Channel monitoring will sample all channels every sample interval. It maintains the average rate of RSSI samples that are above the RSSI threshold within (approximately) this sample window.

Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set).

## 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).