Skip to content

Latest commit

 

History

History
82 lines (67 loc) · 4 KB

README.md

File metadata and controls

82 lines (67 loc) · 4 KB

Logo

LCD-Simulator

GitHub release (latest SemVer) GitHub release (latest by date) GitHub issues GitHub code size in bytes GitHub License


Table of content


About

This project is a simple LCD Simulator for the Mikrocontroller-Labor-Board (HS-Pforzheim). We only support Windows 7+, due to end of life issues.

Windows TypeScript React Electron.js

Built with electron, react and typescript.


Development

IDE

Visual Studio Code

For the best development experience please use Visual Studio Code.

Environment

NodeJS

In order to start developing you need to install the latest LTS version of NodeJS >= 14.17.6.

Be aware that all commands in the following chapters need to be called from some commandline (PowerShell, CMD), at the root of the project folder.

Install dependencies

To install all the needed dependencies just call the following command:

npm install

You only have to call this command after the initial clone.

Start development server

Calling the following command runs a new React development server plus the electron development server concurrently.

npm run start

Bundle application

Finally you can build and bundle the application into a setup executable, which can be installed on any Windows 7+ device, by running the following command.

npm run bundle

Add display commands

This paragraph is currently a stub, maybe the author wants to write something here!


Supported commands

A question mark after an unticked command means that we can receive the command and process it, the implementation is just not quite right yet.

Display commands

  • GLCD_DisplayChars
  • GLCD_SetTextCursor
  • GLCD_SetRow (?)
  • GLCD_SetColumn (?)
  • GLCD_PrintColumn
  • GLCD_PrintMulColumn
  • GLCD_PrintText
  • GLCD_PrintChar
  • GLCD_PrintGrafikLine
  • GLCD_ClearRow
  • GLCD_ClearLCD

Debug commands

  • Printing uint(8/16/32) to hexadecimal, decimal and binary.
  • Printing status messages (error, ok, etc.)