Skip to content

Class definition

Cpu

Bases: PviObject

representing a PVI CPU object ANSL & INA2000 : specifies a cpu SNMP : can be used but is not necessary see PVI documentation for more details

Typical usage example:

device = Device( line, 'TCP', CD='/IF=TcpIp' )
cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
task1 = Task( cpu, 'mainlogic')
Source code in pvi\Cpu.py 
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
class Cpu(PviObject):
    '''representing a PVI CPU object
    ANSL & INA2000 : specifies a cpu
    SNMP : can be used but is not necessary
    see PVI documentation for more details

    Typical usage example:
    ```
    device = Device( line, 'TCP', CD='/IF=TcpIp' )
    cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
    task1 = Task( cpu, 'mainlogic')
    ```        
    '''
    def __init__( self, parent : PviObject, name : str, **objectDescriptor : Union[str,int, float]):
        '''
        Args:
            parent : the device (or station) object  
            name : name of the CPU in PVI hierarchy  
            objectDescriptor : see PVI documentation for more details
                ANSL : e.g. CD='/IP=127.0.0.1 /COMT=2500'  
                INA2000 : e.g. CD='/DAIP=10.49.40.222'
                SNMP : ''
        '''
        if parent.type != T_POBJ_TYPE.POBJ_DEVICE and parent.type != T_POBJ_TYPE.POBJ_STATION:
            raise PviError(12009, self )                    
        super().__init__( parent, T_POBJ_TYPE.POBJ_CPU, name, **objectDescriptor) 
        self._downloaded = None
        self._progress = None  


    def __repr__(self):
        return f"Cpu( name={self._name}, linkID={self._linkID} )" 


    def _eventStatus( self, wParam, responseInfo ):
        '''         
        (internal) handle status events
        '''      
        self._result = PviXReadResponse( self._hPvi, wParam, None, 0 ) 


    def _eventDownloadStream( self, wParam, responseInfo : T_RESPONSE_INFO): 
        '''
        (internal) handle stream download
        '''   
        self._result = PviXWriteResponse( self._hPvi, wParam )
        if self._result == 0:
            if self._downloaded:
                sig = inspect.signature(self._downloaded)
                if len(sig.parameters) == 0:
                    self._downloaded()
                elif len(sig.parameters) == 1:
                    self._downloaded(self)
        else:
            raise PviError(self._result, self)      


    def _eventProceeding( self, wParam, responseInfo : T_RESPONSE_INFO ):    
        proceedingInfo = T_PROCEEDING_INFO()
        self._result = PviXReadResponse( self._hPvi, wParam, byref(proceedingInfo), sizeof(proceedingInfo) )
        if self._result == 0:
            if self._progress:
                sig = inspect.signature(self._progress)
                if len(sig.parameters) == 1:
                    self._progress(int(proceedingInfo.Percent))
                elif len(sig.parameters) == 2:
                    self._progress(self, int(proceedingInfo.Percent))                    
        else:
            raise PviError(self._result, self)   


    def warmStart(self) -> None:
        '''
        executes a warm restart
        '''
        self.status = "WarmStart"


    def coldStart(self) -> None:
        '''
        executes a cold restart
        '''        
        self.status = "ColdStart"


    def stopTarget(self) -> None:
        '''
        executes a SERV stop
        '''        
        self.status = "Reset"


    def diagnostics(self) -> None:
        '''
        executes a DIAG stop
        '''        
        self.status = "Diagnose"


    def downloadModule(self, data : bytes, **kwargs )->None:
        '''
        download given bytes as module

        Args:
            data : bytes  - data content
            kwargs : 
                MT - module type e.g. 'BRT'
                MN - module name
                MV - module version
                LD - memory type e.g. 'Ram', 'Dram', 'Rom'
                downloaded - callback() or callback(Cpu) if module was downloaded
                progress - callback(p) or callback (Cpu, p) to show progress
        '''
        currentFrame = inspect.currentframe()
        currentFunctionName = ''
        if currentFrame:
            currentFunctionName = currentFrame.f_code.co_name

        if not(isinstance(data, bytes)):
            raise TypeError(currentFunctionName + " - data: only bytes accepted !")
        if 'MT' not in kwargs:
            kwargs.update( { 'MT' : 'BRT' } )
        if 'MN' not in kwargs:
            raise KeyError( currentFunctionName + " - argument 'MN' is missing !")

        arguments = ''
        for key, value in kwargs.items():
            if key == 'downloaded':
                if callable(value):
                    self._downloaded = value
                else:
                    raise TypeError("only type function for argument 'downloaded' allowed !")
            elif key == 'progress':
                if callable(value):
                    self._progress = value
                else:
                    raise TypeError("only type function for argument 'progress' allowed !")
            else:
                arguments += f"{key}={value} "
        s = create_string_buffer(bytes(arguments,'ascii') + b'\0' + bytes(data) )            
        self._result = PviXWriteRequest( self._hPvi, self._linkID, POBJ_ACC_DOWNLOAD_STM, byref(s), sizeof(s), PVI_HMSG_NIL, SET_PVIFUNCTION, 0)
        if self._result:
            raise PviError( self._result, self )


    @property
    def modules(self)->List[str]:
        """    
        list of all modules on this CPU

        example:

        ```
        cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
        ...
        print("cpu.modules=", cpu.modules)
        ```

        results in:

        ```
        cpu.modules= ['$$sysconf', '$arlogsys', '$arlogusr', '$fieldbus',
                    ..... 'visTrend', 'visapi', 'visvc']
        ```
        """
        s = create_string_buffer(b'\000' * 4096)   
        self._result = PviXRead( self._hPvi, self._linkID, POBJ_ACC_LIST_MODULE, None, 0, byref(s), sizeof(s) )
        if self._result == 0:
            s = str(s, 'ascii').rstrip('\x00')
            return s.split('\t')
        else:
            raise PviError(self._result, self)


    @property
    def tasks(self)->List[str]:
        '''     
        get a list of all tasks

        example:

        ```
        cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
        ...
        print("cpu.tasks=", cpu.tasks)
        ```

        results in:

        ```
        cpu.tasks= ['brewing', 'conveyor', 'feeder', 'heating', 'mainlogic', 'myProg', 'visAlarm', 'visCtrl', 'visTrend']
        ```
        '''
        s = create_string_buffer(b'\000' * 4096)   
        self._result = PviXRead( self._hPvi, self._linkID, POBJ_ACC_LIST_TASK, None, 0, byref(s), sizeof(s) )
        if self._result == 0:
            s = str(s, 'ascii').rstrip('\x00')
            return s.split('\t')
        else:
            raise PviError(self._result, self)


    @property
    def variables(self)->List[str]:
        '''     
        get a list of global variables

        example:
        ```
        cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
        ...
        print("cpu.variables=", cpu.variables)
        ```

        results in:

        ```
        cpu.variables= ['LCRPID_D_MODE_X', 'LCRPID_FBK_MODE_INTERN', 'LCRPID_MODE_AUTO', 'LCRPID_MODE_CLOSE', 'aoHeating', 
                ...... 'sdm_APPMODE_ERROR', 'sdm_APPMODE_OK', 'sdm_APPMODE_WARNING']
        ```
        '''
        s = create_string_buffer(b'\000' * 65536)   
        self._result = PviXRead( self._hPvi, self._linkID, POBJ_ACC_LIST_PVAR, None, 0, byref(s), sizeof(s) )
        if( self._result == 0 ):
            s = str(s, 'ascii').rstrip('\x00')
            variables = [v.split(' ')[0] for v in s.split('\t')]
            return variables
        else:
            raise PviError(self._result, self)


    @property       
    def status(self) -> dict:
        """
        read the CPU status
         example:

        ```
        cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
        ...
        print("status=", cpu.status )
        ```

        results in:

        ```
        cpu.status= {'ST': 'WarmStart', 'RunState': 'RUN'}
        ```

        possible values of 'ST' are: 'WarmStart', 'ColdStart', 'Diagnose', 'Error', 'Reset' and '<unknown>'
        possible values of 'RunState' are: 'RUN', 'DIAG', 'SERV'

        """    
        st = super().status
        runState = { "WarmStart" : "RUN", "ColdStart" : "RUN", "Diagnose" : "DIAG", "Error" : "SERV", "Reset" : "SERV"}.get(st.get("ST", "<unknown>"))
        st.update({"RunState" : runState})
        return st


    @status.setter
    def status(self, status : str ):
        '''
        sets the CPU status
        '''        
        s = create_string_buffer(b"ST=" + status.encode())
        self._result = PviXWrite( self._hPvi, self._linkID, POBJ_ACC_STATUS, byref(s), sizeof(s), None, 0 )
        if self._result != 0:
            raise PviError(self._result, self)


    @property       
    def cpuInfo(self) -> dict:
        """
        Returns:
            dict with memory information

        example:
        ```
        ```

        """    
        s = create_string_buffer(b'\000' * 1024)             
        self._result = PviXRead( self._hPvi, self._linkID, POBJ_ACC_CPU_INFO  , None, 0, byref(s), sizeof(s) )     
        if self._result == 0:
            s = str(s, 'ascii').rstrip('\x00')
            ret = dict()
            ret.update( dictFromParameterPairString(s)  )
            return ret          
        else:
            raise PviError(self._result, self)     


    @property
    def time(self) -> datetime.datetime:
        """
        Returns:
            datetime : CPU's current clock time

        example:

        ```
        cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
        ...
        print("cpu.time=", cpu.time)
        ```

        results in:

        ```
        cpu.time= 2023-11-09 13:44:02
        ```
        """
        t = struct_tm()       
        self._result = PviXRead( self._hPvi, self._linkID, POBJ_ACC_DATE_TIME , None, 0, byref(t), sizeof(t) )
        if self._result == 0:
            try:
                time =  datetime.datetime( year = t.tm_year+1900, month = t.tm_mon+1, day=t.tm_mday, hour=t.tm_hour, minute = t.tm_min, second = t.tm_sec)
            except ValueError:
                time = datetime.datetime( year = 1970, month = 1, day = 1 )            
            return time            
        else:
            raise PviError(self._result, self)


    @time.setter
    def time(self, time : datetime.datetime):
        '''
        sets the CPU time
        '''        
        t = struct_tm()
        t.tm_year = time.year - 1900
        t.tm_mon = time.month - 1
        t.tm_mday = time.day
        t.tm_hour = time.hour
        t.tm_min = time.minute
        t.tm_sec = time.second
        self._result = PviXWrite( self._hPvi, self._linkID, POBJ_ACC_DATE_TIME, byref(t), sizeof(t), None, 0 )
        if self._result != 0:
            raise PviError(self._result, self)

cpuInfo: dict property

Returns:

Type Description
dict

dict with memory information

example:

descriptor: dict property

object descriptor example:

temperature = Variable( task1, 'gHeating.status.actTemp' )
...
print( "descriptor=", temperature.name)

results in:

descriptor= {'CD': 'gHeating.status.actTemp', 'RF': 0}

errorChanged: Callable property writable

callback for 'error changed'

It is advisable to always check the error status '0' before accessing an object.

Args:
    cb: callback( PviObject, int ) or callback( int )

typical example:

cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
...
def cpuErrorChanged( error : int ):
    if error != 0:
        raise PviError(error)

cpu.errorChanged = cpuErrorChanged

externalObjects property

PviObject.externalObjects : list of dict get a list of external objects retrieved by POBJ_ACC_LIST_EXTERN

only available with ANSL, not with INA2000

example:

cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
...
print("external objects", cpu.externalObjects )

results in:

external objects [{'name': '$$sysconf', 'type': 'Module'}, {'name': '$arlogsys', 'type': 'Module'}
            ...... name': 'visvc', 'type': 'Module'}]

modules: List[str] property

list of all modules on this CPU

example:

cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
...
print("cpu.modules=", cpu.modules)

results in:

cpu.modules= ['$$sysconf', '$arlogsys', '$arlogusr', '$fieldbus',
            ..... 'visTrend', 'visapi', 'visvc']

name: str property

hierarchical PVI object name

example:

name= @Pvi/LNANSL/TCP/myArsim/mainlogic/gHeating.status.actTemp

objectName: str property

object name

example:

temperature = Variable( task1, 'gHeating.status.actTemp' )
...
print( "oname=", temperature.name)

results in:

oname= gHeating.status.actTemp

status: dict property writable

read the CPU status example:

cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
...
print("status=", cpu.status )

results in:

cpu.status= {'ST': 'WarmStart', 'RunState': 'RUN'}

possible values of 'ST' are: 'WarmStart', 'ColdStart', 'Diagnose', 'Error', 'Reset' and '' possible values of 'RunState' are: 'RUN', 'DIAG', 'SERV'

tasks: List[str] property

get a list of all tasks

example:

cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
...
print("cpu.tasks=", cpu.tasks)

results in:

cpu.tasks= ['brewing', 'conveyor', 'feeder', 'heating', 'mainlogic', 'myProg', 'visAlarm', 'visCtrl', 'visTrend']

time: datetime.datetime property writable

Returns:

Name Type Description
datetime datetime

CPU's current clock time

example:

cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
...
print("cpu.time=", cpu.time)

results in:

cpu.time= 2023-11-09 13:44:02

type: T_POBJ_TYPE property

object type

example:

temperature = Variable( task1, 'gHeating.status.actTemp' )
...
print( "type=", temperature.type)

results in:

type= T_POBJ_TYPE.POBJ_PVAR

variables: List[str] property

get a list of global variables

example:

cpu = Cpu( device, 'myArsim', CD='/IP=127.0.0.1' )
...
print("cpu.variables=", cpu.variables)

results in:

cpu.variables= ['LCRPID_D_MODE_X', 'LCRPID_FBK_MODE_INTERN', 'LCRPID_MODE_AUTO', 'LCRPID_MODE_CLOSE', 'aoHeating', 
        ...... 'sdm_APPMODE_ERROR', 'sdm_APPMODE_OK', 'sdm_APPMODE_WARNING']

__init__(parent, name, **objectDescriptor)

Parameters:

Name Type Description Default
parent

the device (or station) object

required
name

name of the CPU in PVI hierarchy

required
objectDescriptor

see PVI documentation for more details ANSL : e.g. CD='/IP=127.0.0.1 /COMT=2500'
INA2000 : e.g. CD='/DAIP=10.49.40.222' SNMP : ''

 {}
Source code in pvi\Cpu.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def __init__( self, parent : PviObject, name : str, **objectDescriptor : Union[str,int, float]):
    '''
    Args:
        parent : the device (or station) object  
        name : name of the CPU in PVI hierarchy  
        objectDescriptor : see PVI documentation for more details
            ANSL : e.g. CD='/IP=127.0.0.1 /COMT=2500'  
            INA2000 : e.g. CD='/DAIP=10.49.40.222'
            SNMP : ''
    '''
    if parent.type != T_POBJ_TYPE.POBJ_DEVICE and parent.type != T_POBJ_TYPE.POBJ_STATION:
        raise PviError(12009, self )                    
    super().__init__( parent, T_POBJ_TYPE.POBJ_CPU, name, **objectDescriptor) 
    self._downloaded = None
    self._progress = None

coldStart()

executes a cold restart

Source code in pvi\Cpu.py 
111
112
113
114
115
def coldStart(self) -> None:
    '''
    executes a cold restart
    '''        
    self.status = "ColdStart"

diagnostics()

executes a DIAG stop

Source code in pvi\Cpu.py 
125
126
127
128
129
def diagnostics(self) -> None:
    '''
    executes a DIAG stop
    '''        
    self.status = "Diagnose"

downloadModule(data, **kwargs)

download given bytes as module

Parameters:

Name Type Description Default
data

bytes - data content

 required
kwargs

MT - module type e.g. 'BRT' MN - module name MV - module version LD - memory type e.g. 'Ram', 'Dram', 'Rom' downloaded - callback() or callback(Cpu) if module was downloaded progress - callback(p) or callback (Cpu, p) to show progress

 {}
Source code in pvi\Cpu.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
def downloadModule(self, data : bytes, **kwargs )->None:
    '''
    download given bytes as module

    Args:
        data : bytes  - data content
        kwargs : 
            MT - module type e.g. 'BRT'
            MN - module name
            MV - module version
            LD - memory type e.g. 'Ram', 'Dram', 'Rom'
            downloaded - callback() or callback(Cpu) if module was downloaded
            progress - callback(p) or callback (Cpu, p) to show progress
    '''
    currentFrame = inspect.currentframe()
    currentFunctionName = ''
    if currentFrame:
        currentFunctionName = currentFrame.f_code.co_name

    if not(isinstance(data, bytes)):
        raise TypeError(currentFunctionName + " - data: only bytes accepted !")
    if 'MT' not in kwargs:
        kwargs.update( { 'MT' : 'BRT' } )
    if 'MN' not in kwargs:
        raise KeyError( currentFunctionName + " - argument 'MN' is missing !")

    arguments = ''
    for key, value in kwargs.items():
        if key == 'downloaded':
            if callable(value):
                self._downloaded = value
            else:
                raise TypeError("only type function for argument 'downloaded' allowed !")
        elif key == 'progress':
            if callable(value):
                self._progress = value
            else:
                raise TypeError("only type function for argument 'progress' allowed !")
        else:
            arguments += f"{key}={value} "
    s = create_string_buffer(bytes(arguments,'ascii') + b'\0' + bytes(data) )            
    self._result = PviXWriteRequest( self._hPvi, self._linkID, POBJ_ACC_DOWNLOAD_STM, byref(s), sizeof(s), PVI_HMSG_NIL, SET_PVIFUNCTION, 0)
    if self._result:
        raise PviError( self._result, self )

kill()

PviObject.kill: kills this object this should be called when object is not beeing used anymore to save PVI resources

Source code in pvi\Object.py 
468
469
470
471
472
473
474
475
476
477
478
479
480
481
def kill(self):
    '''
    PviObject.kill: kills this object
    this should be called when object is not beeing used anymore
    to save PVI resources
    '''
    if self._linkID != 0 and self._connection != None:

        self._connection._linkIDs.pop(self._linkID) # remove from linkIDs
        self._connection._pviObjects.remove(self) # remove from PviObjects
        self._result = PviXUnlink(self._hPvi, self._linkID)
        self._linkID = 0
        if self._result != 0 and self._result != 12045:
            raise PviError(self._result, self)

stopTarget()

executes a SERV stop

Source code in pvi\Cpu.py 
118
119
120
121
122
def stopTarget(self) -> None:
    '''
    executes a SERV stop
    '''        
    self.status = "Reset"

warmStart()

executes a warm restart

Source code in pvi\Cpu.py 
104
105
106
107
108
def warmStart(self) -> None:
    '''
    executes a warm restart
    '''
    self.status = "WarmStart"