MySSIX Thing SDK
Project description
MySSIX Thing SDK for Python
이 문서에서는 MySSIX IoT Platform
의 Thing Python SDK를 소개합니다. Thing
은 MySSIX IoT Platform
에서 사용되는 기능의 단위인 Service
를 제공하는 제공자입니다. 이 문서를 통해 Thing
을 실행하고 개발하는 방법에 대해 알 수 있습니다.
MySSIX IoT Platform
에서 Thing
은 크게 2가지로 나뉩니다.
- Big Thing
- Small Thing
이 문서에서는 Python으로 작성된 Big Thing 어플리케이션을 실행하고 개발하는 방법에 대해 설명합니다. Small Thing에 대해서는 Small Thing을 참고해주세요.
Getting Started
Prerequisites
해당 SDK를 사용하기 위해서는 다음과 같은 요구사항을 만족해야합니다.
- Python 3.7+
Install from PyPI
pip3 install big-thing-py
Install from source
git clone https://github.com/sopiot/big-thing-py.git
cd big-thing-py
pip3 install .
# 만약 Thing SDK를 개발하고자 한다면 다음의 명령어를 사용합니다.
# -e 옵션을 사용하면 레포지토리의 코드 변경사항이 바로 Thing 동작에 반영됩니다.
# pip3 install -e .
Usage
예제를 실행하기 전에 MySSIX IoT Platform
의 Middleware
를 먼저 실행해야 합니다.
Middleware Docker 이미지 다운로드 & 실행
docker pull sopiot/sopiot_middleware_ubuntu1804_x64
docker run -it -d --name sopiot_middleware -p 1883:1883 -p 1884:1884 -p 8883:8883 -p 8884:8884 -p 58132:58132 sopiot/sopiot_middleware_ubuntu1804_x64
이후, 다음의 명령어를 통해 기본 예제를 실행할 수 있습니다.
python3 samples/big_thing/basic_feature_big_thing/run.py
만약 가상환경을 생성하여 예제를 실행하려는 경우 pipenv
를 사용할 수 있습니다. 우선, 다음 명령어로 pipenv
를 설치합니다.
pip install pipenv --upgrade
pipenv
가상환경을 생성 및 레포지토리로부터 패키지를 설치합니다.
pipenv install -e .
그리고, 다음의 명령어를 통해 기본 예제를 실행할 수 있습니다.
pipenv run python samples/big_thing/basic_feature_big_thing/run.py
Thing
이 Middleware
에 등록되면 Thing
의 Service
를 Scenario
를 통해 사용할 수 있습니다. Scenario
는 MySSIX IoT Platform
의 Web Client App을 통해 조작 및 생성할 수 있습니다. -> 따로 Documents 폴더를 생성하여 Web Client App와 관련한 README를 작성해야하는 것이 좋아보임.
Samples
Contributions
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for big_thing_py-0.4.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c73bd84f3214a4bf02ab7f3483e9a5bcd29e45d401a4361b4902eeb2080f726d |
|
MD5 | f181f293f84ce99342e151d5189af50f |
|
BLAKE2b-256 | 2b0aa6d4d46e9425945954fc402d96bd2fe9bb20a8662fd90c7e4fb8e2536cb4 |