kirby-ocpp 0.1.2 → 0.2.0

package/dist/station/transaction-rules.js

@@ -1,34 +0,0 @@
-export function startTransactionRejection(connector, idTag) {
-    if (connector.transactionId) {
-        return `Connector ${connector.id} already has transaction ${connector.transactionId}`;
-    }
-    if (connector.availability === "Inoperative" || connector.status === "Unavailable") {
-        return `Connector ${connector.id} is unavailable`;
-    }
-    if (connector.status === "Faulted") {
-        return `Connector ${connector.id} is faulted`;
-    }
-    if (connector.status === "Finishing") {
-        return `Connector ${connector.id} is finishing; unplug before starting a new transaction`;
-    }
-    if (connector.reservationId && connector.reservationIdTag !== idTag) {
-        return `Connector ${connector.id} is reserved for another idTag`;
-    }
-    return undefined;
-}
-export function canRemoteStart(connector) {
-    return Boolean(connector) &&
-        !connector?.transactionId &&
-        connector?.availability === "Operative" &&
-        connector.status !== "Unavailable" &&
-        connector.status !== "Faulted" &&
-        connector.status !== "Reserved";
-}
-export function statusAfterStopTransaction(reason, evConnected, availability) {
-    const stillConnected = reason !== "EVDisconnected" && evConnected;
-    const availableStatus = availability === "Inoperative" ? "Unavailable" : "Available";
-    return {
-        evConnected: stillConnected,
-        status: stillConnected ? "Finishing" : availableStatus
-    };
-}

package/dist/station/trigger-message.d.ts

@@ -1,2 +0,0 @@
-export declare const TRIGGERABLE_MESSAGES: string[];
-export declare function canTriggerMessage(requestedMessage: string): boolean;

package/dist/station/trigger-message.js

@@ -1,11 +0,0 @@
-export const TRIGGERABLE_MESSAGES = [
-    "BootNotification",
-    "DiagnosticsStatusNotification",
-    "FirmwareStatusNotification",
-    "Heartbeat",
-    "MeterValues",
-    "StatusNotification"
-];
-export function canTriggerMessage(requestedMessage) {
-    return TRIGGERABLE_MESSAGES.includes(requestedMessage);
-}

package/dist/station-store.d.ts

@@ -1,41 +0,0 @@
-export interface PersistedStationState {
-    version: 1;
-    chargePointId: string;
-    connectorCount?: number;
-    connectorMeterValues?: Record<string, number>;
-    connectorReservations?: Record<string, PersistedReservation>;
-    connectorTransactions?: Record<string, PersistedConnectorTransaction>;
-    localListVersion: number;
-    localAuthorizationList: LocalAuthorizationEntry[];
-    authorizationCache?: LocalAuthorizationEntry[];
-    chargingProfiles: unknown[];
-    configurationValues: Record<string, string>;
-    meterWh: number;
-}
-export interface LocalAuthorizationEntry {
-    idTag: string;
-    idTagInfo?: Record<string, unknown>;
-}
-export interface PersistedReservation {
-    reservationId: number;
-    idTag: string;
-    parentIdTag?: string;
-    expiryDate: string;
-}
-export interface PersistedConnectorTransaction {
-    transactionId: number;
-    transactionStartedAt?: string;
-    lastIdTag?: string;
-    evConnected: boolean;
-    status: string;
-    stopTransactionAtWh?: number;
-    pendingStartTransaction?: Record<string, unknown>;
-    pendingStopTransaction?: Record<string, unknown>;
-}
-export declare class StationStore {
-    private readonly chargePointId;
-    private readonly filePath;
-    constructor(chargePointId: string, stateDirectory?: string);
-    load(): PersistedStationState | undefined;
-    save(state: PersistedStationState): void;
-}

package/dist/station-store.js

@@ -1,104 +0,0 @@
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
-import { homedir } from "node:os";
-import { dirname, join } from "node:path";
-export class StationStore {
-    chargePointId;
-    filePath;
-    constructor(chargePointId, stateDirectory = process.env.KIRBY_OCPP_STATE_DIR ?? join(homedir(), ".kirby-ocpp", "stations")) {
-        this.chargePointId = chargePointId;
-        this.filePath = join(stateDirectory, `${safeFileName(chargePointId)}.json`);
-    }
-    load() {
-        if (!existsSync(this.filePath)) {
-            return undefined;
-        }
-        const parsed = JSON.parse(readFileSync(this.filePath, "utf8"));
-        if (parsed.version !== 1 || parsed.chargePointId !== this.chargePointId) {
-            return undefined;
-        }
-        return {
-            version: 1,
-            chargePointId: this.chargePointId,
-            connectorCount: readInteger(parsed.connectorCount, 1),
-            connectorMeterValues: isRecord(parsed.connectorMeterValues) ? readNumberRecord(parsed.connectorMeterValues) : {},
-            connectorReservations: isRecord(parsed.connectorReservations) ? readReservationRecord(parsed.connectorReservations) : {},
-            connectorTransactions: isRecord(parsed.connectorTransactions) ? readTransactionRecord(parsed.connectorTransactions) : {},
-            localListVersion: readInteger(parsed.localListVersion, 0),
-            localAuthorizationList: Array.isArray(parsed.localAuthorizationList) ? parsed.localAuthorizationList : [],
-            authorizationCache: Array.isArray(parsed.authorizationCache) ? parsed.authorizationCache : [],
-            chargingProfiles: Array.isArray(parsed.chargingProfiles) ? parsed.chargingProfiles : [],
-            configurationValues: isRecord(parsed.configurationValues) ? readStringRecord(parsed.configurationValues) : {},
-            meterWh: readNumber(parsed.meterWh, 0)
-        };
-    }
-    save(state) {
-        mkdirSync(dirname(this.filePath), { recursive: true });
-        writeFileSync(this.filePath, `${JSON.stringify(state, null, 2)}\n`, "utf8");
-    }
-}
-function safeFileName(value) {
-    return Buffer.from(value).toString("base64url");
-}
-function readInteger(value, fallback) {
-    return typeof value === "number" && Number.isInteger(value) ? value : fallback;
-}
-function readNumber(value, fallback) {
-    return typeof value === "number" && Number.isFinite(value) ? value : fallback;
-}
-function readStringRecord(value) {
-    return Object.fromEntries(Object.entries(value).filter((entry) => typeof entry[1] === "string"));
-}
-function readNumberRecord(value) {
-    return Object.fromEntries(Object.entries(value).filter((entry) => typeof entry[1] === "number"));
-}
-function readReservationRecord(value) {
-    const entries = Object.entries(value).flatMap(([connectorId, reservation]) => {
-        if (!isRecord(reservation)) {
-            return [];
-        }
-        const reservationId = reservation.reservationId;
-        const idTag = reservation.idTag;
-        const expiryDate = reservation.expiryDate;
-        if (typeof reservationId !== "number" || typeof idTag !== "string" || typeof expiryDate !== "string") {
-            return [];
-        }
-        const parsed = { reservationId, idTag, expiryDate };
-        if (typeof reservation.parentIdTag === "string") {
-            parsed.parentIdTag = reservation.parentIdTag;
-        }
-        return [[connectorId, parsed]];
-    });
-    return Object.fromEntries(entries);
-}
-function readTransactionRecord(value) {
-    const entries = Object.entries(value).flatMap(([connectorId, transaction]) => {
-        if (!isRecord(transaction) || typeof transaction.transactionId !== "number") {
-            return [];
-        }
-        const parsed = {
-            transactionId: transaction.transactionId,
-            evConnected: transaction.evConnected === true,
-            status: typeof transaction.status === "string" ? transaction.status : "Charging"
-        };
-        if (typeof transaction.transactionStartedAt === "string") {
-            parsed.transactionStartedAt = transaction.transactionStartedAt;
-        }
-        if (typeof transaction.lastIdTag === "string") {
-            parsed.lastIdTag = transaction.lastIdTag;
-        }
-        if (typeof transaction.stopTransactionAtWh === "number") {
-            parsed.stopTransactionAtWh = transaction.stopTransactionAtWh;
-        }
-        if (isRecord(transaction.pendingStartTransaction)) {
-            parsed.pendingStartTransaction = transaction.pendingStartTransaction;
-        }
-        if (isRecord(transaction.pendingStopTransaction)) {
-            parsed.pendingStopTransaction = transaction.pendingStopTransaction;
-        }
-        return [[connectorId, parsed]];
-    });
-    return Object.fromEntries(entries);
-}
-function isRecord(value) {
-    return Boolean(value) && typeof value === "object" && !Array.isArray(value);
-}

package/dist/station.d.ts

@@ -1,113 +0,0 @@
-import EventEmitter from "node:events";
-import { OcppClient } from "./ocpp/client.js";
-import { type AuthorizationDecision } from "./station/authorization.js";
-import { type DiagnosticsOutcome, type FirmwareOutcome } from "./station/maintenance-lifecycle.js";
-import type { ChargePointErrorCode, ConnectorStatus, DiagnosticsStatus, FirmwareStatus, LogEntry, StationConfig, StationState, StopReason } from "./ocpp/types.js";
-interface StationEvents {
-    state: [state: StationState];
-    log: [entry: LogEntry];
-}
-export declare interface Station {
-    on<K extends keyof StationEvents>(event: K, listener: (...args: StationEvents[K]) => void): this;
-    emit<K extends keyof StationEvents>(event: K, ...args: StationEvents[K]): boolean;
-}
-export declare class Station extends EventEmitter {
-    readonly config: StationConfig;
-    readonly client: OcppClient;
-    readonly state: StationState;
-    private heartbeatTimer?;
-    private resetTimer?;
-    private bootRetryTimer?;
-    private reconnectTimer?;
-    private reconnectAttempts;
-    private manuallyDisconnected;
-    private readonly store?;
-    private readonly configuration;
-    private readonly localAuthorizationList;
-    private readonly authorizationCache;
-    private readonly connectors;
-    private readonly statusScheduler;
-    private readonly meterValueScheduler;
-    private readonly reservationScheduler;
-    private readonly maintenance;
-    private readonly chargingProfiles;
-    private readonly offlineTransactions;
-    constructor(config: StationConfig);
-    connect(): void;
-    disconnect(): void;
-    reconnect(): void;
-    boot(options?: {
-        scheduleRetry?: boolean;
-    }): Promise<void>;
-    heartbeat(): Promise<void>;
-    statusNotification(connectorId?: number, status?: ConnectorStatus, force?: boolean): Promise<void>;
-    private sendStatusNotification;
-    authorize(idTag?: string): Promise<AuthorizationDecision>;
-    toggleTransaction(connectorId?: number, idTag?: string): Promise<void>;
-    startTransaction(connectorId?: number, idTag?: string): Promise<number | undefined>;
-    stopTransaction(connectorId?: number, reason?: StopReason, idTag?: string): Promise<void>;
-    plugIn(connectorId?: number): Promise<void>;
-    unplug(connectorId?: number): Promise<void>;
-    setFault(connectorId?: number, errorCode?: ChargePointErrorCode, info?: string, vendorErrorCode?: string): Promise<void>;
-    clearFault(connectorId?: number): Promise<void>;
-    meterValues(connectorId?: number, deltaWh?: number, sampledData?: string): Promise<void>;
-    dataTransfer(payload?: Record<string, unknown>): Promise<void>;
-    firmwareStatusNotification(status?: FirmwareStatus): Promise<void>;
-    diagnosticsStatusNotification(status?: DiagnosticsStatus): Promise<void>;
-    setDiagnosticsOutcome(outcome: DiagnosticsOutcome): void;
-    setFirmwareOutcome(outcome: FirmwareOutcome): void;
-    cycleStatus(connectorId?: number): Promise<void>;
-    setStatus(connectorId: number | undefined, status: ConnectorStatus): Promise<void>;
-    addConnector(): number;
-    private bindClientEvents;
-    private handleCentralSystemCall;
-    private handleCancelReservation;
-    private handleChangeAvailability;
-    private handleChangeConfiguration;
-    private handleDataTransfer;
-    private handleGetConfiguration;
-    private handleSetChargingProfile;
-    private handleClearChargingProfile;
-    private handleGetCompositeSchedule;
-    private handleSendLocalList;
-    private handleRemoteStartTransaction;
-    private handleRemoteStopTransaction;
-    private handleReserveNow;
-    private handleReset;
-    private handleTriggerMessage;
-    private handleUnlockConnector;
-    private triggerMessage;
-    private canTriggerMessageForPayload;
-    private triggerConnectorId;
-    private canAcceptRemoteStartChargingProfile;
-    private applyRemoteStartChargingProfile;
-    private send;
-    private sendTransactionMessage;
-    private sendMeterValues;
-    private buildStopTransactionData;
-    private authorizeLocally;
-    private rememberAuthorization;
-    private readIdTagInfo;
-    private stopTransactionsForInvalidIdTag;
-    private stopTransactionIfInvalidEnergyLimitReached;
-    private refreshConnectorSnapshot;
-    private clearReservation;
-    private sendClockAlignedMeterValues;
-    private expireReservation;
-    private loadPersistedState;
-    private savePersistedState;
-    private startHeartbeatTimer;
-    private stopHeartbeatTimer;
-    private performReset;
-    private bootAfterReset;
-    private clearResetTimer;
-    private scheduleBootRetry;
-    private clearBootRetryTimer;
-    private scheduleReconnect;
-    private reconnectDelayMs;
-    private clearReconnectTimer;
-    private patchState;
-    private log;
-    private runSafely;
-}
-export {};