waqi Download - waqi Quellcode Download

waqi

Andere Kategorien

v1.2.1

Herunterladen

Eine einfache PHP -Wrapper für die World Air Quality Index API

Das World Air Quality Index-Projekt ist eine Initiative, um die aktuelle und Echtzeit-Luftqualität rund um den Globus abzubilden. Die Luftqualitätsindizes basieren auf PM2.5-, PM10-, Ozon-, NO2-, SO2- und CO -Stundenmessungen, die von verschiedenen Überwachungsstationen der Welt bereitgestellt werden.

Mit diesem Paketen können Sie den Luftqualitätsindex für Ihre Region einfach abrufen und basiert auf dem Echtzeit-Luftqualitätsdatenfutter (API) des WAQI-Projekts.

Hinweis: Um dieses Paket (und die zugrunde liegende AQI -API) zu verwenden, ist ein Zugriffstoken erforderlich. Sie können Ihr Token hier erwerben: https://aqicn.org/data-platform/token ..

Systemanforderungen

Sie benötigen Php> = 8.2, um azuyalabs/waqi zu verwenden.

Installation

Sie können dieses Paket über den Komponisten einziehen:

composer require azuyalabs/waqi

Verwendung

Beginnen Sie mit der Einbeziehung der Komponisten autoload in Ihr Projekt:

 <?php
require ' vendor/autoload.php ' ;

Erstellen Sie eine Instanz des WAQI -Objekts mit Ihrem AQI Access -Token:

 use Azuyalabs  WAQI  WAQI ;

$ waqi = new WAQI (<your access token>);

Verwenden Sie als Nächstes die getObservationByStation -Methode mit der gewünschten Stadt- oder Überwachungsstationsnamen (zB "New York"). Dadurch werden die neuesten Air -Qualitäts -Beobachtungen erhalten:

 $ waqi -> getObservationByStation ( ' new york ' );

Luftqualität

Wenn alles gut geht, verwenden Sie die verschiedenen API -Methoden, um Details zum abgerufenen Luftqualitätsindex der ausgewählten Stadt oder der Überwachungsstation zu erhalten.

Verwenden Sie die Methode getAQI , um den AQI (Luftqualitätsindex) zu erhalten:

 $ waqi -> getAQI ();

Dies gibt eine Array -Struktur zurück, die den Luftqualitätsindex enthält, der zum Zeitpunkt der Messung an dieser Überwachungsstation gemessen wird. Es enthält 4 Elemente:

"AQI": Die AQI -Ebene (die durch die Dominanzverschmutzungstyp der Überwachungsstationen definiert wird)
'Pollution_level': Eine Erzählung, die die Luftverschmutzungsstufe beschreibt
'Health_implications': Eine Erzählung, die die mit der gemessenen Verschmutzungsstufe verbundenen gesundheitlichen Auswirkungen beschreibt
'Acityary_Statement': Eine mit dem gemessenen Verschmutzungsniveau verbundene Vorsichtserklärung (nur für PM2.5)

Beispielausgabe (für 'New York'):

 - ' aqi ' : 15
 - ' pollution_level ' : Good
 - ' health_implications ' : Air quality is considered satisfactory, and air pollution poses little or no risk.
 - ' cautionary_statement ' : None

Zusätzlich zu den allgemeinen Luftqualitätsinformationen stehen auch spezifische Informationen zur Schadstoffebene zur Verfügung. Beachten Sie, dass nicht jede Überwachungsstation alle Schadstofftypen erfasst, sodass einige dieser API -Funktionen "null" zurückgeben können.

Die folgenden API -Funktionen stehen zur Verfügung, um spezifische Informationen zur Schadstoffebene zu erhalten:

getCO() : Gibt den an der Überwachungsstation zum Zeitpunkt der Messung gemessenen Kohlenmonoxid (CO) zurück.
getNO2() : Gibt den Stickstoffdioxid (NO2) zurück, der zum Zeitpunkt der Messung an der Überwachungsstation gemessen wird.
getO3() : Gibt den Ozon (O3) zurück, der zum Zeitpunkt der Messung an der Überwachungsstation gemessen wird.
getSO2() : Gibt den Schwefeldioxid (SO2) zurück, der zum Zeitpunkt der Messung an der Überwachungsstation gemessen wird.
getPM10() : Gibt den Grad der Partikelmaterial 10 Mikrometer oder niedriger (PM10) zurück, gemessen zum Zeitpunkt der Messung an dieser Überwachungsstation.
getPM25() : Gibt den Grad der Partikel 2,5 -Mikrometer oder niedriger (PM2.5) zurück, gemessen an dieser Überwachungsstation zum Zeitpunkt der Messung.

Überwachungsstation

Informationen zur Überwachungsstation können mit zwei API -Methoden erhalten werden.

Erstens wird die Verwendung der API -Methode getMonitoringStation() Informationen über die angegebene Überwachungsstation zurückgeben:

'ID': Die eindeutige ID für diese Überwachungsstation
'Name': Der Name (oder Beschreibung) dieser Überwachungsstation
"Koordinaten": Die geografischen Koordinaten dieser Überwachungsstation (Array von "Längengrad" und "Breitengrad")
'URL': Die URL dieser Überwachungsstation

Zweitens wird die API -Methode getAttributions() eine Liste von EPA -Zuschreibungen für diese Überwachungsstation zurückgeben.

Andere

Weitere API -Methoden, die zusätzliche Informationen liefern, sind:

getMeasurementTime() : Gibt das Datum/die Uhrzeit zurück, in der die letzte Messung ergriffen wurde. (als DateTime -Objekt).
getHumidity() : Gibt die Luftfeuchtigkeit (in %) zurück, die an dieser Überwachungsstation zum Zeitpunkt der Messung gemessen wird.
getTemperature() : Gibt die Temperatur (in Grad Celsius) zurück, die an dieser Überwachungsstation zum Zeitpunkt der Messung gemessen wird.
getPressure() : Gibt den an dieser Überwachungsstation gemessenen Barometriedruck (in Millibar) zum Zeitpunkt der Messung zurück.
getPrimaryPollutant() : Gibt den Namen des Hauptschadstoffs an dieser Überwachungsstation zum Zeitpunkt der Messung zurück (z. B. PM25 ').

Changelog

Weitere Informationen finden Sie unter ChangeLog, was sich geändert hat.

Testen

Dieses Paket wird mit einer Phpunit -Testsuite geliefert. Führen Sie den folgenden Befehl aus dem Projektverzeichnis aus, um die Tests auszuführen:

composer test

oder alternativ laufen mit:

vendor/bin/phpunit

Beitragen

Beiträge werden gefördert und willkommen; Ich freue mich immer, Feedback zu erhalten oder Anfragen zu Github zu ziehen :) Erstellen Sie Github -Probleme für Fehler und neue Funktionen und kommentieren Sie die, an denen Sie interessiert sind.

Wenn Sie genießen, was ich mache, wird eine zusätzliche Tasse Kaffee sehr geschätzt :). Ihre Unterstützung hilft mir, mehr Zeit in Open-Source-Softwareprojekte wie diese zu setzen.