mirror of
https://github.com/YunoHost-Apps/aeneria_ynh.git
synced 2024-09-03 18:06:15 +02:00
67 lines
2.9 KiB
Markdown
67 lines
2.9 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# æneria for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/aeneria)  
|
|
[](https://install-app.yunohost.org/?app=aeneria)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install æneria quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
The idea of [æneria](https://aeneria.com) is to display energy consumption and weather data on a little dashboard that allow the user to:
|
|
|
|
* Better understand our own energy consumption
|
|
* Analyse energy consumption throw weather data
|
|
|
|
|
|
**Shipped version:** 1.1.6~ynh2
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
## Configuration
|
|
|
|
* First of all, you'll need a Linky and an [Enedis account](https://mon-compte-client.enedis.fr/)
|
|
* In your Enedis space, go to ["Gérer l'accès à mes données"](https://mon-compte-particulier.enedis.fr/donnees/) tab, and allow Enedis to collect and store your hourly consumption
|
|
* After that, install æneria to your Yunohost instance, visit it and just follow instructions
|
|
* That's it, now wait a bit to see data appear !
|
|
|
|
## Comming from Pilea
|
|
|
|
æneria is the new name of Pilea. This new name came whith a brand new version.
|
|
|
|
This new version introduced some breaking changes in data structure: migration from Pilea can't be done automaticly.
|
|
|
|
But don't worry, you can easilly transfer your data from Pilea to æneria following [this documentation](https://docs.aeneria.com/fr/latest/administrateur/pilea_migration.html).
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://aeneria.com>
|
|
* Official admin documentation: <https://docs.aeneria.com>
|
|
* Upstream app code repository: <https://gitlab.com/aeneria/aeneria-app>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_aeneria>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/aeneria_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/aeneria_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/aeneria_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade aeneria -u https://github.com/YunoHost-Apps/aeneria_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|