docs/alarm_api.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2020 AT&T Intellectual Property
   4
   5 RIC Alarm API
   6 =============
   7
   8 Overview
   9 --------
  10
  11 The xapp python framework package includes a python subpackage called
  12 `Alarm`.  This subpackage (`ricxappframe.alarm`) provides objects and
  13 methods for defining and raising alarms, which are transmitted using
  14 the RMR shared library.
  15
  16 Usage of this python package requires that the RMR shared-object
  17 library is installed in a system library that is included in the
  18 directories found by default, usually something like /usr/local/lib.
  19
  20 Alarm messages conform to the following JSON schema.
  21
  22 .. literalinclude:: ../ricxappframe/alarm/alarm-schema.json
  23   :language: JSON
  24
  25 Alarm API
  26 ---------
  27
  28 .. automodule:: ricxappframe.alarm.alarm
  29     :members: