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.FluentFuture;
  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.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.mdsal.common.api.CommitInfo;
  20 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  21 import org.opendaylight.transportpce.common.Timeouts;
  22 import org.opendaylight.transportpce.common.crossconnect.CrossConnect;
  23 import org.opendaylight.transportpce.common.device.DeviceTransaction;
  24 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.OpticalControlMode;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.PowerDBm;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.Ports;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.PortsKey;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacks;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacksKey;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.Interface;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceBuilder;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsBuilder;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.Interface1Builder;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev181019.och.container.OchBuilder;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45
  46
  47 public final class PowerMgmtVersion221 {
  48     private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtVersion221.class);
  49
  50     private PowerMgmtVersion221() {
  51     }
  52
  53     /**
  54      * This method provides Transponder transmit power range.
  55      *
  56      * @param circuitPackName
  57      *            Transponder circuitPack name
  58      * @param portName
  59      *            Transponder port name
  60      * @param deviceId
  61      *            Node Id of a device
  62      * @param deviceTransactionManager
  63      *            Device transaction manager to read device data
  64      * @return HashMap holding Min and Max transmit power for given port
  65      */
  66     public static Map<String, Double> getXponderPowerRange(String circuitPackName, String portName, String deviceId,
  67             DeviceTransactionManager deviceTransactionManager) {
  68         InstanceIdentifier<Ports> portIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
  69                 .child(CircuitPacks.class, new CircuitPacksKey(circuitPackName))
  70                 .child(Ports.class, new PortsKey(portName));
  71         Map<String, Double> powerRangeMap = new HashMap<>();
  72         LOG.debug("Fetching logical Connection Point value for port {} at circuit pack {}", portName, circuitPackName);
  73         Optional<Ports> portObject =
  74                 deviceTransactionManager.getDataFromDevice(deviceId, LogicalDatastoreType.OPERATIONAL, portIID,
  75                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
  76         if (portObject.isPresent()) {
  77             Ports port = portObject.get();
  78             if (port.getTransponderPort().getPortPowerCapabilityMaxTx() != null) {
  79                 powerRangeMap.put("MaxTx", port.getTransponderPort().getPortPowerCapabilityMaxTx().getValue()
  80                         .doubleValue());
  81                 powerRangeMap.put("MinTx", port.getTransponderPort().getPortPowerCapabilityMinTx().getValue()
  82                         .doubleValue());
  83             } else {
  84                 LOG.warn("Logical Connection Point value missing for {} {}", circuitPackName, port.getPortName());
  85             }
  86         }
  87         return powerRangeMap;
  88     }
  89
  90     /**
  91      * This method provides Transponder transmit power range.
  92      *
  93      * @param nodeId
  94      *            Unique identifier for the mounted netconf- node
  95      * @param srgId
  96      *            SRG Id connected to transponder
  97      * @param deviceTransactionManager
  98      *            Device transaction manager to read device data
  99      * @param circuitPackName
 100      *            SRG circuitpack name
 101      * @param portName
 102      *            SRG port name
 103      * @return HashMap holding Min and Max transmit power for given port
 104      */
 105     public static Map<String, Double> getSRGRxPowerRange(String nodeId, String srgId,
 106             DeviceTransactionManager deviceTransactionManager,
 107             String circuitPackName, String portName) {
 108         Map<String, Double> powerRangeMap = new HashMap<>();
 109         LOG.debug("Coming inside SRG power range");
 110         LOG.debug("Mapping object exists.");
 111         InstanceIdentifier<Ports> portIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 112                 .child(CircuitPacks.class, new CircuitPacksKey(circuitPackName))
 113                 .child(Ports.class, new PortsKey(portName));
 114         LOG.debug("Fetching logical Connection Point value for port {} at circuit pack {}{}", portName,
 115                 circuitPackName, portIID);
 116         Optional<Ports> portObject =
 117                 deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL, portIID,
 118                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 119         if (portObject.isPresent()) {
 120             Ports port = portObject.get();
 121             if (port.getRoadmPort() != null) {
 122                 LOG.debug("Port found on the node ID");
 123                 powerRangeMap.put("MinRx", port.getRoadmPort()
 124                          .getPortPowerCapabilityMinRx().getValue().doubleValue());
 125                 powerRangeMap.put("MaxRx", port.getRoadmPort()
 126                          .getPortPowerCapabilityMaxRx().getValue().doubleValue());
 127                 return powerRangeMap;
 128             } else {
 129                 LOG.warn("Roadm ports power value is missing for {} {}", circuitPackName, port.getPortName());
 130             }
 131         } else {
 132             LOG.info("Port not found");
 133         }
 134         return powerRangeMap;
 135     }
 136
 137     /**
 138      * This method retrieves transponder OCH interface and
 139      * sets power.
 140      *
 141      * @param nodeId
 142      *            Unique identifier for the mounted netconf- node
 143      * @param interfaceName
 144      *            OCH interface name carrying WL
 145      * @param txPower
 146      *            Calculated transmit power
 147      * @param deviceTransactionManager
 148      *            Device Transaction Manager
 149      * @param interfaceObj
 150      *            Interface object
 151      *
 152      * @return true/false based on status of operation
 153      */
 154     public static boolean setTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
 155             DeviceTransactionManager deviceTransactionManager,
 156             Interface interfaceObj) {
 157         LOG.debug("Setting target-power for transponder nodeId: {} InterfaceName: {}",
 158                 nodeId, interfaceName);
 159         InterfaceBuilder ochInterfaceBuilder =
 160                 new InterfaceBuilder(interfaceObj);
 161         OchBuilder ochBuilder = new OchBuilder(ochInterfaceBuilder.augmentation(
 162                 Interface1.class).getOch());
 163         ochBuilder.setTransmitPower(new PowerDBm(txPower));
 164         ochInterfaceBuilder.addAugmentation(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         FluentFuture<? extends @NonNull CommitInfo> commit =
 185             deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 186         try {
 187             commit.get();
 188             LOG.info("Transponder Power update is committed");
 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         @SuppressWarnings("unchecked") Optional<RoadmConnections> rdmConnOpt =
 220             (Optional<RoadmConnections>) crossConnect.getCrossConnect(deviceId, connectionNumber);
 221         if (rdmConnOpt.isPresent()) {
 222             RoadmConnectionsBuilder rdmConnBldr = new RoadmConnectionsBuilder(rdmConnOpt.get());
 223             rdmConnBldr.setOpticalControlMode(mode);
 224             if (powerValue != null) {
 225                 rdmConnBldr.setTargetOutputPower(new PowerDBm(powerValue));
 226             }
 227             RoadmConnections newRdmConn = rdmConnBldr.build();
 228             Future<Optional<DeviceTransaction>> deviceTxFuture =
 229                     deviceTransactionManager.getDeviceTransaction(deviceId);
 230             DeviceTransaction deviceTx;
 231             try {
 232                 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 233                 if (deviceTxOpt.isPresent()) {
 234                     deviceTx = deviceTxOpt.get();
 235                 } else {
 236                     LOG.error("Transaction for device {} was not found!", deviceId);
 237                     return false;
 238                 }
 239             } catch (InterruptedException | ExecutionException e) {
 240                 LOG.error("Unable to get transaction for device {}!", deviceId, e);
 241                 return false;
 242             }
 243             // post the cross connect on the device
 244             InstanceIdentifier<RoadmConnections> roadmConnIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 245                     .child(RoadmConnections.class, new RoadmConnectionsKey(connectionNumber));
 246             deviceTx.put(LogicalDatastoreType.CONFIGURATION, roadmConnIID, newRdmConn);
 247             FluentFuture<? extends @NonNull CommitInfo> commit =
 248                 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 249             try {
 250                 commit.get();
 251                 LOG.info("Roadm connection power level successfully set ");
 252                 return true;
 253             } catch (InterruptedException | ExecutionException ex) {
 254                 LOG.warn("Failed to post {}", newRdmConn, ex);
 255             }
 256         } else {
 257             LOG.warn("Roadm-Connection is null in set power level ({})", connectionNumber);
 258         }
 259         return false;
 260     }
 261
 262 }