Datalogger Handlers
Geoprecision
- tsp.dataloggers.detect_geoprecision_type(file: str) Type[AbstractReader] | None
Detect whether a geoprecision file uses from a ‘GP5W’ or ‘FG2’ firmware and return a
- Parameters:
file (str) – Path to a geoprecision file.
- Returns:
An appropriate file reader. If the file corresponds to neither GP5W or FG2, None is returned.
- Return type:
Optional[Type[AbstractReader]]
HoboWare
- class tsp.dataloggers.HOBO(properties: HOBOProperties | None = None)
Bases:
AbstractReader- read(file: str) DataFrame
Read a HOBOWare CSV export using the properties
- Parameters:
file (str) – Path to HoboWare CSV export
- Returns:
A pandas dataframe with only the data
- Return type:
pandas.DataFrame
- class tsp.dataloggers.HOBOProperties(separator: str = ',', include_line_number: bool = True, include_plot_title_in_header: bool = True, always_show_fractional_seconds: bool = False, separate_date_time: bool = False, no_quotes_or_commas: bool = False, include_logger_serial: bool = True, include_sensor_serial: bool = True, date_format: str = 'MDY', date_separator: str = '/', time_format_24hr: bool = False, positive_number_format: int = 1, negative_number_format: int = 1, include_plot_details: bool = False)
Bases:
object- classmethod autodetect(file, n_lines=400)
Automatically detect properties from a file
- classmethod classic()
Create a HOBO Properties object using HOBOWare ‘classic’ settings
- property decimal_separator: str
Return the decimal separator
- Returns:
decimal separator character
- Return type:
str
- classmethod defaults()
Create a HOBO Properties object using HOBOWare defaults
- classmethod from_file(file)
Create a HOBO Properties object from a text file
- get_properties()
Create dictionary-formatted properties
- property positive_number_format: int
Get the positive number format.
- Returns:
Positive number format as an index
- Return type:
int
- static read(file)
Read HOBO file properties from a text file.
- property thousands_separator: str
Get thousands separator
- Returns:
Thousands separator character
- Return type:
str
- write(file)
Write HOBO properties to a text file.
LogR
- class tsp.dataloggers.LogR
Bases:
object