설치 & 설정

PC Node와 ESP32 Node만 설치하면 됩니다. Hub는 OrbiSync 클라우드에서 제공됩니다.

1. Installation Overview

OrbiSync에서는 Hub를 별도로 설치하지 않습니다. Hub는 OrbiSync 클라우드에서 관리되며, 사용자는 PC Node 또는 ESP32 Node만 설치하면 됩니다.

Cloud Hub – OrbiSync가 제공하는 중앙 서버. 모든 Node가 여기에 연결됩니다.
PC Node – Windows/macOS/Linux PC에서 실행. 대시보드에서 다운로드 후 Pairing Code로 등록.
ESP32 Node – Arduino IDE + OrbiSync 라이브러리로 펌웨어 작성 후 보드에 업로드.

수동 서버 주소 입력이나 복잡한 환경 설정은 필요하지 않습니다. 대시보드에서 발급한 Pairing Code만 입력하면 자동으로 연결됩니다.

2. PC Node Installation

PC Node는 웹 대시보드에서 다운로드한 뒤, 실행 시 Pairing Code를 입력하는 방식으로 설치·등록됩니다.

Step 1. 대시보드 로그인

orbisync.io에서 OrbiSync 계정으로 로그인한 뒤 대시보드로 이동합니다.

Step 2. Pairing Code 생성

대시보드에서 「Node 추가하기」 또는 내 장치 메뉴의 등록 키(Pairing Code) 섹션에서 Pairing Code를 발급·확인합니다. 이 코드는 Node 실행 시 한 번 입력하면 해당 계정에 자동 등록됩니다.

Step 3. Node 다운로드 (Windows / macOS / Linux)

대시보드의 「Node 설치하기」 또는 Node 프로그램 다운로드 버튼을 클릭합니다.
사용 중인 OS에 맞는 설치 파일을 받습니다.
- Windows: 설치 실행 파일(.exe) 또는 ZIP
- macOS: .dmg 또는 .pkg
- Linux: .deb / .rpm 또는 바이너리 (제공 형태에 맞게 사용)

Step 4. 실행 후 Pairing Code 입력

다운로드한 Node 프로그램을 실행합니다.
Pairing Code 입력 화면이 나오면 Step 2에서 확인한 코드를 입력합니다.
정상 등록 시 Registered, Connected 또는 Pairing success 등의 메시지가 표시됩니다.

서버 주소, 토큰, 환경 변수 등 별도 설정은 필요하지 않습니다.

Step 5. 대시보드에서 ONLINE 확인

내 장치 또는 데이터 조회 → 장치 상태 탭에서 해당 Node가 ONLINE으로 표시되고, 마지막 연결 시간이 갱신되는지 확인합니다.

자세한 흐름은 빠른 시작 문서를 참고하세요.

3. ESP32 Node Installation

ESP32 Node는 Arduino IDE에서 OrbiSync Arduino 라이브러리를 사용해 스케치를 작성한 뒤, 보드에 업로드하여 사용합니다.

3.1 Arduino IDE 설치

Arduino IDE를 설치합니다. (2.x 또는 1.8.x 지원 여부는 제품 문서를 확인하세요.)

3.2 OrbiSync 라이브러리 설치

Arduino IDE를 실행합니다.
스케치 → 라이브러리 포함하기 → 라이브러리 관리를 엽니다.
검색창에 OrbiSync를 입력합니다.
OrbiSync 라이브러리를 선택한 뒤 설치를 클릭합니다.

3.3 기본 예제 코드 사용

파일 → 예제 → OrbiSync에서 기본 예제 스케치를 엽니다. 예제에는 WiFi SSID/비밀번호와 Pairing Code(또는 설정값)를 넣는 부분이 있습니다.

3.4 WiFi 설정

스케치 내에서 사용 중인 WiFi의 SSID와 비밀번호를 설정합니다. 예시 (변수명은 실제 라이브러리 예제에 맞게 수정):

const char* WIFI_SSID     = "your_wifi_ssid";
const char* WIFI_PASSWORD = "your_wifi_password";

3.5 Pairing Code 설정

대시보드에서 발급한 Pairing Code(또는 라이브러리가 요구하는 설정값)를 스케치에 넣습니다.

const char* PAIRING_CODE = "your_pairing_code";  // 대시보드에서 확인한 코드

3.6 업로드 후 연결 확인

ESP32 보드를 PC에 연결한 뒤, Arduino IDE에서 보드와 포트를 선택합니다.
업로드 버튼을 눌러 스케치를 보드에 업로드합니다.
업로드가 끝나면 ESP32가 WiFi에 연결되고, OrbiSync Hub와 자동으로 연결됩니다.
대시보드의 내 장치 또는 데이터 조회에서 해당 ESP32 Node가 ONLINE으로 표시되는지 확인합니다.

4. Unsupported / Removed Features

아래 기능은 현재 제품에서 지원하지 않거나 제거되었습니다.

Docker 기반 Hub 설치 – 지원하지 않습니다. Hub는 OrbiSync 클라우드에서만 제공됩니다.
사용자 Hub 설치 – 사용자가 직접 Hub를 설치·운영하는 방식은 더 이상 지원하지 않습니다.
구버전 설치 가이드 – 수동 Hub/Node 서버 설정, 환경 변수 기반 Node 등록, Docker/ systemd Hub 설치 안내는 제거되었습니다.

이전에 사용하시던 자체 Hub·Docker 설치 방식이 필요하시면, 별도 문의를 통해 Legacy 안내를 요청하실 수 있습니다.

5. Troubleshooting

Pairing Code 오류

오타 – 복사·붙여넣기 사용, 앞뒤 공백 제거 후 다시 입력하세요.
만료 – Pairing Code는 유효 시간이 있습니다. 대시보드에서 새로 발급(재발급) 후 다시 입력하세요.
이미 사용됨 – 한 번 사용된 코드는 재사용할 수 없습니다. 새 코드를 발급받아 입력하세요.

네트워크 / 방화벽

회사·학교 네트워크에서는 WebSocket/HTTPS 등이 제한될 수 있습니다. 가능하면 일반 인터넷 환경에서 먼저 연결을 확인해 보세요. Node가 OFFLINE이면 PC의 방화벽·프록시 설정도 확인하세요.

ESP32 업로드 실패

USB 케이블과 포트를 확인하고, Arduino IDE에서 올바른 보드와 포트가 선택되었는지 확인하세요.
ESP32 보드용 USB 드라이버(CP210x, CH340 등)가 설치되어 있는지 확인하세요.
업로드 시 보드의 BOOT 버튼을 눌러야 하는 모델이 있으면, 해당 안내를 따라 하세요.

다음 단계

설치를 마치셨다면 다음 문서를 참고해 보세요:

빠른 시작 – 첫 Node 등록하고 대시보드에서 연결 확인하기
튜토리얼 – 실제 사용 사례와 단계별 가이드
API & CLI 레퍼런스 – API 및 CLI 명령어 참고

What Changed

이 문서를 현재 제품 구조에 맞게 전면 개정하면서 아래 내용이 제거되거나 변경되었습니다.

Hub 설치 섹션 삭제 – 사용자 대상 Hub 설치 가이드 전체 제거. Hub는 OrbiSync 클라우드에서만 제공됩니다.
Docker 기반 Hub 설치 삭제 – Docker 이미지 빌드·실행, 환경 변수, .env 설정 등 Docker 관련 내용 제거.
시스템 서비스(systemd) Hub 설치 삭제 – Linux systemd 서비스 파일 예시 및 등록 방법 제거.
Node 설치 방식 변경 – Python/패키지 수동 설치, node_agent 직접 실행, 환경 변수(HUB_URL, NODE_ID, AUTH_TOKEN 등) 및 node_config.json 설정 안내 제거. 현재는 “대시보드에서 다운로드 → 실행 → Pairing Code 입력”만 안내합니다.
Node systemd 서비스 삭제 – Linux에서 Node를 systemd로 등록하는 내용 제거.
Sync 설정 섹션 조정 – sync_config.json, 클라이언트/서버 설정, 릴레이 모드 등 상세 설정은 현재 제품에서 사용하는 방식이 있다면 별도 문서로 이전할 수 있습니다. 본 설치 문서에서는 제거하고, “다음 단계”에서 튜토리얼/레퍼런스로 안내합니다.
ESP32 Node 섹션 추가 – Arduino IDE, 라이브러리 매니저, WiFi·Pairing Code 설정, 업로드 및 연결 확인을 단계별로 추가했습니다.
Unsupported / Removed 섹션 추가 – Docker Hub 설치·사용자 Hub 설치는 지원 종료되었음을 명시했습니다.