ESP32 with AWS IoT -2-

👨‍💻 Connecting AWS with ESP32: Tutorial

이번 글은 🔗 Workshop:ESP32 with AWS IoT 의 내용을 직접 실습한 뒤 재 포스팅 한 내용입니다.

1. AWS IoT 에서 사물(Thing) 만들기

평소에는 Board니 혹은 IoT 기기 등과 같은 단어를 주로 사용하지만 막상 사물 이라는 단어로 글을 적이니 좀 어색한 느낌이 있다. 하지만 IoT의 우리나라 순화어는 사물 인터넷이고 AWS IoT 에서도 사물로 표기하고 있으니 사물 에 대한 정확한 뜻을 알아 보자.

사물(事物)

「명사」

「1」 일과 물건을 아울러 이르는 말.

「2」 물질세계에 있는 모든 구체적이며 개별적인 존재를 통틀어 이르는 말.

출처: 국립국어원 표준국어대사전

AWS IoT에서 사물과 연결을 시키려면 먼저 사물을 생성한 뒤, 등록해야한다. 우선 AWS에 로그인 한 뒤 AWS 관리 콘솔에 들어가 모든 서비스 ➜ 사물인터넷 ➜ IoT Core 를 클릭한다. 브라우저 좌측에서 관리 ➜ 사물 을 클릭하면 사물 생성 이라는 버튼이 있는걸 확인할 수 있다.

사물 생성 버튼을 누르면 단일 사물 생성 과 많은 사물 생성 두 갈래로 나뉘어지는데, 이때 단일 사물 생성을 클릭한다. 사물의 속성에 사물이름에 원하는 사물이름을 적어두자 이번 포스팅에서는 ESP32 로 이름을 짓고 추가 구성은 Default 상태로 둔 뒤 다음 버튼을 누른다.

다음으로 디바이스 인증서 구성을 한다. 자신은 자신만의 인증서와 인증기관을 사용하고싶다면, 권장사항이 아닌 다른 선택을 누르면 되지만 이번 포스팅에서는 새 인증서 자동 생성(권장) 을 선택한 뒤 다음으로 넘어간다. 이제 내 사물의 인증서와 연결될 정책을 설정 해야 하는데 정책은 차후에 설정하니 우선 사물 생성을 누른다.

그럼 다음과 같은 팝업창이 뜨는데 빨간색으로 칠해진건 지금 바로 다운로드 받아야하는 부분이고 파란색은 나중에 다운로드 받을 수 있는 부분이다.

이제 다시 관리 ➜ 사물 탭을 들어가보면 ESP32 사물을 생성한 것을 확인할 수 있다. ✌️

2. AWS IoT 의 정책

AWS IoT인증서를 만들면 이 인증서와 정책을 연결되야 실제 사물이 AWS IoT와 연결이 된다. AWS IoT Core 정책을 통해 데이터 영역에 대한 엑세스를 제어할 수 있다. 말이 어렵지만 사실상 JSON 포맷의 문서이며 정책에 따라 MQTT 브로커와의 Connection, Subscribe, Publish 등을 제어한다. 정책은 다음 세 항목을 포함한다.

• Effect - 작업이 허용되는지 또는 거부되는지를 지정합니다.
• Action - 정책이 허용하거나 거부하는 작업을 지정합니다.
• Resource - 작업이 허용되거나 거부되는 리소스를 지정합니다.

무슨말인지 이해가 잘 안되도 다음 스텝을 밟다보면 어느정도 이해가 될 것이다. 🦶 일단 브라우저 좌측에서 다시 보안 ➜ 정책 탭으로 들어가 정책 생성 버튼을 클릭하자.

이름은 원하는 이름으로 넣어도 된다. 여기서는 ESP32 _Policy 로 지었다. 작업란에 iot:Connect를 입력 하면, 리소스 ARN란에 자동완성으로 채워 넣어진다. 다음 노랗게 강조된 곳인 replaceWithAClientId 라고 적힌 부분은 사물의 이름을 적어 넣어야한다. 이 포스팅을 그대로 따라가면 ESP32 라고 적으면 된다. 그 뒤 허용 체크박스를 클릭하자. 만약 여기서 생성을 하면 AWS의 MQTT Broker에는 연결이 되겠지만... Sub이나 Pub을 할 순없다.

따라서 설명문 추가를 눌러 다음 작업들도 추가해주자. 이번에도 강조된 부분은 Sub 과 Pub 토픽이며, 이를 아래 예시가 맘에 들지 않는다면 다른 토픽을 이용해도 된다.

이제 정책까지 만들었으니 이전에 만들었던 인증서와 이 정책을 연결해 주면 사물연결을 위한 셋업은 다 끝이난다. 관리 ➜ 사물 ➜ YourThingName ➜ 인증서 에서 인증서 ID를 클릭한다. 그럼 다음 창이 띄는데 여기서 작업 버튼을 클릭한다.

그뒤, 방금 만든 정책연결을 연결하면 끝난다.

3. ESP32 Code Uploading

이제 ESP32 와 AWS IoT를 연결할 코드를 업로드 해보자. 우선 필요한 라이브러리 부터 다운로드 받아야 한다. Arduino IDE에 툴 ➜ 라이브러리 관리 에 들어가서 ArduinoJson 과 lwmqtt 를 검색해 다운받아 주자. Ardunio IDE에는 디폴트로 wifi 모듈이 깔려져 있지만, 만약 없다면 이 모듈도 다운받아야한다. 2021년 11월 4일 모듈별 최신 버전은 다음과 같다.

• ArduinoJson: 6.18.5
• lwmqtt: 2.5.0
• WiFi: 1.2.7

다음은 메인 ESP_AWS_IoT_Tutorial.ino 파일이다. 새 프로젝트를 생성한뒤, 아래 코드를 복사해 붙여넣자.

/*
  Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  Permission is hereby granted, free of charge, to any person obtaining a copy of this
  software and associated documentation files (the "Software"), to deal in the Software
  without restriction, including without limitation the rights to use, copy, modify,
  merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so.
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/


#include "secrets.h"
#include <WiFiClientSecure.h>
#include <MQTTClient.h>
#include <ArduinoJson.h>
#include "WiFi.h"

// The MQTT topics that this device should publish/subscribe
#define AWS_IOT_PUBLISH_TOPIC   "esp32/pub"
#define AWS_IOT_SUBSCRIBE_TOPIC "esp32/sub"

WiFiClientSecure net = WiFiClientSecure();
MQTTClient client = MQTTClient(256);

void connectAWS()
{
  WiFi.mode(WIFI_STA);
  WiFi.begin(WIFI_SSID, WIFI_PASSWORD);

  Serial.println("Connecting to Wi-Fi");

  while (WiFi.status() != WL_CONNECTED){
    delay(500);
    Serial.print(".");
  }

  // Configure WiFiClientSecure to use the AWS IoT device credentials
  net.setCACert(AWS_CERT_CA);
  net.setCertificate(AWS_CERT_CRT);
  net.setPrivateKey(AWS_CERT_PRIVATE);

  // Connect to the MQTT broker on the AWS endpoint we defined earlier
  client.begin(AWS_IOT_ENDPOINT, 8883, net);

  // Create a message handler
  client.onMessage(messageHandler);

  Serial.print("Connecting to AWS IOT");

  while (!client.connect(THINGNAME)) {
    Serial.print(".");
    delay(100);
  }

  if(!client.connected()){
    Serial.println("AWS IoT Timeout!");
    return;
  }

  // Subscribe to a topic
  client.subscribe(AWS_IOT_SUBSCRIBE_TOPIC);

  Serial.println("AWS IoT Connected!");
}

void publishMessage()
{
  StaticJsonDocument<200> doc;
  doc["time"] = millis();
  doc["sensor_a0"] = analogRead(0);
  char jsonBuffer[512];
  serializeJson(doc, jsonBuffer); // print to client

  client.publish(AWS_IOT_PUBLISH_TOPIC, jsonBuffer);
}

void messageHandler(String &topic, String &payload) {
  Serial.println("incoming: " + topic + " - " + payload);

//  StaticJsonDocument<200> doc;
//  deserializeJson(doc, payload);
//  const char* message = doc["message"];
}

void setup() {
  Serial.begin(9600);
  connectAWS();
}

void loop() {
  publishMessage();
  client.loop();
  delay(1000);
}

define 매크로를 이용한 AWS_IOT_PUBLISH_TOPIC 과 AWS_IOT_SUBSCRIBE_TOPIC은 2. AWS IoT 의 정책 편에서 만든 Publish 와 Subscribe 정책의 토픽과 일치해야한다.

#define AWS_IOT_PUBLISH_TOPIC   "esp32/pub"
#define AWS_IOT_SUBSCRIBE_TOPIC "esp32/sub"

다음은 secret.h 를 작성해야한다. 여기에는 AWS IoT와 연결될 인증정보 및 개인 WiFi 정보 포함되어 있다.

/*
  Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  Permission is hereby granted, free of charge, to any person obtaining a copy of this
  software and associated documentation files (the "Software"), to deal in the Software
  without restriction, including without limitation the rights to use, copy, modify,
  merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so.
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#include <pgmspace.h>

#define SECRET
#define THINGNAME ""

const char WIFI_SSID[] = "";
const char WIFI_PASSWORD[] = "";
const char AWS_IOT_ENDPOINT[] = "xxxxx.amazonaws.com";

// Amazon Root CA 1
static const char AWS_CERT_CA[] PROGMEM = R"EOF(
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
)EOF";

// Device Certificate
static const char AWS_CERT_CRT[] PROGMEM = R"KEY(
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
)KEY";

// Device Private Key
static const char AWS_CERT_PRIVATE[] PROGMEM = R"KEY(
-----BEGIN RSA PRIVATE KEY-----
-----END RSA PRIVATE KEY-----
)KEY";

우리가 수정해야할 부분은 다음과 같다.

• const char WIFI_SSID[] = ""; : WiFi 네트워크 SSID
• const char WIFI_PASSWORD[] = "";: WiFi 네트워크 비밀번호
• const char AWS_IOT_ENDPOINT[] = "xxxxx.amazonaws.com"; = AWS ENDPOINT 주소
• static const char AWS_CERT_CRT[] PROGMEM = : 인증서
• static const char AWS_CERT_PRIVATE[] PROGMEM =: 개인키

그외 Amazon Root CA1은 다음 링크를 긁어 복사하면 된다.

Amazon Root CA 1

WiFi의 SSID 및 PASSWORD는 준비된 WiFi의 정보를 입력하면된다. AWS_IOT_ENDPOINT 는 AWS IoT 좌측 최하단 설정 탭으로 들어간뒤 엔드포인트를 복사해 주면 된다.

AWS_CERT_CRT 는 미리 다운로드 받았던 ***-certificate.pem.crt 파일을 편집기로 열어서 내용을 복사하고, AWS_CERT_PRIVATE 는 ***-private.pem.key 를 열어서 복사하면 된다. ESP32 가 AWS IoT와 연결되면, AWS IoT Connected! 라는 내용이 시리얼 모니터로 출력된다.

4. MQTT Test Client

ESP32 연결이 끝났으면 이제 다시 AWS IoT 홈페이지로와 좌측 하단 테스트 ➜ MQTT 테스트 클라이언트 탭으로 들어간 뒤, 주제 구독란에 esp32/pub 을 입력하고 구독 버튼을 누르자.

아래의 코드로부터 발생되는 로르이다. analog0 pin에 어떤 센서를 연결하면 센서의 값이 AWS IoT로 보내지게 된다.

void publishMessage()
{
  StaticJsonDocument<200> doc;
  doc["time"] = millis();
  doc["sensor_a0"] = analogRead(0);
  char jsonBuffer[512];
  serializeJson(doc, jsonBuffer); // print to client

  client.publish(AWS_IOT_PUBLISH_TOPIC, jsonBuffer);
}

사물에서 Publish가 잘 되는것을 확인 했으니 이제 Subscribe도 잘 되는지 확인해 보자. 마찬가지로 테스트 클라이언트에서 주제 게시 탭으로 들어가 주제 이름을 esp32/sub 을 적고 디폴트 메시지 페이로드로 게시 버튼을 누르면 다음과 같이 시리얼 모니터에 잘 출력 되는 것을 확인할 수 있다.

아래 코드는 수신된 메시지를 어떻게 처리하는지 보여준다. ✌️✌️

void messageHandler(String &topic, String &payload) {
  Serial.println("incoming: " + topic + " - " + payload);

//  StaticJsonDocument<200> doc;
//  deserializeJson(doc, payload);
//  const char* message = doc["message"];
}

client.subscribe(AWS_IOT_SUBSCRIBE_TOPIC);

🔗 Connecting AWS with ESP32 Tutorial