Changes between Version 4 and Version 5 of tankplayer
- Timestamp:
- 02/27/12 16:43:32 (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
tankplayer
v4 v5 103 103 Function: Playback 104 104 105 Defines the n seconds delay that the GetFromDir should be checked for new tank files. Note that this only effects checks when no tanks are being played back.105 Defines the n seconds delay that the !GetFromDir should be checked for new tank files. Note that this only effects checks when no tanks are being played back. 106 106 {{{ 107 107 Default: 1 108 108 }}} 109 109 110 ''' GetFromDir [dir]'''[[BR]]110 '''!GetFromDir [dir]'''[[BR]] 111 111 Processed by: tankplayer_config[[BR]] 112 112 Function: Playback 113 113 114 Defines the directory dir where to find tank files. This cannot be used in conjunction with WaveFile mode of running. If you set this parameter, then you may also set the OpenWait, OpenTries, CheckPeriod, andSaveDataFiles.115 {{{ 116 Default: none 117 }}} 118 119 ''' InterMessageDelayMillisecs [n_msecs]'''[[BR]]114 Defines the directory dir where to find tank files. This cannot be used in conjunction with !WaveFile mode of running. If you set this parameter, then you may also set the !OpenWait, !OpenTries, !CheckPeriod, and !SaveDataFiles. 115 {{{ 116 Default: none 117 }}} 118 119 '''!InterMessageDelayMillisecs [n_msecs]'''[[BR]] 120 120 Processed by: tankplayer_config [[BR]] 121 121 Function: Playback … … 126 126 }}} 127 127 128 HeartBeatInt nsec tankplayer_config Earthworm setup 128 '''!HeartBeatInt [nsec]''' [[BR]] 129 Processed by: tankplayer_config [[BR]] 130 Function: Earthworm setup 131 129 132 Defines the number of seconds nsec between TYPE_HEARTBEAT messages issued by tankplayer. 130 131 Default: none Calnet: HeartBeatInt 15 132 IgnoreTBVersionNumbers switch tankplayer_config Playback 133 {{{ 134 Default: none 135 Calnet: HeartBeatInt 15 136 }}} 137 138 '''!IgnoreTBVersionNumbers [switch]''' [[BR]] 139 Processed by: tankplayer_config [[BR]] 140 Function: Playback 141 133 142 Prevents tankplayer from objecting to tracebuf2 packets that don't have the correct version field. Not recommended. 143 {{{ 134 144 Default: 0 False 135 LogFile switch tankplayer_config output 136 Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, tankplayer will write a daily log file(s) called tankplayerxx.log_yymmdd where xx is tankplayer's module id (set with "MyModuleId" command) and yymmdd is the current UTC date (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 137 138 Default: none 139 MyModuleId mod_id tankplayer_config Earthworm setup 145 }}} 146 147 '''!LogFile [switch]''' [[BR]] 148 Processed by: tankplayer_config [[BR]] 149 Function: output 150 151 Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, tankplayer will write a daily log file(s) called tankplayerxx.log_yymmdd where xx is tankplayer's module id (set with "!MyModuleId" command) and yymmdd is the current UTC date (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 152 {{{ 153 Default: none 154 }}} 155 156 '''!MyModuleId [mod_id]''' [[BR]] 157 Processed by: tankplayer_config [[BR]] 158 Function: Earthworm setup 159 140 160 Sets the module id for labeling all outgoing messages. mod_id is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. Tankplayer also places this module id in the module id field of each waveform message header before it puts the message into shared memory. 141 161 {{{ 142 162 Default: none 143 163 Example: MyModuleId MOD_ADSEND_A 144 OpenTries n tankplayer_config Playback 145 Defines the number n of times to retry opening a tank file found in the GetFromDir directory. The purpose of this parameter is that sometimes if a copy is used to move the file, it will not be finished writing by the time the tankplayer module gets to it. For that reason, the OpenTries number of open attempts is made to open the file for updating (even though it is just being read from). This assures the file can be read exclusively by the tankplayer module. If the file is not readable after 5 tries it is not attempted. Between each try, the program waits OpenWait milliseconds. 146 147 Default: 5 148 OpenWait n tankplayer_config Playback 149 Defines the number n milliseconds to pause before retrying an open of a file in the GetFromDir directory. 150 164 }}} 165 166 '''!OpenTries [n]''' [[BR]] 167 Processed by: tankplayer_config [[BR]] 168 Function: Playback 169 170 Defines the number n of times to retry opening a tank file found in the !GetFromDir directory. The purpose of this parameter is that sometimes if a copy is used to move the file, it will not be finished writing by the time the tankplayer module gets to it. For that reason, the OpenTries number of open attempts is made to open the file for updating (even though it is just being read from). This assures the file can be read exclusively by the tankplayer module. If the file is not readable after 5 tries it is not attempted. Between each try, the program waits !OpenWait milliseconds. 171 {{{ 172 Default: 5 173 }}} 174 175 '''!OpenWait [n]''' [[BR]] 176 Processed by: tankplayer_config [[BR]] 177 Function: Playback 178 179 Defines the number n milliseconds to pause before retrying an open of a file in the !GetFromDir directory. 180 {{{ 151 181 Default: 200 152 153 Pause nsec tankplayer_config Playback 182 }}} 183 184 '''!Pause [nsec]''' [[BR]] 185 Processed by: tankplayer_config [[BR]] 186 Function: Playback 187 154 188 Defines the integer number of seconds nsec to pause after completing the playback of one waveform file before starting the playback of the next. Tankplayer will continue to issue its heartbeat while it is in pause-mode. 155 189 {{{ 156 190 Default: none 157 191 Example: Pause 15 158 PlayMsgType type tankplayer_config Playback 192 }}} 193 194 '''!PlayMsgType [type]''' [[BR]] 195 Processed by: tankplayer_config [[BR]] 196 Function: Playback 197 159 198 Tells tankplayer what type of message the waveform file(s) contain. type is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. By the message-type, tankplayer knows the format of the waveform message; currently tankplayer only knows how to read and manipulate TYPE_ADBUF TYPE_TRACEBUF, and TYPE_TRACEBUF2 waveform messages. 160 199 {{{ 161 200 Default: none 162 201 Example: PlayMsgType TYPE_TRACEBUF2 163 RingName ring tankplayer_config Earthworm setup 202 }}} 203 204 '''!RingName [ring]''' [[BR]] 205 Processed by: tankplayer_config [[BR]] 206 Function: Earthworm setup 207 164 208 Tells tankplayer which shared memory region to use for output. ring is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region. 165 209 {{{ 166 210 Default: none Calnet: RingName WAVE_RING 167 168 SaveDataFiles n tankplayer_config Playback 169 If n is set to 1, then the tankfiles found in the GetFromDir directory are saved to GetFromDir/save. If n is set to 0, the tank files are deleted.. 170 171 Default: 1 172 SendLate xsec tankplayer_config Playback 211 }}} 212 213 '''!SaveDataFiles [n]''' [[BR]] 214 Processed by: tankplayer_config [[BR]] 215 Function: Playback 216 217 If n is set to 1, then the tankfiles found in the !GetFromDir directory are saved to !GetFromDir/save. If n is set to 0, the tank files are deleted.. 218 {{{ 219 Default: 1 220 }}} 221 222 '''!SendLate [xsec]''' [[BR]] 223 Processed by: tankplayer_config [[BR]] 224 Function: Playback 225 173 226 Defines the integer number of seconds xsec before current time to label the packets with. This is useful for carlsubtrig usage and tuning. 174 227 {{{ 175 228 Default: none, this is an optional setting. 176 229 Example: SendLate 45 177 StartUpDelay xsec tankplayer_config Playback 230 }}} 231 232 '''!StartUpDelay [xsec]''' [[BR]] 233 Processed by: tankplayer_config [[BR]] 234 Function: Playback 235 178 236 Defines the integer number of seconds xsec to wait on startup before beginning the playback of the first waveform file. Tankplayer will continue to issue its heartbeat while it is in startup-delay mode. 179 237 {{{ 180 238 Default: none 181 239 Example: StartUpDelay 45 182 WaveFile path-file tankplayer_config Playback 183 Gives the name path-file of one waveform file that tankplayer should play back. path-file is a character string up to 45 characters long. Up to 50 "WaveFile" commands may be issued. Tankplayer will play the files in the order that they were listed in the configuration file, pausing between files by amount of time set in the "Pause" command. All files must contain the same type of waveform message (specified in the "PlayMsgType" command). 184 240 }}} 241 242 '''!WaveFile [path-file]''' [[BR]] 243 Processed by: tankplayer_config [[BR]] 244 Function: Playback 245 246 Gives the name path-file of one waveform file that tankplayer should play back. path-file is a character string up to 45 characters long. Up to 50 "!WaveFile" commands may be issued. Tankplayer will play the files in the order that they were listed in the configuration file, pausing between files by amount of time set in the "Pause" command. All files must contain the same type of waveform message (specified in the "!PlayMsgType" command). 247 {{{ 185 248 Default: none 186 249 Example: WaveFile event1.waves 250 }}} 251 187 252 == Helpful Hints ==
