olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion221.java

   1 /*
   2  * Copyright © 2017 AT&T and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.transportpce.olm.power;
  10
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import java.math.BigDecimal;
  13 import java.util.HashMap;
  14 import java.util.Map;
  15 import java.util.Optional;
  16 import java.util.concurrent.ExecutionException;
  17 import java.util.concurrent.Future;
  18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  19 import org.opendaylight.transportpce.common.Timeouts;
  20 import org.opendaylight.transportpce.common.crossconnect.CrossConnect;
  21 import org.opendaylight.transportpce.common.device.DeviceTransaction;
  22 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  23 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.OpticalControlMode;
  24 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.PowerDBm;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.Ports;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.PortsKey;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacks;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacksKey;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.Interface;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceBuilder;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsBuilder;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.och.container.OchBuilder;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43
  44
  45 public final class PowerMgmtVersion221 {
  46     private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtVersion221.class);
  47     private static final long DATA_STORE_READ_TIMEOUT = 120;
  48
  49     private PowerMgmtVersion221() {
  50     }
  51
  52     /**
  53      * This method provides Transponder transmit power range.
  54      *
  55      * @param circuitPackName
  56      *            Transponder circuitPack name
  57      * @param portName
  58      *            Transponder port name
  59      * @param deviceId
  60      *            Node Id of a device
  61      * @param deviceTransactionManager
  62      *            Device transaction manager to read device data
  63      * @return HashMap holding Min and Max transmit power for given port
  64      */
  65     public static Map<String, Double> getXponderPowerRange(String circuitPackName, String portName, String deviceId,
  66             DeviceTransactionManager deviceTransactionManager) {
  67         InstanceIdentifier<Ports> portIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
  68                 .child(CircuitPacks.class, new CircuitPacksKey(circuitPackName))
  69                 .child(Ports.class, new PortsKey(portName));
  70         Map<String, Double> powerRangeMap = new HashMap<>();
  71         LOG.debug("Fetching logical Connection Point value for port {} at circuit pack {}", portName, circuitPackName);
  72         Optional<Ports> portObject =
  73                 deviceTransactionManager.getDataFromDevice(deviceId, LogicalDatastoreType.OPERATIONAL, portIID,
  74                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
  75         if (portObject.isPresent()) {
  76             Ports port = portObject.get();
  77             if (port.getTransponderPort().getPortPowerCapabilityMaxTx() != null) {
  78                 powerRangeMap.put("MaxTx", port.getTransponderPort().getPortPowerCapabilityMaxTx().getValue()
  79                         .doubleValue());
  80                 powerRangeMap.put("MinTx", port.getTransponderPort().getPortPowerCapabilityMinTx().getValue()
  81                         .doubleValue());
  82             } else {
  83                 LOG.warn("Logical Connection Point value missing for {} {}", circuitPackName, port.getPortName());
  84             }
  85         }
  86         return powerRangeMap;
  87     }
  88
  89     /**
  90      * This method provides Transponder transmit power range.
  91      *
  92      * @param nodeId
  93      *            Unique identifier for the mounted netconf- node
  94      * @param srgId
  95      *            SRG Id connected to transponder
  96      * @param deviceTransactionManager
  97      *            Device transaction manager to read device data
  98      * @param circuitPackName
  99      *            SRG circuitpack name
 100      * @param portName
 101      *            SRG port name
 102      * @return HashMap holding Min and Max transmit power for given port
 103      */
 104     public static Map<String, Double> getSRGRxPowerRange(String nodeId, String srgId,
 105             DeviceTransactionManager deviceTransactionManager,
 106             String circuitPackName, String portName) {
 107         Map<String, Double> powerRangeMap = new HashMap<>();
 108         LOG.debug("Coming inside SRG power range");
 109         LOG.debug("Mapping object exists.");
 110         InstanceIdentifier<Ports> portIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 111                 .child(CircuitPacks.class, new CircuitPacksKey(circuitPackName))
 112                 .child(Ports.class, new PortsKey(portName));
 113         LOG.debug("Fetching logical Connection Point value for port {} at circuit pack {}{}", portName,
 114                 circuitPackName, portIID);
 115         Optional<Ports> portObject =
 116                 deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL, portIID,
 117                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 118         if (portObject.isPresent()) {
 119             Ports port = portObject.get();
 120             if (port.getRoadmPort() != null) {
 121                 LOG.debug("Port found on the node ID");
 122                 powerRangeMap.put("MinRx", port.getRoadmPort()
 123                          .getPortPowerCapabilityMinRx().getValue().doubleValue());
 124                 powerRangeMap.put("MaxRx", port.getRoadmPort()
 125                          .getPortPowerCapabilityMaxRx().getValue().doubleValue());
 126                 return powerRangeMap;
 127             } else {
 128                 LOG.warn("Roadm ports power value is missing for {} {}", circuitPackName, port.getPortName());
 129             }
 130         } else {
 131             LOG.info("Port not found");
 132         }
 133         return powerRangeMap;
 134     }
 135
 136     /**
 137      * This method retrieves transponder OCH interface and
 138      * sets power.
 139      *
 140      * @param nodeId
 141      *            Unique identifier for the mounted netconf- node
 142      * @param interfaceName
 143      *            OCH interface name carrying WL
 144      * @param txPower
 145      *            Calculated transmit power
 146      * @param deviceTransactionManager
 147      *            Device Transaction Manager
 148      * @param interfaceObj
 149      *            Interface object
 150      *
 151      * @return true/false based on status of operation
 152      */
 153     public static boolean setTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
 154             DeviceTransactionManager deviceTransactionManager,
 155             Interface interfaceObj) {
 156         LOG.debug("Setting target-power for transponder nodeId: {} InterfaceName: {}",
 157                 nodeId, interfaceName);
 158         InterfaceBuilder ochInterfaceBuilder =
 159                 new InterfaceBuilder(interfaceObj);
 160         OchBuilder ochBuilder = new OchBuilder(ochInterfaceBuilder.augmentation(
 161                 Interface1.class).getOch());
 162         ochBuilder.setTransmitPower(new PowerDBm(txPower));
 163         ochInterfaceBuilder.addAugmentation(
 164                 Interface1.class, new Interface1Builder().setOch(ochBuilder.build()).build());
 165         Future<Optional<DeviceTransaction>> deviceTxFuture = deviceTransactionManager.getDeviceTransaction(nodeId);
 166         DeviceTransaction deviceTx;
 167         try {
 168             Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 169             if (deviceTxOpt.isPresent()) {
 170                 deviceTx = deviceTxOpt.get();
 171             } else {
 172                 LOG.error("Transaction for device {} was not found during transponder"
 173                         + " power setup for Node:", nodeId);
 174                 return false;
 175             }
 176         } catch (InterruptedException | ExecutionException e) {
 177             LOG.error("Unable to get transaction for device {} during transponder power "
 178                     + "setup!", nodeId, e);
 179             return false;
 180         }
 181         InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 182                 .child(Interface.class, new InterfaceKey(interfaceName));
 183         deviceTx.put(LogicalDatastoreType.CONFIGURATION, interfacesIID, ochInterfaceBuilder.build());
 184         ListenableFuture<Void> submit = deviceTx.submit(Timeouts.DEVICE_WRITE_TIMEOUT,
 185                 Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 186         try {
 187             submit.get();
 188             LOG.info("Transponder Power update is submitted");
 189             return true;
 190         } catch (InterruptedException | ExecutionException e) {
 191             LOG.error("Setting transponder power failed {}", e);
 192         }
 193         return false;
 194     }
 195
 196     /**
 197      * This method does an edit-config on roadm connection subtree for a given
 198      * connection number in order to set power level for use by the optical
 199      * power control.
 200      *
 201      * @param deviceId
 202      *            Device id.
 203      * @param mode
 204      *            Optical control modelcan be off, power or gainLoss.
 205      * @param powerValue
 206      *            Power value in DBm.
 207      * @param connectionNumber
 208      *            Name of the cross connect.
 209      * @param crossConnect
 210      *            cross connect.
 211      * @param deviceTransactionManager
 212      *            Device Transaction Manager.
 213      *
 214      * @return true/false based on status of operation.
 215      */
 216     public static boolean setPowerLevel(String deviceId, OpticalControlMode mode, BigDecimal powerValue,
 217             String connectionNumber, CrossConnect crossConnect,
 218             DeviceTransactionManager deviceTransactionManager) {
 219         Optional<RoadmConnections> rdmConnOpt =  crossConnect.getCrossConnect(deviceId, connectionNumber);
 220         if (rdmConnOpt.isPresent()) {
 221             RoadmConnectionsBuilder rdmConnBldr = new RoadmConnectionsBuilder(rdmConnOpt.get());
 222             rdmConnBldr.setOpticalControlMode(mode);
 223             if (powerValue != null) {
 224                 rdmConnBldr.setTargetOutputPower(new PowerDBm(powerValue));
 225             }
 226             RoadmConnections newRdmConn = rdmConnBldr.build();
 227             Future<Optional<DeviceTransaction>> deviceTxFuture =
 228                     deviceTransactionManager.getDeviceTransaction(deviceId);
 229             DeviceTransaction deviceTx;
 230             try {
 231                 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 232                 if (deviceTxOpt.isPresent()) {
 233                     deviceTx = deviceTxOpt.get();
 234                 } else {
 235                     LOG.error("Transaction for device {} was not found!", deviceId);
 236                     return false;
 237                 }
 238             } catch (InterruptedException | ExecutionException e) {
 239                 LOG.error("Unable to get transaction for device {}!", deviceId, e);
 240                 return false;
 241             }
 242             // post the cross connect on the device
 243             InstanceIdentifier<RoadmConnections> roadmConnIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 244                     .child(RoadmConnections.class, new RoadmConnectionsKey(connectionNumber));
 245             deviceTx.put(LogicalDatastoreType.CONFIGURATION, roadmConnIID, newRdmConn);
 246             ListenableFuture<Void> submit = deviceTx.submit(Timeouts.DEVICE_WRITE_TIMEOUT,
 247                     Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 248             try {
 249                 submit.get();
 250                 LOG.info("Roadm connection power level successfully set ");
 251                 return true;
 252             } catch (InterruptedException | ExecutionException ex) {
 253                 LOG.warn("Failed to post {}", newRdmConn, ex);
 254             }
 255         } else {
 256             LOG.warn("Roadm-Connection is null in set power level ({})", connectionNumber);
 257         }
 258         return false;
 259     }
 260
 261 }