https://github.com/mafredri/lcm

Implementation of the ASUSTOR NAS LCD serial port communication protocol
https://github.com/mafredri/lcm

asustor lcd

Last synced: 3 months ago
JSON representation

Implementation of the ASUSTOR NAS LCD serial port communication protocol

• Host: GitHub
• URL: https://github.com/mafredri/lcm
• Owner: mafredri
• License: mit
• Created: 2021-05-30T19:19:36.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-29T15:30:30.000Z (about 2 years ago)
• Last Synced: 2024-10-04T15:43:37.344Z (4 months ago)
• Topics: asustor, lcd
• Language: Go
• Homepage:
• Size: 68.4 KB
• Stars: 15
• Watchers: 7
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lcm

The lcm project implements the ASUSTOR NAS LCD serial port communication protocol. ASUSTOR has a daemon running on their NASes (`lcmd`) which is responsible for controlling the LCD and buttons, this project aims to reimplement some of this functionality.

It can be used to write text on the LCD, turn the display on and off and read button presses.

## Status

Most of the protocol has been documented in code and the library implementation is quite robust and tries to handle edge cases and error states.

For a standalone program see [`cmd/openlcmd`](cmd/openlcmd). The `openlcmd` program implements some basic functionality and can be used as a reference implementation for more advanced programs. The underlying library is implemented in the `lcm` package.

All the naming in this project is guesswork, some messages may be named incorrectly and have a hidden or unknown purpose.

## Installation

```

git clone https://github.com/mafredri/lcm

cd lcm

go build ./cmd/openlcmd

sudo cp openlcmd /usr/local/sbin/openlcmd

sudo cp cmd/openlcmd/systemd/openlcmd.service /etc/systemd/system/openlcmd.service

sudo systemctl enable openlcmd

sudo systemctl start openlcmd

```

**NOTE:** `openlcmd` does not have to run as root, but the user will need to have read/write access to `/dev/ttyS1`.

## Why?

I stopped using ADM and switched to plain Debian on my AS-604T and AS-6204T and the ASUSTOR control software is not portable. So I wrote my own.

This project was already working in 2018 but wasn't published until 2021 after a big refactor.

## Project structure

- `lcm`

  - The LCM library, implements the protocol

- `lcm/cmd/openlcmd`

  - Daemon that runs on the ASUSTOR NAS and handles updating of the LCD and reacting to button presses

  - Exposes buttons as virtual keyboard (`uinput`)

  - Can power cycle the LCD via GPIO

## Research

Initially based on captured logs (see [mafredri/asustor_as-6xxt/lcmd-logs](https://github.com/mafredri/asustor_as-6xxt/tree/master/lcmd-logs)), later reverse-engineering of ASUSTOR `lcmd` to determine.