laatzen/ServiceFwUpdate/Common/FwUpdateConfig/Consts/FwUpdateConfig.cs
2023-09-26 12:58:30 +02:00

122 lines
5.0 KiB
C#

using System;
using Xylem.Common.CommonCore.Consts;
namespace Xylem.ServiceFwUpdate.Common.FwUpdateConfig.Consts
{
/// <summary>
/// Configuration of FW-Update specific settings.
/// </summary>
[Serializable]
public static class FwUpdateConfig
{
/// <summary>
/// Standard days for user validation for FW-Update SW on registration with FW-Update Loader.
/// </summary>
public const UInt32 ValidDays = 21;
/// <summary>
/// Search strings for "Firmware up to date!" messages in report file, copied from Resources.resx of all
/// language packages from "ServiceFwUpdateSw"
/// </summary>
public static readonly String[] FirmwareUpToDateSearchStrings =
{
"Firmware is up to date!",
"Firmware ist aktuell!"
};
/// <summary>
/// Name of settings file being able to restores settings on crashed update procedure on next login.
/// </summary>
public const String RestoreSettingsFileName = "RestoreSettings.json";
/// <summary>
/// Name of the file which contains the meter file names that can be erased before the FW-Update
/// to free disk space and have to be restored after the FW-Update
/// </summary>
public const String MeterFwUpdateRulerConfigFileName = "MeterFwUpdateRuler.json";
/// <summary>
/// Name of the file which contains the meter file names that can be erased before the FW-Update
/// to free disk space and have to be restored after the FW-Update
/// </summary>
public const String MeterFilesEraseRestoreConfigFileName = "MeterFilesEraseRestore.json";
/// <summary>
/// Path for FW-Update report files which are not uploaded to the Xylem DB.
/// The FW-Update SW stores all files needed to report, the FW-Update Loader will load, report, backup
/// and erase it from this location.
/// </summary>
public const String UnreportedPath = ProgramConfig.BaseLoggingPath + "FwUpdateUnreported\\";
/// <summary>
/// Path for FW-Update report files which are already uploaded to the Xylem DB.
/// At this location all reported files will be backup by the FW-Update Loader .
/// </summary>
public const String ReportedPath = ProgramConfig.BaseLoggingPath + "FwUpdateReported\\";
/// <summary>
/// Name of local user registration file .
/// </summary>
public const String UserRegistrationFileName = "UserInformation.register";
/// <summary>
/// FW-Update safe default location.
/// </summary>
public const String DefaultFwUpdateSafePath = "Downloads\\FwUpdateSafe\\";
/// <summary>
/// FW-Update safe default location.
/// </summary>
public const String DefaultFwUpdateSwSourcePath = "Downloads\\ServiceFwUpdateSw\\";
/// <summary>
/// Path for FW-Update for a backup of information of already downloaded FW-Update Safes. This will be
/// used by the FW-Update Loader to exclude already downloaded safes.
/// </summary>
public const String FwUpdateSafeInfoBackupPath = "Downloads\\FwUpdateSafesDownloded\\";
/// <summary>
/// Extension for app version files, needed by FW-Update SW to build and FW-Update Loader to read and upload.
/// </summary>
public const String AppVersionFileExtension = ".applist";
/// <summary>
/// Extension for backup name of loaded safes needed by the FW-Update Loader to exclude these from download.
/// </summary>
public const String LoadedSafesBackupFileExtension = ".exclude";
/// <summary>
/// Extension for report files, needed by FW-Update SW to build and FW-Update Loader to read and upload.
/// </summary>
public const String ReportFileExtension = ".report";
/// <summary>
/// Extension for report files, needed by FW-Update SW to build and FW-Update Loader to read and upload.
/// </summary>
public const String FwUpdateFileExtension = ".safe";
/// <summary>
/// Library-subfolder: For releases the files are sorted to subfolders to avoid confusion of the user.
/// </summary>
public const String LibrarySubFolderName = "Library";
/// <summary>
/// Library-subfolder: For releases the files are sorted to subfolders to avoid confusion of the user.
/// </summary>
public const String ConfigSubFolderName = "Config";
/// <summary>
/// Separator in file name between PcbId CustomerName and OrderNumber for the FW-Update Safe and all report
/// files.
/// </summary>
public const Char FwUpdateFileFieldSeparator = '_';
/// <summary>
/// Separator in file name between OrderNumber and position for the FW-Update Safe and all report
/// files.
/// </summary>
public const Char FwUpdateFileOrderPosSeparator = '-';
}
}