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.rev161014.OpticalControlMode;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.PowerDBm;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.OrgOpenroadmDeviceData;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.circuit.pack.Ports;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.circuit.pack.PortsKey;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.circuit.packs.CircuitPacks;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.circuit.packs.CircuitPacksKey;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.Interface;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceKey;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.OrgOpenroadmDevice;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsBuilder;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.och.container.OchBuilder;
41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
42 import org.opendaylight.yangtools.yang.common.Decimal64;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
46 public final class PowerMgmtVersion121 {
47 private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtVersion121.class);
49 private PowerMgmtVersion121() {
53 * This method provides Transponder transmit power range.
55 * @param circuitPackName
56 * Transponder circuitPack name
58 * Transponder port name
61 * @param deviceTransactionManager
62 * Device transaction manager to read device data
63 * @return HashMap holding Min and Max transmit power for given port
65 public static Map<String, Double> getXponderPowerRange(String circuitPackName, String portName, String deviceId,
66 DeviceTransactionManager deviceTransactionManager) {
67 InstanceIdentifier<Ports> portIID = InstanceIdentifier
68 .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
69 .child(CircuitPacks.class, new CircuitPacksKey(circuitPackName))
70 .child(Ports.class, new PortsKey(portName))
72 Map<String, Double> powerRangeMap = new HashMap<>();
73 LOG.debug("Fetching logical Connection Point value for port {} at circuit pack {}", portName, circuitPackName);
74 Optional<Ports> portObject =
75 deviceTransactionManager.getDataFromDevice(deviceId, LogicalDatastoreType.OPERATIONAL, portIID,
76 Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
77 if (portObject.isPresent()) {
78 Ports port = portObject.get();
79 if (port.getTransponderPort().getPortPowerCapabilityMaxTx() != null) {
80 powerRangeMap.put("MaxTx", port.getTransponderPort().getPortPowerCapabilityMaxTx().getValue()
82 powerRangeMap.put("MinTx", port.getTransponderPort().getPortPowerCapabilityMinTx().getValue()
85 LOG.warn("Logical Connection Point value missing for {} {}", circuitPackName, port.getPortName());
92 * This method provides Transponder transmit power range.
95 * Unique identifier for the mounted netconf- node
97 * SRG Id connected to transponder
98 * @param deviceTransactionManager
99 * Device transaction manager to read device data
100 * @param circuitPackName
101 * SRG circuitpack name
104 * @return HashMap holding Min and Max transmit power for given port
106 public static Map<String, Double> getSRGRxPowerRange(String nodeId, String srgId,
107 DeviceTransactionManager deviceTransactionManager,
108 String circuitPackName, String portName) {
109 Map<String, Double> powerRangeMap = new HashMap<>();
110 LOG.debug("Coming inside SRG power range");
111 LOG.debug("Mapping object exists.");
112 InstanceIdentifier<Ports> portIID = InstanceIdentifier
113 .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
114 .child(CircuitPacks.class, new CircuitPacksKey(circuitPackName))
115 .child(Ports.class, new PortsKey(portName))
117 LOG.debug("Fetching logical Connection Point value for port {} at circuit pack {}{}", portName,
118 circuitPackName, portIID);
119 Optional<Ports> portObject =
120 deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL, portIID,
121 Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
122 if (portObject.isPresent()) {
123 Ports port = portObject.get();
124 if (port.getRoadmPort() != null) {
125 LOG.debug("Port found on the node ID");
126 powerRangeMap.put("MinRx", port.getRoadmPort()
127 .getPortPowerCapabilityMinRx().getValue().doubleValue());
128 powerRangeMap.put("MaxRx", port.getRoadmPort()
129 .getPortPowerCapabilityMaxRx().getValue().doubleValue());
130 return powerRangeMap;
132 LOG.warn("Roadm ports power value is missing for {} {}", circuitPackName, port.getPortName());
135 LOG.info("Port not found");
137 return powerRangeMap;
141 * This method retrieves transponder OCH interface and
145 * Unique identifier for the mounted netconf- node
146 * @param interfaceName
147 * OCH interface name carrying WL
149 * Calculated transmit power
150 * @param interfaceObj
152 * @param deviceTransactionManager
153 * Device Transaction Manager
155 * @return true/false based on status of operation
157 public static boolean setTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
158 DeviceTransactionManager deviceTransactionManager,
159 Interface interfaceObj) {
160 LOG.debug("Setting target-power for transponder nodeId: {} InterfaceName: {}",
161 nodeId, interfaceName);
162 InterfaceBuilder ochInterfaceBuilder =
163 new InterfaceBuilder(interfaceObj);
164 OchBuilder ochBuilder = new OchBuilder(ochInterfaceBuilder.augmentation(
165 org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
166 .Interface1.class).getOch());
167 ochBuilder.setTransmitPower(new PowerDBm(Decimal64.valueOf(txPower)));
168 ochInterfaceBuilder.addAugmentation(new Interface1Builder().setOch(ochBuilder.build()).build());
169 Future<Optional<DeviceTransaction>> deviceTxFuture = deviceTransactionManager.getDeviceTransaction(nodeId);
170 DeviceTransaction deviceTx;
172 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
173 if (deviceTxOpt.isPresent()) {
174 deviceTx = deviceTxOpt.get();
176 LOG.error("Transaction for device {} was not found during transponder"
177 + " power setup for Node:", nodeId);
180 } catch (InterruptedException | ExecutionException e) {
181 LOG.error("Unable to get transaction for device {} during transponder power "
182 + "setup!", nodeId, e);
185 InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier
186 .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
187 .child(Interface.class, new InterfaceKey(interfaceName))
189 deviceTx.merge(LogicalDatastoreType.CONFIGURATION, interfacesIID, ochInterfaceBuilder.build());
190 FluentFuture<? extends @NonNull CommitInfo> commit =
191 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
194 LOG.info("Transponder Power update is committed");
196 } catch (InterruptedException | ExecutionException e) {
197 LOG.error("Setting transponder power failed: ", e);
204 * This method does an edit-config on roadm connection subtree for a given
205 * connection number in order to set power level for use by the optical
211 * Optical control modelcan be off, power or gainLoss.
213 * Power value in DBm.
214 * @param connectionNumber
215 * Name of the cross connect.
216 * @param crossConnect
218 * @param deviceTransactionManager
219 * Device Transaction Manager.
221 * @return true/false based on status of operation.
223 public static boolean setPowerLevel(String deviceId, OpticalControlMode mode, BigDecimal powerValue,
224 String connectionNumber, CrossConnect crossConnect,
225 DeviceTransactionManager deviceTransactionManager) {
226 @SuppressWarnings("unchecked") Optional<RoadmConnections> rdmConnOpt =
227 (Optional<RoadmConnections>) crossConnect.getCrossConnect(deviceId, connectionNumber);
228 if (rdmConnOpt.isPresent()) {
229 RoadmConnectionsBuilder rdmConnBldr = new RoadmConnectionsBuilder(rdmConnOpt.get());
230 rdmConnBldr.setOpticalControlMode(mode);
231 if (powerValue != null) {
232 rdmConnBldr.setTargetOutputPower(new PowerDBm(Decimal64.valueOf(powerValue)));
234 RoadmConnections newRdmConn = rdmConnBldr.build();
235 Future<Optional<DeviceTransaction>> deviceTxFuture =
236 deviceTransactionManager.getDeviceTransaction(deviceId);
237 DeviceTransaction deviceTx;
239 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
240 if (deviceTxOpt.isPresent()) {
241 deviceTx = deviceTxOpt.get();
243 LOG.error("Transaction for device {} was not found!", deviceId);
246 } catch (InterruptedException | ExecutionException e) {
247 LOG.error("Unable to get transaction for device {}!", deviceId, e);
250 // post the cross connect on the device
251 InstanceIdentifier<RoadmConnections> roadmConnIID = InstanceIdentifier
252 .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
253 .child(RoadmConnections.class, new RoadmConnectionsKey(connectionNumber))
255 deviceTx.merge(LogicalDatastoreType.CONFIGURATION, roadmConnIID, newRdmConn);
256 FluentFuture<? extends @NonNull CommitInfo> commit =
257 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
260 LOG.info("Roadm connection power level successfully set ");
262 } catch (InterruptedException | ExecutionException ex) {
263 LOG.warn("Failed to post {}", newRdmConn, ex);
266 LOG.warn("Roadm-Connection is null in set power level ({})", connectionNumber);