From dd04c2aef03032a9623c5c6350b9f7ffc2b869f3 Mon Sep 17 00:00:00 2001 From: Yoan VALLET <ext.sopra.yvallet@grandlyon.com> Date: Thu, 11 Mar 2021 16:28:50 +0100 Subject: [PATCH] review consumption section --- docs/ecolyo/functionalities/consumption.md | 32 ++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/docs/ecolyo/functionalities/consumption.md b/docs/ecolyo/functionalities/consumption.md index f3fb274..43023a6 100644 --- a/docs/ecolyo/functionalities/consumption.md +++ b/docs/ecolyo/functionalities/consumption.md @@ -1,10 +1,25 @@ -## Description +# Consumption Ecolyo allow user to see its consumption in two way: + - with an aggregated view aka HomeView - with a specific view for a fluid aka SingleFluidView -## Modal old fluid data +All consumption information are retrieve and calculated by services from the application. + +## HomeView +### Description + +This view is the main view of the application. It displays an agreggation view of all connected fluids + +### Rules + +1. If no fluids are connected, this view will display the konnectors card which allow user to connect its first fluids. These card are the same as the cards in option screen. +2. Fluid are displayed in multi fluid color and in euro +3. The comparison functionnality is not available for this view +4. TimeStep available are the folowing: week, month, year and 5 years + +### Modal old fluid data In order to warn a user that its data is too old regarding a fluid, a modal is displayed when the last date of a fluid is greater than 5 days. @@ -13,6 +28,19 @@ Depending of the konnector status the user will receive 2 differents messages: - if the konnector is in error, the user will be invited to check the konnector - if the konnector has run successfully but hasn't retrieved data from the last 5 days, the user will be invited to contact the supplier + +## SingleFluidView +### Description + +This view displays the consumption of a specified fluid (electricity, water, gas). + +### Rules + +1. Fluid is displayed in the given fluid color and unit (kWh for electricity and gaz, l for water) +2. The comparison functionnality is present for following time step: day, week, month, year +3. TimeStep day is only available for electricity fluid +4. If user has selected day time step and change the fluid, the week time step will be selected by default. + ## Comparison The user can compare its data with a previous period using a switch which will display the previous period on the same chart. -- GitLab