waqi

世界空氣質量指數API的簡單PHP包裝器

世界空氣質量指數項目是一項旨在繪製全球當前和實時空氣質量的計劃。空氣質量指數基於PM2.5，PM10，臭氧，NO2，SO2和CO小時測量，由世界各個監測站提供。

該軟件包使您可以輕鬆地檢索您所在地區的空氣質量指數，並基於WAQI項目的實時空氣質量數據提要（API）。

注意：要使用此軟件包（以及基礎AQI API），需要訪問令牌。您可以在此處獲取令牌：https：//aqicn.org/data-platform/token ..

系統要求

您需要php> = 8.2才能使用azuyalabs/waqi 。

安裝

您可以通過Composer吸引此軟件包：

composer require azuyalabs/waqi

用法

首先在您的項目中包括作曲家autoload文件：

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

使用您的AQI訪問令牌，創建WAQI對象的實例：

 use Azuyalabs  WAQI  WAQI ;

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

接下來，使用帶有所需城市或監視站名稱（例如紐約）的getObservationByStation方法。這將獲得最新的空氣質量觀察：

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

空氣質量

如果一切順利，請使用各種AP​​I方法獲取有關所選城市或監視站檢索到的空氣質量指數的詳細信息。

要獲取AQI（空氣質量指數），請使用方法getAQI ：

 $ waqi -> getAQI ();

這返回了一個陣列結構，該陣列結構包含在測量時在此監測站測量的空氣質量指數。它包含4個元素：

• “ AQI”：AQI級別（由監視站的主要污染類型定義）
• “污染_level”：描述空氣污染水平的敘述
• “ Health_implications”：描述與測量污染水平相關的健康影響的敘述
• “ withutionary_statement”：與測量污染水平相關的警示聲明（僅適用於PM2.5）

示例輸出（“紐約”）：

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

除了一般的空氣質量信息外，還提供特定的污染物水平。請注意，並非每個監視站都捕獲所有污染物類型，因此其中一些API功能可能會返回“ null”。

以下API功能可用於獲取特定的污染物級別信息：

• getCO() ：返回測量時在監測站測量的一氧化碳（CO）水平。
• getNO2() ：返回測量時在監測站測量的二氧化氮（NO2）水平。
• getO3() ：返回測量時在監測站測量的臭氧（O3）水平。
• getSO2() ：返回測量時在監測站測量的二氧化硫（SO2）水平。
• getPM10() ：返回顆粒物的水平10微米或更低（PM10），在測量時在此監測站進行測量。
• getPM25() ：返回顆粒物物質的水平2.5微米或更低（PM2.5），在測量時在此監測站進行測量。

監視站

可以通過兩種API方法獲得有關監視站的信息。

首先，使用API​​方法getMonitoringStation() ，將返回有關給定監視站的信息：

• “ ID”：此監視站的唯一ID
• “名稱”：此監視站的名稱（或描述）
• “坐標”：該監控站的地理坐標（“經度”和“緯度”的數組）
• 'url'：此監視站的URL

其次，API方法getAttributions()將返回此監視站的EPA歸因列表。

其他

提供其他信息的其他API方法是：

• getMeasurementTime() ：返回進行最後測量的日期/時間。 （作為DateTime對象）。
• getHumidity() ：返回測量時在此監測站測量的濕度（以％）。
• getTemperature() ：在測量時在此監測站測量的溫度（以攝氏度為單位）。
• getPressure() ：返回測量時在此監測站測量的氣壓（以毫巴為單位）。
• getPrimaryPollutant() ：在測量時（例如'pm25'）返回此監視站的主要污染物的名稱。

ChangElog

有關更多信息，請參閱ChangElog。

測試

此軟件包帶有Phpunit測試套件。要運行測試，請從項目目錄運行以下命令：

composer test

，或者以：

vendor/bin/phpunit

貢獻

鼓勵和歡迎捐款；我總是很樂意在github上獲得反饋或提取請求:)為錯誤和新功能創建GitHub問題，並對您感興趣的問題進行評論。

如果您喜歡我正在製作的東西，非常感謝額外的咖啡:)。您的支持可以幫助我將更多時間投入到這樣的開源軟件項目中。

學分

• Sacha telgenhof
• 所有貢獻者

執照

該軟件包是根據MIT許可證許可的開源軟件。請參閱許可證以獲取更多信息。