1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/aeneria_ynh.git synced 2024-09-03 18:06:15 +02:00
aeneria_ynh/README.md

69 lines
3 KiB
Markdown
Raw Normal View History

2020-11-26 18:47:34 +01:00
# æneria for YunoHost
2021-01-06 11:42:30 +01:00
[![Integration level](https://dash.yunohost.org/integration/aeneria.svg)](https://dash.yunohost.org/appci/app/aeneria) ![](https://ci-apps.yunohost.org/ci/badges/aeneria.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/aeneria.maintain.svg)
2020-12-31 15:31:31 +01:00
[![Install æneria with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=aeneria)
2020-11-26 18:47:34 +01:00
> *This package allows you to install æeneria 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
2021-01-06 19:25:07 +01:00
The idea of [æneria](https://aeneria.com) is to display energy consumption and weather data on a little dashboard that allow the user to:
2020-11-26 18:47:34 +01:00
2020-12-28 16:06:54 +01:00
* Better understand our own energy consumption
* Analyse energy consumption throw weather data
2020-11-26 18:47:34 +01:00
2021-11-19 10:17:43 +01:00
**Shipped version:** 1.1.6
2020-11-26 18:47:34 +01:00
## Screenshots
![æneria startup screen](https://gitlab.com/aeneria/aeneria-app/-/raw/master/docs/img/dash_accueil.png)
## Configuration
2020-12-28 16:06:54 +01:00
* 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
2020-11-26 19:01:52 +01:00
* That's it, now wait a bit to see data appear !
2020-11-26 18:47:34 +01:00
## Documentation
More information can be found on [æneria documentation](https://docs.aeneria.com).
## Comming from Pilea
2020-11-26 18:48:37 +01:00
æneria is the new name of Pilea. This new name came whith a brand new version.
2020-11-26 18:47:34 +01:00
2020-11-27 15:12:23 +01:00
This new version introduced some breaking changes in data structure: migration from Pilea can't be done automaticly.
2020-11-27 13:51:14 +01:00
2020-12-28 16:06:54 +01:00
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).
2020-11-26 18:47:34 +01:00
## YunoHost specific features
* Integrate with YunoHost users and SSO
* Allow one user to be the administrator (set at the installation)
* Allow multiple instances of this application
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/aeneria%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/aeneria/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/aeneria%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/aeneria/)
## Links
2021-01-06 19:25:07 +01:00
* æneria website: https://aeneria.com/
2020-11-26 18:47:34 +01:00
* æneria repo: https://gitlab.com/aeneria/aeneria-app
* YunoHost website: https://yunohost.org/
---
2021-03-17 21:23:02 +01:00
## Developer info
2020-11-26 18:47:34 +01:00
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.
```
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
```