This repository contains the Device Manager Service, a core component of the Home Energy Management System (FlexiHome). The Device Manager Service is responsible for managing user accounts, authentication, and authorization within the FlexiHome ecosystem. It provides secure access to various functionalities and services offered by the FlexiHome platform.
EMSs (Energy Management Systems) play a key role in the flexibility enablement of consumers, residential and tertiary, which is paramount to accessing the previously untapped flexibility potential of residential DERs (Distributed Energy Resources). These resources, under the form of energy assets, are usually household appliances like heat pumps, EV chargers, dishwashers, PV inverts, batteries, etc. This is where the FlexiHome (Home Energy Management System) comes in.
The goal of this system is to facilitate the user’s participation in the flexibility value chain, while providing them with incentives in a clear, explainable way.
To fulfill this goal in an effective and scalable way, the FlexiHome is designed with a micro-services architecture (below), orchestrated in a Kubernetes environment, where each micro-service is modular and can be replaced or expanded, without breaking the remaining logic.
FlexiHome utilizes an IoT interoperable gateway (FlexiHome Hub) to connect to the end users DERs via interoperable protocols like OCPP and Modbus, which connects with the cloud system (FlexiHome Cloud) via an MQTT message broker.
The cloud operations are done via micro-services, where the flexibility optimization algorithms run. To complement these micro-services, support applications like postgres (database), elasticsearch (log database), prometheus (performance metrics) and grafana (metrics dashboard) are used.
Lastly, the user can view the information regarding their devices and flexibility on a user interface provided by the mobile app, which accesses the FlexiHome microservices using a REST API Gateway for additional security measures and routing of requests.
- FlexiHome Account Manager - Manages user accounts, authentication, and implements cybersecurity measures within the FlexiHome ecosystem
- FlexiHome Statistics Manager - Collects and processes data gathered from IoT devices connected to the FlexiHome ecosystem
- FlexiHome Device Manager - Responsible for the integration and management of IoT devices to the FlexiHome ecosystem
- FlexiHome Energy Manager - Receives grid needs inputs from system operators and user comfort inputs to optimized the flexibility bids taken to market
- FlexiHome Hub - IoT interoperable gateway that implements the communication, using MQTT protocol, between the DERs and the FlexiHome services on the cloud
- FlexiHome Mobile App - mobile application targetted for residential end consumers to manage their flexible DERs. Available in Android and iOS
. # Root directory of the repository
├── device_manager # Main source code for the Account Manager Service
│ ├── controllers/ # API controllers for account management
│ ├── models/ # Data models and schemas
│ ├── templates/ # HTML templates for emails and UI
│ ├── test/ # Unit and integration tests
│ └── ... # Other supporting modules
├── Dockerfile # Docker configuration for containerization
├── LICENSE # Rights and licensing information
├── requirements.txt # Python dependencies
├── README.md # Main documentation
├── setup.py # Python package setup
├── service-start.sh # Service startup script
├── Docker-compose/ # Docker Compose files and monitoring configs
├── docs/ # Documentation and architecture diagrams- 🚧 In Progress: Actively being developed; features and structure may change.
- Programming Language: Python 3.8
- Frameworks/Libraries: Flask, SQLAlchemy, Alembic
- Containerization: Docker, Docker Compose
- Orchestration: Kubernetes (recommended for deployment)
- Other Tools: Alembic (migrations), pytest (testing)
All required Python packages are listed in requirements.txt. For testing, see test-requirements.txt. Docker and Docker Compose are required for containerized deployments.
Follow these steps to install and set up the Device Manager Service:
- Clone the repository:
git clone https://github.com/INESCTEC/hems-device-manager.git
cd device-manager-service- Create and activate a virtual environment:
python3 -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate- Install dependencies:
pip install -r requirements.txt- Set up environment variables:
cp .env.example .env
nano .env # Edit with your configuration values- (Optional) Build and run with Docker:
docker-compose up --buildTo start the Device Manager Service:
source venv/bin/activate
python -m device_managerOr, if using Docker Compose:
cd Docker-compose
docker-compose -f docker-compose-prod.yml upAccess the API documentation and endpoints as defined in the OpenAPI spec (device_manager/openapi/openapi.yaml), which can be open using Swagger Editor
- No major issues reported. Please use GitHub Issues to report bugs or request features.
See LICENSE for details on usage rights and licensing.
For questions or support, contact:
- Vasco Manuel Campos: vasco.m.campos@inesctec.pt
- Daniel Barros: daniel.barros@inesctec.pt