====== Vibrator 디바이스API 가이드 프로그램 ====== ===== 개요 ===== VibratorAPI 가이드 프로그램은 모바일 디바이스 API 실행환경을 활용하여 하이브리드 앱을 개발자들이 구현 시 참고 및 활용될 수 있도록 구현된 전자정부 디바이스 API에 대한 가이드 앱으로써, 모바일 스마트 디바이스의 Notification 관련 기능을 JavaScript 기반으로 구성된 Vibrator DeviceAPI 를 통하여 조회할 수 있도록 지원한다. 또한, 전자정부 표준 프레임워크 기반의 웹 서버 어플리케이션과 연계하여 디바이스 내, 알림 정보를 서버로 전송 및 조회할 수 있는 기능으로 구성되어 있다. ==== 특징 ==== 본 가이드 프로그램 에서는 알람 기능을 가이드 할 수 있도록 **소리로 알림** , **진동으로 알림** , **알림 목록 보기** 기능을 제공하고 있다.\\ Notification API를 이용하여, 사용자가 설정한 시간에 알람 정보를 표시한다. ==== 기능흐름도 ==== {{:egovframework:hyb:guide:add:egovframework_hyb_guideadd_vibrator_알림기능흐름도.png?740|}} ==== 기능시퀀스 ==== {{:egovframework:hyb3.6:guide:ios:vibrator:vibrator_usecase.png?400|}} ==== 전제조건 ==== ^ 구분 ^ 내용 ^ |Local 디바이스 개발 환경| Xcode 8.0 (8A218a), Cordova 6.4.0 | |서버 사이드 개발 환경| 전자정부표준프레임워크 개발환경3.6| |Mash up Open API 연계| N/A| |테스트 디바이스 | iPhone 6 , iPad Air | |테스트 플랫폼 | iOS 9.3, iOS 10.0 | |추가 라이브러리 적용|N/A| ==== 제약사항 ==== === 지원 디바이스 및 플랫폼 === == iPhone 의 경우 장치의 연산속도에 따른 문제가 발생할 수 있다. == * 문제 : 폰갭 오류시. * 해결방안 : setTimeout() 함수로 phonegap 로딩 순서를 지연시킨다.\\ document.addEventListener('DOMContentLoaded', function () { setTimeout(loaded, 200); }, false); * 문제 : iScroll5 컨텐츠 내용 높이 계산 오류. * 해결방안 : setTimeout() 함수로 컨텐츠에 css 적용이 완료되고 iscroll 생성이 되도록 한다. setTimeout(function() { myScroll = new iScroll(thisPage, { checkDOMChanges: true, onBeforeScrollStart:function(e) { } }); }, 500); == 알림 설정 시간은 최소 10초이상으로 설정한다. (validation 조건) == === 크로스 도메인 사용 === 폰갭에서 특정 외부 도메인이나 외부 도메인의 하위 도메인을 사용해야할 경우,\\ [Project_Name]/Supporting/config.xml에서 항목에 외부 도메인 주소를 추가 설정해야 외부 도메인에 접속할 수 있다. === 라이선스 === N/A ===== 설명 ===== Vibrator 디바이스API 가이드 프로그램은 크게 알림 정보를 설정 및 표시 하는 기능과 설정한 알림 정보를 웹 서버 어플리케이션으로 전송 및 조회하는 기능으로 구성되어 있다.(관련기능 부분참조) === 클래스 다이어그램 === {{:egovframework:hyb:guide:add:egovframework_hyb_guide_add_vibrator_클래스다이어그램.png?1024}} ==== Device Application ==== === 관련 소스 === ^유형^대상소스명^비고^ |CSS|assets/www/css/egovframwork/mbl/hyb/VibratorAPI.css |VibratorAPI 가이드 프로그램 주요 Cascading Style Sheets| |IMAGE |assets/www/images/egovframwork/mbl/hyb/ |VibratorAPI 가이드 프로그램 주요 Image 폴더| |JS |assets/www/js/egovframwork/mbl/hyb/VibratorAPI.js |VibratorAPI 가이드 프로그램 주요 JavaScript| |HTML|assets/www/VibratorAPI.html|VibratorAPI 메인 페이지| |HTML|assets/www/license.html|VibratorAPI 라이센스 페이지| |HTML|assets/www/overview.html|VibratorAPI 기능설명 페이지| |HTML|assets/www/intro.html|VibratorAPI Intro 페이지| |RES | [Project_Name]/Resources/ |VibratorAPI 가이드 프로그램 주요 Resource 폴더| |PLIST | [Project_Name]/Resources/[Project_Name]-Info.plist | iOS 어플리케이션 설정 파일| === 활용 API === == notification.beep == * 단말기의 비프(beep)음을 재생한다. \\ * times: 반복되는 비프(beep)음 재생 횟수 \\ navigator.notification.beep(times); == notification.vibrate == * 지정한 시간 동안 단말기의 진동을 울리게 한다. \\ * Milliseconds 단위의 진동이 울리는 시간. \\ navigator.notification.vibrate(milliseconds); ==== Server Application ==== === 관련 소스 === ^유형^대상소스명^비고^ |Controller|egovframework.hyb.ios.vbr.web.EgovVibratoriOSAPIController.java|VibratorAPI 가이드 프로그램 Controller Class| |Service|egovframework.hyb.ios.vbr.service.EgovVibratoriOSAPIService.java|VibratorAPI 가이드 프로그램 Service Class| |ServiceImpl|egovframework.hyb.ios.vbr.service.impl.EgovVibratoriOSAPIServiceImpl.java|VibratorAPI 가이드 프로그램 ServiceImpl Class| |VO|egovframework.hyb.ios.vbr.service.VibratoriOSAPIDefaultVO.java|VibratorAPI 가이드 프로그램 VO Class| |VO|egovframework.hyb.ios.vbr.service.VibratoriOSAPIVO.java|VibratorAPI 가이드 프로그램 VO Class| |VO|egovframework.hyb.ios.vbr.service.VibratoriOSAPIXmlVO.java|VibratorAPI 가이드 프로그램 XML 관련 VO Class| |DAO|egovframework.hyb.ios.vbr.service.impl.VibratoriOSAPIDAO.java|VibratorAPI 가이드 프로그램 Dao Class| |QUERY XML|resources/egovframework/sqlmap/hyb/ios/vbr/EgovVibratoriOSAPIGuide_iOS_mysql.xml|VibratorAPI 가이드 프로그램 QUERY XML| |Idgen XML|resources/egovframework/spring/com/context-idgen.xml|VibratorAPI 가이드 프로그램 Id생성 Idgen XML| ==== 관련 테이블 ==== === 테이블명 === ^테이블명^테이블명(영문)^비고^ |VIBRATOR|알림 정보 관리| | === 테이블 명세서 === == 바이브레이터 == ^No.^컬럼^컬럼명^타입^길이^Null^KEY^ |1|SN|일련번호|NUMERIC|6|NotNull|pk| |2|UUID|UUID|VARCHAR|50|NotNull|pk| |3|TIMESTAMP|시간값|VARCHAR|20|Null| | === ERD === {{:egovframework:hyb:guide:ios:erd.jpg|}} ===== 환경설정 ===== Vibrator 디바이스API 가이드 프로그램에서 제공하는 모바일 디바이스의 알림 관련 기능을 활용하기 위하여 필요한 항목 및 그 환경 설정은 다음과 같다. ==== Device Application ==== === config.xml === == Plugins == == ExternalHosts == ==== Server Aplication ==== === resource/egovframework/sqlmap/sql-map-config_[DB명].xml === ===== 관련기능 ===== ==== 소리로 알림 ==== === 비즈니스 규칙 === 알림 설정 시간이 되면 Beep를 사용하여 사용자에게 알린다. === 관련코드 === function fn_egov_save_notificationConfig() { ... var setTime = $("#txtNotification").val(); if(fn_egov_network_check(true)) { setTimeout ( "fn_egov_set_alram()", setTime * 1000); jAlert("알람이 " + setTime + " 초 뒤에 설정 되었습니다.", "알림", "b"); } ... } function fn_egov_set_alram() { console.log("DeviceAPIGuide fn_egov_set_alram Success"); if($("#swchBeep").val() === "on") { navigator.notification.beep(3); } ... fn_egov_insert_data(); jAlert("알람", "알림", "b"); } === 관련화면 및 수행매뉴얼 === ^Action^URL^Controller method^QueryID^ |알림정보전송|/vbr/addVibratoriOSInfo.do|insertVibrator|"vibratoriOSAPIDAO.insertVibrator"| ^알람 설정 화면 ^ |{{:egovframework:hyb3.6:guide:iOS:vibrator:vibrator_set.png?320|}}| 소리로 알림 버튼을 On 으로 선택한 후, 설정시간과 함께 설정 완료 버튼을 클릭한다. \\ 단, 모든 입력데이터에 대해서 기본적인 validation을 확인하고, 조건이 불충분할 경우 오류 메시지가 출력된다. 기능설명 : **기능설명** 화면으로 이동한다. \\ 라이선스 : **라이선스** 화면으로 이동한다. \\ 소리로 알림 : 소리로 알림 기능을 위하여 On으로 선택한다. \\ 알림목록 : 알림 목록 조회 화면으로 이동한다. \\ 설정완료 : 해당 설정을 바탕으로 알림을 설정한다. \\ ==== 진동으로 알림 ==== === 비즈니스 규칙 === 알림 설정 시간이 되면 Vibrator를 사용하여 사용자에게 알립니다. === 관련코드 === function fn_egov_save_notificationConfig() { ... var setTime = $("#txtNotification").val(); if(fn_egov_network_check(true)) { setTimeout ( "fn_egov_set_alram()", setTime * 1000); jAlert("알람이 " + setTime + " 초 뒤에 설정 되었습니다.", "알림", "b"); } ... } function fn_egov_set_alram() { console.log("DeviceAPIGuide fn_egov_set_alram Success"); ... if($("#swchVibration").val() === "on") { navigator.notification.vibrate(3000); } ... fn_egov_insert_data(); jAlert("알람", "알림", "b"); } === 관련화면 및 수행매뉴얼 === ^Action^URL^Controller method^QueryID^ |알림정보전송|/vbr/addVibratoriOSInfo.do|insertVibrator|"vibratoriOSAPIDAO.insertVibrator"| ^알람설정 완료 화면 ^ 알람 화면 ^ |{{:egovframework:hyb3.6:guide:iOS:vibrator:vibrator_setcom.png?320|}}|{{:egovframework:hyb3.6:guide:iOS:vibrator:vibrator_vibrator.png?320|}}| 진동으로 알림 버튼을 On 으로 선택한 후, 설정시간과 함께 설정 완료 버튼을 클릭한다. \\ 단, 모든 입력데이터에 대해서 기본적인 validation을 확인하고, 조건이 불충분할 경우 오류 메시지가 출력된다. 기능설명 : **기능설명** 화면으로 이동한다. \\ 라이선스 : **라이선스** 화면으로 이동한다. \\ 진동으로 알림 : 소리로 알림 기능을 위하여 On으로 선택한다. \\ 알림목록 : 알림 목록 조회 화면으로 이동한다. \\ 설정완료 : 해당 설정을 바탕으로 알림을 설정한다. \\ ==== 알림 목록 보기 ==== === 비즈니스 규칙 === 서버에 저장된 알림 설정 정보를 화면에 표시한다. === 관련코드 === function fn_egov_select_data() { var url = "/vbr/VibratoriOSInfoList.do"; var acceptType = "xml"; $.mobile.showPageLoadingMsg(); egovHyb.post(url, acceptType, {}, function(xmldata) { console.log("DeviceAPIGuide fn_egov_select_data request Completed"); fn_egov_go_detailPage(xmldata); }); } === 관련화면 및 수행매뉴얼 === ^Action^URL^Controller method^QueryID^ |알림정보조회|/vbr/VibratoriOSInfoList.do|selectVibratorInfoList|"vibratoriOSAPIDAO.selectVibratorList"| ^ 알람 목록조회 화면 ^ |{{:egovframework:hyb3.6:guide:iOS:vibrator:vibrator_list.png?320|}}| 서버에 저장된 알림 정보 목록을 디바이스의 화면에 표시한다. 기능설명 : **기능설명** 화면으로 이동한다. \\ 라이선스 : **라이선스** 화면으로 이동한다. \\ ===== 컴파일 디버깅 배포 ===== ==== 컴파일 ==== === Device Applicaton 컴파일 방법 === * 왼쪽 상단의 삼각형 버튼을 클릭하면 가이드 프로그램이 빌드되어 아이폰 디바이스에 설치 된다. {{:egovframework:hyb3.6:guide:mbl:ios_app_compile.png?740|}} * 빌드가 성공하면 아래와 같은 어플리케이션 실행화면을 확인 할 수 있다. {{:egovframework:hyb3.6:guide:ios:vibrator:vibrator_run.png?320|}} === Server Applicaton 컴파일 방법 === * 서버사이드 가이드 프로그램의 실행은 프로젝트를 마우스 오른쪽 버튼을 클릭 한후 Run As>Run On Server 버튼을 통해 실행 할 수 있다. {{:egovframework:hyb:guide:ios:서버실행.png?640|}} * 빌드가 성공적으로 수행 되면 이클립스의 콘솔 창에서 'Server Startup in xxx ms' 메시지를 확인 할 수 있다. {{:egovframework:hyb:guide:add:서버실행결과_콘솔.png?840|}} ==== 디버깅 ==== 디바이스 어플리케이션에서 발생한 오류 내용 확인 및 디버깅을 위해서는 폰갭 프레임워크에서 제공하는 console.log를 이용할 수 있다. console.log 함수는 자바스크립트 구문에서 사용할 수 있는 디버그 코드로 이클립스 및 Xcode에서 확인 할 수 있다. * 실제 콘솔 로그 예 function fn_egov_network_check(doCheck) { console.log('DeviceAPIGuide fn_egov_network_check'); var networkState = navigator.network.connection.type; ... } * xCode 콘솔 창 {{:egovframework:hyb:guide:ios:vibratordebugxcode.png?700|}}\\ ^로그 메시지^값^비고^ |DeviceAPIGuide fn_egov_network_check|네트워크 상태 체크| | |DeviceAPIGuide fn_egov_sendto_server Response Completed|서버에 요청한 내용이 성공적으로 처리 된 경우| | |DeviceAPIGuide fn_egov_sendto_server Response Failed|서버 내부 처리 오류| | |DeviceAPIGuide fn_egov_sendto_server Request Failed|통신 오류| | ==== 배포 ==== Vibrator 디바이스 API 가이드 다운로드 : [[http://www.egovframe.go.kr/cop/bbs/selectBoardArticle.do?bbsId=BBSMSTR_000000000161&nttId=1276&menu=3&submenu=9|Click]] ===== 참고자료 ===== * Cordova : [[https://cordova.apache.org|Click]] \\ * UX/UI 라이브러리 : jQuery Mobile[[http://jquerymobile.com/demos/1.4.5/|Click]] \\