Health Monitoring Command Interface
===================================

Get Health Status
-----------------

The API exposes a `get_health_status` command which returns an overview snapshot of tile
health.

.. automethod:: ska_low_sps_tpm_api.tile_health_monitor.TileHealthMonitor.get_health_status
   :no-index:

Define Monitoring Point Filter
------------------------------

The API also exposes a `define_monitoring_point_filter` command to allow the user to create
custom keyword argument based filters for the information returned by 
`get_health_status`. This allows upstream software complete control over the
categorisation and polling frequency of each monitoring point.

.. automethod:: ska_low_sps_tpm_api.tile_health_monitor.TileHealthMonitor.define_monitoring_point_filter
   :no-index:

Helper Methods
--------------

.. automethod:: ska_low_sps_tpm_api.tile_health_monitor.TileHealthMonitor.all_monitoring_points
   :no-index:

.. automethod:: ska_low_sps_tpm_api.tile_health_monitor.TileHealthMonitor.all_monitoring_categories
   :no-index: