Compass 디바이스API 가이드 프로그램

개요

Compass 가이드 프로그램은 모바일 디바이스 API 실행환경을 활용하여 하이브리드 앱을 개발 시 참고 및 활용될 수 있도록 구현된 전자정부 디바이스 API에 대한 가이드 앱으로써, 모바일 스마트 디바이스의 Compass 관련 기능을 JavaScript 기반으로 구성 된 Compass DeviceAPI 를 통하여 조회 할 수 있도록 지원한다.

또한, 전자정부 표준프레임워크 기반의 웹 서버 어플리케이션과 연계하여 디바이스 내 Compass 정보를 서버로 전송 및 조회 할 수 있는 기능으로 구성되어 있다.

특징

본 가이드 프로그램 에서는 Compass 기능을 가이드 할 수 있도록 나침반 정보 조회 , 나침반 정보 저장 , 나침반 정보 목록 , 리스트 삭제 기능을 제공하고 있으며.

효율적인 나침반 정보 변화의 조회를 위해 상단의 알림 창 이외에 나침반 형태의 도형의 움직임을 통해 정보를 조회할 수 있으며, 디바이스의 나침반 정보의 변화에 따라 해당 방향으로 회전한다.

기능흐름도

기능시퀀스

전제조건

구분 내용
Local 디바이스 개발 환경전자정부표준프레임워크 개발환경3.5, Android SDK API 22(version 5.0 Lollipop)
서버 사이드 개발 환경전자정부표준프레임워크 개발환경3.5
Mash up Open API 연계N/A
테스트 디바이스 갤럭시S2
테스트 플랫폼 Android 2.3
추가 라이브러리 적용N/A

제약사항

구분 내용
지원 디바이스 및 플랫폼가속도 정보 조회의 시각적 효과를 위해 나침반 형태의 이미지 회전을 제공하고 있어,
가로 모드로 보기 시 화면이 잘려 보이는 경우가 발생할 수 있어 디바이스 API 가이드 프로그램 실행 시 가로보기 모드는 자동변환 되지 않도록 설정하고 테스트 하는것이 좋다.
크로스 도메인 사용폰갭에서 특정 외부 도메인이나 외부 도메인의 하위 도메인을 사용해야할 경우,
Res/xml/config.xml에서 <access origin=”” />에 외부 도메인 주소를 추가 설정해야 외부 도메인에 접속할 수 있다.
라이선스N/A

설명

Compass 디바이스API 가이드 프로그램은 크게 디바이스의 Compass 정보를 조회하고 조회 한 정보를 웹 서버 어플리케이션으로 전송 및 조회하는 기능으로 구성되어 있다.(관련기능 부분참조)

클래스 다이어그램

Device Application

관련 소스

유형대상소스명비고
Activitykr.go.egovframework.hyb.compassapi.CompassAPIGuide_AndroidActivityCompassAPI 가이드 프로그램 Activity Class
CSSassets/www/css/egovframwork/mbl/hyb/CompassAPI.css CompassAPI 가이드 프로그램 주요 Cascading Style Sheets
IMAGE assets/www/images/egovframwork/mbl/hyb/ CompassAPI 가이드 프로그램 주요 Image 폴더
JS assets/www/js/egovframwork/mbl/hyb/CompassAPI.js CompassAPI 가이드 프로그램 주요 JavaScript
JS assets/www/js/egovframwork/mbl/hyb/messages_ko.js Validate 메세지 처리 JavaScript
RES assets/www/res/ CompassAPI 가이드 프로그램 주요 Resource 폴더
XML AndroidManiFest.xml 안드로이드 어플리케이션 설정 XML
HTMLassets/www/CompassAPI.htmlCompassAPI 메인 페이지
HTMLassets/www/intro.htmlCompassAPI Intro 페이지
HTMLassets/www/license.htmlCompassAPI 라이센스 페이지
HTMLassets/www/overview.htmlCompassAPI 기능설명 페이지

활용 API

compass.watchHeading
  • 디바이스의 현재 방향각 정보를 가져온다.
navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
function onSuccess(heading) {
    alert('Heading: ' + heading.magneticHeading);
};

function onError(error) {
    alert('CompassError: ' + error.code);
};

navigator.compass.getCurrentHeading(onSuccess, onError);
compassOption
Option설명비고
frequency 나침반 정보를 조회하는 빈도를 의미한다.
frequency 나침반 성공 콜백함수를 초기화 하는데 필요한 변화의 정도를 의미한다.

Server Application

관련 소스

유형대상소스명비고
Controlleregovframework.hyb.add.cps.web.EgovCompassAndroidAPIController.javaCompassAPI 가이드 프로그램 Controller Class
Serviceegovframework.hyb.add.cps.service.EgovCompassAndroidAPIService.javaCompassAPI 가이드 프로그램 Service Class
ServiceImplegovframework.hyb.add.cps.service.impl.EgovCompassAndroidAPIServiceImpl.javaCompassAPI 가이드 프로그램 ServiceImpl Class
VOegovframework.hyb.add.cps.service.CompassAndroidAPIDefaultVO.javaCompassAPI 가이드 프로그램 VO Class
VOegovframework.hyb.add.cps.service.CompassAndroidAPIFileVO.javaCompassAPI 가이드 프로그램 VO Class
VOegovframework.hyb.add.cps.service.CompassAndroidAPIVO.javaCompassAPI 가이드 프로그램 VO Class
VOegovframework.hyb.add.cps.service.CompassAndroidAPIXmlVO.javaCompassAPI 가이드 프로그램 XML 관련 VO Class
DAOegovframework.hyb.add.cps.service.impl.CompassAndroidAPIDAO.javaCompassAPI 가이드 프로그램 Dao Class
Utilegovframework.hyb.add.cps.service.impl.EgovCompassAndroidFileMngUtil.javaCompassAPI 가이드 프로그램 Util Class
QUERY XMLresources/egovframework/sqlmap/hyb/add/cps/EgovCompassAndroidAPIGuide_XXX_mysql.xmlCompassAPI 가이드 프로그램 QUERY XML
Idgen XMLresources/egovframework/spring/com/context-idgen.xmlCompassAPI 가이드 프로그램 Id생성 Idgen XML

관련 테이블

테이블명테이블명(영문)비고
compassCOMPASS나침반 정보 관리

테이블 정의서

  • Compass
No. 컬럼ID 컬럼명 타입 길이 NULL
1 SN 일련번호 NUMERIC 6 NotNull
2 UUID UUID VARCHAR 50 NotNull
3 DRC 방향 VARCHAR 40 Null
4 ACCRCY 정확도 VARCHAR 10 Null
5 USEYN 활성화여부 CHAR 1 Null
6 TIMESTAMP timestamp VARCHAR 20 Null

ERD

환경설정

Compass 디바이스API 가이드 프로그램에서 제공하는 모바일 디바이스의 Compass 관련 기능을 활용하기 위하여 필요한 항목 및 그 환경 설정은 다음과 같다.

Device Application

res/xml/config.xml

    <!--전자정부 Interface 디바이스 API를 사용하기 위한 Phonegap Plugin 클래스-->
    <plugin name="EgovInterfacePlugin" value="kr.go.egovframework.hyb.plugin.EgovInterfacePlugin" />

res/values/serverinfo.xml

    <!--전자정부 Interface 디바이스 API에서 사용하기 위한 서버경로 설정-->
    <?xml version="1.0" encoding="utf-8"?>
    <resources>
	<string name="SERVER_URL">http://192.168.100.222:8080/DeviceAPIGuideTotal_Web_V1.7.1</string>
    </resources>

AndroidManifest.xml

	<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

Server Application

context-properties.xml

  • 업로드 된 파일 저장 위치
<entry key="fileStorePath" value="파일_저장_경로"/>

resource/egovframework/sqlmap/sql-map-config_[DB명].xml

<sqlMap resource="egovframework/sqlmap/hyb/add/acl/EgovCompassAndroidAPIGuide_SQL_[DB명].xml"/>

관련기능

Compass 디바이스 API 가이드 프로그램은 크게 디바이스의 나침반 정보를 조회 하는 나침반 정보 조회 기능 및 서버 연계를 통한 나침반 정보 저장, 나침반 정보 목록 조회, 나침반 정보 삭제 기능으로 구성되어있다.

나침반 정보 조회

비즈니스 규칙

디바이스 API를 통해 현재 나침반 정보를 호출하여, 나침반 정보를 모니터링 창에 표시 및 나침반 형태의 도형을 통해 디바이스의 방향에 따라 도형을 회전한다.

관련코드

디바이스 API 내의 Compass 함수를 사용하는 JavaScript 코드를 통해 실시간 나침반 정보를 조회 한다.


function fn_egov_update_heading(h) 
{
	drc = h.magneticHeading;
	accrcy = h.headingAccuracy;
	timestamp=  h.timestamp;
	
	// 새로운 각도 값을 받아옴
	newHeading = Math.round(drc);	

	$("#compassMain").trigger("newHeading", newHeading);
		
    var html = "방위각 : " + drc + "<BR />";

    $("#infoDetail").html(html);
    if(CompassInsertCheck) 
    {
        CompassInsertCheck = false;
    }
    console.log("DeviceAPIGuide fn_egov_update_heading Success"); 
}

function fn_egov_get_compass() 
{
    if (CompasswatchID === null) 
    {
                
        //alert("Compass start");
        //toast("Compass start");
        CompassInsertCheck = true;
        var options = { frequency: 1 };
        CompasswatchID = navigator.compass.watchHeading(fn_egov_update_heading, 
                                                        function(e) 
                                                        {
                                                        console.log("DeviceAPIGuide fn_egov_get_compass fail");
                                                        }, 
                                                        options);
    } 
    else 
    {    
    	
    	compassEvent();
    	
        navigator.compass.clearWatch(CompasswatchID);
        CompasswatchID = null;
        fn_egov_update_heading({ drc : "Off"});
        //navigator.notification.alert("Compass stop");
        //toast("Compass stop");
    }
}

관련화면 및 수행매뉴얼

나침반 정보 조회 화면
 --- //[[leemj@hit.co.kr|공통서비스]] 2012/09/11 18:15//

나침반 정보 저장

비즈니스 규칙

조회 된 나침반 정보를 서버에 전송하여 리스트 형태로 저장한다.

관련코드


function fn_registCompassInfo() {
	
	useYn = "Y";
			
	var url = "/cps/xml/addCompassInfo.do"; 
	var accept_type = "json";
	var params = {uuid :  device.uuid,
			drc: drc + '', 
			accrcy: accrcy + '', 
			timestamp: timestamp + '', 
			useYn:  useYn};	
	
	// send the data
	egovHyb.post(url, accept_type, params, function(jsondata) {
		var data = JSON.parse(jsondata);
		
		if(data.useYn == "OK"){
			//fn_goCompassInfoListXml();
		}else{
			$("#alert_dialog").click( function() {
				jAlert('데이터 전송 중 오류가 발생 했습니다.', '전송 오류', 'c');
				});
		}			
		
	});

	console.log("DeviceAPIGuide fn_registCompassInfo request Completed");
    
}

관련화면 및 수행매뉴얼

기능URLControllermethod화면(HTML)
나침반 정보 서버로 송신하기 /cps/xml/addCompassInfo.do EgovCompassAndroidAPIController addCompassInfoXml CompassAPI.html

정보데이터를 서버로 송신하기 위해서는 나침반 정보 저장 버튼을 클릭하면 된다.

나침반 정보 저장 : 나침반 정보를 서버로 송신하기 위해서는 하단의 나침반 정보 저장 버튼을 클릭한다.
나침반 정보 목록 : 나침반 정보 목록 화면으로 이동한다.

나침반 정보 목록

비즈니스 규칙

서버에 저장 되어있는 나침반 정보 목록을 리스트 형태로 출력한다.

관련코드

function fn_goCompassInfoListXml()
{
	if(!fn_egov_network_check(false)){
		return;
	}
	var url = "/cps/xml/compassInfoList.do";
	var accept_type = "xml";
	// get the data from server
	window.plugins.EgovInterface.get(url,accept_type, null, function(xmldata) {
		var list_html = "";
		
		$(xmldata).find("compassInfoList").each(function(){
            var uuid = $(this).find("uuid").text();
            var x = $(this).find("drc").text();
            var y = $(this).find("accrcy").text();
            var t = $(this).find("timestamp").text();

			list_html += "<li><h3>UUID : " + uuid + "</h3>";
			list_html += "<p><strong>drc : " + x + "</strong></p>";
			list_html += "<p><strong>accrcy : " + y + "</strong></p>";
			list_html += "<p>timestamp : " + t + "</p></li>";
        });
		var theList = $('#theList');
		theList.html(list_html);
		$.mobile.changePage($("#compassInfoList"), {reverse: true});
		theList.listview("refresh");
		
	});
}

관련화면 및 수행매뉴얼

기능URLControllermethod화면(HTML)
나침반 정보 목록 조회하기/cps/xml/compassInfoList.do EgovCompassAndroidAPIController selectCompassInfoXMLList CompassAPI.html
나침반 정보 목록 화면

서버에 저장 되어있는 나침반 정보 목록을 조회하기 위해서는 나침반 정보 목록 버튼을 클릭하면 된다.

나침반 정보 저장 : 나침반 정보를 서버로 송신하기 위해서는 하단의 나침반 정보 저장 버튼을 클릭한다.
나침반 정보 목록 : 나침반 정보 목록 화면으로 이동한다.
나침반 정보 조회 : 나침반 정보 조회 화면으로 이동한다.
나침반 정보 삭제 : 서버에 저장 되어있는 나침반 목록을 초기화 하기 위해서는 나침반 정보 삭제 버튼을 클릭한다.

나침반 정보 삭제

비즈니스 규칙

서버에 저장 되어있는 나침반 정보 목록을 초기화 한다.

관련코드


function fn_deleteCompassInfoList() {
	var url = "/cps/xml/withdrawal.do";
	var accept_type = "json";
	// send the data
	egovHyb.post(url, accept_type, null, function(jsondata) {
		var data = JSON.parse(jsondata);
		
		if(data.useYn == "OK"){
			$.mobile.changePage($("#compassMain"), {reverse: true});
		}else{
			$("#alert_dialog").click( function() {
				jAlert('데이터 삭제 중 오류가 발생 했습니다.', '삭제 오류', 'c');
				});
		}
		
	});

	console.log("DeviceAPIGuide fn_deleteCompassInfoList request Completed");
	    
}

관련화면 및 수행매뉴얼

기능URLControllermethod화면(HTML)
나침반 정보 목록 초기화하기/cps/xml/withdrawal.do EgovCompassAndroidAPIController withdrawalXml CompassAPI.html

서버에 저장 되어있는 나침반 정보 목록을 초기화하기 위해서는 나침반 정보 목록 화면 하단의 나침반 정보 삭제 버튼을 클릭하면 된다.

나침반 정보 저장 : 나침반 정보를 서버로 송신하기 위해서는 하단의 나침반 정보 저장 버튼을 클릭한다.
나침반 정보 목록 : 나침반 정보 목록 화면으로 이동한다.
나침반 정보 조회 : 나침반 정보 조회 화면으로 이동한다.
나침반 정보 삭제 : 서버에 저장 되어있는 나침반 목록을 초기화 하기 위해서는 나침반 정보 삭제 버튼을 클릭한다.

컴파일 디버깅 배포

컴파일

CompassAPI Device Applicaton 컴파일 방법

  • 프로젝트 선택 > 오른쪽 클릭 > Run As > Android Application

  • 상단의 메뉴 > Run As > Android Application

  • 실행할 타겟 선택 > 에뮬레이터, 디바이스(디버깅모드)

  • 에뮬레이터를 이용한 실행 화면

  • 디바이스를 이용한 실행 화면

DeviceInfoAPI Server Applicaton 컴파일 방법

  • DeviceInfoAPI 서버사이드 가이드 프로그램의 실행은 프로젝트를 마우스 오른쪽 버튼을 클릭 한후 Run As>Run On Server 버튼을 통해 실행 할 수 있다.

  • 빌드가 성공적으로 수행 되면 이클립스의 콘솔 창에서 'Server Startup in xxx ms' 메시지를 확인 할 수 있다.

디버깅

디바이스 어플리케이션에서 발생한 오류 내용 확인 및 디버깅을 위해서는 폰갭 프레임워크에서 제공하는 console.log를 이용할 수 있다. console.log 함수는 자바스크립트 구문에서 사용할 수 있는 디버그 코드로 이클립스 및 Xcode에서 확인 할 수 있다.

console.log의 작성 방법의 예시는 다음과 같다.

function fn_egov_network_check(doCheck)
{
    console.log('DeviceAPIGuide fn_egov_network_check');
    var networkState = navigator.network.connection.type;
    ...
}

디버깅 코드가 실행 되면 아래와 같은 메시지를 개발도구의 콘솔 메시지 창에서 볼 수 있다.

DeviceInfo 디바이스 API 가이드 프로그램 에서는 디버깅을 위하여 다음과 같이 콘솔 정보를 출력한다.

디버그 코드디버깅 내용
DeviceAPIGuide fn_registCompassInfo request Completed 디바이스의 Compass 정보를 서버로 업데이트 성공 시
DeviceAPIGuide fn_deleteCompassInfoList request Completed서버내의 Compass 정보 초기화 성공 시
DeviceAPIGuide fn_egov_update_heading Success디바이스의 Compass 정보 조회 후 관련 변수에 해당 정보 업데이트 성공 시
DeviceAPIGuide fn_egov_get_compass fail디바이스의 Compass 정보 조회 실패 시

배포

Compass 디바이스 API 가이드 다운로드 : Click

참고자료

  • UX/UI 라이브러리 : jQuery MobileClick
  • Phonegap 4.3.0 : Click
 
egovframework/hyb3.5/guide/add/compass.txt · 마지막 수정: 2015/05/31 18:56 (외부 편집기)
 
이 위키의 내용은 다음의 라이센스에 따릅니다 :CC Attribution-Noncommercial-Share Alike 3.0 Unported
전자정부 표준프레임워크 라이센스(바로가기)

전자정부 표준프레임워크 활용의 안정성 보장을 위해 위험성을 지속적으로 모니터링하고 있으나, 오픈소스의 특성상 문제가 발생할 수 있습니다.
전자정부 표준프레임워크는 Apache 2.0 라이선스를 따르고 있는 오픈소스 프로그램입니다. Apache 2.0 라이선스에 따라 표준프레임워크를 활용하여 발생된 업무중단, 컴퓨터 고장 또는 오동작으로 인한 손해 등에 대해서 책임이 없습니다.
Recent changes RSS feed CC Attribution-Noncommercial-Share Alike 3.0 Unported Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki