# Antenna Status To Network Manager

## ant2nm continuously sends antenna status events to the network manager at a predefined update rate.

  * **ant2nm --register**:  Registers information about the antenna with the network manager.  Can only be run on the command line in a terminal.
    * Needs to be executed first and only once before antenna status events can be sent to the network manager.
    * Sends required parameters about the antenna to the network manager.   
      * The parameters are as follows:
        * id: Antenna IRIS Licence. Six alphanumeric character machine code
        * name: Antenna sitename 
        * model: The model is the radar model i.e. WRM100, WRM200  
        * coordinates: Lon, Lat and Altitude of the antenna.
        * swVersion: IRIS software version
        * connectionHeartbeatPeriod:  The time between updates that antenna status events are sent. 
          * This parameter is read in from the ant2nm.ini file.  The parameter is called heartbeat 
  * **ant2nm**:  Sends antenna status events to the network manager every X seconds. Can be run from the command line in a terminal or as a service.
      * The parameters are as follows:
        * source: This is the id param when we registered the antenna with the network manager.
        * occurred: Time the status event was sent.  The format is: yyyy-mm-ddThh:mm:ss.milZ
        * summary: Status of the antenna
        * transmitReceivePower: Transmit Receive Power
        * transmitterRadiate: Radiate
        * servoPower: Servo Power
        * localControlOverride:  Antenna Mode
        * standby: Standby
        * magnetronCurrent: Magentron
        * airFlow: Air Flow
        * safetyInterlocks: Interlock 
        * waveGuide: Waveguide
        * radarControlProcessor: RCP Status
        * severity: Severity of errors.
  * **ant2nm.ini**: Is the configuration file required by ant2nm. ant2nm.ini will be installed at /usr/sigmet/config/
    * This following parameters need to be filled in:
       * hostname: Hostname or ip-address of the network manager
       * port: Port number of the network manager
       * incoming_authentication:  Key will be acquired from the network manager admin page.
       * authentication_secret: Key will be acquired from the network manager admin page.
       * radar_model: The model or the radar i.e. WRM100, WRM200  
       * heartbeat: This is the time that antenna status events will be sent to the network manager.
  * **ant2nm.service**: Is the ant2nm service. ant2nm.service gets installed at /usr/lib/systemd/system/