Skip to content

Latest commit

 

History

History
111 lines (78 loc) · 4 KB

README.md

File metadata and controls

111 lines (78 loc) · 4 KB
Raw

LOG-680 : Template for Oxygen-CS

image

This Python application continuously monitors a sensor hub and manages HVAC (Heating, Ventilation, and Air Conditioning) system actions based on received sensor data.

It leverages signalrcore to maintain a real-time connection to the sensor hub and utilizes requests to send GET requests to a remote HVAC control endpoint.

This application uses pipenv, a tool that aims to bring the best of all packaging worlds to the Python world.

Requierements

  • Python 3.8+
  • pipenv

Getting Started

  1. Clone the repository :
git clone https://github.com/your-username/sensor-hub-monitor.git
cd sensor-hub-monitor
  1. Install the project's dependencies :
pipenv install
  1. Ajouter les git hook:
pip install pytest pylint pre-commit pytest-env
pre-commit install

Setup

You need to setup the following variables inside the Main class:

  • HOST: The host of the sensor hub and HVAC system.
  • TOKEN: The token for authenticating requests.
  • TICKETS: The number of tickets.
  • T_MAX: The maximum allowed temperature.
  • T_MIN: The minimum allowed temperature.
  • DATABASE: The database connection details.

Running the Program

After setup, you can start the program with the following command:

pipenv run start

Déploiement sur Kubernetes

Des fichiers pour créer le pod et le service de la base de données et ainsi que le déploiement de l'application oxygen-cs vous sont fournis pour faciliter le déploiement sur Kubernetes. Vous pouvez l'explorer à votre gré pour avoir une meilleure compréhension de ce qu'il accomplit. Il est important de noter qu'il y a des variables d'environnement de Kubernetes qui doivent être créé. Nous avons fourni des gabarits pour les différents "secret" et "config map". Toutefois, pour des raisons de sécurité, nous avons enlevé nos valeurs associées à ses variables. Vous devez donc inscrire vos propres valeurs.

Logging

The application logs important events such as connection open/close and error events to help in troubleshooting.

To Implement

There are placeholders in the code for sending events to a database and handling request exceptions. These sections should be completed as per the requirements of your specific application.

Wiki

répertoire contenant la documentation dans différents fichiers en format Markdown. Ces fichiers contiennent toutes lesdiverses informations pertinentes au projet.

Création d’un projet et du tableau Kanban dans GitHub

Explication des choix des colonnes Kanban et des automatisations

Création des étiquettes

Explication des choix des étiquettes

Ajout des modèles

Explication du choix du modèle de nouvelle fonctionnalité Explication du choix du modèle de correction de bogue Explication du choix du modèle de nouvelle documentation Explication des choix des modèles Pull Request

Création des milestones

Explication des choix des milestones

Politiques de branches

Explication des choix de la politique de branche

Création de l’application

Explication des choix des technologies utilisées pour l’API

Base de données

Explication du choix de la DB et le lien avec l’API

Tests et démonstration

Explication des choix de notre suite de test

Conteneurisation de l'applications

Explication des choix technologiques pour la conteneurisation de l'application

Intégration Continue

Explication des choix technologiques pour l'intégration continue

Création des tags de Docker

Explication des choix pour les tags de Docker

License

MIT

Contact

For more information, please feel free to contact the repository owner.