Authorization

はじめに

BASIC認証を行う例です。

プログラム

定義等 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

/**
 * Authorization.ino
 *
 *  Created on: 09.12.2015
 *
 */

#include <Arduino.h>

#include <WiFi.h>
#include <WiFiMulti.h>

#include <HTTPClient.h>

#define USE_SERIAL Serial

WiFiMulti wifiMulti;

WiFiMulti型の変数wifiMultiを定義しています。WiFiMultiクラスは、複数のアクセスポイントを管理するためのクラスです。

setup() 

19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

void setup() {

    USE_SERIAL.begin(115200);

    USE_SERIAL.println();
    USE_SERIAL.println();
    USE_SERIAL.println();

    for(uint8_t t = 4; t > 0; t--) {
        USE_SERIAL.printf("[SETUP] WAIT %d...\n", t);
        USE_SERIAL.flush();
        delay(1000);
    }

    wifiMulti.addAP("SSID", "PASSWORD");

}

USE_SERIALは、Serialと定義されているので、前半はコンソールへの文字列の出力です。

wifiMullti.addAP()は、WiFiアクセスポイントの登録です。SSIDとPASSWORDは、各自の環境に合わせて変更する必要があります。

loop() 

37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

void loop() {
    // wait for WiFi connection
    if((wifiMulti.run() == WL_CONNECTED)) {

        HTTPClient http;

        USE_SERIAL.print("[HTTP] begin...\n");
        // configure traged server and url


        http.begin("http://user:password@192.168.1.12/test.html");

        /*
          // or
          http.begin("http://192.168.1.12/test.html");
          http.setAuthorization("user", "password");

          // or
          http.begin("http://192.168.1.12/test.html");
          http.setAuthorization("dXNlcjpwYXN3b3Jk");
         */


        USE_SERIAL.print("[HTTP] GET...\n");
        // start connection and send HTTP header
        int httpCode = http.GET();

        // httpCode will be negative on error
        if(httpCode > 0) {
            // HTTP header has been send and Server response header has been handled
            USE_SERIAL.printf("[HTTP] GET... code: %d\n", httpCode);

            // file found at server
            if(httpCode == HTTP_CODE_OK) {
                String payload = http.getString();
                USE_SERIAL.println(payload);
            }
        } else {
            USE_SERIAL.printf("[HTTP] GET... failed, error: %s\n", http.errorToString(httpCode).c_str());
        }

        http.end();
    }

    delay(10000);
}

wifiMulti.run()は、wifiMullti.addAP()で登録したアクセスポイントに接続するメソッドです。接続に成功するとWL_CONNECTEDが返ってきます。

HTTPClientクラスは、HTTPクライアントを実現するためのクラスです。

http.begin()は、アクセスしたいURLを登録します。この際、http://user:password@example.com のように、ユーザ名とパスワードを指定することで、BASIC認証に対応したリクエストメッセージを送ることができます。URLにはユーザ名とパスワードは含めず、http.setAutorization()を利用することもできます。

http.GET()は、http.begin()で登録したURLを、GETリクエストを使って取得します。サーバに接続できないなど、エラーの場合は、負の値が返ってきます。HTTP接続が成功した場合は、HTTPのステータスコードが返ってきます。

http.getSting()は、http.GET()で取得したデータを文字列で返します。

http.end()は、TCPのコネクションを切断します。http.setReuse()を使い、コネクションを再利用することもできるようです。このときは、サーバがkeep-aliveを返してきていれば、コネクションはそのままにしておくようです。

http.GET()の呼び出しに失敗した場合は、http.errorToString()を呼び出して、エラーコードをエラーコードに対応した文字列に変換してから、表示します。

バージョン

Hardware:ESP-WROOM-32
Software:Arduino core for the ESP32 2.0.4

最終更新日

September 4, 2022

inserted by FC2 system