163. (TWOK/LOGIC) [Aws] AWS Iot Core 원격 작업 Job OTA 생성 요청 CreateJob API 호출 로직 정리

---

[로직 정리]

​

정리 로직 : Aws / Iot / Job

​

상태 : [Aws] AWS Iot Core 원격 작업 Job OTA 생성 요청 CreateJob API 호출 로직 정리

 

---

[설 명]

​

// --------------------------------------------------------------------------------------
[사전) 설정 및 정보 확인 사항]
// --------------------------------------------------------------------------------------

1. 제 목 : [Aws] AWS Iot Core 원격 작업 Job OTA 생성 요청 CreateJob API 호출 로직 정리


2. 테스트 환경 : Aws / Iot / Job / OTA / Firmware Update


3. 사전) Aws Iot Core 간략 설명 : 

  >> AWS IoT 는 IoT 디바이스를 다른 디바이스 및 AWS 클라우드 서비스에 연결하는 클라우드 서비스를 제공합니다.

  >> 디바이스가에 연결할 수 있는 경우 AWS IoT는 AWS 가 제공하는 클라우드 서비스에 디바이스를 AWS IoT 연결할 수 있습니다.

  >> AWS IoT Core 메시지 브로커는 MQTT 및 MQTT over WSS 프로토콜을 사용하여 메시지를 게시하고 구독하는 디바이스 및 클라이언트를 지원합니다. 
  
    - HTTPS 프로토콜을 사용하여 메시지를 게시하는 디바이스와 클라이언트도 지원합니다.


4. 사전) AWS Iot Core Job 간략 설명 : 

  >> AWS 원격 작업 이란 작업자 또는 기술자의 물리적 존재 없이 원격으로 수행할 수 있는 업데이트 작업입니다 (무선 업데이트 (OTA) 수행)

  >> AWS IoT 작업 서비스는 AWS IoT 에 연결 되는 하나 이상의 디바이스로 전송 된 후 실행 되는 원격 작업 세트를 정의하는데 사용됩니다

    - 주목적 : 소프트웨어 및 펌웨어 업데이트를 디바이스 기기에게 알리는데 사용 (기기에게 작업 문서 전송)

    - 작업 문서 : AWS IoT Job 생성 시 대상이 되는 디바이스로 전송 되는 문서 (펌웨어 다운로드 URL 정보 등 포함)


5. 사전) 자바스크립트 CDN 의존성 설정 코드 : 

  <script src="https://code.jquery.com/jquery-latest.min.js"></script>
  <script src="https://sdk.amazonaws.com/js/aws-sdk-2.1416.0.min.js"></script>

// --------------------------------------------------------------------------------------






// --------------------------------------------------------------------------------------
[로직 설명]
// --------------------------------------------------------------------------------------

1. 자바스크립트 <script> 코드 내에 AWS 연결 및 초기화, Job 생성을 위한 전역 변수 선언 수행

  // -----------------------------------------
  // [AWS 연결 및 초기화 관련 변수]
  // -----------------------------------------
  const region = 'ap-northeast-2'; // [AWS 리전]
  const accessKeyId = 'AK..A6'; // [IAM 액세스 키]
  const secretAccessKey = 'mP..5J'; // [IAM 시크릿 키]
  

  // -----------------------------------------
  // [펌웨어 업데이트 OTA 관련 변수]
  // -----------------------------------------
  var THING_NAME = "TWOK_1234"; // 사물 명칭 이름 : Thing Arn 조회에 사용
  var THING_ARN = ""

  var DEVICE_TYPE = "DEVICE"
  var DEVICE_MODEL = "camera"
  var DEVICE_BRAND = "TWOK_COMPANY"
  var FRM_URL = "https://service.com/TEST_Firmware/V1.0.40_Bin"
  var FRM_MD5 = "e76052c97"
  var FRM_VERSION = "1.0.1"
  
  var JOB_ID = function(){ // ✅ 리턴 JobID : 호출 > JOB_ID()
    return `DEVICE_OTA_JOB_TEST_${THING_NAME}_1`
  }

  var JOB_DOC = function(){ // ✅ 리턴 JobDoc 문서 : 호출 > JOB_DOC()
    return `{
              "operation": "UPDATE",
              "description": "Request Update Firmware",
              "target": [
                {
                  "deviceType": "${DEVICE_TYPE}",
                  "deviceThingList": [
                    "${THING_NAME}"
                  ],
                  "version": "${FRM_VERSION}",
                  "model": "${DEVICE_MODEL}",
                  "brand": "${DEVICE_BRAND}",
                  "firmwareUrl": "${FRM_URL}",
                  "firmwareFileMd5": "${FRM_MD5}"
                }
              ],
              "jobExecutionsRolloutConfig": {
                "maximumPerMinutes": 10
              }
            }`
  }


2. 자바스크립트 window.onload 부분에서 AWS config 업데이트 및 AWS.Iot 객체 생성 수행

  AWS.config.update({
    region: region,
    accessKeyId: accessKeyId,
    secretAccessKey: secretAccessKey
  });

  const aws = new AWS.Iot();


3. 사전 AWS Iot Core 에 특정 Thing 이 생성 되어 있는지 확인을 위한 describeThing 정보 확인 API 호출 수행

  const thing_param = {
    thingName: THING_NAME // 사물 명칭
  };

  const [thing_err, thing_res] = await aws.describeThing( thing_param ).promise()                
    .then(data => [null, data])
    .catch(error => [error, null]);

  if (thing_err) {
    console.error("[describeThing] : [Error] : ", thing_err);

  } else {
    console.log("[describeThing] : [Success] : ", JSON.stringify(thing_res));

    // ✅ Thing 정보 확인 시 thingArn 정보 파싱 로직 코드 추가
  }


4. describeThing 호출 후 특정 Thing 에 대한 정보 확인 완료 시 thingArn 정보 파싱 수행

  // ---------------------------------------------
  // ✅ [describeThing 호출 로그 출력 예시 첨부]
  // ---------------------------------------------
  /*
  {
    "defaultClientId": "TWOK_1234",
    "thingName": "TWOK_1234",
    "thingId": "b6..854",
    "thingArn": "arn:aws:iot:ap-northeast-2:123456789012:thing/TWOK_1234",
    "thingTypeName": "DEVICE",
    "attributes": {},
    "version": 1,
    "billingGroupName": null
  }
  */              
  // ---------------------------------------------

  if (thing_res.hasOwnProperty("thingArn") == true){

    THING_ARN = thing_res.thingArn; // ✅ Set Thing ARN

    // ✅ thingArn 정보 확인 완료 시 펌웨어 업데이트 로직 코드 추가
  }
  else {
    console.error("[describeThing] : [Error] : ThingArn Is Null");
  }


5. 정상적으로 thingArn 정보 확인이 완료 된 경우 > createJob 펌웨어 업데이트 API 호출 수행 실시

  const job_param = {
    jobId: JOB_ID(),
    targets: [THING_ARN],   // 작업을 수행할 Thing 또는 Thing Group
    document: JSON.stringify(JOB_DOC_JSON), // ✅ document 필드는 string 타입으로 정의되어 있습니다
    description: "Firmware Update Job",
    targetSelection: "SNAPSHOT" // 또는 CONTINUOUS
    /*
    , timeoutConfig: { // 디바이스가 Job 을 IN_PROGRESS 상태로 만든 후 일정 시간이 자났음에도 SUCCEEDED , FAILED 상태가 업데이트 되지 않으면 자동 TIME_OUT 상태로 전환 기능
        inProgressTimeoutInMinutes: 60
    }
    // */

  };

  const [job_err, job_res] = await aws.createJob( job_param ).promise()                
    .then(data => [null, data])
    .catch(error => [error, null]);

  if (job_err) {
    console.error("[createJob] : [Error] : ", job_err);
  } else {
    console.log("[createJob] : [Success] : ", JSON.stringify(job_res));

    // ---------------------------------------------
    // ✅ createJob 완료 후 jobId, jobArn 정보 확인 및 DescribeJob 원격 작업 정보 확인 API 추가 호출 수행
    // ---------------------------------------------
    // ✅ [Create Job 로그 출력 예시 첨부]
    // ---------------------------------------------
    /*
    {
      "jobArn": "arn:aws:iot:ap-northeast-2:123456789012:job/DEVICE_OTA_JOB_TEST_TWOK_1234_1",
      "jobId": "DEVICE_OTA_JOB_TEST_TWOK_1234_1",
      "description": "Firmware Update Job"
    }
    */              
    // ---------------------------------------------

  }


6. AWS 콘솔 대시 보드 및 DescribeJob API 호출을 통해 실시간 펌웨어 업데이트 진행 상황 확인 수행

// --------------------------------------------------------------------------------------






// --------------------------------------------------------------------------------------
[참고 사이트]
// --------------------------------------------------------------------------------------

[Aws Iot Core] 원격 작업 무선 업데이트 (OTA) job 개념 학습 및 펌웨어 업데이트 프로세스 정리

https://kkh0977.tistory.com/8133

https://blog.naver.com/kkh0977/223926549194?trackingCode=blog_bloghome_searchlist


[Aws Iot Core] AWS 원격 펌웨어 업데이트 job 알림 수신 jobs/notify 토픽과 jobs/notify-next 토픽 차이점 정리

https://kkh0977.tistory.com/8178

https://blog.naver.com/kkh0977/223954213087?trackingCode=blog_bloghome_searchlist


[Aws Iot Core] AWS 펌웨어 업데이트 Job Execution Rollout 설정 값 snapshot 과 continuous 차이점 정리

https://blog.naver.com/kkh0977/223960153729?trackingCode=blog_bloghome_searchlist


[Aws Iot Core] AWS 원격 펌웨어 업데이트 OTA 수동 job 생성 및 특정 사물 notify 펌웨어 업데이트 요청 방법 정리

https://blog.naver.com/kkh0977/223944636139?trackingCode=blog_bloghome_searchlist


[안드로이드 AWS Iot Core 원격 업데이트 Job 리스트 목록 확인]

https://blog.naver.com/kkh0977/223926528254?trackingCode=blog_bloghome_searchlist


[업무 이슈] Aws Iot Core 에서 Job 원격 펌웨어 업데이트 요청 시 상태가 완료 로 처리 되지 않는 이슈 발생

https://blog.naver.com/kkh0977/223944640508?trackingCode=blog_bloghome_searchlist


[업무 이슈] AWS Job 디바이스 펌웨어 업데이트 파일 순차 업데이트 미동작 이슈 - IN_PROGRESS, QUEUED 배열 펌웨어 처리

https://blog.naver.com/kkh0977/223955019266?trackingCode=blog_bloghome_searchlist


[업무 이슈] AWS Job 디바이스 펌웨어 업데이트 시 동일 버전 펌웨어 버전 체크 및 업데이트 진행 미완료 표시 - publish status

https://blog.naver.com/kkh0977/223955010876?trackingCode=blog_bloghome_searchlist


[업무 이슈] 디바이스 Aws Job OTA 펌웨어 업데이트 시 STS 임시 자격 증명 S3 Presigned URL 프리 사인 주소 파싱 문제 발생

https://blog.naver.com/kkh0977/223951554000?trackingCode=blog_bloghome_searchlist

// --------------------------------------------------------------------------------------

 

---

[참고 사이트]

​

https://kkh0977.tistory.com/8133

83. (Aws/Amazon) [Aws Iot Core] 원격 작업 무선 업데이트 (OTA) job 개념 학습 및 펌웨어 업데이트 프로세

---