https://github.com/legion2/corsairlightingprotocolboards

Arduino boards definition for use with the Corsair Lighting Protocol library.
https://github.com/legion2/corsairlightingprotocolboards

arduino arduino-boards corsair

Last synced: 13 days ago
JSON representation

Arduino boards definition for use with the Corsair Lighting Protocol library.

• Host: GitHub
• URL: https://github.com/legion2/corsairlightingprotocolboards
• Owner: Legion2
• License: apache-2.0
• Created: 2019-11-17T15:13:53.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-16T22:11:09.000Z (about 1 year ago)
• Last Synced: 2024-05-01T17:13:29.373Z (7 months ago)
• Topics: arduino, arduino-boards, corsair
• Language: JavaScript
• Homepage:
• Size: 334 KB
• Stars: 13
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Corsair Lighting Protocol Boards

Arduino board definitions for use with the [Corsair Lighting Protocol](https://github.com/Legion2/CorsairLightingProtocol) 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](#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](images/open-preferences.png)

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

   ![Additional Boards Manager URLs Pop-up](images/add-package-url.png)

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

   ![Tools->Board->Board Manager...](images/open-boards-manager.png)

1. Search and install **Corsair Lighting Protocol Boards**

   ![install boards in Board Manager](images/install-boards.png)

1. For some of the boards you must install additional definitions: [SparkFun Boards](https://github.com/sparkfun/Arduino_Boards#installation-instructions), [Hoodloader2 Boards](https://github.com/NicoHood/HoodLoader2/wiki/Software-Installation#2-installing-board-definitions).

   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](images/additional-boards-urls.png)

## 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](images/select-board.png)

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

   ![Tools->Device](images/select-device.png)

1. Select COM port under Tools->Port

   ![Tools->Port](images/select-port.png)

1. Compile/Upload as usual

## Supported Hardware Boards

| Hardware Board(s)              | Instructions                                                                                                  |

|--------------------------------|---------------------------------------------------------------------------------------------------------------|

| Arduino Leonardo               | installed by default                                                                                          |

| SparkFun Pro Micro             | install [SparkFun Boards](https://github.com/sparkfun/Arduino_Boards#installation-instructions)               |

| Adafruit 32u4 AVR Boards       | install [Adafruit AVR Boards](https://learn.adafruit.com/adafruit-feather-32u4-basic-proto/arduino-ide-setup) |

## How to release a new version (development)

1. On GitHub manually trigger the Release Workflow for the platform and the new version.

1. Wait for the [Release GitHub Action](https://github.com/Legion2/CorsairLightingProtocolBoards/actions?query=workflow%3ARelease) to complete.

1. 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.