Opto MMP Toolkit
 All Classes Functions Variables
O22STRCT.h
1 //-----------------------------------------------------------------------------
2 //
3 // O22STRCT.h
4 // Copyright (c) 1999-2004 by Opto 22
5 //
6 //
7 // This is a support file for "O22SIOMM.H" and its class, O22SnapIoMemMap.
8 // It is seperated from "O22SIOMM.H" because this file is also used in
9 // "OptoSnapIoMemMapX.idl" for the definition of the OptoSnapIoMemMapX ActiveX
10 // component. It should not be modified without consideration to the ActiveX
11 // requirements of an OLE Automation interface.
12 //
13 // Most of the structures in this file map directly or closely to areas
14 // of the I/O unit's memory map.
15 //-----------------------------------------------------------------------------
16 
17 
18 #ifndef __O22STRCT_H
19 #define __O22STRCT_H
20 
27 typedef struct SIOMM_DigBankReadArea
28 {
38 
45 typedef struct SIOMM_DigPointReadArea
46 {
47  int nState;
48  int nOnLatch;
49  int nOffLatch;
51  int nCounts;
53 
54 
61 typedef struct SIOMM_AnaPointReadArea
62 {
63  float fValue;
64  float fCounts;
65  float fMinValue;
66  float fMaxValue;
67  short nRawCounts;
69 
70 
74 typedef struct SIOMM_AnaBank
75 {
76  float fValue[64];
78 
82 typedef struct SIOMM_AnaBanks
83 {
89 
90 
98 typedef struct SIOMM_PointConfigArea4
99 {
102  int nFeature;
103  float fOffset;
104  float fGain;
105  float fHiScale;
106  float fLoScale;
110  unsigned char byName[51];
112 
113 // TODO: SIOMM4096_PointConfigArea2 originally appeared as its own definition, but was
114 // identical to SIOMM_PointConfigArea4. I've collapsed it down to a simple typedef, but
115 // that might break something in the ActiveX building stuff. Need to test it.
117 
126 {
129  int nFeature;
130  float fOffset;
131  float fGain;
132  float fHiScale;
133  float fLoScale;
137  unsigned char byName[16];
138  float fHiClamp;
139  float fLoClamp;
141 
142 
151 {
152  int nModuleType;
154  int nFeature;
155  float fOffset;
156  float fGain;
157  float fHiScale;
158  float fLoScale;
162  unsigned char byName[16];
164 
172 typedef struct SIOMM_PointConfigArea
173 {
174  int nModuleType;
176  int nFeature;
177  float fOffset;
178  float fGain;
179  float fHiScale;
180  float fLoScale;
184 
186 {
187  float fGain;
188  float fTuneI;
189  float fTuneD;
190  float fTuneFF;
191  float fFeedForward;
192 
193  float fInRangeLo;
194  float fInRangeHi;
195  float fOutClampLo;
196  float fOutClampHi;
199 
200  float fScanSec;
201 
202  float fOutWhenInLo;
203  float fOutWhenInHi;
204 
209  int nManual;
210  int nCfgFlags;
212 
213 typedef struct SIOMM_TpoConfigArea
214 {
215  float fPercent;
216  float fPeriod;
217  float fDelaySec;
218  int nPulseQty;
219  int nCfgWord;
220  int nOutputMemMap;
221  int nOutputMask;
222  int nOutputMemMapOff;
224 
225 typedef struct SIOMM_MOMO
226 {
227  int nOn63to32;
228  int nOn31to0;
229  int nOff63to32;
230  int nOff31to0;
232 
234 {
235  int nState;
247  int nPriority;
248  // 1 DWORD reserved
251  unsigned char byMessage[128];
253 
254 
256 {
265 
275 
276 
277 
279 {
291  float fHiAlarmLimitDeadband;
299  float fLoAlarmLimitDeadband;
305  int nIsFloat;
306  // BYTE Pad[0x18];
308 
310 {
312  // int nUnused; // expansion space for bit mask, in case we ever support more ports (up to 64)
313  int nTrapType;
315  unsigned char byPattern[40];
316  unsigned char byReplace[40];
323 
324 
326 {
344  // int reserved;
346  int nState;
348 
349 
350 typedef struct SIOMM_StatusVersion
351 {
352  int nMapVer; // Memory map version
353  int nLoaderVersion; // Loader version (1.2.3.4 format)
354  int nKernelVersion; // Kernel version (1.2.3.4 format)
356 
357 
358 typedef struct SIOMM_StatusHardware2
359 {
360  int nIoUnitType; // I/O unit type
361  unsigned char byHwdVerMonth; // hardware version (month)
362  unsigned char byHwdVerDay; // hardware version (day)
363  short wHwdVerYear; // hardware version (4 digit year)
364  int nRamSize; // bytes of installed RAM
365  unsigned char byPartNumber[32]; // part number as a string
367 
368 typedef struct SIOMM_StatusHardware
369 {
370  int nIoUnitType; // I/O unit type
371  unsigned char byHwdVerMonth; // hardware version (month)
372  unsigned char byHwdVerDay; // hardware version (day)
373  short wHwdVerYear; // hardware version (4 digit year)
374  int nRamSize; // bytes of installed RAM
376 
377 
378 typedef struct SIOMM_StatusNetwork2
379 {
380  short wMACAddress0; // MAC address
381  short wMACAddress1; // MAC address
382  short wMACAddress2; // MAC address
383  int nTCPIPAddress; // IP address
384  int nSubnetMask; // subnet mask
385  int nDefGateway; // default gateway
386  int nTcpIpMinRtoMS; // TCP/IP minimum Response Timeout (RTO)
387  // in milliseconds
388  int nInitialRtoMS; // initial RTO
389  int nTcpRetries; // number of TCP retries
390  int nTcpIdleTimeout; // TCP idle session timeout
391  int nEnetLateCol; // Ethernet late collisions
392  int nEnetExcessiveCol; // Ethernet excessive collisions
393  int nEnetOtherErrors; // Other Ethernet errors
395 
396 typedef struct SIOMM_StatusNetwork
397 {
398  short wMACAddress0; // MAC address
399  short wMACAddress1; // MAC address
400  short wMACAddress2; // MAC address
401  int nTCPIPAddress; // IP address
402  int nSubnetMask; // subnet mask
403  int nDefGateway; // default gateway
405 
406 typedef struct SIOMM_StatusWrite
407 {
408  int nBootpAlways; //
409  int nDegreesFC; //
410  int nReserved1; //
411  int nWatchdogTimeMS; //
412  int nTcpIpMinRto; //
413  int nTcpIpInitRto; //
414  int nTcpIpRetries; //
415  int nTcpIpIdleTimeoutMS; //
416  int nReserved2[10]; //
417  int nDigMaxScanMS; //
418  int nAnaMaxScanMS; //
419  // int byReserved3[64]; //
421 
423 {
424  int nIpPort; // READ ONLY
425  int nBaudRate; // baud rate
426  unsigned char byParity; // parity
427  unsigned char byDataBits; // data bits (7 or 8)
428  unsigned char byStopBits; // stop bits (1 or 2)
429  unsigned char byTestMessage; // bool for sending a powerup test msg
430  unsigned char byEOM1; // first end-of-message character
431  unsigned char byEOM2; // second end-of-message character
432  unsigned char byEOM3; // third end-of-message character
433  unsigned char byEOM4; // fourth end-of-message character
435 
436 
438 // Be careful when making changes to this structure!
439 {
440  // The first three variables map directly to a custom UDP stream packet.
441  int nHeader; // See below for info
442  int nMemMapAddress; // Memory address of custom stream area.
443  unsigned char byData[2034]; // Max data size of 2034
444  int nTCPIPAddress; // The source IP address
446 
448 {
449  int nHeader;
450 
451  // The following items map directly to the standard stream data
452  float fAnalogValue[64];
462  unsigned char byReserved[56];
463 
465 
466  // Be careful when making changes to this structure!
467 
468  /*
469  short wMonth;
470  short wDay;
471  short wYear;
472  short wHour;
473  short wMinute;
474  short wSecond;
475  short wMillisecond;
476  */
478 
479 
481 // Scratch Pad area
482 //
483 
485 {
486  int nValue[256];
488 
490 {
491  float fValue[256];
493 
495 {
496  short wLength;
497  unsigned char byString[128];
499 
501 {
502  int nValue[2048];
504 
505 // The following structures are for the ActiveX component
506 #ifdef __midl
507 typedef struct SIOMM_ScratchPadStringX
508 {
509  short wLength;
510  unsigned char byString[128];
511  BSTR bstrString;
512 } O22_SIOMM_ScratchPadStringX;
513 
514 typedef struct SIOMM_ScratchPadStringBlock
515 {
516  O22_SIOMM_ScratchPadStringX String[8];
517 } O22_SIOMM_ScratchPadStringBlock;
518 #endif
519 
520 typedef struct SIOMM_RTC_DATE_TIME
521 {
522  short wYear;
523  unsigned char byMonth;
524  unsigned char byDay;
525  unsigned char byHours;
526  unsigned char byMinutes;
527  unsigned char bySeconds;
528  unsigned char byHSeconds;
530 
531 
532 typedef struct SIOMM_DataLogSample
533 {
535  int nMemMap;
536  int nFormat;
537 
538  union
539  {
540  int nInteger;
541  float fFloat;
542  int nBitmask;
543  } unData;
544 
546 
547 #endif // __O22STRCT_H
float fScanSec
PID scan time in seconds. Minimum value is 0.001 (1 millisecond)
Definition: O22STRCT.h:200
int nEventScratchOff63to32
Scratchpad off bits to watch (bits 32-63)
Definition: O22STRCT.h:263
float fLoScale
Read/Write. Only used for analog points
Definition: O22STRCT.h:158
Definition: O22STRCT.h:82
float fOutClampHi
Upper bound to clamp output to.
Definition: O22STRCT.h:196
unsigned char bySeconds
Seconds.
Definition: O22STRCT.h:527
Definition: O22STRCT.h:309
float fValue[64]
Generic array of floating point values, used in SIOMM_AnaBanks.
Definition: O22STRCT.h:76
int nDeviationScratchOn31to0
Scratchpad bits to turn on in reaction to a deviation alarm (bits 0-31)
Definition: O22STRCT.h:285
float fTuneD
Tuning constant, Derivative.
Definition: O22STRCT.h:189
float fTuneI
Tuning constant, Integral. Reset rate in units of 1/min.
Definition: O22STRCT.h:188
float fOffset
Only used for analog points.
Definition: O22STRCT.h:130
int nHiAlarmScratchOn63to32
Scratchpad bits to turn on in reaction to a high alarm (bits 32-63)
Definition: O22STRCT.h:292
int nScratchOff63to32
Bitmask showing which scratchpad bits are turned off (bits 32-63)
Definition: O22STRCT.h:238
float fOffset
Read/Write. Only used for analog points.
Definition: O22STRCT.h:103
Definition: O22STRCT.h:396
int nScratchOn31to0
Bitmask showing which scratchpad bits are turned on (bits 0-31)
Definition: O22STRCT.h:237
int nReactionDigitalOn31to0
Digital points to turn on in reaction to triggered event (points 0-31)
Definition: O22STRCT.h:267
Definition: O22STRCT.h:325
int nEventDigitalOn31to0
Digital point states to watch as a bitmask (points 0-31)
Definition: O22STRCT.h:258
int nState
0=off, 1=on, 2=Timer is ticking
Definition: O22STRCT.h:346
int nScratchOn63to32
Bitmask showing which scratchpad bits are turned on (bits 32-63)
Definition: O22STRCT.h:236
int nOnLatchStatePts31to0
On-latch state for digital points 0-31 Does not include high density digital points.
Definition: O22STRCT.h:457
int nOnLatchStatePts63to32
On-latch state for digital points 32-63. Does not include high density digital points.
Definition: O22STRCT.h:456
int nEventScratchOff31to0
Scratchpad off bits to watch (bits 0-31)
Definition: O22STRCT.h:264
unsigned char byMinutes
Minutes.
Definition: O22STRCT.h:526
Definition: O22STRCT.h:125
int nLoAlarmEnabled
Enable low alarm. (Boolean)
Definition: O22STRCT.h:297
int nTrapType
SNMP trap type. Only used if sending an SNMP trap as a reaction to the serial event.
Definition: O22STRCT.h:313
float fLoScale
Read/Write. Only used for analog points.
Definition: O22STRCT.h:106
float fInRangeLo
Lower bound on the valid range for input.
Definition: O22STRCT.h:193
Definition: O22STRCT.h:437
unsigned char byName[16]
Only used for analog points.
Definition: O22STRCT.h:137
Definition: O22STRCT.h:500
int nScratchOut_Off63to32
Mask of scratchpad bits to be set OFF when the timer expires, bits 32-63.
Definition: O22STRCT.h:341
int nDigitalOut_On63to32
Mask of digital points to be set ON when the timer expires, points 32-63.
Definition: O22STRCT.h:335
int nReactionScratchOff31to0
Scratchpad bits to turn on in reaction to triggered event (bits 0-31)
Definition: O22STRCT.h:273
Definition: O22STRCT.h:489
int nInteger
Sample value as an integer.
Definition: O22STRCT.h:540
int nManual
Manual mode. 1 = Yes, 0 = No.
Definition: O22STRCT.h:209
int nScratchOff63to32
Scratchpad bits to turn off in reaction to the event (bits 32-63)
Definition: O22STRCT.h:319
int nScratchOut_On63to32
Mask of scratchpad bits to be set ON when the timer expires, bits 32-63.
Definition: O22STRCT.h:339
int nOffLatch
Boolean state of the point's off latch.
Definition: O22STRCT.h:49
Definition: O22STRCT.h:494
int nScratchIn_Off63to32
Mask of scratch pad bits that will start the timer when they're set OFF, bits 32-63.
Definition: O22STRCT.h:333
int nScratchOff31to0
Bitmask showing which scratchpad bits are turned on (bits 0-31)
Definition: O22STRCT.h:239
int nSerialStreamPeriod
Serial stream period in seconds. 0 = send once, maximum = 604800.
Definition: O22STRCT.h:250
Definition: O22STRCT.h:484
int nCfgFlags
Configuration flags(see Appendix A - PID Configuration and Status - Read/Write of the OptoMMP Protoco...
Definition: O22STRCT.h:210
int nEventScratchOn31to0
Scratchpad on bits to watch (bits 0-31)
Definition: O22STRCT.h:262
int nLoAlarmScratchOn63to32
Scratchpad bits to turn on in reaction to a low alarm (bits 32-63)
Definition: O22STRCT.h:300
int nFormat
Data format (66 for float, 64 for signed integer, 78 for unsigned integer)
Definition: O22STRCT.h:536
float fWatchdogValue
Read/Write. Only used for analog points
Definition: O22STRCT.h:160
float fMinValue
Lowest value recorded by the point since the last time it was cleared.
Definition: O22STRCT.h:65
int nHiAlarmScratchOn31to0
Scratchpad bits to turn on in reaction to a high alarm (bits 0-31)
Definition: O22STRCT.h:293
float fOutWhenInHi
The output value when the input is high.
Definition: O22STRCT.h:203
int nIsFloat
Is value a float? 1 for yes, 0 for no.
Definition: O22STRCT.h:305
unsigned char byDay
Day of the month.
Definition: O22STRCT.h:524
float fDeviationAmount
Deviation alarm, current deviation amount.
Definition: O22STRCT.h:283
float fGain
Read/Write. Only used for analog points
Definition: O22STRCT.h:178
int nHiAlarmScratchOff31to0
Scratchpad bits to turn off in reaction to a high alarm (bits 0-31)
Definition: O22STRCT.h:295
int nEventDigitalOn63to32
Digital point states to watch as a bitmask (points 32-63)
Definition: O22STRCT.h:257
Definition: O22STRCT.h:422
float fOutClampLo
Lower bound to clamp output to.
Definition: O22STRCT.h:195
Definition: O22STRCT.h:520
Definition: O22STRCT.h:213
struct SIOMM_AnaBank Values
Current values (in engineering units) of all analog points.
Definition: O22STRCT.h:84
Definition: O22STRCT.h:172
int nReactionDigitalOff63to32
Digital points to turn off in reaction to triggered event (points 32-63)
Definition: O22STRCT.h:268
int nPointType
Read only.
Definition: O22STRCT.h:175
float fFilterWeight
Only used for analog points.
Definition: O22STRCT.h:134
int nScratchIn_On31to0
Mask of scratch pad bits that will start the timer when they're set ON, bits 0-31.
Definition: O22STRCT.h:332
int nDigitalOut_Off31to0
Mask of digital points to be set OFF when the timer expires, points 0-31.
Definition: O22STRCT.h:338
int nStatePts63to32
On/off state for digital points 32-63. Does not include high density digital points.
Definition: O22STRCT.h:454
float fHiScale
Read/Write. Only used for analog points
Definition: O22STRCT.h:179
float fTuneFF
Tuning constant, Feed Forward.
Definition: O22STRCT.h:190
int nActiveCountersPts31to0
On/off state of counters for digital points 0-31. Does not include high density digital points...
Definition: O22STRCT.h:461
int nWatchdogEnabled
Read/Write
Definition: O22STRCT.h:161
float fFeedForward
Bias or FeedForward.
Definition: O22STRCT.h:191
float fLoAlarmLimit
Low alarm setpoint: values lower than this will trigger the alarm.
Definition: O22STRCT.h:298
float fLoScale
Read/Write. Only used for analog points
Definition: O22STRCT.h:180
unsigned char byName[51]
Read/Write.
Definition: O22STRCT.h:110
int nLoAlarmScratchOff63to32
Scratchpad bits to turn off in reaction to a high alarm (bits 32-63)
Definition: O22STRCT.h:302
Definition: O22STRCT.h:350
int nSnmpSpecificType
SNMP trap type.
Definition: O22STRCT.h:246
int nHiAlarmInAlarm
High alarm state: non-zero if the alarm is currently triggered.
Definition: O22STRCT.h:288
int nPresetMsec
Length of the timer delay, in milliseconds.
Definition: O22STRCT.h:343
short wYear
Year (e.g. 2013)
Definition: O22STRCT.h:522
int nDigitalIn_Off63to32
Mask of digital points that will start the timer when they're set OFF, points 32-63.
Definition: O22STRCT.h:329
int nReactionDigitalOff31to0
Digital points to turn off in reaction to triggered event (points 0-31)
Definition: O22STRCT.h:269
int nLoAlarmInAlarm
Low alarm state: non-zero if the alarm is currently triggered.
Definition: O22STRCT.h:296
int nRemainingMsec
Time remaining until the timer expires, in milliseconds.
Definition: O22STRCT.h:345
int nOffLatchStatePts31to0
Off-latch state for digital points 0-31. Does not include high density digital points.
Definition: O22STRCT.h:459
int nSerialPortsMask
Serial port mask. Bits 0-31 correspond to ports 0-31. On bits represent serial ports to monitor for t...
Definition: O22STRCT.h:311
int nState
Current message state: Inactive/Active/Acknowledged.
Definition: O22STRCT.h:235
struct SIOMM_AnaBank MaxValues
Maximum recorded values of all analog points.
Definition: O22STRCT.h:87
int nTCPIPAddress
The source IP address.
Definition: O22STRCT.h:464
int nSnmpStreamPeriod
SNMP trap period in seconds. 0 = send once, maximum = 604800.
Definition: O22STRCT.h:245
int nDeviationScratchOn63to32
Scratchpad bits to turn on in reaction to a deviation alarm (bits 32-63)
Definition: O22STRCT.h:284
int nEventDigitalOff31to0
Digital point states to watch as a bitmask (points 0-31)
Definition: O22STRCT.h:260
int nScratchIn_Off31to0
Mask of scratch pad bits that will start the timer when they're set OFF, bits 0-31.
Definition: O22STRCT.h:334
float fAnalogValue[64]
Analog engineering units data for 64 points.
Definition: O22STRCT.h:452
float fOutMaxChange
Maximum change for the output.
Definition: O22STRCT.h:197
float fGain
Read/Write. Only used for analog points
Definition: O22STRCT.h:156
Definition: O22STRCT.h:225
int nFeature
Read/Write
Definition: O22STRCT.h:154
int nPointType
Read/Write.
Definition: O22STRCT.h:101
int nReactionScratchOn31to0
Scratchpad bits to turn on in reaction to triggered event (bits 0-31)
Definition: O22STRCT.h:271
int nScratchOn63to32
Scratchpad bits to turn on in reaction to the event (bits 32-63)
Definition: O22STRCT.h:317
int nInputMemMap
The memory map address of the input for this PID loop for cascading PIDs, or 0 if input will be writt...
Definition: O22STRCT.h:205
int nStatePts31to0
On/off state for digital points 0-31. Does not include high density digital points.
Definition: O22STRCT.h:455
Definition: O22STRCT.h:358
int nOnLatchStatePts31to0
Current on-latch state of points 0 through 31 as a bitmask.
Definition: O22STRCT.h:32
int nOffLatchStatePts63to32
Current off-latch state of points 32 through 63 as a bitmask.
Definition: O22STRCT.h:33
int nCounterState
Whether or not the point's counter is active.
Definition: O22STRCT.h:50
int nEventDigitalOff63to32
Digital point states to watch as a bitmask (points 32-63)
Definition: O22STRCT.h:259
float fOutMinChange
Minimum change for the output.
Definition: O22STRCT.h:198
struct SIOMM_AnaBank Counts
Current counts of all analog points.
Definition: O22STRCT.h:85
int nScratchOut_On31to0
Mask of scratchpad bits to be set ON when the timer expires, bits 0-31.
Definition: O22STRCT.h:340
Definition: O22STRCT.h:406
Definition: O22STRCT.h:27
unsigned char byName[16]
Read/Write
Definition: O22STRCT.h:162
int nDeviationInAlarm
Deviation alarm state: non-zero if the alarm is currently triggered.
Definition: O22STRCT.h:280
int nEventScratchOn63to32
Scratchpad on bits to watch (bits 32-63)
Definition: O22STRCT.h:261
float fCounts
Current counter value of the point.
Definition: O22STRCT.h:64
float fWatchdogValue
Read/Write.
Definition: O22STRCT.h:108
int nPointType
Used to specify a point type, used for digital points.
Definition: O22STRCT.h:128
int nFeature
Read/Write
Definition: O22STRCT.h:176
int nModuleType
Read only.
Definition: O22STRCT.h:100
float fHiAlarmLimit
High alarm setpoint: values higher than this will trigger the alarm.
Definition: O22STRCT.h:290
int nAlgorithm
Which algorithm to use (see Appendix A - PID Configuration and Status - Read/Write of the OptoMMP Pro...
Definition: O22STRCT.h:208
int nWatchdogEnabled
Only used for analog points.
Definition: O22STRCT.h:136
int nScratchOff31to0
Scratchpad bits to turn off in reaction to the event (bits 0-31)
Definition: O22STRCT.h:320
int nStreamPeriod
Stream period in seconds. 0 = send once, maximum = 604800.
Definition: O22STRCT.h:241
int nDigitalIn_On63to32
Mask of digital points that will start the timer when they're set ON, points 32-63.
Definition: O22STRCT.h:327
int nSendEmail
Enable sending an email message in response to the event. Boolean.
Definition: O22STRCT.h:321
int nSnmpEnabled
Email SNMP trap. (Boolean).
Definition: O22STRCT.h:244
int nOutputMemMap
The memory map address to write the output of this PID loop for cascading PIDs, or 0 if no output wil...
Definition: O22STRCT.h:207
int nActiveCountersPts31to0
Current counter activation state (e.g. on/off) of points 0 through 31 as a bitmask.
Definition: O22STRCT.h:36
int nOnLatchStatePts63to32
Current on-latch state of points 32 through 63 as a bitmask.
Definition: O22STRCT.h:31
unsigned char byHSeconds
100th of a second
Definition: O22STRCT.h:528
struct SIOMM_RTC_DATE_TIME Time
Time of the data sample.
Definition: O22STRCT.h:534
int nDigitalOut_Off63to32
Mask of digital points to be set OFF when the timer expires, points 32-63.
Definition: O22STRCT.h:337
unsigned char byPattern[40]
Pattern string for the event. Wildcards (* and ?) are allowed.
Definition: O22STRCT.h:315
int nReactionDigitalOn63to32
Digital points to turn on in reaction to triggered evens (points 32-63)
Definition: O22STRCT.h:266
float fHiScale
Read/Write. Only used for analog points.
Definition: O22STRCT.h:105
int nValueLogicalAdr
Memory map address of the value to watch.
Definition: O22STRCT.h:304
int nHeader
Packet header. See Chapter 2 - Streaming Data in the OptoMMP Protocol Guide for details.
Definition: O22STRCT.h:449
int nEmailPeriod
Email period in seconds. 0 = send once, maximum = 604800.
Definition: O22STRCT.h:243
float fLoClamp
Only used for analog points.
Definition: O22STRCT.h:139
float fLoScale
Only used for analog points.
Definition: O22STRCT.h:133
int nLoAlarmScratchOn31to0
Scratchpad bits to turn on in reaction to a low alarm (bits 0-31)
Definition: O22STRCT.h:301
unsigned char byReplace[40]
Reaction string to be sent with the SNMP trap.
Definition: O22STRCT.h:316
int nReactionScratchOff63to32
Scratchpad bits to turn off in reaction to triggered event (bits 32-63)
Definition: O22STRCT.h:272
int nScratchIn_On63to32
Mask of scratch pad bits that will start the timer when they're set ON, bits 32-63.
Definition: O22STRCT.h:331
Definition: O22STRCT.h:368
float fGain
Only used for analog points.
Definition: O22STRCT.h:131
float fFilterWeight
Read/Write. Only used for analog points.
Definition: O22STRCT.h:107
float fHiScale
Only used for analog points.
Definition: O22STRCT.h:132
int nActiveCountersPts63to32
On/off state of counters for digital points 32-63. Does not include high density digital points...
Definition: O22STRCT.h:460
int nSetpointMemMap
The memory map address of the setpoint for this PID loop for cascading PIDs, or 0 if the setpoint wil...
Definition: O22STRCT.h:206
int nOffLatchStatePts63to32
Off-latch state for digital points 32-63. Does not include high density digital points.
Definition: O22STRCT.h:458
int nTrapPeriod
SNMP trap period in seconds. How often to send a trap as a reaction to the serial event...
Definition: O22STRCT.h:314
float fFloat
Sample value as a float.
Definition: O22STRCT.h:541
int nScratchOut_Off31to0
Mask of scratchpad bits to be set OFF when the timer expires, bits 0-31.
Definition: O22STRCT.h:342
int nWatchdogEnabled
Read/Write.
Definition: O22STRCT.h:109
int nOnLatch
Boolean state of the point's on latch.
Definition: O22STRCT.h:48
int nSerialEnabled
Enable serial module message. (Boolean)
Definition: O22STRCT.h:249
float fGain
Read/Write. Only used for analog points.
Definition: O22STRCT.h:104
int nActiveCountersPts63to32
Current counter activation state (e.g. on/off) of points 32 through 63 as a bitmask.
Definition: O22STRCT.h:35
Definition: O22STRCT.h:185
struct SIOMM_AnaBank MinValues
Minimum recorded values of all analog points.
Definition: O22STRCT.h:86
float fWatchdogValue
Read/Write. Only used for analog points
Definition: O22STRCT.h:181
int nReactionScratchOn63to32
Scratchpad bits to turn on in reaction to triggered event (bits 32-63)
Definition: O22STRCT.h:270
float fOutWhenInLo
The output value when the input is low.
Definition: O22STRCT.h:202
int nHiAlarmScratchOff63to32
Scratchpad bits to turn off in reaction to a high alarm (bits 32-63)
Definition: O22STRCT.h:294
int nLoAlarmScratchOff31to0
Scratchpad bits to turn off in reaction to a high alarm (bits 0-31)
Definition: O22STRCT.h:303
int nStatePts63to32
Current state of points 32 through 63 as a bitmask.
Definition: O22STRCT.h:29
int nPointType
Read only.
Definition: O22STRCT.h:153
Definition: O22STRCT.h:74
int nDigitalOut_On31to0
Mask of digital points to be set ON when the timer expires, points 0-31.
Definition: O22STRCT.h:336
int nHiAlarmEnabled
Enable high alarm. (Boolean)
Definition: O22STRCT.h:289
int nDeviationEnabled
Enable Deviation alarm. (Boolean)
Definition: O22STRCT.h:281
float fWatchdogValue
Only used for analog points.
Definition: O22STRCT.h:135
int nCounts
Current counter value of the point.
Definition: O22STRCT.h:51
int nWatchdogEnabled
Read/Write
Definition: O22STRCT.h:182
int nOffLatchStatePts31to0
Current off-latch state of points 0 through 31 as a bitmask.
Definition: O22STRCT.h:34
float fGain
Tuning constant, Proportional.
Definition: O22STRCT.h:187
int nFeature
Set point features. Only used for digital points.
Definition: O22STRCT.h:129
int nBitmask
Sample value as a bitmask.
Definition: O22STRCT.h:542
float fOffset
Read/Write. Only used for digital points
Definition: O22STRCT.h:177
float fHiScale
Read/Write. Only used for analog points
Definition: O22STRCT.h:157
Definition: O22STRCT.h:45
unsigned char byHours
Hour in a 24 hour day.
Definition: O22STRCT.h:525
float fFilterWeight
Read/Write. Only used for analog points
Definition: O22STRCT.h:159
Definition: O22STRCT.h:61
float fValue
Current floating point value (in engineering units) of the analog point.
Definition: O22STRCT.h:63
int nFeature
Read/Write. Only used for digital points.
Definition: O22STRCT.h:102
float fOffset
Read/Write. Only used for digital points
Definition: O22STRCT.h:155
int nStreamEnabled
Enable streaming. (Boolean)
Definition: O22STRCT.h:240
Definition: O22STRCT.h:233
int nDeviationScratchOff31to0
Scratchpad bits to turn off in reaction to a deviation alarm (bits 0-31)
Definition: O22STRCT.h:287
Definition: O22STRCT.h:278
float fDeviationMiddleRange
Deviation alarm, previous deviation value.
Definition: O22STRCT.h:282
int nStatePts31to0
Current state of points 0 through 31 as a bitmask.
Definition: O22STRCT.h:30
Definition: O22STRCT.h:98
Definition: O22STRCT.h:447
unsigned char byMessage[128]
Message text, limited to 127 characters. Used with email, serial and SNMP messages.
Definition: O22STRCT.h:251
int nScratchOn31to0
Scratchpad bits to turn on in reaction to the event (bits 0-31)
Definition: O22STRCT.h:318
Definition: O22STRCT.h:255
Definition: O22STRCT.h:150
float fMaxValue
Highest value recorded by the point since the last time it was cleared.
Definition: O22STRCT.h:66
Definition: O22STRCT.h:378
unsigned char byMonth
Month.
Definition: O22STRCT.h:523
int nModuleType
Read only.
Definition: O22STRCT.h:127
int nPriority
Message priority. 0 = high, 1 = low. Applies only if you are using SNMP with a modem connection...
Definition: O22STRCT.h:247
unsigned char byReserved[56]
reserved for future use
Definition: O22STRCT.h:462
int nMemMap
Memory map address the data comes from.
Definition: O22STRCT.h:535
float fHiClamp
Only used for analog points.
Definition: O22STRCT.h:138
int nEmailEnabled
Enable email. (Boolean).
Definition: O22STRCT.h:242
int nDigitalIn_On31to0
Mask of digital points that will start the timer when they're set ON, points 0-31.
Definition: O22STRCT.h:328
short wLength
Length of the string in byString.
Definition: O22STRCT.h:496
unsigned char byString[128]
String data.
Definition: O22STRCT.h:497
int nDeviationScratchOff63to32
Scratchpad bits to turn off in reaction to a deviation alarm (bits 32-63)
Definition: O22STRCT.h:286
float fInRangeHi
Upper bound on the valid range for input.
Definition: O22STRCT.h:194
Definition: O22STRCT.h:532
int nDigitalIn_Off31to0
Mask of digital points that will start the timer when they're set OFF, points 0-31.
Definition: O22STRCT.h:330
int nState
Boolean state of the digital point.
Definition: O22STRCT.h:47
int nDigPointFeature[64]
Digital point feature data for 64 points. Does not include high density digital points.
Definition: O22STRCT.h:453