[6] ESP32 - Airly - Pobranie danych

W tym poście chciałbym opisać sposób pobrania danych z serwisu Airly.

[Źródło: http://paulobrien.co.nz/2017/03/16/esp32-programming-with-arduino-on-windows/]

Przygotowanie:

Na samym początku należy założyć konto oraz wygenerować klucz API na stronie Airly w części dla programistów (https://developer.airly.eu/).

Po zalogowaniu należy odczytać API key:

Następnym krokiem jest określenie szerokości i długości geograficznej. Te dane należy w celu wysłania żądania odczytania danych z serwisu. Tutaj można się posłużyć stroną www.wspolrzedne-gps.pl

Gdy już posiadamy lokalizację oraz klucz to należy przygotować ciąg znaków z jakiego pobierane będą dane za pomocą żądania http.

1. https://airapi.airly.eu/v2/installations/nearest?lat=50.0918091&lng=19.8998826&maxDistanceKM=5&maxResults=4&apikey=API_KEY

Powyższy string pozwoli na odczytanie ID oraz danych najbliższych czujników w okolicy podanej lokalizacji.

Jako parametry należy wprowadzić:

Następnie w celu uzyskania danych z konkretnego czujnika należy posiadać jego ID. Po identyfikacji czujnika należy odczytać dane w następujący sposób:

1. https://airapi.airly.eu/v2/measurements/installation?installationId=2903&apikey=API_KEY

W odpowiedzi otrzymujemy dane aktualne, historyczne oraz prognozy na najbliższy czas. Całość prezentuje się następująco:

1. {
2.     "current":{
3.         "fromDateTime":"2020-01-13T07:03:06.902Z",
4.         "tillDateTime":"2020-01-13T08:03:06.902Z",
5.         "values":[
6.             {"name":"PM1","value":18.87},
7.             {"name":"PM25","value":28.93},
8.             {"name":"PM10","value":57.27},
9.             {"name":"PRESSURE","value":1024.01},
10.             {"name":"HUMIDITY","value":85.63},
11.             {"name":"TEMPERATURE","value":0.58}
12.         ],
13.         "indexes":[
14.             {
15.                 "name":"AIRLY_CAQI",
16.                 "value":54.54,
17.                 "level":"MEDIUM",
18.                 "description":"Bywało lepiej...",
19.                 "advice":"Lepiej ogranicz dzisiaj swoją aktywność fizyczną na powietrzu.",
20.                 "color":"#EFBB0F"
21.             }
22.         ],
23.         "standards":[
24.             {
25.                 "name":"WHO",
26.                 "pollutant":"PM25",
27.                 "limit":25.0,
28.                 "percent":115.71
29.             },
30.             {
31.                 "name":"WHO",
32.                 "pollutant":"PM10",
33.                 "limit":50.0,
34.                 "percent":114.53}
35.         ]
36.     },
37.     "history":[ ..... ],
38.     "forecast":[ ..... ]
39. }

W celu pobrania danych w postaci załączonej powyżej można skorzystać z następującego programu:

1. #include <WiFi.h>
2. #include <HTTPClient.h>
4. const char* ssid = "WIFI_SSID";
5. const char* password =  "WIFI_PASSWORD";
7. const String ENDPOINT_STRING = "https://airapi.airly.eu/v2/measurements/installation?installationId=2903";
8. const String API_KEY = "&apikey=API_KEY";
9. const String SENSOR_ID = "installationId=2903";
11. void setup() {
12.   Serial.begin(115200);
13.   WiFi.begin(ssid, password);
15.   while (WiFi.status() != WL_CONNECTED) {
16.     delay(1000);
17.     Serial.print("Connection with WIFI Network....");
18.   }
20.   Serial.println("Connected!");
21. }
23. void loop() {
24.   if ((WiFi.status() == WL_CONNECTED))
25.   {
26.     HTTPClient http;
28.     http.begin(ENDPOINT_STRING + SENSOR_ID + API_KEY); //Specify the URL
29.     int httpResponseCode = http.GET();  //Make the request
31.     if (httpResponseCode > 0)
32.     {
33.         String readedData = http.getString();
34.         Serial.println(httpResponseCode);
35.         Serial.println(readedData);
36.     }
37.     else
38.     {
39.       Serial.println("Http Request Error");
40.     }
41.     http.end();
42.   }
43.   delay(100000);
44. }

W powyższym kodzie po połączeniu się z Wifi następuje pobranie i wyświetlenie nie obrobionych danych:

Poniższy drugi program wyciągnie wszystkie aktualne dane z czytnika:

1. #include <ArduinoJson.h>
2. #include <WiFi.h>
3. #include <HTTPClient.h>
5. #define JSON_BUFF_DIMENSION 30000
7. const char* ssid = "WIFI_SSID";
8. const char* password =  "WIFI_PASSWORD";
10. const String ENDPOINT_STRING = "https://airapi.airly.eu/v2/measurements/installation?";
11. const String API_KEY = "&apikey=API_KEY";
12. const String SENSOR_ID = "installationId=2903";
14. String jsonStringText;
16. void setup() {
17.   Serial.begin(115200);
18.   WiFi.begin(ssid, password);
20.   while (WiFi.status() != WL_CONNECTED) {
21.     delay(1000);
22.     Serial.print("Connection with WIFI Network....");
23.   }
24.   Serial.println("Connected!");
25.   jsonStringText.reserve(JSON_BUFF_DIMENSION);
26. }
28. void loop() {
29.   if ((WiFi.status() == WL_CONNECTED))
30.   {
31.     HTTPClient http;
33.     http.begin(ENDPOINT_STRING + SENSOR_ID + API_KEY); //Specify the URL
34.     int httpResponseCode = http.GET();  //Make the request
35.     if (httpResponseCode > 0)
36.     {
37.         jsonStringText = http.getString();
38.         Serial.println(httpResponseCode);
39.         parseJsonData(jsonStringText.c_str());
40.     }
41.     else
42.     {
43.       Serial.println("Http Request Error");
44.     }
45.     http.end();
46.   }
47.   delay(100000);
48. }
50. void parseJsonData(const char * jsonString)
51. {
52.   DynamicJsonDocument jsonBuffer(100000);
53.   auto error = deserializeJson(jsonBuffer, jsonString);
54.   if (error) {
55.     Serial.println("Deserialize error");
56.     Serial.println(error.c_str());
57.     return;
58.   }
59.   else
60.   {
61.     Serial.println("Deserialize OK!");
62.   }
64.   size_t len = measureJson(jsonBuffer);
65.   Serial.println(len);
66.   JsonArray list = jsonBuffer["current"];
68.   String fromDateTime = jsonBuffer["current"]["fromDateTime"];
69.   String tillDateTime = jsonBuffer["current"]["tillDateTime"];
70.   //----------------------------------------------------------------
71.   String namePM1 = jsonBuffer["current"]["values"][0]["name"];
72.   String valuePM1 = jsonBuffer["current"]["values"][0]["value"];
73.   String namePM25 = jsonBuffer["current"]["values"][1]["name"];
74.   String valuePM25 = jsonBuffer["current"]["values"][1]["value"];
75.   String namePM10 = jsonBuffer["current"]["values"][2]["name"];
76.   String valuePM10 = jsonBuffer["current"]["values"][2]["value"];
77.   String namePressure = jsonBuffer["current"]["values"][3]["name"];
78.   String valuePressure = jsonBuffer["current"]["values"][3]["value"];
79.   String nameHumidity = jsonBuffer["current"]["values"][4]["name"];
80.   String valueHumidity = jsonBuffer["current"]["values"][4]["value"];
81.   String nameTemperature= jsonBuffer["current"]["values"][5]["name"];
82.   String valueTemperature = jsonBuffer["current"]["values"][5]["value"];
83.   //----------------------------------------------------------------
84.   String indexesName = jsonBuffer["current"]["indexes"][0]["name"];
85.   String indexesValue = jsonBuffer["current"]["indexes"][0]["value"];
86.   String indexesLevel = jsonBuffer["current"]["indexes"][0]["level"];
87.   String indexesDescription = jsonBuffer["current"]["indexes"][0]["description"];
88.   String indexesAdvice = jsonBuffer["current"]["indexes"][0]["advice"];
89.   String indexesColor = jsonBuffer["current"]["indexes"][0]["color"];
90.   //----------------------------------------------------------------
91.   String standardsPM25Name = jsonBuffer["current"]["standards"][0]["name"];
92.   String standardsPM25Pollutant = jsonBuffer["current"]["standards"][0]["pollutant"];
93.   String standardsPM25Limit = jsonBuffer["current"]["standards"][0]["limit"];
94.   String standardsPM25Percent = jsonBuffer["current"]["standards"][0]["percent"];
95.   //----------------------------------------------------------------
96.   String standardsPM10Name = jsonBuffer["current"]["standards"][1]["name"];
97.   String standardsPM10Pollutant = jsonBuffer["current"]["standards"][1]["pollutant"];
98.   String standardsPM10Limit = jsonBuffer["current"]["standards"][1]["limit"];
99.   String standardsPM10Percent = jsonBuffer["current"]["standards"][1]["percent"];
101.   Serial.println("----------------------------");
102.   /*Current fromDateTime display */
103.   Serial.println("fromDateTime: " + fromDateTime);    
104.   /*Current tillDateTime display */  
105.   Serial.println("tillDateTime: " + tillDateTime);
106.   /*Current values display */
107.   Serial.println("*****************");
108.   Serial.println(namePM1 + " - " + valuePM1);
109.   Serial.println(namePM25 + " - " + valuePM25);
110.   Serial.println(namePM10 + " - " + valuePM10);
111.   Serial.println(namePressure + " - " + valuePressure);
112.   Serial.println(nameHumidity + " - " + valueHumidity);
113.   Serial.println(nameTemperature + " - " + valueTemperature);  
114.   /*Current indexes display */  
115.   Serial.println("*****************");
116.   Serial.println("Indexes name: - " + indexesName);
117.   Serial.println("Indexes value: - " + indexesValue);  
118.   Serial.println("Indexes level: - " + indexesLevel);
119.   Serial.println("Indexes description: - " + indexesDescription);
120.   Serial.println("Indexes advice: - " + indexesAdvice);
121.   Serial.println("Indexes color: - " + indexesColor);
122.   /*Current standards display */
123.   Serial.println("*****************");
124.   Serial.println("Standards name: - " + standardsPM25Name);
125.   Serial.println("Standards pollutant: - " + standardsPM25Pollutant);  
126.   Serial.println("Limit level: - " + standardsPM25Limit);
127.   Serial.println("Percent description: - " + standardsPM25Percent);
128.   Serial.println("*****************");
129.   Serial.println("Standards name: - " + standardsPM10Name);
130.   Serial.println("Standards pollutant: - " + standardsPM10Pollutant);  
131.   Serial.println("Limit level: - " + standardsPM10Limit);
132.   Serial.println("Percent description: - " + standardsPM10Percent);
133.   Serial.println("----------------------------");
134. }

Odczytane w ten sposób dane prezentują się w następujący sposób:

W powyższym programie korzystam z biblioteki ArduinoJson. Dzięki niej można w łatwy sposób wyciągnąć dane z obiektu JSON. Aktualnie dostępna jest biblioteka w wersji 6. Natomiast dużo przykładów zastosowania jej na internecie opisuje wersję 5. Dlatego w poniższym linku opisane jest w jaki sposób przejść na wyższą wersję (https://arduinojson.org/v6/doc/upgrade/).