TOC PREV NEXT INDEX

Put your logo here!

Contents

1 INTRODUCTION 1
1.1 Purpose 1
1.2 Scope 1
1.3 Reference Documents 1
1.4 Abbreviations and Acronyms 2
1.5 Glossary 2
1.6 Stylistic Conventions 3
1.7 Naming Convention 3
1.8 Problem Reporting / Change Request 3
2 USER'S GUIDE 5
2.1 Overview 5
2.1.1 Local Control Unit 5
2.1.2 LCU Common Software 5
2.1.3 Availability 5
2.2 LCU Management 6
2.2.1 Purpose 6
2.2.2 Basic Concepts 6
2.2.3 Node Management 7
2.2.3.1 Device File 8
2.2.3.2 Standard Mode Switching Functions 8
2.2.3.3 Auxiliary Functions 10
2.2.3.4 Status Functions 10
2.2.3.5 Monitoring and Self-Test 10
2.2.3.6 Simulation Mode 11
2.2.4 Memory Tracing 11
2.2.5 Symbol Table Access 11
2.2.6 NON-Posix Functions and Floating Point Library 11
2.2.7 Task management 12
2.2.8 Examples 12
2.2.9 Reference 13
2.3 Database 15
2.3.1 Current Working Point 15
2.3.2 Direct Address 15
2.3.3 Symbolic Address 15
2.3.3.1 Environment Specification 16
2.3.3.2 Points Specification 16
2.3.3.3 Attribute Specification 17
2.3.3.4 View Specifiers 18
2.3.4 Data Types 19
2.3.5 Naming Rules 20
2.3.6 Functions 21
2.3.7 Database Loading/Unloading 21
2.3.8 Data Base Backup/Restore 22
2.3.9 Simulation Mode 22
2.3.10 Memory Usage 22
2.3.11 Examples 23
2.3.12 Reference 23
2.4 I/O Signal Handling 25
2.4.1 Functions 25
2.4.2 Simulation 25
2.4.3 Memory Usage 25
2.4.4 Examples 25
2.4.5 Reference 26
2.5 Event Monitoring 28
2.5.1 Purpose 28
2.5.2 Basic Concept 28
2.5.3 Functions 29
2.5.4 Simulation 29
2.5.5 Filtering of Events 29
2.5.6 Examples 29
2.5.7 Reference 30
2.6 Abnormal Event Handling 31
2.6.1 Purpose 31
2.6.2 Basic Concept 31
2.6.3 Alarm Messages File 31
2.6.4 Functions 32
2.6.5 Simulation 33
2.6.6 Generating Alarms/Abnormal Events 33
2.6.7 Examples 33
2.6.8 Reference 33
2.7 Time Handling 35
2.7.1 Purpose 35
2.7.2 Basic Concepts 35
2.7.3 Functions 35
2.7.4 Local mode 37
2.7.5 Simulation 37
2.7.6 Examples 37
2.7.7 Reference 38
2.8 LCU Access Control 40
2.8.1 Purpose 40
2.8.2 Basic Concept 40
2.8.3 Functions 40
2.8.4 Reference 40
2.9 Logging 41
2.9.1 Purpose 41
2.9.2 Basic Concept 41
2.9.3 Functions 42
2.9.4 Support for Operational Logs 42
2.9.5 Programming Rules 43
2.9.6 Simulation 44
2.9.7 Examples 44
2.9.8 Reference 44
2.10 Error System 46
2.10.1 Purpose 46
2.10.2 Basic Concepts 46
2.10.3 Error Structure 46
2.10.4 Stack Manipulation 47
2.10.5 Error Log Filtering 48
2.10.6 Error Mnemonics 48
2.10.7 Error Definition File 48
2.10.8 Loading of Error Definition File 49
2.10.9 Include Error File 49
2.10.10 errEditor Utility 49
2.10.11 Functions 49
2.10.12 Simulation 50
2.10.13 Use of Error System 50
2.10.14 Examples 50
2.10.15 Macros 52
2.10.16 Reference 52
2.11 Message System 54
2.11.1 Purpose 54
2.11.2 Types of Message 54
2.11.2.1 User Messages 54
2.11.2.2 Internal Messages 54
2.11.3 Protocol 55
2.11.3.1 Registration Functions 55
2.11.3.2 Communication Functions 55
2.11.3.3 Auxiliary Functions 56
2.11.4 Examples 57
2.11.5 Reference 57
2.12 Command Interpreter 58
2.12.1 Purpose 58
2.12.2 Basic Concepts 58
2.12.3 Command Definition Table 58
2.12.4 Functions 61
2.12.5 Interface Functions 61
2.12.6 Use of Command Interpreter 64
2.12.7 Reference 66
2.13 Interface 67
2.13.1 Procedural Interface 67
2.13.2 Command Interface 67
3 ENGINEERING USER INTERFACE 69
4 LCU STATUS PANEL 71
4.1 Overview 71
4.2 Starting from the Command Line 71
4.3 Panel Description 71
4.3.1 Actions 72
4.3.2 Selecting LCU environments to monitor 72
4.4 LCUSTAT server Configuration 73
4.4.1 Starting from the Command Line 73
4.4.2 Overview 74
4.4.3 Watchdog configuration 74
5 LCC's WATCHDOG TRIGGER 75
5.1 Overview 75
5.2 STARTING 75
5.3 COMMANDS 75
6 REFERENCE 77
6.1 Procedures 77
Message System ccsExit 78
Message System ccsGetMyProcId 79
Message System ccsInit 80
Cmd Interpreter cmdInit 82
Cmd Interpreter cmdGetArgument 84
Database dbConversion 85
Database dbDeToStr 86
Database dbEnRemoteAccess 88
Database dbGetAlias 89
Database dbGetAttrNames 90
Database dbGetCwp 94
Database dbGetDirAddr 96
Database dbGetFamily 99
Database dbList 101
Database dbLoad 105
Database dbLockAttr 107
Database dbReadSymbolic 109
Database dbRestoreFile 115
Database dbStrToDe 117
Error System errAdd 118
Error System errCloseStack 120
Error System errCopy 121
Error System errDriverAdd 122
Error System errInStack 123
Error System errIsReason 125
Error System errMergeStack 127
Error System errPrint 128
Error System errResetStack 129
Error System errSetStack 130
Error System errSysAdd 131
Event Monitoring evtAttach 134
Event Monitoring evtConfig 137
Event Monitoring evtEnAlarm 140
Event Monitoring evtGetConfig 141
Event Monitoring evtGetSampleRate 143
Event Monitoring evtParseMsg 144
Event Monitoring evtSingleEnable 147
Signals ioChangeBit 149
Signals ioClearBit 150
Signals ioConfigAnalog 151
Signals ioConfigDigital 153
Signals ioDChangeBit 155
Signals ioDClearBit 156
Signals ioDPulseBit 157
Signals ioDReadAnalog 158
Signals ioDReadDigital 159
Signals ioDSetBit 160
Signals ioDWriteAnalog 161
Signals ioDWriteDigital 162
Signals ioGetAnalogConfig 163
Signals ioGetDigitalConfig 164
Signals ioGetDirectAddress 165
Signals ioGetList 166
Signals ioPulseBit 167
Signals ioReadAnalog 168
Signals ioReadAnalogRaw 169
Signals ioReadDigital 170
Signals ioSetAnalogSimValue 171
Signals ioSetBit 172
Signals ioSetDigitalSimValue 173
Signals ioStartSampling 174
Signals ioWriteAnalog 175
Signals ioWriteDigital 176
LCU Management lccBootResult 177
LCU Management lccCheckConf 178
LCU Management lccColdStart 179
LCU Management lccDevEnterSim 180
LCU Management lccEnSim 181
LCU Management lccFind 182
LCU Management lccFindFunctionEntry 183
LCU Management lccFindSymbolAddress 184
LCU Management lccFmod 185
LCU Management lccGetDeviceList 186
LCU Management lccGetDeviceState 187
LCU Management lccGetDevTimeout 188
LCU Management lccGetId 189
LCU Management lccGetStatus 190
LCU Management lccGetVersion 191
LCU Management lccInitFull 192
LCU Management lccIRound 193
LCU Management lccMemoryTrace 194
LCU Management lccOnLine 195
LCU Management lccReconfigure 196
LCU Management lccRegisterDevice 197
LCU Management lccReboot 198
LCU Management lccReload 199
LCU Management lccRound 201
LCU Management lccSelfTest 202
LCU Management lccShutdown 203
LCU Management lccStandAlone 204
LCU Management lccStandBy 205
LCU Management lccStop 206
LCU Management lccStopWatchdog 207
LCU Management lccSymFindByName 208
LCU Management lccTaskLib 210
LCU Management lccWaitFirstInit 212
LCU Management lccWaitFullInit 213
LCU Management lccWarmStart 214
Logging System logData 215
Logging System logEnDigital 216
Logging System logEnMsg 218
Logging System logEnReadDb 219
Logging System logFitsAction 221
Logging System logFitsComment 223
Logging System logFitsEvent 224
Logging System logFitsParRecord 225
Logging System logFitsSetMask 227
Logging System logGetEventList 228
Message System msgHandleBreak 229
Message System msgHandleKill 230
Message System msgGetProcIdByName 231
Message System msgParseMsg 232
Message System msgPing 234
Message System msgRecvMsg 235
Message System msgRequeueMsg 237
Message System msgScheduleProcess 238
Message System msgSendCommand 240
Message System msgSendReply 242
Timers timerCancelRequest 244
Timers timerConnectOnPulse 245
Timers timerGetStatus 246
Timers timerGetTimerStatus 247
Timers timerScheduleProcess 249
Timers timerSendCommand 250
Timers timerSendReply 252
Timers timerSetInterrupt 254
Timers timerSetTask 256
Timers timerSleep 258
Time System timsAddTime 259
Time System timsGetMode 260
Time System timsGetUTC 261
Time System timsIsoStringToTime 262
Time System timsSetMode 263
Time System timsSetUTC 264
Time System timsTimeToIsoString 265
Time System timsUTCToJD 267
6.2 Commands 268
6.2.1 Command Formats 268
6.2.1.1 ASCII commands 268
6.2.1.2 Formatted binary 269
6.2.1.3 Unformatted binary 269
Cmd Interpreter cmdLoadTable 270
Cmd Interpreter cmdSetTestError 270
Database dbAliasToName 270
Database dbDisRemoteAccess 270
Database dbDisSim 271
Database dbEnRemoteAccess 271
Database dbEnSim 271
Database dbGetAlias 271
Database dbGetAttrInfo 272
Database dbGetAttrNames 272
Database dbGetAttrNumber 272
Database dbGetCwp 273
Database dbGetDirAddr 273
Database dbGetFamily 273
Database dbGetFamilyNames 274
Database dbGetFieldNames 274
Database dbGetParent 274
Database dbLoad 275
Database dbLoadBranch 275
Database dbLockAttr 275
Database dbLockPoint 276
Database dbRead 276
Database dbReadSymbolic 276
Database dbSetCwp 277
Database dbUnload 277
Database dbUnloadBranch 277
Database dbUnlockAttr 277
Database dbUnlockPoint 278
Database dbWrite 278
Database dbWriteSymbolic 278
Error System errGetFirstBuffer 279
Error System errStartLogging 279
Error System errStopLogging 280
Event Monitoring evtAttach 280
Event Monitoring evtAttachAlarm 281
Event Monitoring evtConfig 281
Event Monitoring evtConfigAbnormal 282
Event Monitoring evtDetach 282
Event Monitoring evtDisAlarm 282
Event Monitoring evtDisAllAlarm 283
Event Monitoring evtDisAllEvent 283
Event Monitoring evtDisEvent 283
Event Monitoring evtEnAlarm 283
Event Monitoring evtEnAllAlarm 284
Event Monitoring evtEnAllEvent 284
Event Monitoring evtEnEvent 284
Event Monitoring evtGetAlarmConfig 284
Event Monitoring evtGetAlarmList 285
Event Monitoring evtGetAllAlarmList 285
Event Monitoring evtGetAllEventList 286
Event Monitoring evtGetConfig 286
Event Monitoring evtGetEventList 287
Event Monitoring evtGetSampleRate 287
Event Monitoring evtSetSampleRate 287
Event Monitoring evtSingleDisable 288
Event Monitoring evtSingleEnable 288
Signals ioChangeBit 288
Signals ioClearBit 289
Signals ioConfigAnalog 289
Signals ioConfigDigital 289
Signals ioGetAnalogConfig 290
Signals ioGetDigitalConfig 290
Signals ioGetList 291
Signals ioPulseBit 291
Signals ioReadAnalog 291
Signals ioReadAnalogRaw 292
Signals ioReadDigital 292
Signals ioSetAnalogSimValue 292
Signals ioSetBit 293
Signals ioSetDigitalSimValue 293
Signals ioStartSampling 293
Signals ioStopSampling 294
Signals ioWriteAnalog 294
Signals ioWriteDigital 294
LCU Management lccCheckConf 295
LCU Management lccColdStart 295
LCU Management lccDevExitSim 295
LCU Management lccDevEnterSim 296
LCU Management lccGetDevTimeout 296
LCU Management lccSetDevTimeout 296
LCU Management lccDisSim 296
LCU Management lccDisSim 297
LCU Management lccEnSim 297
LCU Management lccEnSim 298
LCU Management lccGetDeviceList 298
LCU Management lccGetDeviceState 298
LCU Management lccGetId 299
LCU Management lccGetStatus 299
LCU Management lccGetStatus 299
LCU Management lccGetVersion 300
LCU Management lccGetVersion 300
LCU Management lccInitFull 300
LCU Management lccInitFull 301
LCU Management lccNfs 301
LCU Management lccOnLine 301
LCU Management lccOnLine 302
LCU Management lccPrintEnvTbl 302
LCU Management lccPrintLocalTbl 302
LCU Management lccReboot 302
LCU Management lccReconfigure 303
LCU Management lccReload 303
LCU Management lccSelfTest 303
LCU Management lccSelfTest 304
LCU Management lccSetDeviceState 304
LCU Management lccShutdown 304
LCU Management lccShutdown 304
LCU Management lccStandAlone 305
LCU Management lccStandAlone 305
LCU Management lccStandBy 305
LCU Management lccStandBy 305
LCU Management lccStop 306
LCU Management lccStop 306
LCU Management lccStopWatchdog 306
LCU Management lccWaitFirstInit 306
LCU Management lccWaitFullInit 307
LCU Management lccWarmStart 307
Logging System logCheckStart 307
Logging System logDisAnalog 308
Logging System logDisDigital 308
Logging System logDisMsg 308
Logging System logDisReadDb 309
Logging System logDisWriteDb 309
Logging System logEnAnalog 309
Logging System logEnDigital 310
Logging System logEnMsg 310
Logging System logEnReadDb 310
Logging System logEnWriteDb 311
Logging System logGetFirstBuffer 311
Logging System logGetEventList 311
Logging System logStartLogging 312
Logging System logStopLogging 312
Message System msgCheckProcess 313
Message System msgGetProcesses 313
Message System msgScheduleProcess 313
Message System BREAK 314
Message System KILL 314
Timers timerCancelRequest 314
Timers timerGetReport 314
Timers timerGetStatus 315
Timers timerGetTimerStatus 315
Timers timerScheduleTask 316
Timers timerSendCommand 316
Timers timerSendReply 317
Time System timsGetMode 317
Time System timsGetUTC 317
Time System timsSetMode 318
Time System timsSetUTC 318
6.3 Tools 319
Command Table lccdt 320
Command Table lccit 321
Database lccdb 322
LCC lccBoot 323
lcustat lcustatCheck 324
lcuwd lcuwdTrig 325
7 INSTALLATION GUIDE 327
7.1 Installation requirements 327
7.1.1 Hardware Requirements 327
7.1.2 Software Requirements 327
7.2 Building the Software 327
7.2.1 Delivery 327
7.2.2 Tape Downloading 328
7.2.3 Build Procedure 328
7.2.3.1 Pre-Conditions 328
7.2.3.2 Clean-up of Delivered Environment 328
7.2.3.3 Recompilation and Link 328
7.2.3.4 Install Software to Specified Target Directory 329
7.3 VxWorks Environment Configuration 329
7.3.1 Description 329
7.3.2 Required Database 329
7.3.3 Customizable Parameters 329
7.3.3.1 Environment Variables 329
7.3.3.2 NFS Configuration 330
7.3.3.3 Customizing the LCU Common Software 330
7.3.4 Header File for Database Unloading 331
7.3.5 Installation Verification 331
7.3.6 Unix Environment Configuration 331
7.3.6.1 X11 Resource File 331
7.3.6.2 Files 331
7.3.6.3 Environment Variables 333
8 ERROR MESSAGES AND RECOVERY 335
8 APPENDIXES 339
A COMMAND SCRIPT FILE SYNTAX 340
B PARAMETER SET FILE SYNTAX 342
C COMMAND INTERPRETER TABLE SYNTAX 345
D COMMAND DEFINITION TABLE EXAMPLE 347

Quadralay Corporation
http://www.webworks.com
Voice: (512) 719-3399
Fax: (512) 719-3606
sales@webworks.com
TOC PREV NEXT INDEX