support device class in opt payloads

Author: nostromoJohn

openleadr/client.py

@@ -586,7 +586,8 @@ async def sync_events(self):
     ###########################################################################
 
     async def create_opt(self, opt_type, opt_reason, targets, vavailability=None, event_id=None,
-                         modification_number=None, opt_id=None, request_id=None, market_context=None):
+                         modification_number=None, opt_id=None, request_id=None, market_context=None,
+                         signal_target_mrid=None):
         """
         Send a new opt to the VTN, either to communicate a temporary availability
         schedule or to qualify the resources participating in an event.
@@ -624,7 +625,8 @@ async def create_opt(self, opt_type, opt_reason, targets, vavailability=None, ev
             event_id=event_id,
             modification_number=modification_number,
             targets=targets,
-            market_context=market_context
+            market_context=market_context,
+            signal_target_mrid=signal_target_mrid
         )
         self.opts.append(opt)
 

openleadr/objects.py

@@ -346,6 +346,7 @@ class Opt:
     targets: List[Target] = None
     targets_by_type: Dict = None
     market_context: str = None
+    signal_target_mrid: str = None
 
     def __post_init__(self):
         if self.opt_type not in enums.OPT.values:
@@ -354,6 +355,9 @@ def __post_init__(self):
         if self.opt_reason not in enums.OPT_REASON.values:
             raise ValueError(f"""The opt_reason must be one of '{"', '".join(enums.OPT_REASON.values)}', """
                              f"""you specified: '{self.opt_type}'.""")
+        if self.signal_target_mrid is not None and self.signal_target_mrid not in enums.SIGNAL_TARGET_MRID.values and not self.signal_target_mrid.startswith('x-'):
+            raise ValueError(f"""The signal_target_mrid must be one of '{"', '".join(enums.SIGNAL_TARGET_MRID.values)}', """
+                             f"""you specified: '{self.signal_target_mrid}'.""")
         if self.event_id is None and self.vavailability is None:
             raise ValueError(
                 "You must supply either 'event_id' or 'vavailability'.")

openleadr/templates/oadrCreateOpt.xml

@@ -34,5 +34,12 @@
     {% for target in targets %}
     {% include 'parts/eiTarget.xml' %}
     {% endfor %}
+    {% if signal_target_mrid is defined and signal_target_mrid is not none %}
+    <oadr:oadrDeviceClass>
+				<power:endDeviceAsset>
+					<power:mrid>{{ signal_target_mrid }}</power:mrid>
+				</power:endDeviceAsset>
+		</oadr:oadrDeviceClass>
+    {% endif %}
   </oadr:oadrCreateOpt>
 </oadr:oadrSignedObject>