/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ /*** THIS FILE IS GENERATED, DO NOT EDIT ***/ import { Resource } from "#models/Resource.js"; Resource.add( { tag: "cluster", name: "EnergyEvse", pics: "EEVSE", xref: "cluster§9.3", details: "Electric Vehicle Supply Equipment (EVSE) is equipment used to charge an Electric Vehicle (EV) or " + "Plug-In Hybrid Electric Vehicle. This cluster provides an interface to the functionality of Electric " + "Vehicle Supply Equipment (EVSE) management." + "\n" + "Devices targeted by this cluster include Electric Vehicle Supply Equipment (EVSE). The cluster " + "generically assumes a signaling protocol (J1772 in NA and IEC61851 in Europe and Asia) between the " + "EVSE and Electric Vehicle (EV) that utilizes a pilot signal to manage the states of the charging " + "process. [SAE J2847/3_202311] version and IEC61841 define Pilot signal as a modulated DC voltage on " + "a single wire." + "\n" + "Power Line Communication (PLC) is supported by some EVSEs (e.g. for support of ISO 15118 in Europe " + "and SAE J2931/4 in NA) and may enable features such as Vehicle to Grid (V2G) or Vehicle to Home " + "(V2H) that allows for bi-directional charging/discharging of electric vehicles." + "\n" + "More modern EVSE devices may optionally support ISO 15118-20 in Europe and SAE J2836/3 for NA to " + "support bi-directional charging (Vehicle to Grid - V2G) and Plug and Charge capabilities." + "\n" + "This cluster definition assumes AC charging only. DC charging options may be added in future " + "revisions of this cluster." + "\n" + "This cluster supports a safety mechanism that may lockout remote operation until the initial " + "latching conditions have been met. Some of the fault conditions defined in SAE J1772, such as " + "Ground-Fault Circuit Interrupter (GFCI) or Charging Circuit Interrupting Device (CCID), may require " + "clearing by an operator by, for example, pressing a button on the equipment or breaker panel." + "\n" + "This EVSE cluster is written around support of a single EVSE. Having multiple EVSEs at home or a " + "business is managed by backend system and outside scope of this cluster." + "\n" + "Note that in many deployments the EVSE may be outside the home and may suffer from intermittent " + "network connections (e.g. a weak Wi-Fi signal). It also allows for a charging profile to be " + "pre-configured, in case there is a temporary communications loss during a charging session.", children: [ { tag: "attribute", name: "FeatureMap", xref: "cluster§9.3.4", children: [ { tag: "field", name: "PREF", xref: "cluster§9.3.4.1", details: "Since some EVSEs cannot obtain the SoC from the vehicle, some EV charging solutions allow the " + "consumer to specify a daily charging target (for adding energy to the EV's battery). This feature " + "allows the consumer to specify how many miles or km of additional range they need for their typical " + "daily commute. This range requirement can be converted into a daily energy demand with a target " + "charging completion time." + "\n" + "The EVSE itself can use this information (or may allow a controller such as an EMS) to compute an " + "optimized charging schedule. For example, an optimizer may be able to use the Commodity Price " + "cluster to determine the cheapest and lowest GHG based charging schedule for the vehicle." + "\n" + "An EVSE device which includes a Device Energy Management device with the Device Energy Management " + "cluster PFR (PowerForecastReporting) feature can use the charging preferences information to produce " + "its power forecast." + "\n" + "EVSE devices that support the Device Energy Management cluster's FA feature can have their charging " + "profiles set by a controller device such as an EMS. For example, if the EVSE advertises a simple " + "power forecast which allows the EMS to adjust over a wide range of power and time durations, then " + "the EVSE may allow the EMS to propose a revised optimized forecast (which is the charging profile). " + "For example, a solar PV ESA may also share its Forecast, so enabling an EMS to adjust the EVSE " + "forecast to the best time to charge so that any excess solar generation is used to charge the EV." + "\n" + "See the Device Energy Management Cluster for more details." }, { tag: "field", name: "SOC", xref: "cluster§9.3.4.2", details: "Vehicles and EVSEs which support ISO 15118 may allow the vehicle to report its battery size and " + "state of charge. If the EVSE supports PLC it may have a vehicle connected which optionally supports " + "reporting of its battery size and current State of Charge (SoC)." + "\n" + "If the EVSE supports reporting of State of Charge this feature will only work if a compatible EV is " + "connected." + "\n" + "Note some EVSEs may use other undefined mechanisms to obtain vehicle State of Charge outside the " + "scope of this cluster." }, { tag: "field", name: "PNC", xref: "cluster§9.3.4.3", details: "If the EVSE supports PLC, it may be able to support the Plug and Charge feature. e.g. this may allow " + "the vehicle ID to be obtained which may allow an energy management system to track energy usage per " + "vehicle (e.g. to give the owner an indicative cost of charging, or for work place charging)." + "\n" + "If the EVSE supports the Plug and Charge feature, it will only work if a compatible EV is connected." }, { tag: "field", name: "RFID", xref: "cluster§9.3.4.4", details: "If the EVSE is fitted with an RFID reader, it may be possible to obtain the User or Vehicle ID from " + "an RFID card. This may be used to record a charging session against a specific charging account, and " + "may optionally be used to authorize a charging session." + "\n" + "An RFID event can be generated when a user taps an RFID card onto the RFID reader. The event must be " + "subscribed to by the EVSE Management cluster client. This client may use this to enable the EV to " + "charge or discharge. The lookup and authorization of RIFD UID is outside the scope of this cluster." }, { tag: "field", name: "V2X", xref: "cluster§9.3.4.5", details: "If the EVSE can support bi-directional charging, it may be possible to request that the vehicle can " + "discharge to the home or grid." + "\n" + "The charging and discharging may be controlled by a home Energy Management System (EMS) using the " + "Device Energy Management cluster of the associated Device Energy Management device. For example, an " + "EMS may use the PA (PowerAdjustment) feature to continually adjust the charge/discharge current " + "to/from the EV so as to minimise the energy flow from/to the grid as the demand in the home and the " + "solar supply to the home both fluctuate." } ] }, { tag: "attribute", name: "State", xref: "cluster§9.3.8.1", details: "Indicates the current status of the EVSE. This higher-level status is partly derived from the " + "signaling protocol as communicated between the EVSE and the vehicle through the pilot signal." + "\n" + "The State attribute shall change when the EVSE detects change of condition of the EV (plugged in or " + "unplugged, whether the vehicle is asking for demand or not, and if it is charging or discharging)." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: SessionEnding is not really a state but a transition. However, the transition period may " + "take a few seconds and is useful for some clean up purposes." + "\n" + "The Fault state is used to indicate that the FaultState attribute is not NoError." + "\n" + "A null value shall indicate that the state cannot be determined." }, { tag: "attribute", name: "SupplyState", xref: "cluster§9.3.8.2", details: "Indicates whether the EV is currently allowed to charge from or discharge to the EVSE." }, { tag: "attribute", name: "FaultState", xref: "cluster§9.3.8.3", details: "Indicates the type of fault detected by the EVSE (internally or as detected in the pilot signal)." + "\n" + "When the SupplyState attribute is DisabledError, the FaultState attribute will be one of the values " + "listed in FaultStateEnum, except NoError. For all values of SupplyState other than DisabledError, " + "the FaultState attribute shall be NoError." }, { tag: "attribute", name: "ChargingEnabledUntil", xref: "cluster§9.3.8.4", details: "Indicates the time, in UTC, that the EVSE will automatically stop current flow to the EV." + "\n" + "A null value indicates the EVSE is always enabled for charging." + "\n" + "A value in the past or 0x0 indicates that EVSE charging shall be disabled. The attribute is only set " + "via the payload of the EnableCharging command." + "\n" + "This attribute shall be persisted, for example a temporary power failure should not stop the vehicle " + "from being charged." }, { tag: "attribute", name: "DischargingEnabledUntil", xref: "cluster§9.3.8.5", details: "Indicates the time, in UTC, that the EVSE will automatically stop current flow from the EV." + "\n" + "A null value indicates the EVSE is always enabled for discharging." + "\n" + "A value in the past or 0x0 indicates that EVSE discharging shall be disabled. The attribute is only " + "set via the payload of the EnableDischarging command." + "\n" + "This attribute shall be persisted, for example a temporary power failure should not stop the vehicle " + "from being discharged." }, { tag: "attribute", name: "CircuitCapacity", xref: "cluster§9.3.8.6", details: "Indicates the capacity that the circuit that the EVSE is connected to can provide. It is intended to " + "allow implementation of a self-managed network of EVSEs. It is assumed that the device will allow " + "the setting of such values by an installer." }, { tag: "attribute", name: "MinimumChargeCurrent", xref: "cluster§9.3.8.7", details: "Indicates the minimum current that can be delivered by the EVSE to the EV." + "\n" + "The attribute can be set using the EnableCharging command." }, { tag: "attribute", name: "MaximumChargeCurrent", xref: "cluster§9.3.8.8", details: "Indicates the maximum current that can be delivered by the EVSE to the EV." + "\n" + "This shall represent the actual maximum current offered to the EV at any time. Note that the EV can " + "draw less current than this value. For example, the EV may be limiting its power draw based on the " + "operating conditions of the battery, such as temperature and state of charge." + "\n" + "The attribute can be initially set using the EnableCharging command or by adjusting the " + "UserMaximumChargeCurrent attribute." + "\n" + "> [!NOTE]" + "\n" + "> This attribute value shall be the minimum of: - CircuitCapacity - Electrician's installation " + "setting - CableAssemblyCurrentLimit (detected by the EVSE when the cable is plugged in) - " + "MaximumChargeCurrent field in the EnableCharging command - UserMaximumChargeCurrent attribute" }, { tag: "attribute", name: "MaximumDischargeCurrent", xref: "cluster§9.3.8.9", details: "Indicates the maximum current that can be received by the EVSE from the EV." + "\n" + "This attribute can be set using the EnableDischarging command." + "\n" + "> [!NOTE]" + "\n" + "> This attribute value shall be the minimum of: - CircuitCapacity - Electrician's installation " + "setting - CableAssemblyCurrentLimit (detected by the EVSE when the cable is plugged in) - " + "MaximumDischargeCurrent field in the EnableDischarging command" }, { tag: "attribute", name: "UserMaximumChargeCurrent", xref: "cluster§9.3.8.10", details: "Indicates a maximum current that can set by the consumer (e.g. via an app) as a preference to " + "further reduce the charging rate. This may be desirable if the home owner has a solar PV or battery " + "storage system which may only be able to deliver a limited amount of power. The consumer can " + "manually control how much they allow the EV to take." + "\n" + "This attribute value shall be limited by the EVSE to be in the range of:" + "\n" + "where MinimumChargeCurrent and MaximumChargeCurrent are the values received in the EnableCharging " + "command." + "\n" + "Its default value SHOULD be initialized to the same as the CircuitCapacity attribute. This value " + "shall be persisted across reboots to ensure it does not cause charging issues during temporary power " + "failures." }, { tag: "attribute", name: "RandomizationDelayWindow", xref: "cluster§9.3.8.11", details: "Indicates the size of a random window over which the EVSE will randomize the start of a charging " + "session. This value is in seconds." + "\n" + "This is a feature that is mandated in some markets (such as UK) where the EVSE should by default " + "randomize its start time within the randomization window. By default in the UK this should be 600s." + "\n" + "For example, if the RandomizationDelayWindow is 600s (i.e. 10 minutes) and if there was a cheap rate " + "energy starting at 00:30, then the EVSE must compute a random delay between 0-599s and add this to " + "its initial planned start time." }, { tag: "attribute", name: "NextChargeStartTime", xref: "cluster§9.3.8.12", details: "Indicates the time, in UTC, when the EVSE plans to start the next scheduled charge based on the " + "charging preferences." + "\n" + "A null value indicates that there is no scheduled charging (for example, the EVSE Mode is set to use " + "Manual mode tag), or that the vehicle is not plugged in with the SupplyState indicating that " + "charging is enabled." }, { tag: "attribute", name: "NextChargeTargetTime", xref: "cluster§9.3.8.13", details: "Indicates the time, in UTC, when the EVSE SHOULD complete the next scheduled charge based on the " + "charging preferences." + "\n" + "A null value indicates that there is no scheduled charging (for example, the EVSE Mode is set to use " + "Manual mode tag), or that the vehicle is not plugged in with the SupplyState indicating that " + "charging is enabled." }, { tag: "attribute", name: "NextChargeRequiredEnergy", xref: "cluster§9.3.8.14", details: "Indicates the amount of energy that the EVSE is going to attempt to add to the vehicle in the next " + "charging target." + "\n" + "A null value indicates that there is no scheduled charging (for example, the EVSE Mode is set to use " + "Manual mode tag), or that the vehicle is not plugged in with the SupplyState indicating that " + "charging is enabled, or that the next ChargingTargetStruct is using the TargetSoC value to charge " + "the vehicle." }, { tag: "attribute", name: "NextChargeTargetSoC", xref: "cluster§9.3.8.15", details: "Indicates the target SoC the EVSE is going to attempt to reach when the vehicle is next charged." + "\n" + "A null value indicates that there is no scheduled charging (for example, the EVSE Mode is set to use " + "Manual mode tag), or that the vehicle is not plugged in with the SupplyState indicating that " + "charging is enabled, or that the next ChargingTargetStruct is using the AddedEnergy value to charge " + "the vehicle." + "\n" + "If the SOC feature is not supported, only the values null and 100% are supported." }, { tag: "attribute", name: "ApproximateEvEfficiency", xref: "cluster§9.3.8.16", details: "Indicates the vehicle efficiency rating for a connected vehicle." + "\n" + "This can be used to help indicate to the user approximately how many miles or km of range will be " + "added. It allows user interfaces to display to the user simpler terms that they can relate to " + "compared to kWh." + "\n" + "This is value is stored in km per kWh multiplied by a scaling factor of 1000." + "\n" + "A null value indicates that the EV efficiency is unknown and the NextChargeRequiredEnergy attribute " + "cannot be converted from Wh to miles or km." + "\n" + "> [!NOTE]" + "\n" + "> To convert from Wh into Range: AddedRange (km) = AddedEnergy (Wh) x ApproxEVEfficiency (km/kWh x " + "1000) AddedRange (Miles) = AddedEnergy (Wh) x ApproxEVEfficiency (km/kWh x 1000) x 0.6213 Example: " + "ApproxEVEfficiency (km/kWh x 1000): 4800 (i.e. 4.8km/kWh x 1000) AddedEnergy (Wh): 10,000 " + "AddedRange (km) = 10,000 x 4800 / 1,000,000 = 48 km AddedRange (Miles) = AddedEnergy (Wh) x " + "ApproxEVEfficiency (km/kWh x 1000) x 0.6213 = 29.82 Miles" }, { tag: "attribute", name: "StateOfCharge", xref: "cluster§9.3.8.17", details: "Indicates the state of charge of the EV battery in steps of 1%. The values are in the 0-100%. This " + "attribute is only available on EVSEs which can read the state of charge from the vehicle and that " + "support the SOC feature. If the StateOfCharge cannot be read from the vehicle it shall be returned " + "with a NULL value." }, { tag: "attribute", name: "BatteryCapacity", xref: "cluster§9.3.8.18", details: "Indicates the capacity of the EV battery in mWh. This value is always positive." }, { tag: "attribute", name: "VehicleId", xref: "cluster§9.3.8.19", details: "Indicates the vehicle ID read by the EVSE via ISO-15118 using the PNC feature, if the EVSE supports " + "this capability." + "\n" + "The field may be based on the e-Mobility Account Identifier (EMAID)." + "\n" + "A null value shall indicate that this is unknown." }, { tag: "attribute", name: "SessionId", xref: "cluster§9.3.8" }, { tag: "attribute", name: "SessionDuration", xref: "cluster§9.3.8" }, { tag: "attribute", name: "SessionEnergyCharged", xref: "cluster§9.3.8" }, { tag: "attribute", name: "SessionEnergyDischarged", xref: "cluster§9.3.8" }, { tag: "event", name: "EvConnected", xref: "cluster§9.3.10.1", details: "This event shall be generated when the EV is plugged in.", children: [{ tag: "field", name: "SessionId", xref: "cluster§9.3.10.1.1", details: "This is the new session ID created after the vehicle is plugged in." }] }, { tag: "event", name: "EvNotDetected", xref: "cluster§9.3.10.2", details: "This event shall be generated when the EV is unplugged or not detected (having been previously " + "plugged in). When the vehicle is unplugged then the session is ended.", children: [ { tag: "field", name: "SessionId", xref: "cluster§9.3.10.2.1", details: "This field shall indicate the current value of the SessionID attribute." }, { tag: "field", name: "State", xref: "cluster§9.3.10.2.2", details: "This field shall indicate the value of the State attribute prior to the EV not being detected." }, { tag: "field", name: "SessionDuration", xref: "cluster§9.3.10.2.3", details: "This field shall indicate the total duration of the session, from the start of the session when the " + "EV was plugged in, until it was unplugged." }, { tag: "field", name: "SessionEnergyCharged", xref: "cluster§9.3.10.2.4", details: "This field shall indicate the total amount of energy transferred from the EVSE to the EV during the " + "session." + "\n" + "Note that if bi-directional charging occurs during the session, then this value shall only include " + "the sum of energy transferred from the EVSE to the EV, and shall NOT be a net value of charging and " + "discharging energy." }, { tag: "field", name: "SessionEnergyDischarged", xref: "cluster§9.3.10.2.5", details: "This field shall indicate the total amount of energy transferred from the EV to the EVSE during the " + "session." + "\n" + "Note that if bi-directional discharging occurs during the session, then this value shall only " + "include the sum of energy transferred from the EV to the EVSE, and shall NOT be a net value of " + "charging and discharging energy." } ] }, { tag: "event", name: "EnergyTransferStarted", xref: "cluster§9.3.10.3", details: "This event shall be generated whenever the EV starts charging or discharging, except when an EV has " + "switched between charging and discharging under the control of the PowerAdjustment feature of the " + "Device Energy Management cluster of the associated Device Energy Management device.", children: [ { tag: "field", name: "SessionId", xref: "cluster§9.3.10.3.1", details: "This field shall indicate the value of the SessionID attribute at the time the event was generated." }, { tag: "field", name: "State", xref: "cluster§9.3.10.3.2", details: "This field shall indicate the value of the State attribute at the time the event was generated." }, { tag: "field", name: "MaximumCurrent", xref: "cluster§9.3.10.3.3", details: "This field shall indicate the value of the maximum charging current at the time the event was " + "generated." + "\n" + "A non-zero value indicates that the EV has been enabled for charging and the value is taken directly " + "from the MaximumChargeCurrent attribute. A zero value indicates that the EV has not been enabled for " + "charging." }, { tag: "field", name: "MaximumDischargeCurrent", xref: "cluster§9.3.10.3.4", details: "This field shall indicate the value of the maximum discharging current at the time the event was " + "generated." + "\n" + "A non-zero value indicates that the EV has been enabled for discharging and the value is taken " + "directly from the MaximumDischargeCurrent attribute. A zero value indicates that the EV has not been " + "enabled for discharging." } ] }, { tag: "event", name: "EnergyTransferStopped", xref: "cluster§9.3.10.4", details: "This event shall be generated whenever the EV stops charging or discharging, except when an EV has " + "switched between charging and discharging under the control of the PowerAdjustment feature of the " + "Device Energy Management cluster of the associated Device Energy Management device.", children: [ { tag: "field", name: "SessionId", xref: "cluster§9.3.10.4.1", details: "This field shall indicate the value of the SessionID attribute prior to the energy transfer " + "stopping." }, { tag: "field", name: "State", xref: "cluster§9.3.10.4.2", details: "This field shall indicate the value of the State attribute prior to the energy transfer stopping." }, { tag: "field", name: "Reason", xref: "cluster§9.3.10.4.3", details: "This field shall indicate the reason why the energy transferred stopped." }, { tag: "field", name: "EnergyTransferred", xref: "cluster§9.3.10.4.4", details: "This field shall indicate the amount of energy transferred from the EVSE to the EV since the " + "previous EnergyTransferStarted event, in mWh." }, { tag: "field", name: "EnergyDischarged", xref: "cluster§9.3.10.4.5", details: "This field shall indicate the amount of energy transferred from the EV to the EVSE since the " + "previous EnergyTransferStarted event, in mWh." } ] }, { tag: "event", name: "Fault", xref: "cluster§9.3.10.5", details: "If the EVSE detects a fault it shall generate a Fault Event. The SupplyState attribute shall be set " + "to DisabledError and the type of fault detected by the EVSE shall be stored in the FaultState " + "attribute." + "\n" + "This event shall be generated when the FaultState changes from any error state. i.e. if it changes " + "from NoError to any other state and if the error then clears, this would generate 2 events." + "\n" + "It is assumed that the fault will be cleared locally on the EVSE device. When all faults have been " + "cleared, the EVSE device shall set the FaultState attribute to NoError and the SupplyState attribute " + "shall be set back to its previous state.", children: [ { tag: "field", name: "SessionId", xref: "cluster§9.3.10.5.1", details: "This field shall indicate the value of the SessionID attribute prior to the Fault State being " + "changed. A value of null indicates no sessions have occurred before the fault occurred." }, { tag: "field", name: "State", xref: "cluster§9.3.10.5.2", details: "This field shall indicate the value of the State attribute prior to the Fault State being changed." }, { tag: "field", name: "FaultStatePreviousState", xref: "cluster§9.3.10.5.3", details: "This field shall indicate the value of the FaultState attribute prior to the Fault State being " + "changed." }, { tag: "field", name: "FaultStateCurrentState", xref: "cluster§9.3.10.5.4", details: "This field shall indicate the current value of the FaultState attribute." } ] }, { tag: "event", name: "Rfid", xref: "cluster§9.3.10.6", details: "This event shall be generated when a RFID card has been read. This allows a controller to register " + "the card ID and use this to authenticate and start the charging session.", children: [{ tag: "field", name: "Uid", xref: "cluster§9.3.10.6.1", details: "The UID field (ISO 14443A UID) is either 4, 7 or 10 bytes." }] }, { tag: "command", name: "Disable", xref: "cluster§9.3.9.1", details: "Allows a client to disable the EVSE from charging and discharging." }, { tag: "command", name: "EnableCharging", xref: "cluster§9.3.9.2", details: "This command allows a client to enable the EVSE to charge an EV, and to provide or update the " + "maximum and minimum charge current.", children: [ { tag: "field", name: "ChargingEnabledUntil", xref: "cluster§9.3.9.2.1", details: "This field shall indicate the expiry time, in UTC, when charging will be automatically disabled." + "\n" + "A value in the past in this field shall disable the EVSE charging whereas a null value shall enable " + "it permanently." }, { tag: "field", name: "MinimumChargeCurrent", xref: "cluster§9.3.9.2.2", details: "This field shall indicate the minimum current that can be delivered by the EVSE to the EV in trickle " + "mode. The EVSE current limit can be advertised to an EV in 0.6A steps." + "\n" + "The value of the MinimumChargeCurrent attribute shall be set to the value of this field (see Section " + "9.3.8.7, \"MinimumChargeCurrent Attribute\" for further details)." }, { tag: "field", name: "MaximumChargeCurrent", xref: "cluster§9.3.9.2.3", details: "This field shall indicate the maximum current that can be delivered by the EVSE to the EV. The EVSE " + "current limit can be advertised to an EV in 0.6A steps." + "\n" + "The value of the this field shall be stored by the EVSE to determine the value of " + "MaximumChargeCurrent attribute. For example, if the UserMaximumChargeCurrent attribute is adjusted " + "below then this value, and then later adjusted above this value, the resulting MaximumChargeCurrent " + "attribute will be limited to this value." } ] }, { tag: "command", name: "EnableDischarging", xref: "cluster§9.3.9.3", details: "Upon receipt, this shall allow a client to enable the discharge of an EV, and to provide or update " + "the maximum discharge current.", children: [ { tag: "field", name: "DischargingEnabledUntil", xref: "cluster§9.3.9.3.1", details: "This field shall indicate the expiry time, in UTC, when discharging will be automatically disabled." + "\n" + "A value in the past in this field shall disable the EVSE discharging whereas a null value shall " + "enable EVSE discharging permanently." }, { tag: "field", name: "MaximumDischargeCurrent", xref: "cluster§9.3.9.3.2", details: "This field shall indicate the maximum current that can be received by the EVSE from the EV. The EVSE " + "current limit can be advertised to an EV in 0.6A steps. The value of the MaximumDischargeCurrent " + "attribute shall be stored and persisted across reboots by the EVSE to the value of this field." } ] }, { tag: "command", name: "StartDiagnostics", xref: "cluster§9.3.9.4", details: "Allows a client to put the EVSE into a self-diagnostics mode." }, { tag: "command", name: "SetTargets", xref: "cluster§9.3.9.5", details: "Allows a client to set the user specified charging targets.", children: [{ tag: "field", name: "ChargingTargetSchedules", xref: "cluster§9.3.9.5.1", details: "This field shall indicate a list of up to 7 sets of daily charging targets together with their " + "associated days of the week. Each of the days of the week may only be included in a single " + "ChargingTargetSchedule within this list field." }] }, { tag: "command", name: "GetTargets", xref: "cluster§9.3.9.6", details: "Allows a client to retrieve the current set of charging targets." }, { tag: "command", name: "ClearTargets", xref: "cluster§9.3.9.8", details: "Allows a client to clear all stored charging targets." }, { tag: "command", name: "GetTargetsResponse", xref: "cluster§9.3.9.7", details: "The GetTargetsResponse is sent in response to the GetTargets Command.", children: [{ tag: "field", name: "ChargingTargetSchedules", xref: "cluster§9.3.9.7.1", details: "This field shall indicate a list of up to 7 sets of daily charging targets together with their " + "associated days of the week." }] }, { tag: "datatype", name: "TargetDayOfWeekBitmap", xref: "cluster§9.3.7.1", children: [ { tag: "field", name: "Sunday", description: "Sunday" }, { tag: "field", name: "Monday", description: "Monday" }, { tag: "field", name: "Tuesday", description: "Tuesday" }, { tag: "field", name: "Wednesday", description: "Wednesday" }, { tag: "field", name: "Thursday", description: "Thursday" }, { tag: "field", name: "Friday", description: "Friday" }, { tag: "field", name: "Saturday", description: "Saturday" } ] }, { tag: "datatype", name: "StateEnum", xref: "cluster§9.3.7.2", children: [ { tag: "field", name: "NotPluggedIn", description: "The EV is not plugged in." }, { tag: "field", name: "PluggedInNoDemand", description: "The EV is plugged in, but not demanding current." }, { tag: "field", name: "PluggedInDemand", description: "The EV is plugged in and is demanding current, but EVSE is not allowing current to flow." }, { tag: "field", name: "PluggedInCharging", description: "The EV is plugged in, charging is in progress, and current is flowing" }, { tag: "field", name: "PluggedInDischarging", description: "The EV is plugged in, discharging is in progress, and current is flowing" }, { tag: "field", name: "SessionEnding", description: "The EVSE is transitioning from any plugged-in state to NotPluggedIn" }, { tag: "field", name: "Fault", description: "There is a fault, further details in the FaultState attribute" } ] }, { tag: "datatype", name: "SupplyStateEnum", xref: "cluster§9.3.7.3", children: [ { tag: "field", name: "Disabled", description: "The EV is not currently allowed to charge or discharge" }, { tag: "field", name: "ChargingEnabled", description: "The EV is currently allowed to charge" }, { tag: "field", name: "DischargingEnabled", description: "The EV is currently allowed to discharge" }, { tag: "field", name: "DisabledError", description: "The EV is not currently allowed to charge or discharge due to an error, the error must be cleared before operation can continue" }, { tag: "field", name: "DisabledDiagnostics", description: "The EV is not currently allowed to charge or discharge due to self-diagnostics mode." }, { tag: "field", name: "Enabled", description: "The EV is currently allowed to charge and discharge" } ] }, { tag: "datatype", name: "FaultStateEnum", xref: "cluster§9.3.7.4", children: [ { tag: "field", name: "NoError", description: "The EVSE is not in an error state." }, { tag: "field", name: "MeterFailure", description: "The EVSE is unable to obtain electrical measurements." }, { tag: "field", name: "OverVoltage", description: "The EVSE input voltage level is too high." }, { tag: "field", name: "UnderVoltage", description: "The EVSE input voltage level is too low." }, { tag: "field", name: "OverCurrent", description: "The EVSE detected charging current higher than allowed by charger." }, { tag: "field", name: "ContactWetFailure", description: "The EVSE detected voltage on charging pins when the contactor is open." }, { tag: "field", name: "ContactDryFailure", description: "The EVSE detected absence of voltage after enabling contactor." }, { tag: "field", name: "GroundFault", description: "The EVSE has an unbalanced current supply." }, { tag: "field", name: "PowerLoss", description: "The EVSE has detected a loss in power." }, { tag: "field", name: "PowerQuality", description: "The EVSE has detected another power quality issue (e.g. phase imbalance)." }, { tag: "field", name: "PilotShortCircuit", description: "The EVSE pilot signal amplitude short circuited to ground." }, { tag: "field", name: "EmergencyStop", description: "The emergency stop button was pressed." }, { tag: "field", name: "EvDisconnected", description: "The EVSE detected that the cable has been disconnected." }, { tag: "field", name: "WrongPowerSupply", description: "The EVSE could not determine proper power supply level." }, { tag: "field", name: "LiveNeutralSwap", description: "The EVSE detected Live and Neutral are swapped." }, { tag: "field", name: "OverTemperature", description: "The EVSE internal temperature is too high." }, { tag: "field", name: "Other", description: "Any other reason." } ] }, { tag: "datatype", name: "EnergyTransferStoppedReasonEnum", xref: "cluster§9.3.7.5", children: [ { tag: "field", name: "EvStopped", description: "The EV decided to stop" }, { tag: "field", name: "EvseStopped", description: "The EVSE decided to stop" }, { tag: "field", name: "Other", description: "An other unknown reason" } ] }, { tag: "datatype", name: "ChargingTargetStruct", xref: "cluster§9.3.7.6", details: "This represents a single user specified charging target for an EV." + "\n" + "An EVSE or EMS system optimizer may use this information to take the Time of Use Tariff, grid carbon " + "intensity, local generation (solar PV) into account to provide the cheapest and cleanest energy to " + "the EV." + "\n" + "The optimization strategy is not defined here, however in simple terms, the AddedEnergy requirement " + "can be fulfilled by knowing the charging Power (W) and the time needed to charge." + "\n" + "> [!NOTE]" + "\n" + "> To compute the Charging Time: Required Energy (Wh) = Power (W) x ChargingTime (s) / 3600 " + "Therefore: ChargingTime (s) = (3600 x RequiredEnergy (wH)) / Power (W) To compute the charging " + "time: Charging StartTime = TargetTimeMinutesPastMidnight - ChargingTime", children: [ { tag: "field", name: "TargetTimeMinutesPastMidnight", xref: "cluster§9.3.7.6.1", details: "This field shall indicate the desired charging completion time of the associated day. The time will " + "be represented by a 16 bits unsigned integer to designate the minutes since midnight. For example, " + "6am will be represented by 360 minutes since midnight and 11:30pm will be represented by 1410 " + "minutes since midnight." + "\n" + "This field is based on local wall clock time. In case of Daylight Savings Time transition which may " + "result in an extra hour or one hour less in the day, the charging algorithm should take into account " + "the shift appropriately." + "\n" + "Note that if the TargetTimeMinutesPastMidnight values are too close together (e.g. 2 per day) these " + "may overlap. The EVSE may have to coalesce the charging targets into a single target. e.g. if the " + "1st charging target cannot be met in the time available, the EVSE may be forced to begin working " + "towards the 2nd charging target and immediately continue until both targets have been satisfied (or " + "the vehicle becomes full)." + "\n" + "The EVSE itself cannot predict the behavior of the vehicle (i.e. if it cannot obtain the SoC from " + "the vehicle), so should attempt to perform a sensible operation based on these targets. It is " + "recommended that the charging schedule is pessimistic (i.e. starts earlier) since the vehicle may " + "charge more slowly than the electrical supply may provide power (especially if it is cold)." + "\n" + "If the user configures large charging targets (e.g. high values of AddedEnergy or SoC) then it is " + "expected that the EVSE may need to begin charging immediately, and may not be able to guarantee that " + "the vehicle will be able to reach the target." }, { tag: "field", name: "TargetSoC", xref: "cluster§9.3.7.6.2", details: "This field represents the target SoC that the vehicle should be charged to before the " + "TargetTimeMinutesPastMidnight." + "\n" + "If the EVSE supports the SOC feature and can obtain the SoC of the vehicle:" + "\n" + " - the TargetSoC field shall take precedence over the AddedEnergy field." + "\n" + " - the EVSE SHOULD charge to the TargetSoC and then stop the charging automatically when it reaches " + "that point." + "\n" + " - if the TargetSoC value is set to 100% then the EVSE SHOULD continue to charge the vehicle until " + "the vehicle decides to stop charging." + "\n" + "If the EVSE does not support the SOC feature or cannot obtain the SoC of the vehicle:" + "\n" + " - the AddedEnergy field shall take precedence over the TargetSoC field, and if the EVSE does not " + "support the SOC feature then the TargetSoC field may only take the values null or 100%." + "\n" + " - if the AddedEnergy field has not been provided, the EVSE SHOULD assume the vehicle is empty and " + "charge until the vehicle stops demanding a charge." }, { tag: "field", name: "AddedEnergy", xref: "cluster§9.3.7.6.3", details: "This field represents the amount of energy that the user would like to have added to the vehicle " + "before the TargetTimeMinutesPastMidnight." + "\n" + "This represents a positive value in mWh that SHOULD be added during the session (i.e. if the vehicle " + "charging is stopped and started several times, this equates to the total energy since the vehicle " + "has been plugged in)." + "\n" + "The maximum value (500kWh) is much larger than most EV batteries on the market today. If the client " + "tries to set this value too high then the EVSE will need to start charging immediately and continue " + "charging until the vehicle stops demanding charge (i.e. it is full). Therefore the maximum value " + "should be set based on typical battery size of the vehicles on the market (e.g. 70000Wh), however " + "this is up to the client to carefully choose a value." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: If the EVSE can obtain the Battery Capacity of the vehicle, it SHOULD NOT limit this " + "AddedEnergy value to the Battery Capacity of the vehicle, since the EV may also require energy for " + "heating and cooling of the battery during charging, or for heating or cooling the cabin." } ] }, { tag: "datatype", name: "ChargingTargetScheduleStruct", xref: "cluster§9.3.7.7", details: "This represents a set of user specified charging targets for an EV for a set of specified days.", children: [ { tag: "field", name: "DayOfWeekForSequence", xref: "cluster§9.3.7.8", details: "This field shall indicate the days of the week that the charging targets SHOULD be associated to. " + "This field is a bitmap and therefore the associated targets could be applied to multiple days." }, { tag: "field", name: "ChargingTargets", xref: "cluster§9.3.7.9", details: "This field shall indicate a list of up to 10 charging targets for each of the associated days of the " + "week." } ] } ] } );