https://github.com/kostrse/waqi-matlab

WAQI (World Air Quality Index) client for MATLAB
https://github.com/kostrse/waqi-matlab

aqicn waqi

Last synced: about 2 months ago
JSON representation

WAQI (World Air Quality Index) client for MATLAB

• Host: GitHub
• URL: https://github.com/kostrse/waqi-matlab
• Owner: kostrse
• License: mit
• Created: 2022-11-05T09:02:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-07T02:00:04.000Z (about 2 years ago)
• Last Synced: 2024-01-26T03:37:05.889Z (12 months ago)
• Topics: aqicn, waqi
• Language: MATLAB
• Homepage:
• Size: 1.03 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![View WAQI (World Air Quality Index) client for MATLAB on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/120043-waqi-world-air-quality-index-client-for-matlab)

# WAQI client for MATLAB

WAQI (World Air Quality Index) provides open API for reading air quality data from the stations registered on the project.

## Get your API token

Request the WAQI API access token at https://aqicn.org/api/.

## Usage

### Air quality data for the given location

```MATLAB

token = "";

aqi = waqi.WAQI(token);

% Get data for the given known city

bangkok = aqi.city("bangkok");

% Get data from the nearest station for given coordinates

seattle = aqi.nearest([47.62050, -122.34930]);

```

Plot received forecast data:

```MATLAB

forecast = seattle.Forecast.pm25;

figure

plot(forecast.Time, forecast.Avg, Color="black", LineWidth=1.5, Color=[0, 0.3, 0.5])

title("Air Quality Forecast")

hold on

plot(forecast.Time, forecast.Max, Color=[0.6, 0.6, 0.6])

plot(forecast.Time, forecast.Min, Color=[0.3, 0.3, 0.3])

legend(["Avg", "Max", "Min"], Location="northwest")

hold off

```



### List of stations for the given geographical area

```MATLAB

% Geographic boundary

chiang_mai_area = [

    geopoint(19.05580, 98.53775)

    geopoint(18.41727, 99.32121)

];

% Get list of stations

result = aqi.stations(chiang_mai_area)

```

Result includes locations of returned stations, station information and current readings of AQI:



Display stations on the map:

```MATLAB

station_names = [result.Station.Name];

station_descriptions = arrayfun(@(a, t) sprintf("AQI: %.0f
Measured: %s", a, string(t, "M/dd/yyyy hh:mm:ss XXX")), result.AQI, result.Timestamp);

colors = cell2mat(arrayfun(@colorcode, result.AQI, UniformOutput=false));

wmmarker(result.Location, FeatureName=station_names, Description=station_descriptions, Color=colors);

% A helper function to color code values of AQI

function color = colorcode(aqi)

    if aqi <= 50

        % Good

        color = [0, 153/255, 102/255];

    elseif aqi <= 100

        % Moderate

        color = [1, 222/255, 51/255];

    elseif aqi <= 150

        % Unhealthy for Sensitive Groups

        color = [1, 153/255, 51/255];

    elseif aqi <= 200

        % Unhealthy

        color = [204/255, 0, 51/255];

    elseif aqi <= 300

        % Very Unhealthy

        color = [102/255, 0, 153/255];

    else

        % Hazardous

        color = [126/255, 0, 35/255];

    end

end

```



### Air quality data for a specific station

```MATLAB

% Find station with the worst AQI

[~, i] = max(result.AQI);

worst_station = result.Station([i(1)]);

% Get air quality data for given station

measurements = aqi.station(worst_station)

```