logdoc.c File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

 puts ("The format of the -log output is:")
 puts ("YYYY.MM.DD-hh.mm.ss epoch name:serial key0 value0_0 value0_1 ... key1 value1_0 key2...")
 puts ("")
 puts ("The time (first and second fields) represents the uncorrected time")
 puts ("(station system time).")
 puts ("A key may be followed by one or more values. The number of values for a")
 puts ("given key is constant.")
 puts ("The lines beginning with '#' should be ignored.")
 puts ("The information is issued when a significant change of a value is")
 puts ("detected: e.g. the software release won't be issued each time the frame")
 puts ("is decoded.")
 puts ("Below is a full description of each key/value pair of the log:")
 puts ("FormatVersion value0")
 puts ("value0: Titan format version (A.B.C)")
 puts ("ReaderVersion value0")
 puts ("value0: Titan2Reader release (X.Y.Z)")
 puts ("X.Y.Z must be higher than A.B.C.")
 puts ("StationBoot value0")
 puts ("value0: epoch time since the station boot")
 puts ("TimeReset value0")
 puts ("value0: epoch time used during the previous time reset.")
 puts ("StationName value0")
 puts ("value0: the station name (as setup in the station parameters).")
 puts ("SerialNumber value0")
 puts ("value0: serial number of the station.")
 puts ("SoftwareRelease value0")
 puts ("value0: Dddd-Aaaa, ddd is the DSP firwmare release, aaa is the Osiris")
 puts ("system release. Does not apply for Titan digitizers.")
 puts ("Freq0, Decim0, Len0, Len1, Delay, ADCId describe the decimation chain")
 puts ("and is used internally to compute the filter delay times. These")
 puts ("informations are also issued in the .info files.")
 puts ("Freq0 value0")
 puts ("value0: A/D converter head sampling rate.")
 puts ("Decim0 value0")
 puts ("value0: first decimation order (applied at most once)")
 puts ("Len0 value0")
 puts ("value0: length of the first decimation filter")
 puts ("Len1 value0")
 puts ("value0: length of the secondary decimation filters")
 puts ("Vbatt value0")
 puts ("value0: external power supply")
 puts ("ADCId value0")
 puts ("value0: A/D converter numeric identification")
 puts ("Delay value0")
 puts ("value0: static delay time for the A/D converter (samples at the head")
 puts ("frequency Freq0)")
 puts ("LSB(nV) value0")
 puts ("value0: LSB")
 puts ("InputImp(kOhm)")
 puts ("value0: input impedance in kOhm")
 puts ("G0 value0")
 puts ("G1 value0")
 puts ("G2 value0")
 puts ("G3 value0")
 puts ("value0: gain value for index 0 (always value 1), 1, 2, and 3.")
 puts ("ChannelName value0 value1")
 puts ("value0: channel number")
 puts ("value1: channel name.")
 puts ("The channel name is built after the network name, station name, channel")
 puts ("code and location name, as in the following example:")
 puts ("2007.12.06-00.00.02 1196899202 LEPF:057.0002 ChannelName 00 FR:LEPF.EHZ.00")
 puts ("HPFilterPeriodX value0")
 puts ("value0: high pass cut-off frequency for channel X")
 puts ("FSChannelX value0")
 puts ("value0: sampling rate for channel X")
 puts ("ClockMode value0")
 puts ("value0: requested clock mode")
 puts ("The clock mode reflects the ClockMode parameter, refer to the Osiris")
 puts ("family documentation. This key/value pair as well as the ClockState pair")
 puts ("should be ignored for stations that do not have the hardware for clock")
 puts ("adjustement (Osiris data loggers do not implement this feature).")
 puts ("ClockState value0")
 puts ("value0: actual state")
 puts ("The value indicates the current state of the internal clock")
 puts ("(free/frequency_locked/phase_locked).")
 puts ("FlashBytes value0")
 puts ("value0: flash used")
 puts ("HardDiskData(MB) value0")
 puts ("value0: storage used (Mbytes)")
 puts ("AvgLat value0")
 puts ("AvgLon value0")
 puts ("AvgElev value0")
 puts ("value0: average latitude, longitude, elevation")
 puts ("InstLat value0")
 puts ("InstLon value0")
 puts ("InstElev value0")
 puts ("value0: instantaneous latitude, longitude, elevation")
 puts ("NSat value0")
 puts ("value0: instantaneous number of satellites used")
 puts ("The following keys report the Titan1 configuration and state. They are")
 puts ("issued only for Titan1 digitizers.")
 puts ("PreEvent(s) value0")
 puts ("value0: pre event time")
 puts ("PostEvent(s) value0")
 puts ("value0: post event time")
 puts ("EndDuration(s) value0")
 puts ("value0: en duration")
 puts ("EndMode value0")
 puts ("value0: LTA/LTA0 or STA/LTA0")
 puts ("CyclePolicy value0")
 puts ("value0: cycle or stop")
 puts ("Gain value0")
 puts ("value0: gain")
 puts ("PulseLength(ms) value0")
 puts ("value0: reference duration for the time mark")
 puts ("ValidIf value0")
 puts ("value0: shorter/longer, defines the validity of a time mark")
 puts ("PPM value0")
 puts ("value0: number of pulses per minute expected")
 puts ("Reboot value0")
 puts ("value0: yes/no, time was or was not set by a reboot")
 puts ("Triplet value0 sta value1 lta value2 FS value3 Thr value4 ON value5 OFFSET value6")
 puts ("value0: triplet number")
 puts ("value1: STA window length (s)")
 puts ("value2: LTA window length (s)")
 puts ("value3: sampling rate")
 puts ("value4: trigger threshold")
 puts ("value5: 1/0, active/not active")
 puts ("value6: 1/0, offset correction enable/disable")
 puts ("ADCNumber value0")
 puts ("value0: number of A/D converters")
 puts ("value0: numeric id of the A/D converters")
 puts ("ADCName value0")
 puts ("value0: name of the A/D converters")
 puts ("SamplingSet value0")
 puts ("value0: base sampling rate (250 or 160Hz)")
 puts ("TimeKeeper value0")
 puts ("value0: yes/no station has a time keeper")
 puts ("ParallelLink value0")
 puts ("value0: yes/no, station implements the data dump over a parallel link")
 puts ("AUXChannels value0")
 puts ("value0: yes/no, station implements aux. channels")
 puts ("RadioMode value0")
 puts ("value0: yes/no, station is running with radio mode enable")
 puts ("LostFlushMediumError value0")
 puts ("value0: number of flush lost because of medium errors")
 puts ("LostFlushLowBatt value0")
 puts ("value0: number of flush lost because of low battery level")
 puts ("FlashCycles value0")
 puts ("value0: number of flash cycles")
 puts ("FlushState value0")
 puts ("value0: NotRunning, LoadingMedium, SeekingEnd, WritingData, Rewinding,")
 puts ("WritingIndex, UnloadingMedium")
 puts ("FlushRunning value0")
 puts ("value0: 1/0 flush is currently running")
 puts ("MEDIUMERROR value")
 puts ("vaule0: last medium error reported, one or more of: TimeOut, LinkSCSI,")
 puts ("LowBatt, UnexpectedSCSIAnswer, LoadingError, MediumFull, Unknown,")
 puts ("NoMedium.")
 puts ("TriggerInProcess value0")
 puts ("value0: yes/no, an triggered event is going on")
 puts ("Detections value0")
 puts ("value0: number of triggered events")
 puts ("RecordingMode value0")
 puts ("value0: continuous/trigger")
 puts ("RecordingTarget value0")
 puts ("value0: disk/DAT")
 puts ("ContinuousGPS value0")
 puts ("value0: yes/no")
 puts ("FlashCapacity(MB) value0")
 puts ("value0: flash capacity")
 puts ("StorageCapacity(2+GB) value0")
 puts ("value0: yse/no, the storage medium is larger than 2Gbytes")


Function Documentation

puts ( "value0: yse/  no,
the storage medium is larger than 2Gbytes"   
)

puts ( "StorageCapacity(2+GB) value0"   ) 

puts ( "value0: flash capacity"   ) 

puts ( "FlashCapacity(MB) value0"   ) 

puts ( "value0: yes/no"   ) 

puts ( "ContinuousGPS value0"   ) 

puts ( "value0: disk/DAT"   ) 

puts ( "RecordingTarget value0"   ) 

puts ( "value0: continuous/trigger  ) 

puts ( "RecordingMode value0"   ) 

puts ( "value0: number of triggered events"   ) 

puts ( "Detections value0"   ) 

puts ( "value0: yes/  no,
an triggered event is going on"   
)

puts ( "TriggerInProcess value0"   ) 

puts ( "NoMedium."   ) 

puts ( LowBatt,
UnexpectedSCSIAnswer  ,
LoadingError  ,
MediumFull  ,
Unknown  ,
 
)

puts ( "vaule0: last medium error   reported,
one or more of:TimeOut  ,
LinkSCSI  ,
 
)

puts ( "MEDIUMERROR value"   ) 

puts ( "value0: 1/0 flush is currently running"   ) 

puts ( "FlushRunning value0"   ) 

puts ( WritingIndex,
UnloadingMedium"   
)

puts ( "value0:   NotRunning,
LoadingMedium  ,
SeekingEnd  ,
WritingData  ,
Rewinding  ,
 
)

puts ( "FlushState value0"   ) 

puts ( "value0: number of flash cycles"   ) 

puts ( "FlashCycles value0"   ) 

puts ( "value0: number of flush lost because of low battery level"   ) 

puts ( "LostFlushLowBatt value0"   ) 

puts ( "value0: number of flush lost because of medium errors"   ) 

puts ( "LostFlushMediumError value0"   ) 

puts ( "value0: yes/  no,
station is running with radio mode enable"   
)

puts ( "RadioMode value0"   ) 

puts ( "value0: yes/  no,
station implements aux.channels"   
)

puts ( "AUXChannels value0"   ) 

puts ( "value0: yes/  no,
station implements the data dump over a parallel link"   
)

puts ( "ParallelLink value0"   ) 

puts ( "value0: yes/no station has a time keeper"   ) 

puts ( "TimeKeeper value0"   ) 

puts ( "value0: base sampling rate (250 or 160Hz)"   ) 

puts ( "SamplingSet value0"   ) 

puts ( "value0: name of the A/D converters"   ) 

puts ( "ADCName value0"   ) 

puts ( "value0: numeric id of the A/D converters"   ) 

puts ( "value0: number of A/D converters"   ) 

puts ( "ADCNumber value0"   ) 

puts ( "value6: 1/  0,
offset correction enable/disable"   
)

puts ( "value5: 1/  0,
active/not active"   
)

puts ( "value4: trigger threshold  ) 

puts ( "value3: sampling rate"   ) 

puts ( "value2: LTA window length (s)"   ) 

puts ( "value1: STA window length (s)"   ) 

puts ( "value0: triplet number"   ) 

puts ( "Triplet value0 sta value1 lta value2 FS value3 Thr value4 ON value5 OFFSET value6"   ) 

puts ( "value0: yes/  no,
time was or was not set by a reboot"   
)

puts ( "Reboot value0"   ) 

puts ( "value0: number of pulses per minute expected"   ) 

puts ( "PPM value0"   ) 

puts ( "value0: shorter/  longer,
defines the validity of a time mark"   
)

puts ( "ValidIf value0"   ) 

puts ( "value0: reference duration for the time mark"   ) 

puts ( "PulseLength(ms) value0"   ) 

puts ( "value0: gain"   ) 

puts ( "Gain value0"   ) 

puts ( "value0: cycle or stop"   ) 

puts ( "CyclePolicy value0"   ) 

puts ( "value0: LTA/LTA0 or STA/LTA0"   ) 

puts ( "EndMode value0"   ) 

puts ( "value0: en duration"   ) 

puts ( "EndDuration(s) value0"   ) 

puts ( "value0: post event time"   ) 

puts ( "PostEvent(s) value0"   ) 

puts ( "value0: pre event time"   ) 

puts ( "PreEvent(s) value0"   ) 

puts ( "issued only for Titan1 digitizers."   ) 

puts ( "The following keys report the Titan1 configuration and state. They are"   ) 

puts ( "value0: instantaneous number of satellites used"   ) 

puts ( "NSat value0"   ) 

puts ( "value0: instantaneous   latitude,
longitude  ,
elevation"   
)

puts ( "InstElev value0"   ) 

puts ( "InstLon value0"   ) 

puts ( "InstLat value0"   ) 

puts ( "value0: average   latitude,
longitude  ,
elevation"   
)

puts ( "AvgElev value0"   ) 

puts ( "AvgLon value0"   ) 

puts ( "AvgLat value0"   ) 

puts ( "value0: storage used (Mbytes)"   ) 

puts ( "HardDiskData(MB) value0"   ) 

puts ( "value0: flash used"   ) 

puts ( "FlashBytes value0"   ) 

puts ( "(free/frequency_locked/phase_locked)."   ) 

puts ( "The value indicates the current state of the internal clock"   ) 

puts ( "value0: actual state"   ) 

puts ( "ClockState value0"   ) 

puts ( "adjustement (Osiris data loggers do not implement this feature)."   ) 

puts ( "should be ignored for stations that do not have the hardware for clock"   ) 

puts ( "family documentation. This key/value pair as well as the ClockState pair"   ) 

puts ( "The clock mode reflects the ClockMode   parameter,
refer to the Osiris"   
)

puts ( "value0: requested clock mode"   ) 

puts ( "ClockMode value0"   ) 

puts ( "value0: sampling rate for channel X"   ) 

puts ( "FSChannelX value0"   ) 

puts ( "value0: high pass cut-off frequency for channel X"   ) 

puts ( "HPFilterPeriodX value0"   ) 

puts ( "2007.12.06-00.00.02 1196899202 LEPF:057.0002 ChannelName 00 FR:LEPF.EHZ.00"   ) 

puts ( "code and location   name,
as in the following example:"   
)

puts ( "The channel name is built after the network   name,
station  name,
channel"   
)

puts ( "value1: channel name."   ) 

puts ( "value0: channel number"   ) 

puts ( "ChannelName value0 value1"   ) 

puts ( "value0: gain value for index 0   always value 1,
,
,
and 3."   
)

puts ( "G3 value0"   ) 

puts ( "G2 value0"   ) 

puts ( "G1 value0"   ) 

puts ( "G0 value0"   ) 

puts ( "value0: input impedance in kOhm"   ) 

puts ( "InputImp(kOhm)"   ) 

puts ( "value0: LSB"   ) 

puts ( "LSB(nV) value0"   ) 

puts ( "frequency   Freq0  ) 

puts (  ) 

puts ( "Delay value0"   ) 

puts ( "value0: A/D converter numeric identification"   ) 

puts ( "ADCId value0"   ) 

puts ( "value0: external power supply"   ) 

puts ( "Vbatt value0"   ) 

puts ( "value0: length of the secondary decimation filters"   ) 

puts ( "Len1 value0"   ) 

puts ( "value0: length of the first decimation filter"   ) 

puts ( "Len0 value0"   )