waqi

世界大気品質指数APIのシンプルなPHPラッパー

World Air Quality Index Projectは、世界中の現在およびリアルタイムの大気質をマッピングするためのイニシアチブです。大気質のインデックスは、PM2.5、PM10、オゾン、NO2、SO2、および世界のさまざまな監視ステーションが提供するCO時間ごとの測定に基づいています。

このパッケージにより、お住まいの地域の大気質インデックスを簡単に取得でき、WAQIプロジェクトのリアルタイム大気品質データフィード（API）に基づいています。

注：このパッケージ（および基礎となるAQI API）を使用するには、アクセストークンが必要です。ここでトークンを入手できます：https：//aqicn.org/data-platform/token ..

システム要件

azuyalabs/waqiを使用するには、 php> = 8.2が必要です。

インストール

Composerを介してこのパッケージを引き込むことができます。

composer require azuyalabs/waqi

使用法

プロジェクトにComposer autoloadファイルを含めることから始めます。

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

AQIアクセストークンを使用して、WAQIオブジェクトのインスタンスを作成します。

 use Azuyalabs  WAQI  WAQI ;

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

次に、目的の都市または監視ステーション名（「ニューヨーク」など）を使用して、 getObservationByStationメソッドを使用します。これにより、最新の大気質観測が得られます。

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

空気の質

すべてがうまくいった場合は、さまざまなAPIメソッドを使用して、選択した都市または監視ステーションの検索された大気質インデックスの詳細を取得します。

AQI（大気質指数）を取得するには、メソッドgetAQIを使用してください。

 $ waqi -> getAQI ();

これにより、測定時にこの監視ステーションで測定された大気質指数を含むアレイ構造が返されます。 4つの要素が含まれています。

• 「AQI」：AQIレベル（監視ステーションの支配的な汚染タイプによって定義されています）
• 「Pollution_Level」：大気汚染レベルを説明する物語
• 「Health_implications」：測定された汚染レベルに関連する健康への影響を説明する物語
• 'Cautionary_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関数の一部が「ヌル」を返す可能性があることに注意してください。

特定の汚染物質レベルの情報を取得するために、次のAPI関数が利用可能です。

• getCO() ：測定時に監視ステーションで測定された一酸化炭素（CO）レベルを返します。
• getNO2() ：測定時に監視ステーションで測定された二酸化窒素（NO2）レベルを返します。
• getO3() ：測定時に監視ステーションで測定されたオゾン（O3）レベルを返します。
• getSO2() ：測定時に監視ステーションで測定された二酸化硫黄（SO2）レベルを返します。
• getPM10() ：測定時にこの監視ステーションで測定された粒子状物質10マイクロメートル以下（PM10）のレベルを返します。
• getPM25() ：測定時にこの監視ステーションで測定された粒子状物質2.5マイクロメートル以下（PM2.5）のレベルを返します。

監視ステーション

監視ステーションに関する情報は、2つの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ライセンスに基づいてライセンスされているオープンソースソフトウェアです。詳細については、ライセンスをご覧ください。