Skip to content

Add UTC timestamp remarks #61

@thomas-nicolai-frequenz

Description

@thomas-nicolai-frequenz

What's needed?

Indication that the UTC timestamps are translated to the microgrids local timezone.

Proposed solution

Add timezone clarification notes to the Dispatch and RecurrenceRule message as drafted below:

// Message representing one dispatch
// Note: Timestamps are in UTC. Each microgrid is responsible for translating the UTC timestamp to its local time.
message Dispatch {
  // ... existing fields ...

  // The creation time in UTC
  // This is set when a dispatch is created via the create request message
  google.protobuf.Timestamp create_time = 4;

  // The update time in UTC
  // This is set when a dispatch is modified via the update request message
  google.protobuf.Timestamp update_time = 5;

  // The start time in UTC
  google.protobuf.Timestamp start_time = 6;

  // The end time in UTC
  google.protobuf.Timestamp end_time = 7;

  // ... existing fields ...

  // The recurrence rule
  RecurrenceRule recurrence = 12;
}

// Ruleset governing when and how a dispatch should re-occur
//
// Timezone Note: Timestamps are in UTC. It is the responsibility of each microgrid to translate UTC 
// to its local timezone.
//
// This definition tries to adhere closely to the iCalendar specification (RFC 5545),
// particularly for recurrence rules. For advanced use-cases or further clarifications,
// refer to RFC 5545.
//
message RecurrenceRule {
  // ... existing fields ...
}

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:❓We need to figure out which part is affectedpriority:❓We need to figure out how soon this should be addressedtype:enhancementNew feature or enhancement visitble to users

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions