투케이2K

462. (javaScript) 자바스크립트 AWS Iot Core 원격 작업 펌웨어 업데이트 OTA 요청 수행 - CreateJob 본문

JavaScript

462. (javaScript) 자바스크립트 AWS Iot Core 원격 작업 펌웨어 업데이트 OTA 요청 수행 - CreateJob

투케이2K 2025. 12. 6. 16:20
728x90
반응형

[개발 환경 설정]

​

개발 툴 : Edit++

개발 언어 : JavaScript

 

[소스 코드]

​

-----------------------------------------------------------------------------------------
[사전 설명 및 설정 사항]
-----------------------------------------------------------------------------------------

- 개발 환경 : Web


- 개발 기술 : JavaScript (자바스크립트) / AWS / Iot / Job / OTA


- 사전) Aws Iot Core 간략 설명 : 

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

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

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


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

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

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

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

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

-----------------------------------------------------------------------------------------





-----------------------------------------------------------------------------------------
[소스 코드]
-----------------------------------------------------------------------------------------

<!DOCTYPE HTML>
<html lang="ko">
<head>
    <title>javaScriptTest</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">


    <!-- 반응형 구조 만들기 -->
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no">


    <!-- 내부 CSS 스타일 지정 -->
    <style>

        html, body {
            width: 100%;
            height: 100%;
            margin : 0 auto;
            padding : 0;
            border : none;
            background-color: #666;
        }

    </style>





    <!-- [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>






    <!-- [자바스크립트 코드 지정] -->
    <script>

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

        // [전역 변수 선언]
        const region = 'ap-northeast-2'; // [AWS 리전]
        const accessKeyId = 'AK..A6'; // [IAM 액세스 키]
        const secretAccessKey = 'mP..5J'; // [IAM 시크릿 키]
        
        var innerFunction = null; // [내부 클로저 선언 실시]

        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
                    }
                  }`
        }

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

        // [html 최초 로드 및 이벤트 상시 대기 실시]
        window.onload = async function() {
            console.log("");
            console.log("=========================================");
            console.log("[window onload] : [start]");
            console.log("=========================================");
            console.log("");


            // -----------------------------------------
            // [초기 변수 초기화]
            // -----------------------------------------
            innerFunction = null;


            // -----------------------------------------
            // [AWS.config 지정]
            // -----------------------------------------
            // IAM 계정 정보를 사용해 AWS.config 정보 업데이트 수행
            // -----------------------------------------            
            AWS.config.update({
              region: region,
              accessKeyId: accessKeyId,
              secretAccessKey: secretAccessKey
            });



            // -----------------------------------------
            // [AWS.Iot 객체 생성]
            // -----------------------------------------
            const aws = new AWS.Iot();


            // -----------------------------------------
            // [내부 클로저 함수 정의]
            // -----------------------------------------
            innerFunction = async function() {

              try {
                
                // -----------------------------------------
                // [Thing Info 요청 파라미터 생성]
                // -----------------------------------------
                const thing_param = {
                  thingName: THING_NAME // 사물 명칭
                };


                // -----------------------------------------
                // [DescribeThing] : Aws Iot Core 에 생성 된 Thing 사물 정보 조회
                // -----------------------------------------
                // AWS 참고 사이트 : https://docs.aws.amazon.com/ko_kr/iot/latest/apireference/API_DescribeThing.html
                // -----------------------------------------
                const [thing_err, thing_res] = await aws.describeThing( thing_param ).promise()                
                  .then(data => [null, data])
                  .catch(error => [error, null]);

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

                } else {

                  // ---------------------------------------------
                  // ✅ [Thing Info 로그 출력 예시 첨부]
                  // ---------------------------------------------
                  /*
                  {
                    "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 == null || thing_res == undefined || String(typeof thing_res).toLowerCase() == "undefined" || JSON.stringify(thing_res) == "null" || thing_res == "") {                    
                    console.error("");
                    console.error("=========================================");
                    console.error("[describeThing] : [Error]");
                    console.error("---------------------------------------");
                    console.error("thing info is null");					
                    console.error("=========================================");
                    console.error("");
  
                  }
                  else {
                    console.log("");
                    console.log("=========================================");
                    console.log("[describeThing] : [Success]");
                    console.log("---------------------------------------");
                    console.log(JSON.stringify(thing_res));
                    console.log("=========================================");
                    console.log("");

                    
                    if (thing_res.hasOwnProperty("thingArn") == true){
                      THING_ARN = thing_res.thingArn; // ✅ Set Thing ARN


                      // [테스트 동적 데이터 변경]
                      /*
                      THING_NAME = "TWOK1234";
                      DEVICE_TYPE = "DEVICE_TEST"
                      DEVICE_MODEL = "testModel"
                      DEVICE_BRAND = "2K"
                      FRM_URL = "https://test.com"
                      FRM_MD5 = "abcd"
                      FRM_VERSION = "1.0.1" 
                      // */


                      const JOB_DOC_JSON = JSON.parse(JOB_DOC()); // ✅ Parse JobDoc


                      console.warn("");
                      console.warn("=========================================");
                      console.warn("[createJobDocument] : [Info]");
                      console.warn("---------------------------------------");
                      console.warn("THING_ARN : ", THING_ARN);
                      console.warn("---------------------------------------");
                      console.warn("JOB_ID : ", JOB_ID());
                      console.warn("---------------------------------------");
                      console.warn("JOB_DOC_STRING : ", JOB_DOC());
                      console.warn("---------------------------------------");
                      console.warn("JOB_DOC_JSON : ", JOB_DOC_JSON);

                      console.warn("=========================================");
                      console.warn("");


                      // -----------------------------------------
                      // [create Job 요청 파라미터 생성]
                      // -----------------------------------------
                      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
                        }
                        // */

                      };


                      console.log("job_param : ", JSON.stringify(job_param));


                      // -----------------------------------------
                      // [createJob] : Aws Iot Core 에 원격 작업 생성 수행
                      // -----------------------------------------
                      // AWS 참고 사이트 : https://docs.aws.amazon.com/iot/latest/apireference/API_CreateJob.html
                      // -----------------------------------------
                      const [job_err, job_res] = await aws.createJob( job_param ).promise()                
                        .then(data => [null, data])
                        .catch(error => [error, null]);


                      if (job_err) {
                        console.error("");
                        console.error("=========================================");
                        console.error("[createJob] : [Error]");
                        console.error("---------------------------------------");
                        console.error(job_err);					
                        console.error("=========================================");
                        console.error("");

                      } else {
                        // ---------------------------------------------
                        // ✅ [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"
                        }
                        */              
                        // ---------------------------------------------

                        if (job_res == null || job_res == undefined || String(typeof job_res).toLowerCase() == "undefined" || JSON.stringify(job_res) == "null" || job_res == "") {                    
                          console.error("");
                          console.error("=========================================");
                          console.error("[createJob] : [Error]");
                          console.error("---------------------------------------");
                          console.error("job info is null");					
                          console.error("=========================================");
                          console.error("");
        
                        }
                        else {
                          console.log("");
                          console.log("=========================================");
                          console.log("[createJob] : [Success]");
                          console.log("---------------------------------------");
                          console.log(JSON.stringify(job_res));
                          console.log("=========================================");
                          console.log("");

                        }

                      }

                    }
                    else {
                      console.error("[describeThing] : [Error] : ThingArn Is Null");
                    }
  
                  }               

                }

              }
              catch(exception){
                console.error("");
                console.error("=========================================");
                console.error("[innerFunction] : [Exception] : ", exception);
                console.error("=========================================");
                console.error("");
              }

            };



            // -----------------------------------------
            // [내부 클로저 함수 호출]
            // -----------------------------------------
            innerFunction();

        };

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

    </script>


</head>


<body>

</body>

</html>

-----------------------------------------------------------------------------------------





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

[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

-----------------------------------------------------------------------------------------
 
728x90
반응형
저작자표시 (새창열림)

'JavaScript' 카테고리의 다른 글

464. (javaScript) 자바스크립트 S3 특정 버킷 (Bucket) 에 저장 된 파일 전체 목록 조회 - NextContinuationToken, ListObjectsV2  (0) 2025.12.08
463. (javaScript) 자바스크립트 AWS Iot Core 원격 작업 펌웨어 업데이트 작업 삭제 요청 수행 - DeleteJob  (0) 2025.12.07
461. (javaScript) 자바스크립트 AWS Iot Core 룰엔진 리스트 nextToken 사용해 전체 조회 수행 - listTopicRules  (0) 2025.12.05
460. (javaScript) 자바스크립트 AWS Iot Core 원격 작업 리스트 nextToken 사용해 전체 조회 수행 - ListJobs  (0) 2025.12.05
459. (javaScript) [간단 소스] 자바스크립트 AWS DynamoDB 다이나모 디비 테이블 파티션키 (PartitionKey) 지정 스캔 수행 - table query  (0) 2025.12.05
'JavaScript' Related Articles more
Comments