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 CAN bus I/O 25 2.4.3 Simulation 26 2.4.4 Memory Usage 26 2.4.5 Examples 26 2.4.6 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 Logging 40 2.8.1 Purpose 40 2.8.2 Basic Concept 40 2.8.3 Functions 41 2.8.4 Support for Operational Logs 41 2.8.5 Programming Rules 42 2.8.6 Simulation 43 2.8.7 Examples 43 2.8.8 Reference 43 2.9 Error System 45 2.9.1 Purpose 45 2.9.2 Basic Concepts 45 2.9.3 Error Structure 45 2.9.4 Stack Manipulation 46 2.9.5 Error Log Filtering 47 2.9.6 Error Mnemonics 47 2.9.7 Error Definition File 47 2.9.8 Loading of Error Definition File 48 2.9.9 Include Error File 48 2.9.10 errEditor Utility 48 2.9.11 Functions 48 2.9.12 Simulation 49 2.9.13 Use of Error System 49 2.9.14 Examples 49 2.9.15 Macros 51 2.9.16 Reference 51 2.10 Message System 53 2.10.1 Purpose 53 2.10.2 Types of Message 53 2.10.2.1 User Messages 53 2.10.2.2 Internal Messages 53 2.10.3 Protocol 54 2.10.3.1 Registration Functions 54 2.10.3.2 Communication Functions 54 2.10.3.3 Auxiliary Functions 55 2.10.4 Examples 56 2.10.5 Reference 56 2.11 Command Interpreter 57 2.11.1 Purpose 57 2.11.2 Basic Concepts 57 2.11.3 Command Definition Table 57 2.11.4 Functions 60 2.11.5 Interface Functions 60 2.11.6 Use of Command Interpreter 63 2.11.7 Reference 65 2.12 Interface 66 2.12.1 Procedural Interface 66 2.12.2 Command Interface 66 3 ENGINEERING USER INTERFACE 68 4 LCU STATUS PANEL 69 4.1 Overview 69 4.2 Starting from the Command Line 69 4.3 Panel Description 69 4.3.1 Actions 70 4.3.2 Selecting LCU environments to monitor 70 4.4 LCUSTAT server Configuration 71 4.4.1 Starting from the Command Line 71 4.4.2 Overview 72 4.4.3 Watchdog configuration 72 5 LCC's WATCHDOG TRIGGER 73 5.1 Overview 73 5.2 STARTING 73 5.3 COMMANDS 73 6 REFERENCE 75 6.1 Procedures 75 Message System ccsExit 76 Message System ccsGetMyProcId 77 Message System ccsInit 78 Cmd Interpreter cmdInit 80 Cmd Interpreter cmdGetArgument 83 Database dbConversion 84 Database dbDeToStr 86 Database dbEnRemoteAccess 88 Database dbGetAlias 90 Database dbGetAttrNames 91 Database dbGetCwp 96 Database dbGetDirAddr 98 Database dbGetFamily 101 Database dbList 103 Database dbLoad 108 Database dbLockAttr 110 Database dbReadSymbolic 112 Database dbRestoreFile 119 Database dbStrToDe 122 Error System errAdd 124 Error System errCloseStack 126 Error System errCopy 127 Error System errDriverAdd 128 Error System errInStack 129 Error System errIsReason 130 Error System errMergeStack 132 Error System errPrint 133 Error System errResetStack 135 Error System errSetStack 137 Error System errSysAdd 138 Event Monitoring evtConfig 143 Event Monitoring evtEnAlarm 146 Event Monitoring evtGetConfig 147 Event Monitoring evtGetSampleRate 149 Event Monitoring evtParseMsg 150 Event Monitoring evtSingleEnable 154 Signals ioCANSendSync 156 Signals ioChangeBit 158 Signals ioClearBit 159 Signals ioConfigAnalog 160 Signals ioConfigCANAnalogSync 162 Signals ioConfigDigital 164 Signals ioConfigMenDigital 166 Signals ioDChangeBit 168 Signals ioDClearBit 169 Signals ioDPulseBit 170 Signals ioDReadAnalog 171 Signals ioDReadDigital 172 Signals ioDSetBit 173 Signals ioDWriteAnalog 174 Signals ioDWriteDigital 175 Signals ioEnableInterrupt 177 Signals ioGetAnalogConfig 179 Signals ioGetDigitalConfig 181 Signals ioGetDirectAddress 182 Signals ioGetList 183 Signals ioPulseBit 184 Signals ioReadAnalog 185 Signals ioReadAnalogRaw 186 Signals ioReadDigital 187 Signals ioSetAnalogSimValue 188 Signals ioSetBit 189 Signals ioSetDigitalSimValue 190 Signals ioStartSampling 191 Signals ioWriteAnalog 193 Signals ioWriteDigital 194 LCU Management lccBootResult 195 LCU Management lccCheckConf 196 LCU Management lccColdStart 197 LCU Management lccDevEnterSim 198 LCU Management lccEnSim 200 LCU Management lccFind 201 LCU Management lccFindFunctionEntry 202 LCU Management lccFindSymbolAddress 203 LCU Management lccFmod 204 LCU Management lccGetDeviceList 205 LCU Management lccGetDeviceState 206 LCU Management lccGetDevTimeout 207 LCU Management lccGetId 208 LCU Management lccGetStatus 209 LCU Management lccGetVersion 211 LCU Management lccInitFull 212 LCU Management lccIRound 214 LCU Management lccMemoryTrace 215 LCU Management lccOnLine 216 LCU Management lccReconfigure 217 LCU Management lccRegisterDevice 219 LCU Management lccReboot 221 LCU Management lccReload 222 LCU Management lccRound 224 LCU Management lccSelfTest 225 LCU Management lccShutdown 226 LCU Management lccStandAlone 227 LCU Management lccStandBy 228 LCU Management lccStop 229 LCU Management lccStopWatchdog 230 LCU Management lccSymFindByName 231 LCU Management lccTaskLib 233 LCU Management lccWaitFirstInit 235 LCU Management lccWaitFullInit 236 LCU Management lccWarmStart 237 Logging System logData 238 Logging System logEnDigital 240 Logging System logEnMsg 242 Logging System logEnReadDb 243 Logging System logFitsAction 245 Logging System logFitsComment 247 Logging System logFitsEvent 248 Logging System logFitsParRecord 249 Logging System logFitsSetMask 252 Logging System logGetEventList 253 Message System msgHandleBreak 254 Message System msgHandleKill 255 Message System msgGetProcIdByName 257 Message System msgParseMsg 258 Message System msgPing 260 Message System msgRecvMsg 261 Message System msgRequeueMsg 263 Message System msgScheduleProcess 264 Message System msgSendCommand 266 Message System msgSendReply 268 Timers timerCancelRequest 271 Timers timerConnectOnPulse 272 Timers timerGetStatus 273 Timers timerGetTimerStatus 274 Timers timerScheduleProcess 276 Timers timerSendCommand 278 Timers timerSendReply 280 Timers timerSetInterrupt 282 Timers timerSetTask 285 Timers timerSleep 288 Time System timsAddTime 289 Time System timsGetMode 290 Time System timsGetUTC 291 Time System timsIsoStringToTime 292 Time System timsSetMode 294 Time System timsSetUTC 295 Time System timsTimeToIsoString 296 Time System timsUTCToJD 298 6.2 Commands 299 6.2.1 Command Formats 299 6.2.1.1 ASCII commands 299 6.2.1.2 Formatted binary 300 6.2.1.3 Unformatted binary 300 Cmd Interpreter cmdLoadTable 301 Cmd Interpreter cmdSetTestError 301 Database dbAliasToName 301 Database dbDisRemoteAccess 301 Database dbDisSim 302 Database dbEnRemoteAccess 302 Database dbEnSim 302 Database dbGetAlias 302 Database dbGetAttrInfo 303 Database dbGetAttrNames 303 Database dbGetAttrNumber 304 Database dbGetCwp 304 Database dbGetDirAddr 304 Database dbGetFamily 305 Database dbGetFamilyNames 305 Database dbGetFieldNames 305 Database dbGetParent 306 Database dbLoad 306 Database dbLoadBranch 306 Database dbLockAttr 307 Database dbLockPoint 307 Database dbRead 307 Database dbReadSymbolic 308 Database dbSetCwp 308 Database dbUnload 308 Database dbUnloadBranch 309 Database dbUnlockAttr 309 Database dbUnlockPoint 309 Database dbWrite 310 Database dbWriteSymbolic 310 Error System errGetFirstBuffer 311 Error System errStartLogging 311 Error System errStopLogging 312 Event Monitoring evtAttach 312 Event Monitoring evtAttachAlarm 313 Event Monitoring evtConfig 313 Event Monitoring evtConfigAbnormal 314 Event Monitoring evtDetach 314 Event Monitoring evtDisAlarm 314 Event Monitoring evtDisAllAlarm 315 Event Monitoring evtDisAllEvent 315 Event Monitoring evtDisEvent 315 Event Monitoring evtEnAlarm 315 Event Monitoring evtEnAllAlarm 316 Event Monitoring evtEnAllEvent 316 Event Monitoring evtEnEvent 316 Event Monitoring evtGetAlarmConfig 316 Event Monitoring evtGetAlarmList 317 Event Monitoring evtGetAllAlarmList 317 Event Monitoring evtGetAllEventList 318 Event Monitoring evtGetConfig 318 Event Monitoring evtGetEventList 319 Event Monitoring evtGetSampleRate 319 Event Monitoring evtSetSampleRate 319 Event Monitoring evtSingleDisable 320 Event Monitoring evtSingleEnable 320 Signals ioChangeBit 321 Signals ioClearBit 321 Signals ioConfigAnalog 321 Signals ioConfigCANAnalogSync 322 Signals ioConfigDigital 322 Signals ioConfigMenDigital 322 Signals ioGetAnalogConfig 323 Signals ioGetDigitalConfig 323 Signals ioGetList 324 Signals ioPulseBit 324 Signals ioReadAnalog 324 Signals ioReadAnalogRaw 325 Signals ioCANSendSync 325 Signals ioReadDigital 325 Signals ioEnableInterrupt 325 Signals ioDisableInterrupt 326 Signals ioSetAnalogSimValue 326 Signals ioSetBit 326 Signals ioSetDigitalSimValue 327 Signals ioStartSampling 327 Signals ioStopSampling 328 Signals ioWriteAnalog 328 Signals ioWriteDigital 328 LCU Management lccCheckConf 329 LCU Management lccColdStart 329 LCU Management lccDevExitSim 329 LCU Management lccDevEnterSim 329 LCU Management lccGetDevTimeout 330 LCU Management lccSetDevTimeout 330 LCU Management lccDisSim 330 LCU Management lccDisSim 331 LCU Management lccEnSim 331 LCU Management lccEnSim 332 LCU Management lccGetDeviceList 332 LCU Management lccGetDeviceState 332 LCU Management lccGetId 333 LCU Management lccGetStatus 333 LCU Management lccGetStatus 333 LCU Management lccGetVersion 334 LCU Management lccGetVersion 334 LCU Management lccInitFull 334 LCU Management lccInitFull 336 LCU Management lccNfs 336 LCU Management lccOnLine 336 LCU Management lccOnLine 337 LCU Management lccPrintEnvTbl 337 LCU Management lccPrintLocalTbl 337 LCU Management lccReboot 337 LCU Management lccReconfigure 338 LCU Management lccReload 338 LCU Management lccSelfTest 338 LCU Management lccSelfTest 340 LCU Management lccSetDeviceState 340 LCU Management lccShutdown 340 LCU Management lccShutdown 340 LCU Management lccStandAlone 341 LCU Management lccStandAlone 341 LCU Management lccStandBy 341 LCU Management lccStandBy 342 LCU Management lccStop 342 LCU Management lccStop 342 LCU Management lccStopWatchdog 342 LCU Management lccWaitFirstInit 343 LCU Management lccWaitFullInit 343 LCU Management lccWarmStart 343 Logging System logCheckStart 344 Logging System logDisAnalog 345 Logging System logDisDigital 345 Logging System logDisMsg 345 Logging System logDisReadDb 346 Logging System logDisWriteDb 346 Logging System logEnAnalog 346 Logging System logEnDigital 347 Logging System logEnMsg 347 Logging System logEnReadDb 347 Logging System logEnWriteDb 348 Logging System logGetFirstBuffer 348 Logging System logGetEventList 348 Logging System logStartLogging 349 Logging System logStopLogging 349 Message System msgCheckProcess 350 Message System msgGetProcesses 350 Message System msgScheduleProcess 350 Message System BREAK 351 Message System KILL 351 Timers timerCancelRequest 351 Timers timerGetReport 352 Timers timerGetStatus 352 Timers timerGetTimerStatus 352 Timers timerScheduleTask 354 Timers timerSendCommand 354 Timers timerSendReply 355 Time System timsGetMode 355 Time System timsGetUTC 355 Time System timsSetMode 356 Time System timsSetUTC 356 6.3 Tools 357 Command Table lccdt 358 Command Table lccit 359 Database lccdb 360 LCC lccBoot 361 lcustat lcustatCheck 362 lcuwd lcuwdTrig 364 7 INSTALLATION GUIDE 365 7.1 Installation requirements 365 7.1.1 Hardware Requirements 365 7.1.2 Software Requirements 365 7.2 Building the Software 365 7.2.1 Delivery 365 7.2.2 Build Procedure 366 7.3 VxWorks Environment Configuration 366 7.3.1 Description 366 7.3.2 Required Database 366 7.3.3 Customizable Parameters 366 7.3.3.1 Environment Variables 366 7.3.3.2 NFS Configuration 367 7.3.3.3 Customizing the LCU Common Software 367 7.3.4 Header File for Database Unloading 368 7.3.5 Installation Verification 368 7.3.6 Unix Environment Configuration 368 7.3.6.1 Files 368 7.3.6.2 Environment Variables 370 8 ERROR MESSAGES AND RECOVERY 371 8 APPENDIXES 375 A COMMAND SCRIPT FILE SYNTAX 376 2 PARAMETER SET FILE SYNTAX 379 3 COMMAND INTERPRETER TABLE SYNTAX 383 4 COMMAND DEFINITION TABLE EXAMPLE 385
Contents
