Skip to content

Commit

Permalink
Fix inconsistent DataUpdate event type identifiers for LPP use cases (
Browse files Browse the repository at this point in the history
…#137)

This pull request resolves inconsistencies in the event type identifiers
within usecases/cs/lpp/types.go and usecases/eg/lpp/types.go. The
following changes were made:

- Corrected event type identifiers to align with LPP scenarios instead
of LPC scenarios where applicable. This helps ensure the identifiers
accurately reflect their use cases and scenarios.
- Updated DataUpdateHeartbeat in both files to reflect the correct
uclppserver and cs-lpp prefixes.

These changes improve code accuracy, documentation and maintain the
correct mapping of constants to their respective use cases in the EEBUS
library.
  • Loading branch information
DerAndereAndi authored Nov 5, 2024
2 parents ad314b8 + b939158 commit 7fb578c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion usecases/cs/lpp/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ const (
// E.g. going into or out of the Failsafe state
//
// Use Case LPP, Scenario 3
DataUpdateHeartbeat api.EventType = "uclpcserver-DataUpdateHeartbeat"
DataUpdateHeartbeat api.EventType = "uclppserver-DataUpdateHeartbeat"
)
10 changes: 5 additions & 5 deletions usecases/eg/lpp/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,28 @@ const (
//
// Use `ProductionLimit` to get the current data
//
// Use Case LPC, Scenario 1
// Use Case LPP, Scenario 1
DataUpdateLimit api.EventType = "eg-lpp-DataUpdateLimit"

// Failsafe limit for the produced active (real) power of the
// Controllable System data updated
//
// Use `FailsafeProductionActivePowerLimit` to get the current data
//
// Use Case LPC, Scenario 2
// Use Case LPP, Scenario 2
DataUpdateFailsafeProductionActivePowerLimit api.EventType = "eg-lpp-DataUpdateFailsafeProductionActivePowerLimit"

// Minimum time the Controllable System remains in "failsafe state" unless conditions
// specified in this Use Case permit leaving the "failsafe state" data updated
//
// Use `FailsafeDurationMinimum` to get the current data
//
// Use Case LPC, Scenario 2
// Use Case LPP, Scenario 2
DataUpdateFailsafeDurationMinimum api.EventType = "eg-lpp-DataUpdateFailsafeDurationMinimum"

// Indicates a notify heartbeat event the application should care of.
// E.g. going into or out of the Failsafe state
//
// Use Case LPC, Scenario 3
DataUpdateHeartbeat api.EventType = "cs-lpc-DataUpdateHeartbeat"
// Use Case LPP, Scenario 3
DataUpdateHeartbeat api.EventType = "cs-lpp-DataUpdateHeartbeat"
)

0 comments on commit 7fb578c

Please sign in to comment.