Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs with screenshots #1103

Merged
merged 2 commits into from
Jun 21, 2024
Merged

Update docs with screenshots #1103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3302250
Add screenshots to account page in documentation
BelhsanHmida Jun 21, 2024
72eedc8
Add screenshots to asset-sensor page in documentation
BelhsanHmida Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion documentation/views/account.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,22 @@ This is the account overview page:

.. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot_account.png
:align: center
.. :scale: 40%
.. :scale: 40%

|
|

This is the current User overview page:

.. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot-user-overview.png
:align: center
.. :scale: 40%

|
|

This is the account audit log page:

.. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot-account-auditlog.PNG
:align: center
.. :scale: 40%
20 changes: 19 additions & 1 deletion documentation/views/asset-data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,24 @@ This includes the possibility to specify which sensors the asset page should sho
|
|

For each asset, you can also visit a status page to see if your data connectivity and recent jobs are okay. This is how data connectivity status looks like on the building asset from our tutorial:

.. image:: https://github.com/FlexMeasures/screenshots/raw/main/tut/toy-schedule/screenshot_building_status.png
:align: center
.. :scale: 40%

|
|

This is how the audit log looks for the history of actions taken on an asset:

.. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot-auditlog.PNG
:align: center
.. :scale: 40%

|
|

.. note:: It is possible to overlay data for multiple sensors, by setting the `sensors_to_show` attribute to a nested list. For example, ``{"sensor_to_show": [3, [2, 4]]}`` would show the data for sensor 4 laid over the data for sensor 2.
.. note:: While it is possible to show an arbitrary number of sensors this way, we recommend showing only the most crucial ones for faster loading, less page scrolling, and generally, a quick grasp of what the asset is up to.
.. note:: Asset attributes can be edited through the CLI as well, with the CLI command ``flexmeasures edit attribute``.
Expand Down Expand Up @@ -56,4 +74,4 @@ And here are 4 days of (dis)-charging patterns in Seita's V2GLiberty project:

Charging (blue) mostly happens in sunshine hours, discharging during high-price hours (morning & evening)

So on a technical level, the daily heatmap is essentially a heatmap of the sensor's values, with dates on the y-axis and time of day on the x-axis. For individual devices, it gives an insight into the device's running times. A new button lets users switch between charts.
So on a technical level, the daily heatmap is essentially a heatmap of the sensor's values, with dates on the y-axis and time of day on the x-axis. For individual devices, it gives an insight into the device's running times. A new button lets users switch between charts.
Loading