menu

The article describes the user accessible part of the file structure of a ToolScope, TooScope Server and SoftScope.

Basics

The ToolScope firmware offers two file structures externally.

  1. An area for log files
  2. An area for service aspects

The directory structure within the areas is the same on ToolScopes, SoftScopes or ToolScope Servers. The screenshots in this article are thus made in SoftScopes.

Log file area

Generics

 

The log file area offers two type of directories in the uppermost level:

  1. Directories from monitoring channels. They are named by the window name and the window number (same as in the user interface).
  2. A Service directory

Log files from monitoring channels

The log files from monitoring channels are stored in subdirectories per hour. The folder names contain the date and the hour of the day.

Within those hourly directories one finds typically:

  • CSV files of recorded measuring data
  • PNG files of monitoring channel screenshot in two sizes. First size: the size as it is drawn on the screen, second size: the siz as it is drawn, if the monitoring window is zoomed in the offline mode
  • PDF files, if you licenced this and enabled the PDFgeneration; be careful: PDF generation includes a full screenshots of the live screen. This enforces a full stop of several actions, taking the photo, and restarting. The PDF generation halts the system for some 100ms. This will not lead to data los, because all data is stored in the mean time and processed afterwards much faster, till the system is "in time" again. But: if you have performance or timing problems: disable the PDF generation.

    Some channels have additional information. E.G. "Average" channels do store their shown curve as CSV file, too, so that you can use it for trend analysis and statistical purposes in external software.

Service logs from several parts of the firmware

The service directory contains:

  • raw text files of the alarm monitor (Alarm Monitor)
  • raw CSV files of the app TS-MDA (Shift Log)
  • raw CSV files of the app TS-TCLog (within User log)
  • raw CSV files of changes of settings by the user (within User log)
  • Quality assurance topics (see internal Knowledge Base of KOMET BRINKHAUS)

Service file area

Generics

The service file area offers files, which are mostly relevant for service purposes.

The directory is watched by a thread which posts messages into the view under Service > Diagnosis, if there is a file which does not belog there for a longer time. This is meant to enforce a cleanup of this directory.

Contents

The single components of this directory are

  • The directory itsself

    Backups of Settings or processes are placed here and restored from here.
     
  • Custom

    A directory where the user can place files; here e.g. sensor mappings for the "characteristic map" driver can be placed.
     
  • Hotfix

    Installed hotfixes are placed here. A deletion of all files which are placed here, removes the hotfix completely. Do not do this while the user interface is shown, if you want to use the interface afterwards. Do this only, if you can enforce a reboot (by e.g. pulling the power plug) afterwards.
     
  • LicenceBackup

    The currently working licences are backuped here. This is meant as backup if you restore settings, which were backuped on an other ToolScope. After restoring the backup, the licences do not fit.

    If the ToolScope realizes, that no licence is valid for the current device, it restores backuped licences from here.
     
  • Systemlogs

    Low-Level-Logs or logs which shall not be stored in the main log area.
     
    • FileSystemCleaner

      Deletion protocol of the threads which clean the oldest file sin directories, if the directories run full.
       
    • GarbageCollection

      Protocols around the memory system (RAM) of the ToolScope. There is a seperate article around the possibilities of analyzing RAM issues.

Settings file area

The settings files are not directly accessible, but a user can reach them. This is only useful for rare purposes.

The folder contains a main directory with the main database and perhaps other small files. Additionally there is a directory "BigStorage" which contains other files, like process information and touchscreen calibration data.

Regarding processes: each process is saved as one file. The file names are the result hashing the process identifiers (program name, tool name, ... ). The hashing makes the file name lengths indepedent from content of the process identifiers. A file "phoneBook.txt" which is places in the directory "Processes" lists all stored processes. For customized mass deletion of old processes it is therefore possible to delete all lines of unwanted processes from the "phoneBook.txt", while the firmware is not active. At the next restart of the software, all process files which do not belong to an entry in the phone book are deleted as part of housekeeping consistency checks.