Référence de la classe app.api_client.ApiClient

Client pour interroger les APIs oblosolutions.ch. Plus de détails...

Graphe de collaboration de app.api_client.ApiClient:

Fonctions membres publiques
	__init__ (self, str mac_address)
	Initialise le client API.
Dict[str, Any]	get_parameters (self)
	Récupère les paramètres depuis l'API td25_param.
Dict[str, Any]	get_forecast (self)
	Récupère la température prévue depuis l'API td25_forecast.
bool	post_measured_temperature (self, float temperature, int channel=None)
	Envoie la température mesurée vers l'API td25_param.

Attributs publics
	mac_address = mac_address
str	base_url = "https://dev.oblosolutions.ch"

Attributs publics statiques
str	API_PATH_PREFIX = ""

Description détaillée

Client pour interroger les APIs oblosolutions.ch.

Fournit des méthodes pour récupérer les paramètres de simulation, les prévisions météo et envoyer les mesures de température. Gère automatiquement les retries et les timeouts.

Documentation des constructeurs et destructeur

__init__()

app.api_client.ApiClient.__init__	(		self,
		str	mac_address )

Initialise le client API.

Configure l'adresse MAC du dispositif et l'URL de base pour les communications avec les services oblosolutions.ch.

Paramètres

mac_address

Adresse MAC du dispositif (ex: "0030DEABCDEF").

Documentation des fonctions membres

get_forecast()

Dict[str, Any] app.api_client.ApiClient.get_forecast

(

self

)

Récupère la température prévue depuis l'API td25_forecast.

Effectue une requête GET vers l'endpoint td25_forecast avec l'adresse MAC comme paramètre. Parse la réponse JSON et extrait la température de prévision météorologique. Inclut un système de retry automatique en cas d'échec.

Renvoie

Dictionnaire contenant la temperature prévue.

Exceptions

ApiError

En cas d'erreur de récupération des données.

get_parameters()

Dict[str, Any] app.api_client.ApiClient.get_parameters

(

self

)

Récupère les paramètres depuis l'API td25_param.

Effectue une requête GET vers l'endpoint td25_param avec l'adresse MAC comme paramètre. Parse la réponse JSON et extrait les champs probe_type, n, k_m et temperature. Inclut un système de retry automatique en cas d'échec.

Renvoie

Dictionnaire contenant probe_type, n, k_m, temperature.

Exceptions

ApiError

En cas d'erreur de récupération des données.

post_measured_temperature()

bool app.api_client.ApiClient.post_measured_temperature	(		self,
		float	temperature,
		int	channel = None )

Envoie la température mesurée vers l'API td25_param.

Effectue une requête POST vers l'endpoint td25_param avec la température mesurée et optionnellement le numéro de canal. Tous les paramètres sont envoyés dans l'URL comme paramètres de requête. Inclut un système de retry automatique.

Paramètres

temperature	Température mesurée en °C.
channel	Canal de mesure (optionnel).

Renvoie

True si succès, False sinon.

Documentation des données membres

API_PATH_PREFIX

str app.api_client.ApiClient.API_PATH_PREFIX = ""

static

base_url

str app.api_client.ApiClient.base_url = "https://dev.oblosolutions.ch"

mac_address

app.api_client.ApiClient.mac_address = mac_address

---

La documentation de cette classe a été générée à partir du fichier suivant :

• C:/Users/thebi/Documents/2510_RegulationChauffage/doc/9.SoftWare/Doxygen/src/app/api_client.py