Giter Club home page Giter Club logo

corsairlightingprotocolboards's Introduction

Corsair Lighting Protocol Boards

Arduino board definitions for use with the Corsair Lighting Protocol library. These board definitions have modified USB settings so they can be used to simulate Corsair devices. It is not required for boards using TinyUSB other than the ESP32 series (not yet implemented).

Install CLP Boards in Arduino

All boards can simply be installed in Arduino IDE via the Boards Manager. When using 3rd party boards such as SparkFun you must install them additionally. See Supported Hardware Boards down below for more details.

package index URL:

https://raw.githubusercontent.com/Legion2/CorsairLightingProtocolBoards/master/package_Legion2_CorsairLightingProtocolBoards_index.json
  1. Open the Preferences of the Arduino IDE.

    File->Preferences

  2. Add the package index URL above in the Additional Boards Manager URLs field, and click OK.

    Additional Boards Manager URLs Pop-up

  3. Open the Boards Manager by opening the menu Tools->Board->Board Manager...

    Tools->Board->Board Manager...

  4. Search and install Corsair Lighting Protocol Boards

    install boards in Board Manager

  5. For some of the boards you must install additional definitions: SparkFun Boards, Hoodloader2 Boards. Make sure you add the additional board urls each on a new line and don't remove the already existing ones.

    all additional boards urls

How to use these boards in Arduino

The CLP Boards can now be used in Arduino IDE. The following is only an example on how to use the boards, it's not required for the installation.

  1. Select one of the boards under Corsair Lighting Protocol Boards in Tools->Board menu

    Tools->Board menu

  2. Select one of the devices from corsair under Tools->Device

    Tools->Device

  3. Select COM port under Tools->Port

    Tools->Port

  4. Compile/Upload as usual

Supported Hardware Boards

Hardware Board(s) Instructions
Arduino Leonardo installed by default
SparkFun Pro Micro install SparkFun Boards
Adafruit 32u4 AVR Boards install Adafruit AVR Boards

How to release a new version (development)

  1. On GitHub manually trigger the Release Workflow for the platform and the new version.
  2. Wait for the Release GitHub Action to complete.
  3. Add the new version to the package index file by running ./scripts/update-index.mjs 'metadatajson' and provide the metadata json from the output of the Release GitHub Action. Commit and push these changes.

License

This project is licensed under the Apache License Version 2.0.

corsairlightingprotocolboards's People

Contributors

legion2 avatar dependabot[bot] avatar github-actions[bot] avatar spegs21 avatar vfjr avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.