diff --git a/documentation/cli/commands.rst b/documentation/cli/commands.rst index 8d3c5a6f6..dfd40a7ea 100644 --- a/documentation/cli/commands.rst +++ b/documentation/cli/commands.rst @@ -14,6 +14,8 @@ You can also get the current overview over the commands you have available by: .. code-block:: console flexmeasures --help + flexmeasures [command] --help + This also shows admin commands made available through Flask and installed extensions (such as `Flask-Security `_ and `Flask-Migrate `_), of which some are referred to in this documentation. @@ -45,7 +47,7 @@ of which some are referred to in this documentation. ================================================= ======================================= ``flexmeasures show accounts`` List accounts. ``flexmeasures show account`` Show an account, its users and assets. -``flexmeasures show asset-types` List available asset types. +``flexmeasures show asset-types`` List available asset types. ``flexmeasures show asset`` Show an asset and its sensors. ``flexmeasures show roles`` List available account- and user roles. ``flexmeasures show data-sources`` List available data sources. @@ -59,7 +61,8 @@ of which some are referred to in this documentation. ================================================= ======================================= ``flexmeasures edit attribute`` Edit (or add) an asset attribute or sensor attribute. -``flexmeasures edit resample-data`` Assign a new event resolution to an existing sensor and resample its data accordingly. +``flexmeasures edit resample-data`` | Assign a new event resolution to an existing sensor + | and resample its data accordingly. ================================================= ======================================= @@ -67,10 +70,11 @@ of which some are referred to in this documentation. -------------- ================================================= ======================================= -``flexmeasures delete structure`` Delete all structural (non time-series) data like assets (types), - roles and users. +``flexmeasures delete structure`` | Delete all structural (non time-series) data, + | like assets (types), roles and users. ``flexmeasures delete account-role`` Delete a tenant account role. -``flexmeasures delete account`` Delete a tenant account & also their users (with assets and power measurements). +``flexmeasures delete account`` | Delete a tenant account & also their users + | (with assets and power measurements). ``flexmeasures delete user`` Delete a user & also their assets and power measurements. ``flexmeasures delete asset`` Delete an asset & also its sensors and data. ``flexmeasures delete sensor`` Delete a sensor and all beliefs about it. diff --git a/documentation/index.rst b/documentation/index.rst index 143d00d28..c073af47f 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -190,6 +190,7 @@ The platform operator of FlexMeasures can be an Aggregator. :maxdepth: 1 views/dashboard + views/asset-data views/admin .. toctree:: diff --git a/documentation/views/admin.rst b/documentation/views/admin.rst index f66ffdb86..8d1b3d5be 100644 --- a/documentation/views/admin.rst +++ b/documentation/views/admin.rst @@ -4,7 +4,7 @@ Administration ************** -The administrator can edit assets and users here. +The administrator can see assets and users here. Assets ------ @@ -15,11 +15,6 @@ Listing all assets: :align: center .. :scale: 40% -Viewing & editing one asset: - -.. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot_asset.png - :align: center -.. :scale: 40% Users diff --git a/documentation/views/asset-data.rst b/documentation/views/asset-data.rst new file mode 100644 index 000000000..a9cec351a --- /dev/null +++ b/documentation/views/asset-data.rst @@ -0,0 +1,19 @@ +.. _view_asset-data: + +************** +Assets & data +************** + +The asset page allows to see data from the asset's sensors, and also to edit meta information, like its location: + + +.. image:: https://github.com/FlexMeasures/screenshots/raw/main/screenshot_asset.png + :align: center +.. :scale: 40% + +| +| + +.. note:: It is possible to determine which sensors this page should show. For instance, here we include a price sensor from a public asset. + For this, set the `sensors_to_show` attribute with the CLI command ``flexmeasures edit attribute``. +