/uhk-squal_research-agent

Ultimate Hacking Keyboard configurator

Primary LanguageTypeScriptOtherNOASSERTION

Fork info:

This fork contains some extended commands to get sensor image out of the keyboard.

Usage:

  • checkout && build && flash firmware from the neighbouring repository

  • cd into package/usb

  • now you can:

    • ./get-pixgrab.ts will pull the raw data from the sensor and dump them into the terminal
    • ./makeImg.sh will run pixgrab, and make a bitmap image out of them using xxd
    • ./streamImg.sh will continuously pull data from the keyboard and show them using a spawned instance of feh

  • or just feel free to look into package/usb/Balls directory which contains some shots of various balls...

  • if you want to read more about this adventure, continue here

Standard official readme:

Agent logo & text

Agent is the configuration application of the Ultimate Hacking Keyboard.

Please do not build Agent from source unless you want to develop it. Using an existing release is far easier for everyone involved:

  • If you already own a UHK then download the latest desktop build of Agent from the releases page. On Linux, download the AppImage, make it executable, and run it. If you don't own a UHK then you won't get past the opening screen!
  • If you don't own a UHK yet then try out the web build of Agent in your browser. This is meant to be used for demonstration purposes.

Building the electron application

Step 1: Build Dependencies

You'll need Node.js 12. Use your OS package manager to install it. Check the NodeJS site for more info. Mac OS users can simply brew install node to get both. Should you need multiple Node.js versions on the same computer, use Node Version Manager for Mac/Linux or for Windows

You'll also need libusb. On debian-based linux distros, apt-get install libusb-dev libudev-dev g++ is sufficient. On Mac OS, use brew install libusb libusb-compat. For everyone else, use the appropriate package manager for your OS.

Step 2: Build Environment

git clone git@github.com:UltimateHackingKeyboard/agent.git
cd agent
npm install
npm run build
npm run electron

At this point, Agent should be running on your machine.

Developing the web application

  • The frontend code is located in packages/uhk-web/
  • Run the project locally with npm run server:web
  • View the app at http://localhost:8080
  • The app will automatically reload when you make changes

Contributing

Wanna contribute? Please let us show you how.