Storages/COM-like: Expose in Python

The port from COM was already available in DSS C-API

Author: PMeira

dss/dss_capi_gr/ICircuit.py

@@ -45,6 +45,7 @@
 from .IReactors import IReactors
 from .IParallel import IParallel
 from .IReduceCkt import IReduceCkt
+from .IStorages import IStorages
 
 class ICircuit(Base):
     __slots__ = [
@@ -89,7 +90,8 @@ class ICircuit(Base):
         'TSData',
         'Reactors',
         'Parallel',
-        'ReduceCkt'
+        'ReduceCkt',
+        'Storages'
     ]
 
     _columns = [
@@ -162,6 +164,7 @@ def __init__(self, api_util):
         self.TSData = ITSData(api_util)
         self.Reactors = IReactors(api_util)
         self.ReduceCkt = IReduceCkt(api_util) #: Circuit Reduction Interface
+        self.Storages = IStorages(api_util)
 
         if hasattr(api_util.lib, 'Parallel_CreateActor'):
             self.Parallel = IParallel(api_util)

dss/dss_capi_gr/IStorages.py

@@ -0,0 +1,56 @@
+'''
+A compatibility layer for DSS C-API that mimics the official OpenDSS COM interface.
+
+Copyright (c) 2022 Paulo Meira
+Copyright (c) 2022 DSS Extensions contributors
+'''
+from .._cffi_api_util import Iterable
+
+class IStorages(Iterable):
+    '''Storage objects'''
+    
+    __slots__ = []
+
+    _columns = [
+        'Name',
+        'idx',
+        'RegisterNames',
+        'RegisterValues',
+        'puSOC',
+        'State',
+    ]
+
+
+    @property
+    def puSOC(self):
+        '''Per unit state of charge'''
+        return self.CheckForError(self._lib.Storages_Get_puSOC())
+
+    @puSOC.setter
+    def puSOC(self, Value):
+        self.CheckForError(self._lib.Storages_Set_puSOC(Value))
+
+    @property
+    def State(self):
+        '''
+        Get/set state: 0=Idling; 1=Discharging; -1=Charging;
+
+        Related enumeration: StorageStates
+        '''
+        return self.CheckForError(self._lib.Storages_Get_State())
+
+    @State.setter
+    def State(self, Value):
+        self.CheckForError(self._lib.Storages_Set_State(Value))
+
+    @property
+    def RegisterNames(self):
+        '''Array of Names of all Storage energy meter registers'''
+        return self.CheckForError(self._get_string_array(self._lib.Storages_Get_RegisterNames))
+
+    @property
+    def RegisterValues(self):
+        '''Array of values in Storage registers.'''
+        self.CheckForError(self._lib.Storages_Get_RegisterValues_GR())
+        return self._get_float64_gr_array()
+

dss/dss_capi_ir/ICircuit.py

@@ -45,6 +45,7 @@
 from .IReactors import IReactors
 from .IParallel import IParallel
 from .IReduceCkt import IReduceCkt
+from .IStorages import IStorages
 
 class ICircuit(Base):
     __slots__ = [
@@ -89,7 +90,8 @@ class ICircuit(Base):
         'TSData',
         'Reactors',
         'Parallel',
-        'ReduceCkt'
+        'ReduceCkt',
+        'Storages'
     ]
 
     _columns = [
@@ -162,6 +164,7 @@ def __init__(self, api_util):
         self.TSData = ITSData(api_util)
         self.Reactors = IReactors(api_util)
         self.ReduceCkt = IReduceCkt(api_util) #: Circuit Reduction Interface
+        self.Storages = IStorages(api_util)
 
         if hasattr(api_util.lib, 'Parallel_CreateActor'):
             self.Parallel = IParallel(api_util)

dss/dss_capi_ir/IStorages.py

@@ -0,0 +1,55 @@
+'''
+A compatibility layer for DSS C-API that mimics the official OpenDSS COM interface.
+
+Copyright (c) 2022 Paulo Meira
+Copyright (c) 2022 DSS Extensions contributors
+'''
+from .._cffi_api_util import Iterable
+
+class IStorages(Iterable):
+    '''Storage objects'''
+    
+    __slots__ = []
+
+    _columns = [
+        'Name',
+        'idx',
+        'RegisterNames',
+        'RegisterValues',
+        'puSOC',
+        'State',
+    ]
+
+
+    @property
+    def puSOC(self):
+        '''Per unit state of charge'''
+        return self.CheckForError(self._lib.Storages_Get_puSOC())
+
+    @puSOC.setter
+    def puSOC(self, Value):
+        self.CheckForError(self._lib.Storages_Set_puSOC(Value))
+
+    @property
+    def State(self):
+        '''
+        Get/set state: 0=Idling; 1=Discharging; -1=Charging;
+
+        Related enumeration: StorageStates
+        '''
+        return self.CheckForError(self._lib.Storages_Get_State())
+
+    @State.setter
+    def State(self, Value):
+        self.CheckForError(self._lib.Storages_Set_State(Value))
+
+    @property
+    def RegisterNames(self):
+        '''Array of Names of all Storage energy meter registers'''
+        return self.CheckForError(self._get_string_array(self._lib.Storages_Get_RegisterNames))
+
+    @property
+    def RegisterValues(self):
+        '''Array of values in Storage registers.'''
+        return self._get_float64_array(self._lib.Storages_Get_RegisterValues)
+