2 * Copyright © 2017 AT&T and others. All rights reserved.
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
9 package org.opendaylight.transportpce.olm.power;
11 import com.google.common.util.concurrent.FluentFuture;
12 import java.math.BigDecimal;
13 import java.util.HashMap;
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;
47 public final class PowerMgmtVersion221 {
48 private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtVersion221.class);
50 private PowerMgmtVersion221() {
54 * This method provides Transponder transmit power range.
56 * @param circuitPackName
57 * Transponder circuitPack name
59 * Transponder port name
62 * @param deviceTransactionManager
63 * Device transaction manager to read device data
64 * @return HashMap holding Min and Max transmit power for given port
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()
81 powerRangeMap.put("MinTx", port.getTransponderPort().getPortPowerCapabilityMinTx().getValue()
84 LOG.warn("Logical Connection Point value missing for {} {}", circuitPackName, port.getPortName());
91 * This method provides Transponder transmit power range.
94 * Unique identifier for the mounted netconf- node
96 * SRG Id connected to transponder
97 * @param deviceTransactionManager
98 * Device transaction manager to read device data
99 * @param circuitPackName
100 * SRG circuitpack name
103 * @return HashMap holding Min and Max transmit power for given port
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;
129 LOG.warn("Roadm ports power value is missing for {} {}", circuitPackName, port.getPortName());
132 LOG.info("Port not found");
134 return powerRangeMap;
138 * This method retrieves transponder OCH interface and
142 * Unique identifier for the mounted netconf- node
143 * @param interfaceName
144 * OCH interface name carrying WL
146 * Calculated transmit power
147 * @param deviceTransactionManager
148 * Device Transaction Manager
149 * @param interfaceObj
152 * @return true/false based on status of operation
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(
165 Interface1.class, new Interface1Builder().setOch(ochBuilder.build()).build());
166 Future<Optional<DeviceTransaction>> deviceTxFuture = deviceTransactionManager.getDeviceTransaction(nodeId);
167 DeviceTransaction deviceTx;
169 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
170 if (deviceTxOpt.isPresent()) {
171 deviceTx = deviceTxOpt.get();
173 LOG.error("Transaction for device {} was not found during transponder"
174 + " power setup for Node:", nodeId);
177 } catch (InterruptedException | ExecutionException e) {
178 LOG.error("Unable to get transaction for device {} during transponder power "
179 + "setup!", nodeId, e);
182 InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
183 .child(Interface.class, new InterfaceKey(interfaceName));
184 deviceTx.put(LogicalDatastoreType.CONFIGURATION, interfacesIID, ochInterfaceBuilder.build());
185 FluentFuture<? extends @NonNull CommitInfo> commit =
186 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
189 LOG.info("Transponder Power update is committed");
191 } catch (InterruptedException | ExecutionException e) {
192 LOG.error("Setting transponder power failed {}", e);
198 * This method does an edit-config on roadm connection subtree for a given
199 * connection number in order to set power level for use by the optical
205 * Optical control modelcan be off, power or gainLoss.
207 * Power value in DBm.
208 * @param connectionNumber
209 * Name of the cross connect.
210 * @param crossConnect
212 * @param deviceTransactionManager
213 * Device Transaction Manager.
215 * @return true/false based on status of operation.
217 public static boolean setPowerLevel(String deviceId, OpticalControlMode mode, BigDecimal powerValue,
218 String connectionNumber, CrossConnect crossConnect,
219 DeviceTransactionManager deviceTransactionManager) {
220 Optional<RoadmConnections> rdmConnOpt = 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));
227 RoadmConnections newRdmConn = rdmConnBldr.build();
228 Future<Optional<DeviceTransaction>> deviceTxFuture =
229 deviceTransactionManager.getDeviceTransaction(deviceId);
230 DeviceTransaction deviceTx;
232 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
233 if (deviceTxOpt.isPresent()) {
234 deviceTx = deviceTxOpt.get();
236 LOG.error("Transaction for device {} was not found!", deviceId);
239 } catch (InterruptedException | ExecutionException e) {
240 LOG.error("Unable to get transaction for device {}!", deviceId, e);
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);
251 LOG.info("Roadm connection power level successfully set ");
253 } catch (InterruptedException | ExecutionException ex) {
254 LOG.warn("Failed to post {}", newRdmConn, ex);
257 LOG.warn("Roadm-Connection is null in set power level ({})", connectionNumber);