Welcome to the online documentation of Entropy project!¶
Contents:
Entropy walkthrough¶
Create Account¶
- When a user access the ENTROPY site (https://http://hesso-entropy.euprojects.net//) the following screen is shown:
- Click on login button.
- Click on “Create Account” button.
- Provide account information and click on “CREATE ACCOUNT” button.
- Go to your email and click on ENTROPY account information link.
- Complete the ENTROPY Questionnaire.
- You have successfully Create an New Account.
Login¶
- When a user access the ENTROPY site (https://http://hesso-entropy.euprojects.net//) the following screen is shown:
- Click the <Log in> button .
- Provide your login credentials and click the <SIGN IN> button.
- Upon successful authentication the following screen will be presented.
Logout¶
- In order to perform logout click the <Log-out > Button.
- Upon successful logout the following screen will be presented.
Reset password¶
- In order to reset our existing password click the Reset Button.
- Click on “RESET” button.
- An Email has been send to your associate email account.
- Go to your email and click on ENTROPY reset account link.
- Login again to Entropy.
- Use your temporarily password.
- Click on “Account” menu-item.
- Click on “Change password” button.
- Provide your new password and click on “SAVE” button.
- Your password has successfully reset and updated.
Dashboard¶
Campaign Manager Dashboard¶
- Initially the user must login using the Campaign manager Credentials.
- Click on Dashboard button to review it.
- Dashboard includes sever information such as an overall view of registered sensors, areas , streams etc, local weather conditions, connected consumption apps.
- In case there is an active campaign, Dashboard also informs about the responsiveness of the users to the generated recommendations.
- Within a dropdown menu the Admin or Campaign manager can see some area statistics for the last 25 hours regarding the temperature and consuption of each registered building/area.
- Within a dropdown menu the Admin or Campaign manager can see the cooling/heating degree days as well as the relevant energy waste per area.
Also can see the behavioural profile of the registered Users. To see the behavioural change has to compare the behavioural heatmaps hosted at the campaigns menu part.
End User Dashboard¶
- Initially the user must login using the End User Credentials.
- Click on Dashboard button to review it. The End User has limited access (messages, campaign evaluation)
Account¶
Edit Profile¶
- In order to edit an existing profile several consecutive steps have to be undertaken.
- Initially the user must be login.
- Click on “account” menu-item.
- Click on “edit profile” button.
- Provide profile details and push the “save” button.
- Upon successful update,the overall list of profiles will be update it.
Disable Account¶
- In order to disable an existing account several consecutive steps have to be undertaken.
- Initially the user must be login.
- Click on “account” menu-item.
- Press on the “Disable Account” button.
- The desired account has been disabled.
Admin¶
Approve Campaign managers¶
- In order to approve Campaign managers several consecutive steps have to be undertaken.
- Initially the user must be login.
- Click on “Admin” menu-item.
- Click on “approve” button.
- Upon successful approve,the overall list of profiles will be update it.
Visualize system Logs¶
- In order to visualize system logs several consecutive steps have to be undertaken.
- Initially the user must be login.
- Click on “Admin” menu-item.
- Click on “System logs” menu-item.
- The campaign manager can access the appropriate system log.
Register a new Building area¶
Register a new Building Area¶
- In order register a new building area several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Areas” Menu-item.
- Click on “New Area” button.
- Provide the new area details and click on “Save” button.
In order to get information about the energy waste of you building you should providing data for (see attached figure):
- the global energy performance (as made available in the energy certificate) in kWh/m3
- the heating energy performance (as made available in the energy certificate) in kWh/m3
- the cooling energy performance (as made available in the energy certificate) in kWh/m3
- the heating degree days for the previous year (e.g. 2017) as made available by wunderground.com (e.g. https://www.wunderground.com/history/airport/LERI/2018/4/30/CustomHistory.html?req_city=Murcia&req_statename=Spain&reqdb.zip=00000&reqdb.magic=248&reqdb.wmo=08429)
- the cooling degree days for the previous year (e.g. 2017) as made available by wunderground.com
Such data is used towards the calculation of the Heat Transfer Coefficient, as well as the estimated need for power for heating/cooling at each period of time.
- Upon successful addition, the new area appears in area list.
Edit a Building Area¶
- In order to edit an existing building area consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Areas” Menu-item.
- Click on “EDIT” button.
- Provide the edit area details and click on “Save” button.
- During editing the admin can move sensors from main areas to sub areas.
- It is also possible to define some main steams per area. Main streams have a default frequency of one hour and refer to indoor/outdoor temperature and consumption and production power. it is necessary to define this because serveral analytic packages make use of them so as to calculate the energy saving and waste compared with the calculated consumption baseline.
- Default main stream are declared by clicking on “Add stream” option as seen followingly:
- Upon successful editing, the modified area appears in the list.
Delete Building Area¶
- In order to delete a building area several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Areas” Menu-item.
- Click on “DELETE” button.
- Upon successful delete of the selected area,the area list will be modified.
Synchronize sensors¶
Synchronize sensors¶
- In order to syncronize sensors of a given area, the user must click on “Areas” menu-item
- and then select the”SENSORS” option for a specific area.
- by clicking the “Synchronize Sensors” button Entropy engine aytomatically fetch all declared Fiware Sensors for the specific area. User can search for specific sensors via the search box on the top of the sensors list.
Streams¶
Visualize streams¶
- In order to visualize a stream several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Streams” menu-item.
- The campaign manager can access the appropriate stream .
Start/stop stream¶
- In order to Start/stop a stream several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Streams” menu-item.
- Click on “start” button to start a stream.
- Press the “pause” button to stom a stream.
Visualize stream graph¶
- In order to Visualize stream graph several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Streams” menu-item.
- Press on “graph” button on the desired stream.
- Upon successful selection,the desired stream graph can be viewed.
Create a new stream from a specific sensor¶
- In order to create a new stream from a specific sensor several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Sensors” Menu-item.
- Click on “New Stream” button.
- Provide new data streams details such us (Real Time or Aggregated data monitoring, sensor attribute, Description etc).
- Click on “Add Stream” button.
- Upon successful declaration, the new stream appears in sensor management list.
View streams generated by a sensor¶
- In order to view streams that generated by sensor several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Sensor” menu-item.
- Press the “view streams” button.
- The campaign manager can access the appropriate stream.
Queries¶
Create a new query¶
- In order to create a new query several consecutive steps have to be undertaken.
- Initially the user must be login.
- Click on “Queries” menu-item.
- Click on “New Query” button.
- Provide now query details such us (Observation Values from data sensor streams, User, Etc)
- Click on “Save Query” button.
- Upon successful addition, the new query appears in list.
Edit a query¶
- In order to edit a query, several consecutive steps have to be undertaken.
- Initially the user must be login.
- Click on “Queries” menu-item.
- Click on edit button(pencil item).
- Click on “Update Query” button.
- The selected query has been updated.
Execute a query¶
- In order to execute a query, several consecutive steps have to be undertaken.
- Initially the user must be login.
- Click on “Queries” menu-item.
- Click on “Run Query” button.
- The selected query has been executed.
Delete a query¶
- In order to delete a query, several consecutive steps have to be undertaken.
- Initially the user must be login.
- Click on “Queries” menu-item.
- Click on delete Query button.
- The selected query has been deleted.
Analytics¶
Algorithm¶
Register a new algorithm
- In order to register a new algorithm several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Algorithms” button.
- Click on “New Algorithm” button.
- Provide new algorithm details.
- Click on “Save” button.
- You have successfully create new algorithm.
View a registered algorithm
- In order to view a registered algorithm several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Algorithms” button.
- Click on View button(eye object).
- The registered algorithm details appears in the platform.
Delete an algorithm
- In order to delete a registered algorithm several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Algorithms” button.
- Click on delete button (bin object).
- You have successfully delete the selected algorithm.
Algorithm Template¶
Create a new algorithm template
- In order to create a new algorithm template consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Templates” button.
- Click on “New Template” button.
- Provide custom analytic process template details.
- Click on “Save” button.
- You have successfully create new algorithm template.
View an algorithm template
- In order to view an algorithm template several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Templates” button.
- Click on “VIEW” button.
- The registered algorithm template appears in the platform.
Delete an algorithm template
- In order to delete an algorithm template several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Templates” button.
- Click on DELETE button.
- You have successfully delete the selected algorithm template.
Execute an algorithm template
- In order to execute an algorithm template several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Templates” button.
- Click on RUN button.
- You have successfully execute the selected algorithm template.
Analytic process¶
View an analytic process
- In order to view an algorithm template several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Reports” button.
- Click on View button(eye object).
- The analytic process results appear in platform.
Delete an analytic process
- In order to delete an analytic process several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Analytics” menu-item.
- Click on “Reports” button.
- Click on DELETE button(Bin object).
- You have successfully delete the selected analytic process.
Messages¶
Via the Messages menu tabs you can orchestrate the conditions upon which the personalized recommendations are triggered.
In short, during the definition of a recommendation template, the campaign manager is able to declare the points to be given to the end user as well as the associated badge (if any) and the percentage of the badge to be received. The percentage of the badge is given only if the total points associated with this recommendation are given to the end user.
Then, in the definition of rules for triggering the sending of a recommendation, the campaign manager is able to define whether the recommendation is validatable or not as well as if it is validatable by an action. In the last case, rules for validation have also to be provided.
Upon the consumption of the recommendations, during the receipt of feedback messages, the set of points to be allocated to the user are provided by the apps through an API. Then, calculation of total score, ranking and percentage of badges achieved is also made available trhough an API.
The following figure shows the overall process.
View list of generated recommendation messages¶
- In order to view the list of generated recommendation messages several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Messages” menu-item.
- The generated recommendation messages appear in platform.
Recommendation Template¶
Create a new recommendation Template
- In order to create a new recommendation template several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Messages” menu-item.
- Click on “Templates” button.
- Click on “New Template” button.
- Provide recommendation template details such us (friendly name,type,message, etc.)
- Click on “SAVE” button.
- You have successfully create a new recommendation template.
Edit a recommendation Template
- In order to edit a recommendation template several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Messages” menu-item.
- Click on “Templates” button.
- Click on edit button(pencil object).
- Provide recommendation template details such us (friendly name,type,message, etc.)
- Click on “SAVE” button.
- You have successfully edit the selected recommendation template.
Delete a recommendation Template
- In order to delete a recommendation template several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Messages” menu-item.
- Click on “Templates” button.
- Click on delete button(bin object).
- You have successfully delete the selected recommendation template.
View list of recommendation Template
- In order to view a recommendation template list several consecutive steps have to be undertaken.
- Initially the user must login.
- Click on “Messages” menu-item.
- Click on “Templates” button.
- The recommendation template list appear in platform.
Recommendation Rule¶
Create a new Recommendation Rule
- In order to create a new recommendation rule several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Messages” menu-item.
- Click on “Recommendation rules” button.
- Click on “New Rule” button.
- Provide rules details such us (description,target users,etc.)
Defining the target users conditions can make the recomendation messages be personalized. End users demografic data, their behavioural properties and their responsiveness to previous recommendations are some of the conditions that may afect the recommendation send to them. Following figure depicts the workflow towards generating personalized content.
The property “hasSelfDeterministicMotivation” fits the option 2 of the above figure. Each user has a percentage of intrisic and extrinsic motivation. For example “user A” can be 20% intrinsic and 80% extrinsic. This means that will receive an intrinsic message with a probability of 20% and an extrinsic with a propability of 80%. If the users receives 10 messages it is very probable to get 2 Intrinsic messages and 8 Extrinsic.
- Click on “SAVE” button.
- You have successfully create a new recommendation rule.
Edit a Recommendation Rule
- In order to edit a recommendation rule several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Messages” menu-item.
- Click on “Recommendation rules” button.
- Click on edit button(pencil object).
- Provide rules details such us (description,target users,stream conditions,etc.)
- Click on “UPDATE” button.
- You have successfully update a recommendation rule.
Delete a Recommendation Rule
- In order to edit a recommendation rule several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Messages” menu-item.
- Click on “Recommendation rules” button.
- Click on delete button (bin object)
- You have successfully delete a recommendation rule.
Enable/Disable a Recommendation Rule
- In order to Enable/Disable a Recommendation Rule several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on “Messages” menu-item.
- Click on “Recommendation rules” button.
- Slide the bar to the left in order to disable a recommendation rule.
- Slide the bar to the right in order to enable a recommendation rule.
Campaigns¶
Create a new Campaign¶
- In order to create a new campaign several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on ‘’Campaign Evaluation’’ menu-item.
- Click on “New Evaluation” button.
- Provide new Campaign details and click on “SAVE” button.
- Upon successful declaration of the new campaign the list of campaign evaluation will be update it.
Edit a Campaign¶
- In order to edit a Campaign several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on ‘’Campaign Evaluation’’ menu-item.
- Press the “edit” button (pencil object).
- Upon successful editing of the campaign , the list of declare campaigns will be update it.
Delete a Campaign¶
- In order to delete a Campaign several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on ‘’Campaign Evaluation’’ menu-item.
- Press on “delete” button on the desired campaign.
- Upon successful deletion of a desired campaign the list of campaigns will be update it.
View a Campaign¶
- In order to delete a Campaign several consecutive steps have to be undertaken .
- Initially the user must login.
- Click on ‘’Campaign Evaluation’’ menu-item.
- Press on “view” button (eye object) on the desired campaign.
- You can review campaign statistics such us user metrics,work engagement,etc.
