Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maexled/mystrom-django-interface
The Django application is designed to help users view power usage charts for MyStrom and Shelly3EM devices.
https://github.com/maexled/mystrom-django-interface
django django-rest-framework mystrom mystrom-switch python shelly-3em
Last synced: 8 days ago
JSON representation
The Django application is designed to help users view power usage charts for MyStrom and Shelly3EM devices.
- Host: GitHub
- URL: https://github.com/maexled/mystrom-django-interface
- Owner: maexled
- License: mit
- Created: 2022-06-10T17:51:18.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T09:39:18.000Z (4 months ago)
- Last Synced: 2024-07-21T15:33:12.024Z (4 months ago)
- Topics: django, django-rest-framework, mystrom, mystrom-switch, python, shelly-3em
- Language: Python
- Homepage:
- Size: 608 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## About the Project
The Django application is designed to allow users to view power usage charts for MyStrom and Shelly3EM devices. The application collects the current power usage data every 60 seconds, which is then used to calculate and present power usage charts to the user.
There are two main views: the Device view and the Result view. Here's what each view looks like:
#### Device View
In the Device view, users can add new devices that they want to track. Once added, the device will be listed in the Devices table.
#### Result View
In the Result view, users can view power usage charts for their devices. They can select the device they want to view data for, and then choose the date range they want to view data for.
## Prerequisites
* \>= python3.10 [Django Supported Python Versions](https://docs.djangoproject.com/en/5.0/releases/5.0/#python-compatibility)
## Installation
1. Clone the repo
```sh
git clone https://github.com/maexled/mystrom-django-interface.git
cd mystrom-django-interface/
```
2. Install needed python libraries
```sh
pip install -r requirements.txt
```
## Environment Variables
Here's a breakdown of all the environment variables that are being used in the Django application:
- `ENGINE_TYPE`: Specifies the type of database engine to use, either `mysql` or `postgresql`.
- `DB_NAME`: Specifies the name of the database to use.
- `DB_USER`: Specifies the username to use when connecting to the database.
- `DB_PASSWORD`: Specifies the password to use when connecting to the database.
- `DB_HOST`: Specifies the host to use when connecting to the database.
- `DB_PORT`: Specifies the port to use when connecting to the database.
- `SECRET_KEY`: Specifies the secret key to use for the Django application.
- `ALLOWED_HOSTS`: Specifies a comma-separated list of hosts that are allowed to access the application.
- `CORS_ORIGIN_ALLOW_ALL`: Specifies whether to allow all cross-origin requests.
- `CORS_ORIGIN_WHITELIST`: Specifies a comma-separated list of whitelisted origins for cross-origin requests.
- `CHART_TYPE`: Specifies the type of chart library to use, either `apexcharts` or `uplot`.
- `TZ`: Specifies the timezone to use for the Django application.
The environment variables can be set in the `.env` file when running the application with docker-compose.
### Chart Types
The `CHART_TYPE` environment variable specifies the type of chart library to use for the Django application. There are two options: `apexcharts` and `uplot`. Here are examples of what each chart type looks like:
#### ApexCharts
ApexCharts is a modern charting library that provides a wide range of chart types and features. However, it can have longer loading times when dealing with very large datasets.
#### uPlot
uPlot is a lightweight and fast charting library that excels at handling large datasets with many data points. It's an ideal choice for applications that need to render charts with a lot of data, but with a smaller feature set.
## Database migrations
```sh
python manage.py makemigrations
python manage.py migrate
```
## Run App
```sh
python manage.py collectstatic
python manage.py runserver
```
Static files are served with WhiteNoise.
## Run with docker
```sh
docker run \
--name mystrom-interface \
-p 8000:8000 \
-e ENGINE_TYPE={mysql/postgresql}
-e DB_NAME=db-name \
-e DB_USER=username \
-e DB_PASSWORD=password \
-e DB_HOST=host \
-e DB_PORT=port \
-e SECRET_KEY=secretKey \
-e ALLOWED_HOSTS=localhost,mysite.com \
-e CORS_ORIGIN_ALLOW_ALL=False \
-e CORS_ORIGIN_WHITELIST=http://localhost:8000,http://mysite.com \
-e CHART_TYPE={apexcharts/uplot}
-e TZ=Europe/Berlin \
ghcr.io/maexled/mystrom-django-interface
```
Make sure to replace the content in `{...}` with your variable of your choice.
## Run with docker-compose and needed containers
```sh
docker compose up
```
## Configurations
### Important things to know
Database configuraton in `pim/settings.py` under `DATABASES`