diff --git a/doc/Configuration.md b/doc/Configuration.md new file mode 100644 index 0000000..c4f4738 --- /dev/null +++ b/doc/Configuration.md @@ -0,0 +1,86 @@ +# Configuration + +The configuration is loaded as YAML file into the backend server and is used +to configurate all parameters for the platform. + + +## Location + +The configuration file should be located in the root folder of the Flask app and +named "configuration.yaml". If this is not the case, The full path can be specified +via the environment variable "APP_CONFIG_PATH". The docker-compose.yml file in +this repository already defined the mounting of the config.yaml. + + +## Structure + +The configuration has the following structure: +``` +check_every: 60 +activation_threshold: 200 + +producers: +# list of producers + +consumers: +# list of consumers + +storages: +# list of storages +``` + +The different elements are described below. + + +### check_every + +Defines the interval (in seconds), of which the platform checks if some +controllable consumers should be activated. Default is 5 minutes (300 seconds). + + +### activation_threshold + +Defines the threshold (in Watt) to activate controllable consumers. The producers +must at least produce more then the threshold amount of energy more than the +consumers use. Default is 100 Watt. + + +### Producers + +List of the energy producers. Every producer can have the following attributes: + +* id: Id of the producer (integer) +* name: Name of the producer that is shown in the UI +* type: Type of the producer. The following types are available: + * 'constant': Return a constant value + * 'modbus': Return a value for a Modbus Device +* config: Configuration of the producer. For the possible configuration values for each + producer, see the documentation of the different producers. + + +### Consumers + +List of the consumer devices. Every consumer has the following attributes: + +* id: Id of the consumer (integer) +* name: Name of the consumer that is shown in the UI +* type: Type of the consumer. The following types are available: + * 'constant': Return a constant value + * 'modbus': Return a value from a Modbus Device + * 'fakeControllable': Same as the constant provider, but is also controllable (does nothing) + * 'vzugHome': Controlls a V-ZUG Device (that is equipped with V-ZUG Home) +* config: Configuration of the consumer. For the possible configuration values for each + consumer, see the documentation of the different consumers. + + +### Storages + +List of the energy storages. Every storage has the following attributes: + +* id: Id of the storage (integer) +* name: Name of the storage that is shown in the UI +* type: Type of the storage. The following types are available: + * 'constant': Return a constant value for the battery percentage + * 'vartaBattery': Return the battery percentage from a VARTA battery +* config: Configuration of the storage. For the possible configuration values for each + storage type, see the documentation of the different storage adapters. diff --git a/doc/Quickstart.md b/doc/Quickstart.md new file mode 100644 index 0000000..b0b0868 --- /dev/null +++ b/doc/Quickstart.md @@ -0,0 +1,25 @@ +# Quickstart Guide + +This quickstart guide will provide you with a little tutorial on how to install +the OpenEnergize software in your environment. + +## Prerequirements + +- The Docker engine is installed and running on your system (https://docs.docker.com/get-docker/) +- Docker-Compose is installed (https://docs.docker.com/compose/install/) + +## Steps + +1. Clone the repository +1. Copy the example config for your own configuration: + ``` + cp exampleconfig.yaml config.yaml + ``` +1. Modify the config.yaml to match your environment. See the [Configuration Doc](Configuration.md) + for more information +1. Startup with Docker-compose: + ``` + docker-compose up + ``` +1. Open your browser and open http://localhost:80 (replace the URL with the address + of the device if you do not installed it on your local device) diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..971ad32 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,7 @@ +# Documentation of OpenEnergize + +This documentation contains some information on how to setup the platform and +configure devices. + +- [Quickstart Guide](Quickstart.md) +- [Configuration Documentation](Configuration.md)