Merge pull request #858 from SAP/combined-prs-branch
[e-mobility-charging-stations-simulator.git] / src / utils / Constants.ts
index c98dae7404389065bb7dbbb06a8ce3a866dd188d..a17b56a8b644b938c29a0f9eef68cfd1d53b1458 100644 (file)
@@ -1,44 +1,64 @@
-export default class Constants {
-  static readonly ENTITY_CHARGING_STATION = 'ChargingStation';
-  static readonly ENTITY_AUTOMATIC_TRANSACTION_GENERATOR = 'AutomaticTransactionGenerator';
-
-  static readonly WS_UNSUPPORTED_DATA = 1007;
-
-  static readonly OCPP_RESPONSE_ACCEPTED = Object.freeze({ status: 'Accepted' });
-  static readonly OCPP_RESPONSE_REJECTED = Object.freeze({ status: 'Rejected' });
-  static readonly OCPP_RESPONSE_REBOOT_REQUIRED = Object.freeze({ status: 'RebootRequired' });
-  static readonly OCPP_SOCKET_TIMEOUT = 60000; // 60 sec
-  static readonly OCPP_JSON_CALL_MESSAGE = 2; // Caller to callee
-  static readonly OCPP_JSON_CALL_RESULT_MESSAGE = 3; // Callee to caller
-  static readonly OCPP_JSON_CALL_ERROR_MESSAGE = 4; // Callee to caller
-  // Requested Action is not known by receiver
-  static readonly OCPP_ERROR_NOT_IMPLEMENTED = 'NotImplemented';
-  // Requested Action is recognized but not supported by the receiver
-  static readonly OCPP_ERROR_NOT_SUPPORTED = 'NotSupported';
-  // An internal error occurred and the receiver was not able to process the requested Action successfully
-  static readonly OCPP_ERROR_INTERNAL_ERROR = 'InternalError';
-  // Payload for Action is incomplete
-  static readonly OCPP_ERROR_PROTOCOL_ERROR = 'ProtocolError';
-  // During the processing of Action a security issue occurred preventing receiver from completing the Action successfully
-  static readonly OCPP_ERROR_SECURITY_ERROR = 'SecurityError';
-  // Payload for Action is syntactically incorrect or not conform the PDU structure for Action
-  static readonly OCPP_ERROR_FORMATION_VIOLATION = 'FormationViolation';
-  // Payload is syntactically correct but at least one field contains an invalid value
-  static readonly OCPP_ERROR_PROPERTY_RAINT_VIOLATION = 'PropertyraintViolation';
-  // Payload for Action is syntactically correct but at least one of the fields violates occurrence raints
-  static readonly OCPP_ERROR_OCCURENCE_RAINT_VIOLATION = 'OccurenceraintViolation';
-  // Payload for Action is syntactically correct but at least one of the fields violates data type raints (e.g. “somestring” = 12)
-  static readonly OCPP_ERROR_TYPERAINT_VIOLATION = 'TyperaintViolation';
-  // Any other error not covered by the previous ones
-  static readonly OCPP_ERROR_GENERIC_ERROR = 'GenericError';
-
-  static readonly OCPP_PROTOCOL_JSON = 'json';
-  static readonly OCPP_PROTOCOL_SOAP = 'soap';
-  static readonly OCPP_VERSION_12 = '1.2';
-  static readonly OCPP_VERSION_15 = '1.5';
-  static readonly OCPP_VERSION_16 = '1.6';
-  static readonly OCPP_VERSION_20 = '2.0';
+import type { AutomaticTransactionGeneratorConfiguration } from '../types';
+
+export class Constants {
+  static readonly DEFAULT_BOOT_NOTIFICATION_INTERVAL = 60000; // Ms
+  static readonly DEFAULT_HEARTBEAT_INTERVAL = 60000; // Ms
+  static readonly DEFAULT_METER_VALUES_INTERVAL = 60000; // Ms
 
   static readonly CHARGING_STATION_DEFAULT_RESET_TIME = 60000; // Ms
-  static readonly CHARGING_STATION_ATG_WAIT_TIME = 2000; // Ms
+  static readonly CHARGING_STATION_ATG_AVAILABILITY_TIME = 1000; // Ms
+  static readonly CHARGING_STATION_ATG_INITIALIZATION_TIME = 1000; // Ms
+
+  static readonly DEFAULT_ATG_CONFIGURATION: AutomaticTransactionGeneratorConfiguration =
+    Object.freeze({
+      enable: false,
+      minDuration: 60,
+      maxDuration: 120,
+      minDelayBetweenTwoTransactions: 15,
+      maxDelayBetweenTwoTransactions: 30,
+      probabilityOfStart: 1,
+      stopAfterHours: 0.25,
+      stopOnConnectionFailure: true,
+    });
+
+  // See https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+  static readonly SEMVER_PATTERN =
+    '^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$';
+
+  static readonly DEFAULT_CIRCULAR_BUFFER_CAPACITY = 4096;
+
+  static readonly DEFAULT_HASH_ALGORITHM = 'sha384';
+
+  static readonly DEFAULT_IDTAG = '00000000';
+
+  static readonly DEFAULT_CONNECTION_TIMEOUT = 30;
+
+  static readonly DEFAULT_LOG_STATISTICS_INTERVAL = 60; // Seconds
+
+  static readonly DEFAULT_FLUCTUATION_PERCENT = 5;
+
+  static readonly DEFAULT_PERFORMANCE_DIRECTORY = 'performance';
+  static readonly DEFAULT_PERFORMANCE_RECORDS_FILENAME = 'performanceRecords.json';
+  static readonly DEFAULT_PERFORMANCE_RECORDS_DB_NAME = 'e-mobility-charging-stations-simulator';
+  static readonly PERFORMANCE_RECORDS_TABLE = 'performance_records';
+
+  static readonly DEFAULT_UI_SERVER_HOST = 'localhost';
+  static readonly DEFAULT_UI_SERVER_PORT = 8080;
+
+  static readonly UNKNOWN_COMMAND = 'unknown command';
+
+  static readonly MAX_RANDOM_INTEGER = 281474976710654;
+
+  static readonly STOP_CHARGING_STATIONS_TIMEOUT = 120000; // Ms
+
+  static readonly EMPTY_FROZEN_OBJECT = Object.freeze({});
+  static readonly EMPTY_FUNCTION = Object.freeze(() => {
+    /* This is intentional */
+  });
+
+  static readonly DEFAULT_MESSAGE_BUFFER_FLUSH_INTERVAL = 60000; // Ms
+
+  private constructor() {
+    // This is intentional
+  }
 }