Kihun Song / GitHub_HardwareProjects - Files

    1 Branches
    Close Menu
    Help

    Files

    View on GitHub
    Install Extension
    Last update 1 year 7 months by Kihun Song
    FilesLoRaSKT_IM-LM400SKT_DocumentsthingplugAPI_PythonExample
    ..
    image
    README.md
    create_subscription.py
    delete_subscription.py
    get_device_list.py
    get_latest_data.py
    login.py
    mgmtCmd.py
    retrieve_subscription.py
    subscription_mqtt.py
    thingplug_bridge.py
    		 
    README.md
    Examples
    


    ThingPlug 계정의 uKey 가져 오기
    


    login.py는 ThingPlug에 접속하기 위한 User ID와 User Password를 이용하여 uKey를 요청하는 예제 이다.
    


    uKey란 ThingPlug의 Northbound (ThingPlug API to Application Server) API 접근 권한을 위한 Access Token으로 해당 uKey는 ThingPlug 홈페이지의 회원 가입시 발급 가능 하다.
    


    $ python login.py --help

    


    usage: login.py [-h] -u USERID -p USERPW [-th THINGPLUGHOST]
                [-tp THINGPLUGPORT]
    


    ThingPlug Login Example
    


    optional arguments:
  -h, --help            show this help message and exit
  -u USERID, --userid USERID
                        ThingPlug User ID
  -p USERPW, --userpw USERPW
                        ThingPlug User Password
  -th THINGPLUGHOST, --thingplughost THINGPLUGHOST
                        ThingPlug Host IP(Default:onem2m.sktiot.com)
  -tp THINGPLUGPORT, --thingplugport THINGPLUGPORT
                        ThingPlug Port(Default:9443)

    


    $ python login.py -u USERID -p USERPASSWORD

    


    INFO:Login Success
ZG9qcUNscTA3RlhLZ.............................................

    


    THINGPLUG_HOST와 THINGPLUG_PORT를 별도로 입력하지 않으면, Default 값으로 onem2m.sktiot.com과 9443번 포트를 이용한다.
    


    $ python login.py -u USERID -p USERPASSWORD -th onem2m.sktiot.com -tp 9443

    


    등록된 Device List 가져오기
    


    get_device_list.py는 ThingPlug의 계정에 등록되어 있는 Device들의 List를 요청하는 예제 이다.
    


    $ python getdevicelist.py --help

    


    usage: getdevicelist.py [-h] -u USERID -p USERPW [-th THINGPLUGHOST]
                          [-tp THINGPLUGPORT]
    


    ThingPlug Login Example
    


    optional arguments:
  -h, --help            show this help message and exit
  -u USERID, --userid USERID
                        ThingPlug User ID
  -p USERPW, --userpw USERPW
                        ThingPlug User Password
  -th THINGPLUGHOST, --thingplughost THINGPLUGHOST
                        ThingPlug Host IP(Default:onem2m.sktiot.com)
  -tp THINGPLUGPORT, --thingplugport THINGPLUGPORT
                        ThingPlug Port(Default:9443)

    


    아래와 같이 명령을 수행하면 내 계정에 등록되어 있는 Device의 갯수와 Device ID를 확인 할 수 있다.
    


    $ python getdevicelist.py -u USERID -p USERPASSWORD

    


    INFO:Login Success
INFO:0008DC000000
INFO:0008DC000001
INFO:0008DC000002
(True, u'3', [u'0008DC000000', u'0008DC000001', u'0008DC000002'])

    


    -th(THINGPLUG_HOST)와 -tp(THINGPLUG_PORT) 옵션은 login.py와 동일 하다.
    


    Device 주기 보고의 최신 값 가져오기
    


    get_latest_data.py는 Device의 주기보고로 저장된 값 중에서 가장 최신에 저장된 값을 확인하기 위한 예제 이다.
    


    $ python getlatestdata.py --help

    


    usage: getlatestdata.py [-h] -u USERID -p USERPW -ni NODEID -ct CONTAINER
                          -ae APPEUI [-th THINGPLUGHOST]
                          [-tp THINGPLUGPORT] [-pt PERIODTIME]
                          [-el ENABLELOG]
    


    ThingPlug Login Example
    


    optional arguments:
  -h, --help            show this help message and exit
  -u USERID, --userid USERID
                        ThingPlug User ID
  -p USERPW, --userpw USERPW
                        ThingPlug User Password
  -ni NODEID, --nodeid NODEID
                        ThingPlug Node ID
  -ct CONTAINER, --container CONTAINER
                        ThingPlug Container Name
  -ae APPEUI, --appeui APPEUI
                        ThingPlug APP EUI
  -th THINGPLUGHOST, --thingplughost THINGPLUGHOST
                        ThingPlug Host IP(Default:onem2m.sktiot.com)
  -tp THINGPLUGPORT, --thingplugport THINGPLUGPORT
                        ThingPlug Port(Default:9443)
  -pt PERIODTIME, --periodtime PERIODTIME
                        Get Latest Data Period Time(Default:0,One Time)
  -el ENABLELOG, --enablelog ENABLELOG

    


    아래와 같은 명령을 수행하면 해당 USER_ID에 등록되어 있는 DEVICE_ID의 최신 주기보고 값을 확인 할 수 있다.
출력되는 메시지 포맷은 아래와 같습니다.
<현재 시간>,<최신 주기보고 값>,<lt(lastModifiedTime)>
    


    python getlatestdata.py -u USERID -p PASSWORD -ni DEVICEID -ct CONTAINER -ae APP_EUI

    


    INFO:Login Success
2017-03-15 09:21:45.860000,1001,20170314133418042

    


    주기적으로 DEVICE_ID에 대한 최신 주기보고 값을 확인 하려면, 아래와 같이 -pt 옵션을 사용하면 된다. (단위:초)
    


    python getlatestdata.py -u USERID -p PASSWORD -ni DEVICEID -ct CONTAINER -ae APP_EUI -pt 60

    


    INFO:Login Success
2017-03-15 09:56:16.998000,1001,20170314133418042
2017-03-15 09:57:17.311000,1001,20170314133418042
2017-03-15 09:58:17.475000,1001,20170314133418042

    


    -el 옵션을 이용하면 주기적으로 출력되는 값을 파일로 저장 할 수 있다. 사용 방법은 아래와 같다.
    


    python getlatestdata.py -u USERID -p PASSWORD -ni DEVICEID -ct CONTAINER -ae APP_EUI -pt 60 -el 1

    


    출력되는 메시지는 아래와 같다. 출력된 메시지는 get_latest_data.py 파일과 같은 경로의 get_latest_data.log 파일에 저장된다.
    


    INFO:Login Success
2017-03-15 10:04:45.912000,1001,20170314133418042

    


    Application Server에서 Push 메시지를 전달 받기 위한 예제
    


    ThingPlug에서는 구독(Subscription) 및 통지(Notification)을 위한 API를 제공한다. 이는 마치 신문을 배달 받는 것과 같다. 어떤 신문을 구독하려면 신문사에 연락해서 계약을 진행한다. 이런 행위를 구독이라고 한다. 이때 계약자는 배달 받을 주소와 배달 받는 신문의 종류 및 배달 주기 등을 전달하고, 계약에 따라 신문이 나오면 희망 배달지에 배달 즉, 통지되는 형태로 서비스가 진행된다. < ThingPlug_API_Document 참고 >
    


    아래 그림과 같이, 온도정보를 감시하기 위한 장치에서 ThingPlug에게 온도센서 장치의 값을 구독 하겠다고 요청 할 수 있다.
구독 요청이 완료되면, ThingPlug에서는 온도센서 장치의 주기보고 값을 모니터링 하고 있다가 온도 값이 변경하면 구독 요청 시 등록한 NotificationURI에게 온도 값을 전달 하는 구조로 동작 한다.
    


    


    Subscription_mqtt
    


    디바이스에서 송신한 데이터 값이 변경 되거나 특정 조건이 발생할 때 통지(Notification) 메시지 또는 푸시(Push) 메시지를 ThingPlug 서버가 보내도록 설정 할 수 있다.
subscription_mqtt.py는 통지 메시지를 MQTT로 수신 할 수 있도록 ThingPlug를 설정하는 예제이며, 아래와 같은 옵션을 이용 할 수 있다.
통지 메시지를 수신 하기 위한 방법은 MQTT, HTTP 두가지 방법이 있다. 단 HTTP 방식으로 메시지를 수신 할 경우, 장치의 IP 주소는 공인 IP가 아닌 환경이거나 유동 IP를 사용하는 경우 별도의 설정이 필요한 제약이 있다.
    


    python subscription_mqtt.py --help

    


    usage: subscriptionmqtt.py [-h] -u USERID -p USERPW -ae APPEUI
                            [-ni NODEID] [-ct CONTAINER] [-th THINGPLUGHOST]
                            [-tp THINGPLUGPORT] [-ci MQTTCLIENT_ID]
    


    ThingPlug Login Example
    


    optional arguments:
  -h, --help            show this help message and exit
  -u USERID, --userid USERID
                        ThingPlug User ID
  -p USERPW, --userpw USERPW
                        ThingPlug User Password
  -ae APPEUI, --appeui APPEUI
                        ThingPlug APP EUI
  -ni NODEID, --nodeid NODEID
                        ThingPlug Node ID
  -ct CONTAINER, --container CONTAINER
                        ThingPlug Container Name(Default:LoRa)
  -th THINGPLUGHOST, --thingplughost THINGPLUGHOST
                        ThingPlug Host IP(Default:onem2m.sktiot.com)
  -tp THINGPLUGPORT, --thingplugport THINGPLUGPORT
                        ThingPlug Port(Default:9443)
  -ci MQTTCLIENTID, --mqttclientid MQTTCLIENTID
                        ThingPlug MQTT Client ID(Deafult:bridge)

    


    $ python subscriptionmqtt.py -u USERID -p PASSWORD -ae APP_EUI -ct CONTAINER

    


    INFO:Login Success
INFO:000000123456789123456789
thingplug_00000037d02544fffef04f10
INFO:registered subscription
INFO:subscription is deleted
INFO:subscription is created
INFO:mqtt connected
2017-03-15 12:34:01.040000,1123,2017-03-15T12:34:03+09:00
2017-03-15 12:34:31.466000,1125,2017-03-15T12:34:34+09:00
    Report a bug