Skip to content

Commit fe44638

Browse files
committed
Document device monitor filter custom locations
1 parent 5ed82cb commit fe44638

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

core/userguide/device/cmd_monitor.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -231,11 +231,18 @@ install them manually. Please visit an official filter's documentation on how to
231231
Custom Filters
232232
~~~~~~~~~~~~~~
233233

234-
:ref:`piocore` provides an API to extend device monitor with custom filters declared
235-
in :ref:`projectconf_pio_monitor_dir` or in "monitor" folder of :ref:`platforms`.
234+
:ref:`piocore` provides an API to extend device monitor with custom filters.
236235
Each filter is a Python-based file and its name should have the ``filter_`` prefix.
237236
In a Python code, you need to extend ``DeviceMonitorFilter`` class to get access to
238-
the ``rx()`` and ``tx()`` methods/callbacks. See the base API below:
237+
the ``rx()`` and ``tx()`` methods/callbacks.
238+
239+
:ref:`piocore` looks for the custom filters in the next locations:
240+
241+
- Project :ref:`projectconf_pio_monitor_dir`
242+
- :ref:`projectconf_pio_platforms_dir`/<platform>/monitor
243+
- :ref:`projectconf_pio_packages_dir`/<package>/monitor
244+
245+
See the base API below:
239246

240247
**filter_demo.py**
241248

0 commit comments

Comments
 (0)