Skip to content

Conversation

@flora-hofmann-frequenz
Copy link
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings May 6, 2025 09:43
@github-actions github-actions bot added the part:docs Affects the documentation label May 6, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README by bumping the installation version and adding new code examples demonstrating how to query sensor data.

  • Updated installation instructions to use version 0.16.0.
  • Added examples for querying metrics for a single microgrid sensor and for multiple microgrids and sensors.
  • Updated the command-line tool description to reflect the new functionality.
Comments suppressed due to low confidence (1)

README.md:77

  • Consider adding import statements (e.g., for datetime, timedelta, and Metric) at the beginning of the code snippet to clarify dependencies for users copying the example.
    sample async for sample in

microgrid_id=1,
sensor_id=100,
metrics=[Metric.SENSOR_IRRADIANCE],
start_dt=datetime.fromisoformat("2024-05-01T00:00:00"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should first change these argument names to {start,end}_time before sending this out.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be with the next release tough. Should I just change it for sensors & in this PR and then make a new release?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, let's get this in, then change the arguments and make a new release with this and the receiver changes soon.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in #178

@flora-hofmann-frequenz flora-hofmann-frequenz merged commit 54b7bdd into frequenz-floss:v0.x.x May 6, 2025
5 checks passed
flora-hofmann-frequenz added a commit that referenced this pull request May 12, 2025
Addressed comments from #169 and #176.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants