Skip to main content

Exemple : utilisation du OpenWeather Client SL Bibliothèque

Produit: Bibliothèques CODESYS IIOT SL

Le OpenWeather Client SL Example.project un exemple de projet montre comment utiliser OpenWeather Client SL bibliothèque pour interroger les données météorologiques via l'API OpenWeather.

Préparation

Pour interroger des données provenant de l'extérieur OpenWeather API, vous devez saisir une clé API valide. Le service « One Call API 3.0 » doit être activé pour cette clé. Si vous avez déjà généré une clé, vous n'avez pas besoin d'effectuer d'autres étapes préparatoires.

Si vous n'avez pas encore de clé et souhaitez en créer une nouvelle ou si vous ne savez pas si le service requis a été activé pour votre clé, procédez comme suit :

  1. Créez un compte.

    Créez un compte sur Site web OpenWeather ou connectez-vous si vous êtes déjà inscrit.

  2. Générez une clé.

    Lorsque vous êtes connecté, accédez au API keys menu. Vous pouvez y afficher toutes les clés d'API actives et créer de nouvelles clés à l'aide du Generate bouton.

  3. Activez le service « One Call API 3.0 ».

    Ce service est nécessaire au bon fonctionnement de la bibliothèque. Naviguez jusqu'au Billing Plans élément de menu et recherchez le service « One Call API 3.0 ».

    Si vous n'êtes pas encore abonné à ce service, vous pouvez le faire en cliquant sur Subscribe bouton. À présent, le Status le champ doit être Activated.

    Après cette étape, vous devriez être en mesure de voir ce qui suit :

    _example_img_iiot_openwheather.png
  4. Facultatif : définissez une limite d'appels.

    Si vous souhaitez uniquement utiliser le quota quotidien gratuit, vous pouvez définir une limite pour vous assurer qu'il ne peut pas être passé plus de 1 000 appels.

    Pour ce faire, accédez au Billing Plans élément de menu afin que vous puissiez voir la vue ci-dessus. Dans le Calls per day colonne, vous pouvez définir le nombre maximum d'appels que vous souhaitez autoriser par jour.

    Terminé

    Préparez votre clé API pour exécuter les exemples d'applications.

Descriptif

Remarque générale concernant les informations de localisation dans les exemples

  • Dans les exemples, les données de localisation (GeoLocation) est défini statiquement dans la zone de déclaration du programme principal correspondant de l'application (ici : CFC_PRG).

  • Vous pouvez modifier les valeurs de cet objet pour interroger des données météorologiques provenant d'autres emplacements.

    Avis

    Seule la coordonnée GPS au format « Degré décimal » (DD), qui est définie par une longitude et une latitude, influence réellement l'emplacement pour lequel les données sont demandées. Les autres informations, telles que le nom de la ville, n'ont aucun effet.

  • Vous pouvez obtenir les coordonnées d'un lieu via un service de carte et saisir les informations restantes manuellement si nécessaire. Vous pouvez également utiliser le GeoLocator blocs fonctionnels (voir GeoLocatorExamplesapplication) pour remplir correctement le GeoLocation structure.

Candidature : CurrentWeatherExample

Dans cette application, les données météorologiques actuelles pour un lieu spécifié sont demandées à l'API OpenWeather. Dans le sApiKey champ, entrez votre clé API et définissez le xLoadWeatherData drapeau pour TRUE afin de récupérer des données. Les données sont chargées dans currentWeatherData structure. Vous pouvez consulter le contenu de la structure dans la zone de surveillance.

Candidature : WeatherForecastExample

Dans cette application, une prévision météorologique horaire pour les prochaines 48 heures pour un lieu spécifié est demandée au OpenWeather API. Dans le sApiKey champ, entrez votre clé API et définissez le xLoadWeatherData drapeau pour TRUE afin de récupérer des données. Les données sont chargées dans weatherForecast structure. Vous pouvez consulter le contenu de la structure dans la zone de surveillance.

Candidature : CurrentWeatherAndForecastExample

Dans cette application, la météo actuelle et les prévisions météorologiques horaires pour les prochaines 48 heures pour un lieu spécifié sont demandées au OpenWeather API. Dans le sApiKey champ, entrez votre clé API et définissez le xLoadWeatherData drapeau pour TRUE afin de récupérer des données. Les données sont chargées dans currentWeatherData et weatherForecast structures. Vous pouvez consulter le contenu des structures dans la zone de surveillance.

Important

Le CurrentWeatherAndForecastExample le bloc de fonction pourrait donner l'impression qu'il exécute simplement le CurrentWeather et ForecastWeather blocs de fonctions les uns après les autres. Ce n'est pas le cas. CurrentWeatherAndForecastExample bloc de fonctions peut interroger les données météorologiques actuelles et les données météorologiques prévues en un seul appel d'API. Il doit donc toujours être utilisé lorsque les deux types de données sont requis.

Candidature : GeoLocatorExamples

Dans cette application, une description du lieu, mais surtout les coordonnées d'un lieu, est demandée au OpenWeather Geocoding API.

Dans le sApiKey champ, entrez votre clé API et définissez le xLoad[...] drapeaux pour TRUE afin de récupérer des données. Les données sont chargées dans location structure. Vous pouvez consulter le contenu de la structure dans la zone de surveillance.

Candidature : VisuExample

L'application affiche la requête de la météo actuelle et les prévisions météorologiques pour les prochaines 48 heures en liaison avec une interface de visualisation.

Une visualisation est un bon moyen d'obtenir un aperçu rapide des informations disponibles.

Interface utilisateur

Lorsque vous démarrez l'application, la fenêtre de visualisation suivante s'ouvre :

_example_img_iiot_openwheather_visu.png
. L'interface se compose de quatre parties principales :
  1. Barre de contrôle

    Vous pouvez utiliser la barre de contrôle sur le côté gauche pour contrôler l'application.

    Cliquez sur _example_icon_iiot_openwheather_update_data.png bouton pour récupérer et afficher des données réelles depuis le serveur API. Notez que vous devez définir une clé API pour cela. Si le fait de cliquer sur ce bouton n'a aucun effet, vérifiez la clé API que vous avez saisie.

    Cliquez sur _example_icon_iiot_openwheather_load_dummy.png bouton pour charger des données factices qui ne nécessitent pas d'appel d'API. Ces données sont ensuite chargées à partir d'un fichier JSON qui contient une réponse API précédente.

    Cliquez sur _example_icon_iiot_openwheather_api_key.png bouton pour afficher et masquer la fenêtre dans laquelle vous entrez votre clé API.

  2. Superposition de clés d'API

    En cliquant sur _example_icon_iiot_openwheather_api_key.png le bouton ouvrira la fenêtre pour saisir la clé API. Cliquez dans le champ de texte pour saisir ou modifier votre clé.

  3. Affichage de la météo actuelle

    Le panneau en haut au centre affiche les données météorologiques actuelles. Toutes les informations disponibles sont affichées. Vous pouvez utiliser une info-bulle (passez la souris dessus avec le pointeur de la souris) pour afficher la description des valeurs qui n'ont pas d'étiquette sur l'interface

  4. Affichage des prévisions météorologiques

    Le panneau en bas au centre affiche les prévisions météorologiques. Les informations affichées ici ont été réduites afin d'obtenir un affichage clair. Théoriquement, presque toutes les informations sont disponibles pour chaque entrée, qui sont également disponibles pour la météo actuelle (sauf les heures de lever et de coucher du soleil).

    Comme les prévisions pour les 48 prochaines heures contiennent un point de données toutes les heures, il y a 48 panneaux à parcourir.

    Utilisez le _example_icon_iiot_openwheather_arrow_left.png et _example_icon_iiot_openwheather_arrow_right.png boutons pour déplacer la vue des 48 entrées d'une entrée vers la gauche ou la droite. Utilisez le _example_icon_iiot_openwheather_arrow2_left.png et _example_icon_iiot_openwheather_arrow2_right.png boutons pour passer rapidement au début ou à la fin.

Exigences et restrictions du système

Système de programmation

CODESYS Development System (version 3.5.18.0 ou supérieure)

Système d'exécution

CODESYS Control Win (version 3.5.18.0)

Composants complémentaires

-

Avis

_example_icon.png TÉLÉCHARGER projets