wipdevice 0.0.1__tar.gz

wipdevice-0.0.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: wipdevice
+Version: 0.0.1
+Summary: Wow IoT Platform API libraries
+Home-page: https://github.com/WOWSYSTEM/WIP-Python
+Author: wowsystem, nobu
+Author-email: contact@wowsystem.co.kr
+License: UNKNOWN
+Keywords: wowsystem,IoT,WIP,IoT Platform,IoT Server,wowsystem,WOW IoT Platform
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.6
+
+UNKNOWN
+

wipdevice-0.0.1/README.md

@@ -0,0 +1,51 @@
+# WOW IoT Platform Python Library
+
+**프로젝트 개요**  
+WOW IoT Platform과 연동하여 사용할 수 있는 Python 라이브러리이다.
+간편하게 IoT Platform과 연동하여, 데이터 전송 및 제어 명령 수신이 가능하다.
+
+디바이스를 연동하기 위해선 IoT Platform에 로그인 후 디바이스를 등록하여야 사용할 수 있다.
+
+해당 라이브러리 개발 시 다양한 테스트 조건에도 문제 없이 Platform에 접속하여 사용할 수 있도록 최선을 다한다.
+
+
+## Getting Started
+- Python3.6 버전 이상 파이썬 설치
+- Visual Code 등으로 수정 가능
+- 최종 및 안정화 버전은 PyPI에 업로드 할 수 있으며, 관련 방법은 사내에서 공유되는 자료를 확인
+
+
+### Installing
+
+WIP Library를 사용하기 위해선 아래의 명령어로 설치 가능하다.
+```
+pip install wipdevice
+```
+
+만약 해당 라이브러리의 소스코드 개발 시 아래와 같이 Clone 가능하다.
+```
+gh repo clone WOWSYSTEM/WIP-Python
+```
+
+pip로 wipdevice를 설치하였다면, dependency로 설치되었겠지만 만약 설치 안한 경우 Crypto를 설치하여야 한다.
+```
+pip install Crypto
+```
+
+### Versioning
+* 업데이트 시 반드시 버전 관련 설정 수정할 것
+* 버전 수정안할 시 업데이트 사항이 정상적으로 적용안될 수 있다.
+
+
+## Built With / 누구랑 만들었나요?
+* [이승명(nobu)](nobu1015@naver.com, nobu1015@wowsystem.co.kr) - 무엇 무엇을 했어요
+
+## Contributiong / 기여
+
+Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. / [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) 를 읽고 이에 맞추어 pull request 를 해주세요.
+
+## License / 라이센스
+협의 필요
+
+## Acknowledgments
+* 화이팅

wipdevice-0.0.1/WIPClient/WIPClient.py

@@ -0,0 +1,280 @@
+import socket
+import time
+import threading
+from .interface import SocketManagerV2
+from .WIPClientAbstractModel import WIPClientAbstractModel
+
+class WIPClient(WIPClientAbstractModel, SocketManagerV2.SocketClient):
+    # ip : 연결할 서버의 IP
+    # port : 연결할 서버의 Port
+    # name : 연결할 서버를 구분하기 위한 용도 (ex: iotGateway, AutoVehicle, iotMakers .. 등등)
+    def __init__(self, ip="127.0.0.1", port=10008, device_id="device1", device_pw="00000000", isAutoConnect=True, live_receive=True, live_send=False, live_send_interval=1):
+        super().__init__(ip, port, "WOW Iot Platform", isAutoConnect=isAutoConnect, live_receive=live_receive)
+        self.device_id = str(device_id)
+        self.device_pw = str(device_pw)
+        self.isCertified = False
+
+        # 각 데이터가 노드 ID로 구분되기 때문에 WIP Client에서만 사용한다.
+        self.live_send = live_send
+        self.live_send_run = False
+        self.live_send_interval = live_send_interval
+        self.socketSendThread = None
+        self.sendDataQueues = {}
+
+    # 서버 자동 접속 쓰레드 호출 시 사용되는 함수 (필요 시 사용자 정의)
+    def _connectToServer(self):
+        certify_check_time = time.time()
+        print("[" + self.log_title + "] Connecting to {0}:{1}...".format(self.ip, self.port))
+        while(self.socketConnectThread_Enable):
+            try:
+                # 한 번 서버에 연결되면 연결이 끊어지기 전까지 더 이상 접속을 시도하지 않도록 함
+                if(not self.ser_socket_connect_status):
+                    self.ser_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+                    self.ser_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+                    self.ser_socket.connect((self.ip, self.port))
+                    self.ser_socket_connect_status = True
+
+                    self.ser_socket.send("{0},{1},{2}\n".format(self.device_id, self.device_pw, "S100").encode("utf-8"))
+
+                    # URL로부터 이미지를 읽어들일 경우 (영상 지연 문제로 쓰레드를 별도로 만들어 아래와 같이 비동기로 읽어들임)
+                    if(self.live_receive):
+                        self.live_receive_run = True
+                        self.receiveDataQueue.clear()
+                        self.socketReceiveThread = threading.Thread(target=self._receiveThread)
+                        self.socketReceiveThread.setDaemon(True)
+                        self.socketReceiveThread.start()
+
+                    if(self.live_send):
+                        self.live_send_run = True
+                        self.socketSendThread = threading.Thread(target=self._sendThread)
+                        self.socketSendThread.setDaemon(True)
+                        self.socketSendThread.start()
+
+                    print("[" + self.log_title + "] Server connection was successful.")
+                    certify_check_time = time.time() # 인증 체크 시간 초기화
+
+                # 접속 후 5초 넘게 인증이 완료되지 않았을 경우 재요청
+                elif (time.time() - certify_check_time >= 5) and not self.isCertified:
+                    certify_check_time = time.time()
+                    print("[" + self.log_title + "] Not certified long time. retry")
+                    self.ser_socket.send("{0},{1},{2}\n".format(self.device_id, self.device_pw, "S100").encode("utf-8"))
+
+            except socket.error as e:
+                print("[" + self.log_title + "] Connect to server process error " + str(e))
+                self.close()
+                continue
+
+            finally:
+                time.sleep(1)
+
+    # 소켓 서버에 IoT 데이터 전송. live_send에 따라 전송 방식이 달라짐
+    def sendData(self, values):
+        try:
+            if(type(values) != list):
+                print("[" + self.log_title + "] Invalid data format ({0})".format(value))
+                return
+            if(type(values[0]) != list):
+                values = [values] # to 2d array
+            
+            for value in values:
+                if(type(value) != list or len(value) != 3):
+                    print("[" + self.log_title + "] Invalid data format ({0})".format(value))
+                    continue
+                if(value[1] not in ["CS", "CN", "SS", "SN"]):
+                    print("[" + self.log_title + "] Invalid data type. ({0})".format(value[1]))
+                    continue
+                value_final = [self.device_id, self.device_pw] + value
+                tagData = ','.join(map(str, value_final)) + "\n"
+                tagPacket = tagData.encode('utf-8')
+                
+                if(self.live_send):
+                    if(self.live_send_run and self.socketSendThread.is_alive()):
+                        self.sendDataQueues[value[0]] = tagPacket
+                    # else:
+                    #     print("[" + self.log_title + "] {0}:{1} The connection with the socket has been terminated or closed. Data cannot be sent.".format(self.ip, self.port))
+                else:
+                    self.ser_socket.send(tagPacket)
+
+        except ConnectionResetError:
+            self.close()
+            print("[" + self.log_title + "] {0}:{1} The connection to the server has been lost.".format(self.ip, self.port))
+            pass
+        except socket.error as e:
+            self.close()
+            print("[" + self.log_title + "] {0}:{1} The connection to the server has been lost.".format(self.ip, self.port))
+            pass
+        finally:
+            pass
+
+    # 소켓 서버에 IoT 데이터 즉시 전송
+    def sendDataDirect(self, values):
+        try:
+            if(type(values) != list):
+                print("[" + self.log_title + "] Invalid data format ({0})".format(value))
+                return
+            if(type(values[0]) != list):
+                values = [values] # to 2d array
+            
+            for value in values:
+                if(type(value) != list or len(value) != 3):
+                    print("[" + self.log_title + "] Invalid data format ({0})".format(value))
+                    continue
+                if(value[1] not in ["CS", "CN", "SS", "SN"]):
+                    print("[" + self.log_title + "] Invalid data type. ({0})".format(value[1]))
+                    continue
+                value_final = [self.device_id, self.device_pw] + value
+                tagData = ','.join(map(str, value_final)) + "\n"
+                tagPacket = tagData.encode('utf-8')
+                
+                self.ser_socket.send(tagPacket)
+
+        except ConnectionResetError:
+            self.close()
+            print("[" + self.log_title + "] {0}:{1} The connection to the server has been lost.".format(self.ip, self.port))
+            pass
+        except socket.error as e:
+            self.close()
+            print("[" + self.log_title + "] {0}:{1} The connection to the server has been lost.".format(self.ip, self.port))
+            pass
+        finally:
+            pass
+
+    def _sendThread(self):
+        send_interval_time = 0
+        self_break = False
+
+        while(self.live_send_run):
+            try:
+                if time.time() - send_interval_time >= self.live_send_interval:
+                    send_interval_time = time.time()
+                    # 인증 된 상태인지 확인한다.
+                    if self.checkCertified() and len(self.sendDataQueues) > 0:
+                        for key, value in self.sendDataQueues.items():
+                            self.ser_socket.send(value)
+                            time.sleep(0.05)
+
+            except Exception as e:
+                self.live_send_run = False
+                print("[" + self.log_title + "] Problem processing data in _sendThread. => ", e)
+                break
+
+            finally:
+                time.sleep(0.01)
+
+    # 데이터 자동 수신 쓰레드 호출 시 사용되는 함수 (사용자 정의)
+    def _receiveThread(self):
+        data = ""
+        while(self.live_receive_run):
+            try:
+                data += self.ser_socket.recv(self.receiveBuffer).decode('utf-8')
+
+                if data is not None:
+                    if not (len(data) == 0):
+                        packets = data.split('\n')
+                        # 마지막 항목은 제외
+                        for i in range(len(packets) - 1):
+                            if len(packets[i]) > 5: # 못해도 5는 넘어야 정상적인 데이터 "A,B,C"
+                                data_str = packets[i].strip()
+                                data_list = data_str.split(',')
+                                if(len(data_list) == 3):
+                                    device_id = data_list[0]
+                                    device_pw = data_list[1]
+                                    status = data_list[2]
+                                    self.isCertified = (device_id == self.device_id and device_pw == self.device_pw and status == "S001")
+                                    if(not self.isCertified):
+                                        print("[" + self.log_title + "] Device not certified. Please check your ID and password again.")
+                                elif(len(data_list) == 5):
+                                    device_id = data_list[0]
+                                    device_pw = data_list[1]
+                                    tag_id = data_list[2]
+                                    tag_type = data_list[3]
+                                    tag_value = data_list[4]
+                                    self.receiveDataQueue.append([tag_id, tag_type, tag_value])
+                                else:
+                                    continue
+
+                        # for문을 다 돌았으면, 마지막 하나는 '' 또는 '남은데이터' 이다.
+                        # data를 packets의 마지막 데이터로 적용하고, 뒤에 데이터 수신 시 쌓을 수 있도록 한다.
+                        data = packets[-1]
+
+                    else:
+                        print("[" + self.log_title + "] Disconnect from", str(self.getServerIP()))
+                        self.close()
+                        break
+
+            except ConnectionResetError:
+                self.close()
+                break
+            except socket.timeout as e:
+                pass
+            except socket.error as e:
+                self.close()
+                break
+            finally:
+                time.sleep(0.01)
+
+    # 소켓 서버로부터 데이터 수신 (사용자 정의)
+    def receiveData(self):
+        data = ""
+        try:
+            if(self.live_receive):
+                if(self.live_receive_run and self.socketReceiveThread.is_alive()):
+                    data = self.receiveDataQueue.popleft() if self.receiveDataQueue else None
+                else:
+                    print("The connection with the socket has been terminated. A value of None is returned.")
+                    data = None
+            else:
+                data += self.ser_socket.recv(self.receiveBuffer).decode('utf-8')
+                if data is not None:
+                    if not (len(data) == 0):
+                        packets = data.split('\n')
+                        # 마지막 항목은 제외
+                        for i in range(len(packets) - 1):
+                            if len(packets[i]) > 5: # 못해도 5는 넘어야 정상적인 데이터 "A,B,C"
+                                data_str = packets[i].strip()
+                                data_list = data_str.split(',')
+                                if(len(data_list) == 3):
+                                    device_id = data_list[0]
+                                    device_pw = data_list[1]
+                                    status = data_list[2]
+                                    self.isCertified = (device_id == self.device_id and device_pw == self.device_pw and status == "S001")
+                                    if(not self.isCertified):
+                                        print("[" + self.log_title + "] Device not certified. Please check your ID and password again.")
+                                elif(len(data_list) == 5):
+                                    device_id = data_list[0]
+                                    device_pw = data_list[1]
+                                    tag_id = data_list[2]
+                                    tag_type = data_list[3]
+                                    tag_value = data_list[4]
+                                    self.receiveDataQueue.append([tag_id, tag_type, tag_value])
+                                else:
+                                    continue
+
+                        # for문을 다 돌았으면, 마지막 하나는 '' 또는 '남은데이터' 이다.
+                        # data를 packets의 마지막 데이터로 적용하고, 뒤에 데이터 수신 시 쌓을 수 있도록 한다.
+                        data = packets[-1]
+
+                    else:
+                        print("[" + self.log_title + "] Disconnect from", str(self.getServerIP()))
+                        self.close()
+
+            return data
+
+        except ConnectionResetError:
+            self.close()
+            return None
+        except socket.error as e:
+            self.close()
+            return None
+        except Exception as e:
+            return None
+
+    def checkCertified(self):
+        return self.isCertified
+
+    def isExistReceiveData(self):
+        return len(self.receiveDataQueue) > 0
+
+    def waitForConnect(self):
+        while(self.socketConnectThread_Enable and not self.checkConnected()):
+            time.sleep(0.5)

wipdevice-0.0.1/WIPClient/WIPClientAbstractModel.py

@@ -0,0 +1,61 @@
+from abc import ABC, ABCMeta, abstractmethod
+
+class WIPClientAbstractModel(metaclass=ABCMeta):
+	"""
+	@brief 생성자
+	@param ip Server IP
+	@param port Server Port
+	@param device_id Device ID
+	@param device_pw Device PW
+	@param isAutoConnect 자동 접속 관련 boolean. True일 경우 연결이 끊길 시 자동으로 접속한다.
+	@param live_receive 자동으로 수신관련 처리를 수행할지 여부
+	@param live_send 데이터를 자동으로 전송할지 여부
+	@param live_send_interval live_send가 True일 경우 전송할 주기
+	"""
+	# @abstractmethod 
+	# def __init__(self, ip="127.0.0.1", port=10008, device_id="device1", device_pw="00000000", isAutoConnect=True, live_receive=True, live_send=False, live_send_interval=1):
+	# 	print("AbstractModel Initialize")
+
+	"""
+	@brief 노드 데이터를 전송하는 메소드
+	"""
+	@abstractmethod 
+	def sendData(self, values):
+		print("AbstractModel sendData")
+
+	"""
+	@vbrief 
+	"""
+	@abstractmethod
+	def sendDataDirect(self, values):
+		print("AbstractModel sendDataDirect")
+
+	"""
+	@brief 수신받은 데이터를 받는 메소드
+	live_receive가 True일 경우 백그라운드에서 수신한 노드 데이터를 리턴한다.
+	advanced protocol에서 live_receive가 False일 경우 None 리턴
+	"""
+	@abstractmethod
+	def receiveData(self):
+		print("AbstractModel receiveData")
+
+	"""
+	@brief 인증이 완료되었는지 확인하는 메소드
+	"""
+	@abstractmethod
+	def checkCertified(self):
+		print("AbstractModel checkCertified")
+
+	"""
+	live_receive가 True일 경우 Queue에 받은 데이터가 존재하는지 확인
+	"""
+	@abstractmethod
+	def isExistReceiveData(self):
+		print("AbstractModel isExistReceiveData")
+
+	"""
+	서버 접속이 완료될 때 까지 대기한다.
+	"""
+	@abstractmethod
+	def waitForConnect(self):
+		print("AbstractModel waitForConnect")