Skip to content

carbncl/CorneMAXHelper

 
 

Repository files navigation

Corne Max Helper

A tray application built on electron for sending data to the displays on the Mechboards CRKBD Max

Development

Development of the project makes use of electron-forge this handles the recompilation of modules for runtime in the electron environment.

  1. Fork this repo
  2. Clone your fork
  3. Install the dependencies
    npm install
    
  4. Start the Application
    npm run start
    

Adding a new module

Modules can be added under ./src/modules exporting a sync command that can be imported under ./src/index.ts and enabled by updating the new Device args. Each command needs a new enum value added to CODES in ./src/types.ts AND to the enum display_data_type in the keyboards display.h which is used to uniquely identify the command.

The sync command exported must take a Device as the first argument which can be written to with .write(command, half, data) where command is the corresponding value from CODES, half is the keyboard half to write to, and data is data you want sending to the keyboard.

Some notes on Windows CPU Utilisation when providing Stats

This project makes use of the SystemInformation node module for the purpose of obtaining system utilisation. In order to obtain this information the module spawns a powershell instance which has a larger overhead than in faced by Mac/Linux. See #616 for further discussion arround this topic. See #732 RE Windows Defender. GPU Load is only accessable for NVIDIA GPUs hence has been ommited.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 99.8%
  • HTML 0.2%