From 0fa7ec16ba3ec2ce29cded19f3fc9ef5a0ae3e70 Mon Sep 17 00:00:00 2001
From: Yoan VALLET <ext.sopra.yvallet@grandlyon.com>
Date: Thu, 18 Feb 2021 10:14:00 +0100
Subject: [PATCH] add consumption and ecogesture sections

---
 docs/ecolyo/functionalities/consumption.md | 27 ++++++++++++
 docs/ecolyo/functionalities/ecogesture.md  | 48 ++++++++++++++++++++++
 mkdocs.yml                                 |  2 +
 3 files changed, 77 insertions(+)
 create mode 100644 docs/ecolyo/functionalities/consumption.md
 create mode 100644 docs/ecolyo/functionalities/ecogesture.md

diff --git a/docs/ecolyo/functionalities/consumption.md b/docs/ecolyo/functionalities/consumption.md
new file mode 100644
index 0000000..83ddaa1
--- /dev/null
+++ b/docs/ecolyo/functionalities/consumption.md
@@ -0,0 +1,27 @@
+# Description
+
+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
+
+In order to avertise user that the data is too old for a fluid, a modal is displayed when the last date of a fluid is greater than 5 days.
+
+In function of the connector status the user will receive 2 differents message:
+- if the konnector is in error, the user will be invited to check the konnector
+- if the konnector has ran successfully, the user will be invited to contact the supplier
+
+# Comparison
+
+User can compare its data with a previous period using a switch which will display the previous period on the same chart. 
+This features is only available on single fluid chart and if not available at the year time step
+
+# Time step
+
+Different time steps can be selected by the user which will display different period on the graph in function of this time step. 
+- Day: display data at half-an-hour step on a period of one day
+- Week: display data at daily step on a period of a week
+- Month: display data at daily step on a period of a month
+- Year: display data at monthly step on a period of a year
+- 5 years: display data at yearly step on a period of 5 years (5 last years)
\ No newline at end of file
diff --git a/docs/ecolyo/functionalities/ecogesture.md b/docs/ecolyo/functionalities/ecogesture.md
new file mode 100644
index 0000000..9a20ab1
--- /dev/null
+++ b/docs/ecolyo/functionalities/ecogesture.md
@@ -0,0 +1,48 @@
+# Ecogesture
+
+## All ecogestures screen
+
+This screen display the full list of ecogestures. User can filter ecogesture by usage.
+
+## Ecogestures filtered by profile
+
+This screen display is based on a filtered ecogesture list that fit to the user profile type. 
+The user can also filter ecogesture by usage.
+
+Following rules are used to filter the ecogesture:
+
+### Case ecogesture usage is heating
+
+We will display the ecogesture if:
+- the ecogesture has electricity fluid and profile type has an individual heating which use electricity fluid.
+
+OR
+- the ecogesture has gas fluid and profile type has an individual heating which use gas fluid.
+
+### Case ecogesture usage is ECS
+
+We will display the ecogesture if:
+- the ecogesture has electricity fluid and profile type has an individual hot water which use electricity fluid.
+
+OR
+- the ecogesture has gas fluid and profile type has an individual hot water which use gas fluid.
+
+### Case ecogesture usage is ECS
+
+We will display the ecogesture if:
+- the ecogesture has electricity fluid and profile type has an electricity fluid for cooking.
+
+OR
+- the ecogesture has gas fluid and profile type has an gas fluid for cooking.
+
+### Case ecogesture usage is cold water
+
+We will display the ecogesture if the profile type has a individual cold water.
+
+### Case ecogesture usage is specific electricity
+
+We will display the ecogesture.
+
+### Case ecogesture usage is air conditioning
+
+We will NOT display the ecogesture.
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 2aaf8eb..36c1a31 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -73,6 +73,8 @@ nav:
           - Eau du Grand Lyon: ecolyo/konnectors/egl.md
       - Functionalities:
           - Initialization: ecolyo/functionalities/initialization.md
+          - Consumption: ecolyo/functionalities/consumption.md
+          - Ecogesture: ecolyo/functionalities/ecogesture.md
           - Challenge: ecolyo/functionalities/challenge.md
           - Profile Type: ecolyo/functionalities/profile_type.md
   - Proxy:
-- 
GitLab