알리익스프레스에서 산 매크로 키패드 개조하기 (Raw HTML)

<h1>매크로 키패드</h1>

<p>알리익스프레스에서 5천원만 주면 아래와 같은 매크로 키패드를 살 수 있다.</p>

<img src="https://blog.atj.sh/post-attachments/v/0194e4fa-5717-7cd0-9c14-bc9d94000b76"
  width="100%"
/>

<p><a href="https://ko.aliexpress.com/item/1005005419376722.html?spm=a2g0o.order_list.order_list_main.5.528e140fFFwWmV&gatewayAdapt=glo2kor">알리익스프레스 상품 페이지</a> - 이게 사람마다 다르게 가격이 표시되는 것 같다. 시크릿 탭에서 확인해보니 최저가가 2,860원이라고 표시되는 중이다.</p>

<p>
  실제로 받아서 써보면 생각보다 잘 작동한다. 스위치도 교체 가능하고 노브도 부드러워서 나쁘지 않다. 나는 이 키패드에 미디어 컨트롤 키를 할당하여 사용 중이다. 3개의 키에 이전 곡, 재생/일시정지, 다음 곡 기능을 할당하고, 노브에 음량 조정 기능을, 노브가 클릭될 때는 음소거되도록 기능을 할당했는데 정말 잘 작동했다. 
</p>

<p>문제는 매크로 키패드를 설정하는 데에서 온다. </p>
<ul>
  <li>
    매크로 키패드를 처음 받고 설정하려면 설정 프로그램을 다운받아 설정을 진행해야 하는데, 이 설정 프로그램이 EXE로만 제공된다. 즉, 리눅스 환경 또는 맥북에서는 설정이 불가하고 무조건 윈도우 PC에서 진행해야 한다.
  </li>
  <li>
    설정 프로그램 자체도 좀 의심스럽다. 바이러스가 들어있지 않은지 확신할 수 없다.
  </li>
  <li>
    복잡한 매크로를 설정한다던가 하는 건 기대할 수 없다.
  </li>
</ul>

<p>이런 점을 해결하려고 나는 이 키패드에 커스텀 펌웨어를 설치하기로 결심했다.</p>

<h1>키패드 하드웨어 분석</h1>

<p>이 키패드는 알리익스프레스에서 꽤 인기있는 상품인 편이다. 아마 낮은 가격 때문일 것이다. 이미 해외의 많은 유저들이 사용하고 있었고, 이루어진 연구도 있는 편이었다.</p>

<p>직접 알아낸 정보는 아래와 같다.</p>

<ul>
  <li>
    칩: CH552G
  </li>
  <li>
    부트로더 펌웨어: 2.40
  </li>
  <li>
    사용된 핀
    <ul>
      <li>LED (NeoPixel) - P3.4</li>
      <li>첫번째 키 (노브에서 가장 먼 키) - P1.1</li>
      <li>두번째 키 - P1.7</li>
      <li>세번째 키 - P1.6</li>
      <li>노브 클릭 - P3.3</li>
      <li>노브 A - P3.1</li>
      <li>노브 B - P3.0</li>
    </ul>
  </li>
</ul>


<h1>
  키패드 소프트웨어 분석
</h1>

<p>사실 많이 진행한 바는 없다. 키패드에 내장된 펌웨어를 읽어서 리버스 엔지니어링을 해보려고 했는데, 현재 설치된 부트로더 펌웨어로는 이 방법이 불가한 것 같다. 또한 설정 프로그램을 리버스 엔지니어링해보는 것도 고려했었다. 프로그램이 .Net 프레임워크 기반 윈도우 앱으로 보였는데, 디버그 정보도 같이 배포되는 것처럼 보였다. 하지만 난 .Net 프레임워크 개발을 진행해본 적이 없었어서 리버스 엔지니어링을 할 순 없었다. </p>

<p>설정 프로그램을 재구현하는 방법은 다른 사람이 이미 진행한 바 있다. 다음 링크에서 확인 가능하다. <a href="https://www.reddit.com/r/MechanicalKeyboards/comments/17j27ic/i_wrote_a_new_app_for_chinese_macro_keypads/">reddit.com - I wrote a new app for chinese macro keypads</a></p>

<p>나는 이 설정 프로그램을 재구현하는 대신, 키패드의 펌웨어를 처음부터 새로 작성하고자 마음먹었다.</p>

<h1>
  커스텀 펌웨어
</h1>

<p>펌웨어란 장치에 내장되는 프로그램을 뜻한다. 이 매크로 키패드의 경우엔, 각 키/노브가 눌리고 움직였을 때 어떻게 작동할지를 정의하는 것이 펌웨어이아. </p>

<p>우선 이미 구현된 커스텀 펌웨어가 있는지 조사했다. 다행히도 biemster라는 사람이 직접 커스텀 펌웨어를 개발하며 남긴 기록을 확인할 수 있었다. <a href="https://hackaday.io/project/189914-rgb-macropad-custom-firmware">Hackaday - RGB macropad custom firmware
</a> 나는 "이거다" 싶었다.</p>

<p><a href="https://github.com/biemster/3keys_1knob">GitHub 리포지토리</a>에서 그 사람이 작성한 커스텀 펌웨어 소스코드를 확인할 수 있었다. 나는 이 코드로 내 버전의 커스텀 펌웨어를 작성하기로 했다.</p>

<h2>
  툴체인
</h2>

<p>그 펌웨어를 바로 키패드에 업로드해보려고 했는데, 아무래도 내 컴퓨터에 이런 임베디드 개발 환경이 구축되어 있지 않다 보니 툴체인을 구성해야 했다.</p>

<p>웹개발자인 나로써는 처음 보는 툴들을 접했다. macOS 환경에서 요구됐던 툴체인은 아래와 같다.</p>

<ul>
  <li>Python 3 - 그냥 전반적으로 필요.</li>
  <li><a href="https://formulae.brew.sh/formula/binutils">binutils</a> - C로 작성된 커스텀 펌웨어를 빌드하기 위해 필요했다.</li>
  <li><a href="https://pypi.org/project/ch55xtool/">ch55xtool</a> - 키패드의 EEPROM을 컴퓨터에서 읽고 쓰는 데 필요하다.</li>
  <li><a href="https://formulae.brew.sh/formula/libusb">libusb</a> - USB와 관련된 기능을 포함하는 C 라이브러리이다. 커스텀 펌웨어를 빌드하기 위해 필요했다.</li>
  <li>EEPROM 데이터 수정을 위해서는 바이너리 데이터 편집 툴이 필요했다. 나는 VSCode 확장 프로그램인 <a href="https://marketplace.visualstudio.com/items?itemName=ms-vscode.hexeditor">Hex Editor</a>를 사용했다.</li>
</ul>

<h2>빌드 & 업로드</h2>

<p>우선 키패드를 부트로더에 진입시켜야 펌웨어 업로드가 가능하다. 키패드의 나사를 푼 후, 뒷판에 저항&캐피시터가 배치된 부분을 보면 빈 패드 2개가 있을 것이다. 이 패드 2개를 클립 같은 것으로 연결시킨 후 컴퓨터에 연결하면 부트로더에 진입될 것이다. </p>

<p>그리고 커스텀 펌웨어를 빌드해야 한다. <a href="https://github.com/atjsh/3keys_1knob/">내가 작성한 커스텀 펌웨어</a> 소스코드를 클론받는다. 그리고 파이썬 가상환경을 하나 생성한 후, <a href="https://pypi.org/project/pyusb/">pyusb</a> 라이브러리를 설치한다.</p>

<p>커스텀 펌웨어 빌드는 `make bin`, 업로드는 `make build`로 진행한다. 만약 libusb, binutils, pyusb 모두 준비된 상태라면 아무 문제 없이 업로드까지 진행될 것이다.</p>

<h2>기능</h2>

<p>칩에 내장된 EEPROM에 각 키/노브의 기능을 저장하도록 했다. 각 키/노브 정보는 3바이트에 걸쳐 저장되는데, 첫 바이트는 Modifier 키값, 두번째 키는 미디어 키 여부, 세번째 키는 실제 입력할 키의 코드이다. 그리고 총 6개의 입력이 존재하므로 18바이트의 EEPROM이 사용되는 셈이다.</p>

<p>EEPROM 편집은 ch55xtool를 사용하여 진행할 수 있다. `ch55xtool -d` 명령어로 EEPROM을 덮어쓰고, `ch55xtool -g` 명령어로 EEPROM을 읽어올 수 있다. 읽어온 EEPROM은 VSCode Hex Editor 확장 프로그램을 통해 할 수 있다.</p>

<p>3개의 키 위에 장착된 RGB LED도 프로그램할 수 있었는데, LED가 너무 밝아서 난 그냥 컴퓨터에 연결됐을 때만 빛나게 하고, 그 후에는 꺼져 있도록 작성했다.</p>

<h2>더 남은 것</h2>

<p>우선 GUI로 설정 프로그램을 작성하고 싶다. EEPROM을 업로드하는 것만 구현하면 될 것이다.</p>

<p>그리고 이 커스텀 펌웨어를 설치하는 과정을 더 쉽게 만들고 싶다. 지금은 펌웨어를 직접 빌드하고 업로드까지 CLI를 통해 진행해야 하는데, 요구되는 툴체인이 너무 복잡하다는 생각이 든다. 이 커스텀 펌웨어 업로드 작업 또한 GUI 설정 프로그램에 내장되어 있으면 최고일 것이다.</p>

<p>만약 그렇게까지 된다면, 이 알리익스프레스산 매크로 키패드를 구매하는 사람들은 더 자유롭고 편리하게 기능을 커스터마이징하고 사용할 수 있을 것이다.</p>

<h1>
  총평
</h1>

<p>너무 저렴한 제품이라 더 편한 마음으로 커스텀 펌웨어 제작에 도전할 수 있었던 것 같다. 장치가 더 비쌌다면 더 어려웠을 것이다 (아까워서). 임베디드 프로그램을 빌드해본 것도 처음이라 신선했다. 지금은 이 정도에서 마치지만 더 발전시킨 후에 기능이 더 추가된 커스텀 펌웨어를 공유할 수 있으면 좋겠다.</p>