Update event types documentation

Author: DerAndereAndi

uccevc/types.go

@@ -7,65 +7,40 @@ const (
 
 	// EV provided an energy demand
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `EnergyDemand` to get the current data
 	DataUpdateEnergyDemand api.EventType = "DataUpdateEnergyDemand"
 
 	// Scenario 2
 
 	// EV provided a charge plan constraints
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `TimeSlotConstraints` to get the current data
 	DataUpdateTimeSlotConstraints api.EventType = "DataUpdateTimeSlotConstraints"
 
 	// Scenario 3
 
 	// EV incentive table data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `IncentiveConstraints` to get the current data
 	DataUpdateIncentiveTable api.EventType = "DataUpdateIncentiveTable"
 
-	// EV incentive table data constraints updated
-	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
-	DataUpdateIncentiveTableConstraints api.EventType = "DataUpdateIncentiveTableConstraints"
-
 	// EV requested an incentive table, call to WriteIncentiveTableDescriptions required
-	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
 	DataRequestedIncentiveTableDescription api.EventType = "DataRequestedIncentiveTableDescription"
 
 	// Scenario 2 & 3
 
 	// EV requested power limits, call to WritePowerLimits and WriteIncentives required
-	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
 	DataRequestedPowerLimitsAndIncentives api.EventType = "DataRequestedPowerLimitsAndIncentives"
 
 	// Scenario 4
 
 	// EV provided a charge plan
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `ChargePlanConstraints` to get the current data
 	DataUpdateChargePlanConstraints api.EventType = "DataUpdateChargePlanConstraints"
 
 	// EV provided a charge plan
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `ChargePlan` to get the current data
 	DataUpdateChargePlan api.EventType = "DataUpdateChargePlan"
 )

ucevcc/types.go

@@ -14,79 +14,57 @@ const (
 
 	// An EV was connected
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
-	//
 	// Use Case EVCC, Scenario 1
 	EvConnected api.EventType = "EvConnected"
 
 	// An EV was disconnected
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV was connected to
-	//   - the entity of the EV
-	//
 	// Note: The ev entity is no longer connected to the device!
 	//
 	// Use Case EVCC, Scenario 8
 	EvDisconnected api.EventType = "EvDisconnected"
 
 	// EV charge state data was updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `ChargeState` to get the current data
 	DataUpdateChargeState api.EventType = "DataUpdateChargeState"
 
 	// EV communication standard data was updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `CommunicationStandard` to get the current data
 	//
 	// Use Case EVCC, Scenario 2
 	DataUpdateCommunicationStandard api.EventType = "DataUpdateCommunicationStandard"
 
 	// EV asymmetric charging data was updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `AsymmetricChargingSupport` to get the current data
 	DataUpdateAsymmetricChargingSupport api.EventType = "DataUpdateAsymmetricChargingSupport"
 
 	// EV identificationdata was updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `Identifications` to get the current data
 	//
 	// Use Case EVCC, Scenario 4
 	DataUpdateIdentifications api.EventType = "DataUpdateIdentifications"
 
 	// EV manufacturer data was updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `ManufacturerData` to get the current data
 	//
 	// Use Case EVCC, Scenario 5
 	DataUpdateManufacturerData api.EventType = "DataUpdateManufacturerData"
 
 	// EV charging power limits
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `ChargingPowerLimits` to get the current data
 	//
 	// Use Case EVCC, Scenario 6
 	DataUpdateCurrentLimits api.EventType = "DataUpdateCurrentLimits"
 
 	// EV permitted power limits updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `IsInSleepMode` to get the current data
 	//
 	// Use Case EVCC, Scenario 7
 	DataUpdateIsInSleepMode api.EventType = "DataUpdateIsInSleepMode"

ucevcem/types.go

@@ -5,36 +5,28 @@ import "github.com/enbility/cemd/api"
 const (
 	// EV number of connected phases data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `PhasesConnected` to get the current data
 	//
 	// Use Case EVCEM, Scenario 1
 	DataUpdatePhasesConnected api.EventType = "DataUpdatePhasesConnected"
 
 	// EV current measurement data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `CurrentPerPhase` to get the current data
 	//
 	// Use Case EVCEM, Scenario 1
 	DataUpdateCurrentPerPhase api.EventType = "DataUpdateCurrentPerPhase"
 
 	// EV power measurement data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `PowerPerPhase` to get the current data
 	//
 	// Use Case EVCEM, Scenario 2
 	DataUpdatePowerPerPhase api.EventType = "DataUpdatePowerPerPhase"
 
 	// EV charging energy measurement data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `EnergyCharged` to get the current data
 	//
 	// Use Case EVCEM, Scenario 3
 	DataUpdateEnergyCharged api.EventType = "DataUpdateEnergyCharged"

ucevsecc/types.go

@@ -4,24 +4,14 @@ import "github.com/enbility/cemd/api"
 
 const (
 	// An EVSE was connected
-	//
-	// The callback with this message provides:
-	//   - the device of the EVSE
-	//   - the entity of the EVSE
 	EvseConnected api.EventType = "EvseConnected"
 
 	// An EVSE was disconnected
-	//
-	// The callback with this message provides:
-	//   - the device of the EVSE
-	//   - the entity of the EVSE
 	EvseDisconnected api.EventType = "EvseDisconnected"
 
 	// EVSE manufacturer data was updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE
-	//   - the entity of the EVSE
+	// Use `ManufacturerData` to get the current data
 	//
 	// Use Case EVSECC, Scenario 1
 	//
@@ -30,9 +20,7 @@ const (
 
 	// EVSE operation state was updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE
-	//   - the entity of the EVSE
+	// Use `OperatingState` to get the current data
 	//
 	// Use Case EVSECC, Scenario 2
 	//

ucevsoc/types.go

@@ -5,9 +5,7 @@ import "github.com/enbility/cemd/api"
 const (
 	// EV state of charge data was updated
 	//
-	// The callback with this message provides:
-	//   - the device of the EVSE the EV is connected to
-	//   - the entity of the EV
+	// Use `StateOfCharge` to get the current data
 	//
 	// Use Case EVSOC, Scenario 1
 	DataUpdateStateOfCharge api.EventType = "DataUpdateStateOfCharge"

uclpc/types.go

@@ -5,29 +5,23 @@ import "github.com/enbility/cemd/api"
 const (
 	// Load control obligation limit data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. EVSE
-	//   - the entity of the e.g. EVSE
+	// Use `ConsumptionLimit` to get the current data
 	//
 	// Use Case LPC, Scenario 1
 	DataUpdateLimit api.EventType = "DataUpdateLimit"
 
 	// Failsafe limit for the consumed active (real) power of the
 	// Controllable System data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. EVSE
-	//   - the entity of the e.g. EVSE
+	// Use `FailsafeConsumptionActivePowerLimit` to get the current data
 	//
 	// Use Case LPC, Scenario 2
 	DataUpdateFailsafeConsumptionActivePowerLimit api.EventType = "DataUpdateFailsafeConsumptionActivePowerLimit"
 
 	// Minimum time the Controllable System remains in "failsafe state" unless conditions
 	// specified in this Use Case permit leaving the "failsafe state" data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. EVSE
-	//   - the entity of the e.g. EVSE
+	// Use `FailsafeDurationMinimum` to get the current data
 	//
 	// Use Case LPC, Scenario 2
 	DataUpdateFailsafeDurationMinimum api.EventType = "DataUpdateFailsafeDurationMinimum"

uclpcserver/types.go

@@ -9,6 +9,8 @@ const (
 	//   - the device of the e.g. SMGW
 	//   - the entity of the e.g. SMGW
 	//
+	// Use `ConsumptionLimit` to get the current data
+	//
 	// Use Case LPC, Scenario 1
 	DataUpdateLimit api.EventType = "DataUpdateLimit"
 
@@ -23,19 +25,15 @@ const (
 	// Failsafe limit for the consumed active (real) power of the
 	// Controllable System data update received
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. SMGW
-	//   - the entity of the e.g. SMGW
+	// Use `FailsafeConsumptionActivePowerLimit` to get the current data
 	//
 	// Use Case LPC, Scenario 2
 	DataUpdateFailsafeConsumptionActivePowerLimit api.EventType = "DataUpdateFailsafeConsumptionActivePowerLimit"
 
 	// Minimum time the Controllable System remains in "failsafe state" unless conditions
 	// specified in this Use Case permit leaving the "failsafe state" data update received
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. SMGW
-	//   - the entity of the e.g. SMGW
+	// Use `FailsafeDurationMinimum` to get the current data
 	//
 	// Use Case LPC, Scenario 2
 	DataUpdateFailsafeDurationMinimum api.EventType = "DataUpdateFailsafeDurationMinimum"

uclpp/types.go

@@ -5,29 +5,23 @@ import "github.com/enbility/cemd/api"
 const (
 	// Load control obligation limit data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. EVSE
-	//   - the entity of the e.g. EVSE
+	// Use `ProductionLimit` to get the current data
 	//
 	// Use Case LPC, Scenario 1
 	DataUpdateLimit api.EventType = "DataUpdateLimit"
 
 	// Failsafe limit for the produced active (real) power of the
 	// Controllable System data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. EVSE
-	//   - the entity of the e.g. EVSE
+	// Use `FailsafeProductionActivePowerLimit` to get the current data
 	//
 	// Use Case LPC, Scenario 2
 	DataUpdateFailsafeProductionActivePowerLimit api.EventType = "DataUpdateFailsafeProductionActivePowerLimit"
 
 	// Minimum time the Controllable System remains in "failsafe state" unless conditions
 	// specified in this Use Case permit leaving the "failsafe state" data updated
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. EVSE
-	//   - the entity of the e.g. EVSE
+	// Use `FailsafeDurationMinimum` to get the current data
 	//
 	// Use Case LPC, Scenario 2
 	DataUpdateFailsafeDurationMinimum api.EventType = "DataUpdateFailsafeDurationMinimum"

uclppserver/types.go

@@ -5,9 +5,7 @@ import "github.com/enbility/cemd/api"
 const (
 	// Load control obligation limit data update received
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. SMGW
-	//   - the entity of the e.g. SMGW
+	// Use `ProductionLimit` to get the current data
 	//
 	// Use Case LPC, Scenario 1
 	DataUpdateLimit api.EventType = "DataUpdateLimit"
@@ -23,19 +21,15 @@ const (
 	// Failsafe limit for the produced active (real) power of the
 	// Controllable System data update received
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. SMGW
-	//   - the entity of the e.g. SMGW
+	// Use `FailsafeProductionActivePowerLimit` to get the current data
 	//
 	// Use Case LPC, Scenario 2
 	DataUpdateFailsafeProductionActivePowerLimit api.EventType = "DataUpdateFailsafeProductionActivePowerLimit"
 
 	// Minimum time the Controllable System remains in "failsafe state" unless conditions
 	// specified in this Use Case permit leaving the "failsafe state" data update received
 	//
-	// The callback with this message provides:
-	//   - the device of the e.g. SMGW
-	//   - the entity of the e.g. SMGW
+	// Use `FailsafeDurationMinimum` to get the current data
 	//
 	// Use Case LPC, Scenario 2
 	DataUpdateFailsafeDurationMinimum api.EventType = "DataUpdateFailsafeDurationMinimum"