Installation Guide

1. Prerequisites

가장 먼저 사용자 계정을 확인하시기 바랍니다. 사용자 계정에 공백이 있으면 실행 중 오류가 발생할 수 있습니다. 사용 중인 계정 이름에 공백이 있는 경우, 새로운 계정을 만들기를 권장합니다.

1-1. Atom

Nol.A-SDK는 Atom의 패키지로 배포됩니다. 따라서, Nol.A-SDK를 사용하기 위해서는 Atom이 우선 설치되어야 합니다. Atom의 설치는 여기를 참고하시기 바랍니다.

Nol.A-SDK는 몇몇 Node.js 모듈들을 사용합니다. 그 중 serialport 모듈은 운영체제 의존성이 높아 설치시 설치 환경에 맞게 native build 하게 됩니다. 그런 이유로 아래와 같이 설치 환경에 따라 추가적인 환경 설정을 해줘야 합니다.

1-1-1. Windows

Windows 에서는 Windows-Build-Tools를 설치하여야 합니다. 이는 Nol.A-SDK에서 사용하는 serialport를 native build 하기 위함입니다. 만약, 이미 Visual Studio 2015를 사용 중이고, Python 2.7이 설치되어 있다면 생략할 수 있습니다만 아래 방법으로 추가적으로 설치한다 해도 기존 환경에는 영향을 주지 않기 때문에 가급적 아래 방법으로 진행하는 것을 추천합니다.

먼저 환경변수 중 시스템 변수 Path에 다음 Windows Powershell 실행파일 경로가 추가되어 있는지 확인하고, 없으면 추가합니다.

%SYSTEMROOT%\System32\WindowsPowerShell\v1.0\

Windows Powershell을 관리자 권한으로 열고, C:\Users\{your name}\AppData\Local\atom\app-{atom version}\resources\app\apm\bin 디렉토리로 이동합니다. 먼저 다음 명령어로 내장 node 버전을 확인해봅니다.

> .\node --version

버전이 8.x 보다 낮다면 먼저 Atom을 업데이트하고 다시 시도해보시기 바랍니다.

버전이 8.x 이상이라면 다음과 같이 Windows-Build-Tools 를 설치합니다.

> .\npm install --global --production windows-build-tools --vs2015

--vs2015는 Microsoft Visual Studio 2015를 사용하게 하는 옵션입니다. serialport v7.1.3(2019년 1월 14일 기준 최신버전)는 Microsoft Visual Studio 2017에서 제대로 빌드되지 않습니다.

> .\apm config set msvs_version 2015
> .\apm config set python '%USERPROFILE%\.windows-build-tools\python27\python.exe'

위 Python 경로는 Windows-Build-Tools 로 설치한 Python 경로입니다. 만약 다른 경로에 설치했다면 변경하여 입력해야 합니다.

1-1-2. macOS

macOS 에서는 Xcode를 설치해야 합니다. Xcode 설치가 완료되면 한번은 실행하여 사용자 동의 및 추가 컴포넌트 설치 등을 완료해야 합니다.

그래도 설치가 안된다면 다음과 같이 Xcode를 제대로 지정해야 합니다.

$ sudo xcode-select -s /Applications/Xcode.app/Contents/Developer

1-2. Node.js

내부 기능들이 원활하게 실행되도록 하기 위해서는 Node.js의 설치가 필요합니다.

1-2-1. Windows

Windows에서는 설치 후, node 명령어가 어디에서든 실행될 수 있도록 PATH가 설정되었는지 확인하시기 바랍니다.

1-3. Python

Python 및 pyserial, pythoncrc의 설치도 필요합니다.

1-3-1. Windows

1-1-1 에서 Windows-Build-Tools를 설치한 경우 Python 2.7 버전이 자동으로 ~\.windows-build-tools\python27에 설치됩니다. pyserial, pythoncrc만 설치하면 됩니다.

Windows에서는 설치 후, python 명령어가 어디에서든 실행될 수 있도록 해당 경로(Windows-Build-Tools에서 설치시 경로: ~\.windows-build-tools\python27)가 PATH가 설정되었는지 확인하시기 바랍니다. 또한 pip도 설치되었는지 확인하시고, 역시 PATH에 해당 경로(Windows-Build-Tools에서 설치시 경로: ~\.windows-build-tools\python27\Scripts)가 추가되어있는지 확인하시기 바랍니다. 커맨드 프롬프트에서 다음과 같이 pyserial, pythoncrc 등 패키지를 설치할 수 있습니다.

> pip install pyserial pythoncrc

pip 경로를 찾을 수 없다고 나오면 Scripts 경로가 PATH에 추가되지 않은 것입니다. 해당 경로를 PATH에 추가하지 않고 설치하기 원한다면 다음과 같이 입력하셔도 됩니다.

> python -m pip install pyserial pythoncrc

1-3-2. macOS

macOS에서는 Python이 기본적으로 포함되어 있습니다. 다음과 같이 pyserial, pythoncrc 패키지 등을 설치할 수 있습니다.

# python -m pip install pyserial pythoncrc

1-3-3. Linux

Linux에서는 pyserial, pythoncrc 패키지 등을 설치하여야 합니다.

$ curl https://bootstrap.pypa.io/get-pip.py --output get-pip.py
$ sudo `apm config get python` get-pip.py
$ sudo `apm config get python` -m pip install pyserial pythoncrc

1-4. srecord

일부 보드에서는 srecord가 필요할 수도 있습니다.

1-4-1. Windows

여기에서 다운로드 및 설치하시기 바랍니다. 설치 후에는 PATH에 해당 경로를 추가하시기 바랍니다.

1-4-2. Linux & macOS

Linux 및 macOS에서는 자체 패키지 관리자를 통하여 srecord를 설치할 수 있습니다.

1-5. 기타 보드별 추가 설치

기타 보드별로 추가 설치해야 하는 프로그램, 또는 드라이버들이 있을 수 있습니다. 자세한 사항은 Board-specific Tools를 참고하세요.

2. Install

Atom이 설치가 되었다면, 다음과 같이 Settings View 에서 패키지를 설치할 수 있습니다. 패키지 이름은 nola-sdk 입니다. Install 버튼을 클릭하면 설치가 시작됩니다.

Nol.A-SDK의 정상적인 동작을 위해서 build 및 busy 패키지를 추가로 설치될 수 있습니다.

3. Activate Nol.A Control Panel

설치가 완료된 후에는 다음과 같이 Packages–Nol.A-SDK–Show Control Panel을 클릭, 또는 단축키 ctrl+alt+s를 입력하여 패키지를 활성화합니다. 패키지의 활성화는 Atom을 새로 실행할 때마다 해줘야 합니다.

패키지를 활성화하면 다음과 같이 Atom 상단에 Nol.A-SDK 제어 패널이 나타납니다.

드디어 Nol.A-SDK 설치가 완료되었습니다! 간략한 사용법은 Quick Tutorial을 참고하시기 바랍니다.