X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConstants.ts;h=ee9d96d9d03c00fb920b0664086fdcdd406ca730;hb=b25b86842dc61b2a95f672dcf38992f7d63d6ec3;hp=0057f066e34dcf5efcb233e85a26888232e97e45;hpb=7f134acac81b80858d53ce3195e3e4ce3e3eec0f;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Constants.ts b/src/utils/Constants.ts
index 0057f066..ee9d96d9 100644
--- a/src/utils/Constants.ts
+++ b/src/utils/Constants.ts
@@ -1,144 +1,137 @@
+import { MeterValueMeasurand } from '../types/ocpp/MeterValues';
+import {
+  AvailabilityStatus,
+  ChargingProfileStatus,
+  ClearChargingProfileStatus,
+  ConfigurationStatus,
+  DataTransferStatus,
+  DefaultStatus,
+  TriggerMessageStatus,
+  UnlockStatus,
+} from '../types/ocpp/Responses';
+
 export default class Constants {
-  static REST_RESPONSE_SUCCESS = { status: 'Success' };
-
-  static CONN_STATUS_AVAILABLE = 'Available';
-  static CONN_STATUS_OCCUPIED = 'Occupied';
-
-  static STATS_GROUP_BY_CONSUMPTION = 'C';
-  static STATS_GROUP_BY_USAGE = 'U';
-
-  // Statuses
-  static ENTITY_SITE = 'Site';
-  static ENTITY_SITES = 'Sites';
-  static ENTITY_SITE_AREA = 'SiteArea';
-  static ENTITY_SITE_AREAS = 'SiteAreas';
-  static ENTITY_COMPANY = 'Company';
-  static ENTITY_COMPANIES = 'Companies';
-  static ENTITY_CHARGING_STATION = 'ChargingStation';
-  static ENTITY_CHARGING_STATIONS = 'ChargingStations';
-  static ENTITY_TENANT = 'Tenant';
-  static ENTITY_TENANTS = 'Tenants';
-  static ENTITY_TRANSACTION = 'Transaction';
-  static ENTITY_TRANSACTIONS = 'Transactions';
-  static ENTITY_TRANSACTION_METER_VALUES = 'MeterValues';
-  static ENTITY_TRANSACTION_STOP = 'Stop';
-  static ENTITY_USER = 'User';
-  static ENTITY_USERS = 'Users';
-  static ENTITY_VEHICLE_MANUFACTURER = 'VehicleManufacturer';
-  static ENTITY_VEHICLE_MANUFACTURERS = 'VehicleManufacturers';
-  static ENTITY_VEHICLES = 'Vehicles';
-  static ENTITY_VEHICLE = 'Vehicle';
-  static ENTITY_LOGGINGS = 'Loggings';
-  static ENTITY_LOGGING = 'Logging';
-  static ENTITY_PRICING = 'Pricing';
-
-  static NOTIFICATION_TYPE_CHARGING_STATION_CONFIGURATION = 'Configuration';
-
-  static ACTION_READ = 'Read';
-  static ACTION_CREATE = 'Create';
-  static ACTION_UPDATE = 'Update';
-  static ACTION_DELETE = 'Delete';
-
-  static NO_LIMIT = 0;
-
-  static CENTRAL_SERVER = 'Central Server';
-
-  static WITH_CONNECTORS = true;
-  static WITHOUT_CONNECTORS = false;
-
-  static WITH_CHARGING_STATIONS = true;
-  static WITHOUT_CHARGING_STATIONS = false;
-  static WITH_SITE = true;
-  static WITHOUT_SITE = false;
-
-  static VEHICLE_TYPE_CAR = 'C';
-
-  // Statuses
-  static USER_STATUS_PENDING = 'P';
-  static USER_STATUS_ACTIVE = 'A';
-  static USER_STATUS_DELETED = 'D';
-  static USER_STATUS_INACTIVE = 'I';
-  static USER_STATUS_BLOCKED = 'B';
-  static USER_STATUS_LOCKED = 'L';
-
-  // Roles
-  static ROLE_SUPER_ADMIN = 'S';
-  static ROLE_ADMIN = 'A';
-  static ROLE_BASIC = 'B';
-  static ROLE_DEMO = 'D';
-  static ACTION_LOGOUT = 'Logout';
-  static ACTION_LIST = 'List';
-  static ACTION_RESET = 'Reset';
-  static ACTION_AUTHORIZE = 'Authorize';
-  static ACTION_CLEAR_CACHE = 'ClearCache';
-  static ACTION_STOP_TRANSACTION = 'StopTransaction';
-  static ACTION_START_TRANSACTION = 'StartTransaction';
-  static ACTION_REFUND_TRANSACTION = 'RefundTransaction';
-  static ACTION_UNLOCK_CONNECTOR = 'UnlockConnector';
-  static ACTION_GET_CONFIGURATION = 'GetConfiguration';
-
-  // Password constants
-  static PWD_MIN_LENGTH = 15;
-  static PWD_MAX_LENGTH = 20;
-  static PWD_UPPERCASE_MIN_COUNT = 1;
-  static PWD_LOWERCASE_MIN_COUNT = 1;
-  static PWD_NUMBER_MIN_COUNT = 1;
-  static PWD_SPECIAL_MIN_COUNT = 1;
-
-  static PWD_UPPERCASE_RE = /([A-Z])/g;
-  static PWD_LOWERCASE_RE = /([a-z])/g;
-  static PWD_NUMBER_RE = /([\d])/g;
-  static PWD_SPECIAL_CHAR_RE = /([!#$%^&*.?-])/g;
-
-  static DEFAULT_LOCALE = 'en_US';
-
-  static ANONYMIZED_VALUE = '####';
-
-  static DEFAULT_DB_LIMIT = 100;
-
-  static METER_VALUE_CTX_SAMPLE_PERIODIC = 'Sample.Periodic';
-  static METER_VALUE_CTX_SAMPLE_CLOCK = 'Sample.Clock';
-
-  static WS_UNSUPPORTED_DATA = 1007;
-
-  static OCPP_RESPONSE_ACCEPTED = { status: 'Accepted' };
-  static OCPP_RESPONSE_REJECTED = { status: 'Rejected' };
-  static OCPP_RESPONSE_REBOOT_REQUIRED = { status: 'RebootRequired' };
-  static OCPP_SOCKET_TIMEOUT = 60000; // 60 sec
-  static OCPP_JSON_CALL_MESSAGE = 2; // Caller to callee
-  static OCPP_JSON_CALL_RESULT_MESSAGE = 3; // Callee to caller
-  static OCPP_JSON_CALL_ERROR_MESSAGE = 4; // Callee to caller
-  // Requested Action is not known by receiver
-  static OCPP_ERROR_NOT_IMPLEMENTED = 'NotImplemented';
-  // Requested Action is recognized but not supported by the receiver
-  static OCPP_ERROR_NOT_SUPPORTED = 'NotSupported';
-  // An internal error occurred and the receiver was not able to process the requested Action successfully
-  static OCPP_ERROR_INTERNAL_ERROR = 'InternalError';
-  // Payload for Action is incomplete
-  static OCPP_ERROR_PROTOCOL_ERROR = 'ProtocolError';
-  // During the processing of Action a security issue occurred preventing receiver from completing the Action successfully
-  static OCPP_ERROR_SECURITY_ERROR = 'SecurityError';
-  // Payload for Action is syntactically incorrect or not conform the PDU structure for Action
-  static OCPP_ERROR_FORMATION_VIOLATION = 'FormationViolation';
-  // Payload is syntactically correct but at least one field contains an invalid value
-  static OCPP_ERROR_PROPERTY_RAINT_VIOLATION = 'PropertyraintViolation';
-  // Payload for Action is syntactically correct but at least one of the fields violates occurrence raints
-  static 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 OCPP_ERROR_TYPERAINT_VIOLATION = 'TyperaintViolation';
-  // Any other error not covered by the previous ones
-  static OCPP_ERROR_GENERIC_ERROR = 'GenericError';
-
-  static OCPP_PROTOCOL_JSON = 'json';
-  static OCPP_PROTOCOL_SOAP = 'soap';
-  static OCPP_VERSION_12 = '1.2';
-  static OCPP_VERSION_15 = '1.5';
-  static OCPP_VERSION_16 = '1.6';
-  static OCPP_VERSION_20 = '2.0';
-
-  static STATUS_NOTIFICATION_TIMEOUT = 500;
-  static START_TRANSACTION_TIMEOUT = 500;
-
-  static CHARGING_STATION_DEFAULT_RESET_TIME = 60000; // Ms
-  static CHARGING_STATION_ATG_WAIT_TIME = 2000; // Ms
+  static readonly OCPP_RESPONSE_EMPTY = Object.freeze({});
+  static readonly OCPP_RESPONSE_ACCEPTED = Object.freeze({ status: DefaultStatus.ACCEPTED });
+  static readonly OCPP_RESPONSE_REJECTED = Object.freeze({ status: DefaultStatus.REJECTED });
+  static readonly OCPP_CONFIGURATION_RESPONSE_ACCEPTED = Object.freeze({
+    status: ConfigurationStatus.ACCEPTED,
+  });
+
+  static readonly OCPP_CONFIGURATION_RESPONSE_REJECTED = Object.freeze({
+    status: ConfigurationStatus.REJECTED,
+  });
+
+  static readonly OCPP_CONFIGURATION_RESPONSE_REBOOT_REQUIRED = Object.freeze({
+    status: ConfigurationStatus.REBOOT_REQUIRED,
+  });
+
+  static readonly OCPP_CONFIGURATION_RESPONSE_NOT_SUPPORTED = Object.freeze({
+    status: ConfigurationStatus.NOT_SUPPORTED,
+  });
+
+  static readonly OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED = Object.freeze({
+    status: ChargingProfileStatus.ACCEPTED,
+  });
+
+  static readonly OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED = Object.freeze({
+    status: ChargingProfileStatus.REJECTED,
+  });
+
+  static readonly OCPP_SET_CHARGING_PROFILE_RESPONSE_NOT_SUPPORTED = Object.freeze({
+    status: ChargingProfileStatus.NOT_SUPPORTED,
+  });
+
+  static readonly OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED = Object.freeze({
+    status: ClearChargingProfileStatus.ACCEPTED,
+  });
+
+  static readonly OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN = Object.freeze({
+    status: ClearChargingProfileStatus.UNKNOWN,
+  });
+
+  static readonly OCPP_RESPONSE_UNLOCKED = Object.freeze({ status: UnlockStatus.UNLOCKED });
+  static readonly OCPP_RESPONSE_UNLOCK_FAILED = Object.freeze({
+    status: UnlockStatus.UNLOCK_FAILED,
+  });
+
+  static readonly OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED = Object.freeze({
+    status: UnlockStatus.NOT_SUPPORTED,
+  });
+
+  static readonly OCPP_AVAILABILITY_RESPONSE_ACCEPTED = Object.freeze({
+    status: AvailabilityStatus.ACCEPTED,
+  });
+
+  static readonly OCPP_AVAILABILITY_RESPONSE_REJECTED = Object.freeze({
+    status: AvailabilityStatus.REJECTED,
+  });
+
+  static readonly OCPP_AVAILABILITY_RESPONSE_SCHEDULED = Object.freeze({
+    status: AvailabilityStatus.SCHEDULED,
+  });
+
+  static readonly OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED = Object.freeze({
+    status: TriggerMessageStatus.ACCEPTED,
+  });
+
+  static readonly OCPP_TRIGGER_MESSAGE_RESPONSE_REJECTED = Object.freeze({
+    status: TriggerMessageStatus.REJECTED,
+  });
+
+  static readonly OCPP_TRIGGER_MESSAGE_RESPONSE_NOT_IMPLEMENTED = Object.freeze({
+    status: TriggerMessageStatus.NOT_IMPLEMENTED,
+  });
+
+  static readonly OCPP_DATA_TRANSFER_RESPONSE_REJECTED = Object.freeze({
+    status: DataTransferStatus.REJECTED,
+  });
+
+  static readonly OCPP_DEFAULT_BOOT_NOTIFICATION_INTERVAL = 60000; // Ms
+  static readonly OCPP_WEBSOCKET_TIMEOUT = 60000; // Ms
+  static readonly OCPP_TRIGGER_MESSAGE_DELAY = 500; // Ms
+
+  static readonly CHARGING_STATION_DEFAULT_RESET_TIME = 60000; // Ms
+  static readonly CHARGING_STATION_ATG_INITIALIZATION_TIME = 1000; // Ms
+  static readonly CHARGING_STATION_ATG_DEFAULT_STOP_AFTER_HOURS = 0.25; // Hours
+
+  // See https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+  static readonly SEMVER_REGEXP =
+    /^(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 = Number.MAX_SAFE_INTEGER;
+
+  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_HEARTBEAT_INTERVAL = 60000; // Ms
+  static readonly DEFAULT_METER_VALUES_INTERVAL = 60000; // Ms
+
+  static readonly SUPPORTED_MEASURANDS = Object.freeze([
+    MeterValueMeasurand.STATE_OF_CHARGE,
+    MeterValueMeasurand.VOLTAGE,
+    MeterValueMeasurand.POWER_ACTIVE_IMPORT,
+    MeterValueMeasurand.CURRENT_IMPORT,
+    MeterValueMeasurand.ENERGY_ACTIVE_IMPORT_REGISTER,
+  ]);
+
+  static readonly DEFAULT_FLUCTUATION_PERCENT = 5;
+
+  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';
+
+  private constructor() {
+    // This is intentional
+  }
 }