LP CRIMSON 3 REFERENCE MANUAL

1 LPXXXX REVISION CRIMSON 3 REFERENCE MANUAL Copyright 2003-2010 Red Lion Controls Inc. All Rights Reserved Worldwide. The information contained herein is provided in good faith, but is subject to change without notice. It is supplied with no warranty whatsoever, and does not represent a commitment on the part of Red Lion Controls. Companies, names and data used as examples herein are fictitious unless otherwise stated. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, without the express written permission of Red Lion Controls Inc. The Red Lion logo is a registered trademark of Red Lion Controls Inc. CRIMSON and the CRIMSON logo are registered trademarks of Red Lion Controls Inc. All other trademarks are acknowledged as the property of their respective owners. Written by Mike Granby and Jesse Benefiel. TABLE OF CONTENTS REVISION PAGE I TABLE OF CONTENT FUNCTION REFERENCE .

2 1 ABS(VALUE) .. 2 ACOS(VALUE) .. 3 ALARMACCEPT(ALARM) .. 4 ALARMACCEPTALL() .. 5 ALARMACCEPTEX(SOURCE, METHOD, CODE) .. 6 ALARMACCEPTTAG(TAG, INDEX, EVENT) .. 7 ASIN(VALUE) .. 8 ASTEXT(N) .. 9 ATAN(VALUE) ..10 ATAN2(A, B) ..11 BEEP(FREQ, PERIOD) ..12 CANGOTONEXT() ..13 CANGOTOPREVIOUS() ..14 CLEAREVENTS() ..15 CLOSEFILE(FILE)..16 COLBLEND(DATA, MIN, MAX, COL1, COL2) ..17 COLFLASH(FREQ, COL1, COL2) ..18 COLGETBLUE(COL) ..19 COLGETGREEN(COL) ..20 COLGETRED(COL) ..21 COLGETRGB(R,G,B) ..22 COLPICK2(PICK, COL1, COL2) ..23 COLPICK4(DATA1, DATA2, COL1, COL2, COL3, COL4) ..24 COLSELFLASH(ENABLE, FREQ, COL1, COL2, COL3) ..25 COMMITANDRESET() ..26 COMPACTFLASHEJECT() ..27 COMPACTFLASHSTATUS() ..28 CONTROLDEVICE(DEVICE, ENABLE) ..29 COPY(DEST, SRC, COUNT) ..30 COPYFILES(SOURCE, TARGET, FLAGS) ..31 COS(THETA) ..32 CREATEDIRECTORY(NAME) ..33 CREATEFILE(NAME) ..34 DATATOTEXT(DATA, LIMIT) ..35 DATE(Y, M, D).

3 36 DECTOTEXT(DATA, SIGNED, BEFORE, AFTER, LEADING, GROUP) ..37 DEG2 RAD(THETA) ..38 TABLE OF CONTENTS CRIMSON 3 REFERENCE MANUAL PAGE II DELETEDIRECTORY(NAME) .. 39 DELETEFILE(FILE) .. 40 DEVCTRL(DEVICE, FUNCTION, DATA) .. 41 DISABLEDEVICE(DEVICE) .. 42 DISPOFF() .. 43 DISPON() .. 44 DRVCTRL(PORT, FUNCTION, DATA OR VALUE???) .. 45 EJECTDRIVE(DRIVE) .. 46 EMPTYWRITEQUEUE (DEV) .. 47 ENABLEDEVICE(DEVICE) .. 48 ENDBATCH() .. 49 ENDBATCHEX(SLOT) .. 50 ENDMODAL(CODE) .. 51 ENUMOPTIONCARD(S) .. 52 EXP(VALUE) .. 53 EXP10(VALUE) .. 54 FILESEEK(FILE, POS) .. 55 FILETELL(FILE) .. 56 FILL(ELEMENT, DATA, COUNT) .. 57 FIND(STRING,CHAR,SKIP) .. 58 FINDFILEFIRST(DIR) .. 59 FINDFILENEXT() .. 60 FINDTAGINDEX(LABEL) .. 61 FLASH(FREQ) .. 62 FORCE(DEST, DATA).. 63 FORCECOPY(DEST, SRC, COUNT) .. 64 FORMATCOMPACTFLASH() .. 65 FORMATDRIVE(DRIVE) .. 66 FTPGETFILE(SERVER, LOC, REM, DELETE) .. 67 FTPPUTFILE(SERVER, LOC, REM, DELETE).

4 68 GETALARMTAG(INDEX) .. 69 GETAUTOCOPYSTATUSCODE() .. 70 GETAUTOCOPYSTATUSTEXT() .. 71 GETBATCH() .. 72 GETBATCHEX(SLOT) .. 73 GETCAMERADATA(PORT, CAMERA, PARAM) .. 74 GETCURRENTUSERNAME() .. 75 GETCURRENTUSERREALNAME() .. 76 GETCURRENTUSERRIGHTS() .. 77 GETDATE (TIME) AND FAMILY .. 78 GETDEVICESTATUS(DEVICE) .. 79 TABLE OF CONTENTS REVISION PAGE III GETDISKFREEBYTES(DRIVE) ..80 GETDISKFREEPERCENT(DRIVE) ..81 GETDISKSIZEBYTES(DRIVE) ..82 GETDRIVESTATUS(DRIVE) ..83 GETFILEBYTE(FILE) ..84 GETFILEDATA(FILE, DATA, LENGTH) ..85 GETFORMATTEDTAG(INDEX) ..86 GETINTERFACESTATUS(PORT) ..87 GETINTTAG(INDEX) ..88 GETLANGUAGE() ..89 GETLASTEVENTTEXT(ALL) ..90 GETLASTEVENTTIME(ALL) ..91 GETLASTEVENTTIME(ALL) ..92 GETLASTEVENTTYPE(ALL) ..93 GETMODELNAME(CODE) ..94 GETMONTHDAYS(Y, M) ..95 GETNETGATE(PORT) ..96 GETNETID(PORT) ..97 GETNETIP(PORT) ..98 GETNETMASK(PORT) ..99 GETNOW() .. 100 GETNOWDATE() .. 101 GETNOWTIME().

5 102 GETPORTCONFIG(PORT, PARAM) .. 103 GETREALTAG(INDEX) .. 104 GETRESTARTCODE(N) .. 105 GETRESTARTINFO(N) .. 106 GETRESTARTTEXT(N) .. 107 GETRESTARTTIME(N) .. 108 GETSTRINGTAG(INDEX) .. 109 GETTAGLABEL(INDEX) .. 110 GETUPDOWNDATA(DATA, LIMIT) .. 111 GETUPDOWNSTEP(DATA, LIMIT) .. 112 GETVERSIONINFO(CODE) .. 113 GOTONEXT() .. 114 GOTOPAGE(NAME) .. 115 GOTOPREVIOUS() .. 116 HASACCESS (RIGHTS) .. 117 HASALLACCESS(RIGHTS) .. 118 HIDEALLPOPUPS() .. 119 HIDEPOPUP() .. 120 TABLE OF CONTENTS CRIMSON 3 REFERENCE MANUAL PAGE IV INTTOTEXT(DATA, RADIX, COUNT) .. 121 ISBATCHNAMEVALID(NAME) .. 122 ISBATCHNAMEVALIDEX(SET, NAME) .. 123 ISBATTERYLOW() .. 124 ISDEVICEONLINE(DEVICE) .. 125 ISLOGGINGACTIVE() .. 126 ISPORTREMOTE(PORT) .. 127 ISWRITEQUEUEEMPTY(DEV) .. 128 KILLDIRECTORY(NAME) .. 129 LEFT(STRING, COUNT) .. 130 LEN(STRING) .. 131 LOADCAMERASETUP(PORT, CAMERA, INDEX, FILE) .. 132 LOADSECURITYDATABASE(MODE, FILE).

6 133 LOG(VALUE) .. 134 LOG10(VALUE) .. 135 LOGBATCHCOMMENT(SET, TEXT) .. 136 LOGBATCHHEADER(SET, TEXT) .. 137 LOGCOMMENT(LOG, TEXT) .. 138 LOGHEADER(LOG, TEXT) .. 139 LOGSAVE() .. 140 MAKEFLOAT(VALUE) .. 141 MAKEINT(VALUE) .. 142 MAX(A, B) .. 143 MEAN(ELEMENT, COUNT) .. 144 MID(STRING, POS, COUNT) .. 145 MIN(A, B) .. 146 MOVEFILES(SOURCE, TARGET, FLAGS) .. 147 MULDIV(A, B, C) .. 148 MUTESIREN() .. 149 NEWBATCH(NAME) .. 150 NEWBATCHEX(SLOT, NAME) .. 151 NOP() .. 152 OPENFILE(NAME, MODE) .. 153 PI() .. 154 PLAYRTTTL(TUNE) .. 155 POPDEV(ELEMENT, COUNT) .. 156 PORTCLOSE(PORT) .. 157 PORTGETCTS(PORT) .. 158 PORTINPUT(PORT, START, END, TIMEOUT, LENGTH) .. 159 PORTPRINT(PORT, STRING) .. 160 PORTREAD(PORT, PERIOD) .. 161 TABLE OF CONTENTS REVISION PAGE V PORTSETRTS(PORT, STATE) .. 162 PORTWRITE(PORT, DATA) .. 163 POSTKEY(CODE, TRANSITION) .. 164 POWER(VALUE, POWER) .. 165 PRINTSCREENTOFILE(PATH, NAME, RES).

7 166 PUTFILEBYTE(FILE, DATA) .. 167 PUTFILEDATA(FILE, DATA, LENGTH) .. 168 RAD2 DEG(THETA) .. 169 RANDOM(RANGE) .. 170 READDATA(DATA, COUNT) .. 171 READFILE(FILE, CHARS) .. 172 READFILELINE(FILE) .. 173 RENAMEFILE(HANDLE, NAME) .. 174 RESOLVEDNS(NAME) .. 175 RIGHT(STRING, COUNT) .. 176 SAVECAMERASETUP(PORT, CAMERA, INDEX, FILE) .. 177 SAVECONFIGFILE(FILE).. 178 SAVESECURITYDATABASE(MODE, FILE).. 179 SCALE(DATA, R1, R2, E1, E2) .. 180 SENDFILE(RCPT, FILE) .. 181 SENDFILEEX(RCPT, FILE, SUBJECT, FLAG) .. 182 SENDMAIL(RCPT, SUBJECT, BODY) .. 183 SET(TAG, VALUE) .. 184 SETINTTAG(INDEX, VALUE) .. 185 SETLANGUAGE(CODE) .. 186 SETNETCONFIG(PORT, ADDR, MASK, GATE) .. 187 SETNOW(TIME) .. 188 SETPORTCONFIG(PORT, PARAM, VALUE) .. 189 SETREALTAG(INDEX, VALUE) .. 190 SETSTRINGTAG(INDEX, DATA) .. 191 SGN(VALUE) .. 192 SHOWMENU(NAME) .. 193 SHOWMODAL(NAME).. 194 SHOWNESTED(NAME) .. 195 SHOWPOPUP(NAME) .. 196 SIN(THETA).

8 197 SIRENON() .. 198 SLEEP(PERIOD) .. 199 SQRT(VALUE) .. 200 STDDEV(ELEMENT, COUNT).. 201 STOPSYSTEM() .. 202 TABLE OF CONTENTS CRIMSON 3 REFERENCE MANUAL PAGE VI STRIP(TEXT, TARGET).. 203 SUM(ELEMENT, COUNT) .. 204 TAN(THETA).. 205 TESTACCESS(RIGHTS, PROMPT) .. 206 TEXTTOADDR(ADDR) .. 207 TEXTTOFLOAT(STRING) .. 208 TEXTTOINT(STRING, RADIX) .. 209 TIME(H, M, S) .. 210 USECAMERASETUP(PORT, CAMERA, INDEX) .. 211 USERLOGOFF() .. 212 USERLOGON() .. 213 WAITDATA(DATA, COUNT, TIME) .. 214 WRITEALL() .. 215 WRITEFILE(FILE, TEXT) .. 216 WRITEFILELINE(FILE, TEXT) .. 217 CRIMSON 3 REFERENCE MANUAL FUNCTION REFERENCE INTRODUCTION REVISION PAGE 1 FUNCTION REFERENCE The following pages describe the various standard functions that provided by CRIMSON . These functions can be invoked within programs, actions or expressions as described in the previous chapters. Functions that are marked as active may not be used in expressions that are not allowed to change values, such as in the controlling expression of a display primitive.

9 Functions that are marked as passive may be used in any context. ABS(VALUE) CRIMSON 3 REFERENCE MANUAL PAGE 2 ABS(VALUE) ARGUMENT TYPE DESCRIPTION value int / float The value to be processed. DESCRIPTION Returns the absolute value of the argument. In other words, if value is a positive value, that value will be returned; if value is a negative value, a value of the same magnitude but with the opposite sign will be returned. FUNCTION TYPE This function is passive. RETURN TYPE int or float, depending on the type of the value argument. EXAMPLE Error := abs(PV SP) APPENDIX A FUNCTION REFERENCE ACOS(VALUE) REVISION PAGE 3 ACOS(VALUE) ARGUMENT TYPE DESCRIPTION value float The value to be processed. DESCRIPTION Returns the angle theta in radians such that cos(theta) is equal to value. FUNCTION TYPE This function is passive. RETURN TYPE float EXAMPLE theta := acos( ) ALARMACCEPT(ALARM) CRIMSON 3 REFERENCE MANUAL PAGE 4 ALARMACCEPT(ALARM) ARGUMENT TYPE DESCRIPTION alarm int A value encoding the alarm to be accepted.

10 DESCRIPTION This function is not implemented in the current build. FUNCTION TYPE This function is active. RETURN TYPE This function does not return a value. APPENDIX A FUNCTION REFERENCE ALARMACCEPTALL() REVISION PAGE 5 ALARMACCEPTALL() ARGUMENT TYPE DESCRIPTION none DESCRIPTION Accepts all active alarms. FUNCTION TYPE This function is passive. RETURN TYPE This function does not return a value. EXAMPLE AlarmAcceptAll() ALARMACCEPTEX(SOURCE, METHOD, CODE) CRIMSON 3 REFERENCE MANUAL PAGE 6 ALARMACCEPTEX(SOURCE, M ETHOD, CODE) ARGUMENT TYPE DESCRIPTION source int The source of the alarm. method int The acceptance method. code int The acceptance code. DESCRIPTION Accepts an alarm that has been signaled by a rich communications driver that is itself capable of generating alarms and events. This functionality is not used by any drivers that are currently included with CRIMSON . FUNCTION TYPE This function is active.