Showing preview only (361K chars total). Download the full file or copy to clipboard to get everything.
Repository: Legion2/CorsairLightingProtocol
Branch: dev
Commit: ab045805303d
Files: 87
Total size: 336.1 KB
Directory structure:
gitextract_ctaqa293/
├── .clang-format
├── .editorconfig
├── .github/
│ ├── CONTRIBUTING.md
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── support.md
│ ├── dependabot.yml
│ └── workflows/
│ ├── documentation.yml
│ ├── lint.yml
│ ├── push.yml
│ └── stale.yaml
├── .gitignore
├── LICENSE
├── README.md
├── examples/
│ ├── .clang-format
│ ├── AdditionalFeatures/
│ │ └── AdditionalFeatures.ino
│ ├── AmbientBacklight/
│ │ └── AmbientBacklight.ino
│ ├── CommanderPRO/
│ │ ├── CommanderPRO.ino
│ │ ├── PWMFan.cpp
│ │ ├── PWMFan.h
│ │ ├── SimpleFanController.cpp
│ │ ├── SimpleFanController.h
│ │ ├── ThermistorTemperatureController.cpp
│ │ └── ThermistorTemperatureController.h
│ ├── DebugSketch/
│ │ ├── DebugSketch.ino
│ │ └── board.txt
│ ├── DeviceIDTool/
│ │ └── DeviceIDTool.ino
│ ├── HoodLoader2CLPBridge/
│ │ ├── CLPUSBSerialBridge.cpp
│ │ ├── CLPUSBSerialBridge.h
│ │ └── HoodLoader2CLPBridge.ino
│ ├── HoodLoader2UnoMegaController/
│ │ └── HoodLoader2UnoMegaController.ino
│ ├── LS100/
│ │ └── LS100.ino
│ ├── LT100/
│ │ └── LT100.ino
│ ├── LightingNodeCORE/
│ │ └── LightingNodeCORE.ino
│ ├── LightingNodePRO/
│ │ └── LightingNodePRO.ino
│ ├── MultipleFans/
│ │ └── MultipleFans.ino
│ ├── NoEEPROM/
│ │ └── NoEEPROM.ino
│ ├── NonAddressable/
│ │ └── NonAddressable.ino
│ ├── RepeatAndScale/
│ │ └── RepeatAndScale.ino
│ ├── SingleStripLightingNodePRO/
│ │ └── SingleStripLightingNodePRO.ino
│ ├── TinyUSB/
│ │ └── TinyUSB.ino
│ ├── TransformLLFansFormatToStrip/
│ │ └── TransformLLFansFormatToStrip.ino
│ ├── UnitTests/
│ │ └── UnitTests.ino
│ └── UnitTests2/
│ └── UnitTests2.ino
├── extra/
│ └── doxygen.conf
├── keywords.txt
├── library.properties
└── src/
├── CLPAdditionalFeatures.cpp
├── CLPAdditionalFeatures.h
├── CLPUtils.cpp
├── CLPUtils.h
├── CorsairLightingFirmware.cpp
├── CorsairLightingFirmware.h
├── CorsairLightingFirmwareStorageEEPROM.cpp
├── CorsairLightingFirmwareStorageEEPROM.h
├── CorsairLightingFirmwareStorageStatic.cpp
├── CorsairLightingFirmwareStorageStatic.h
├── CorsairLightingProtocol.h
├── CorsairLightingProtocolConstants.h
├── CorsairLightingProtocolController.cpp
├── CorsairLightingProtocolController.h
├── CorsairLightingProtocolHID.cpp
├── CorsairLightingProtocolHID.h
├── CorsairLightingProtocolResponse.cpp
├── CorsairLightingProtocolResponse.h
├── CorsairLightingProtocolSerial.cpp
├── CorsairLightingProtocolSerial.h
├── CorsairLightingProtocolTinyUSBHID.cpp
├── CorsairLightingProtocolTinyUSBHID.h
├── FanController.cpp
├── FanController.h
├── FastLEDController.cpp
├── FastLEDController.h
├── FastLEDControllerStorage.h
├── FastLEDControllerStorageEEPROM.cpp
├── FastLEDControllerStorageEEPROM.h
├── FastLEDControllerUtils.cpp
├── FastLEDControllerUtils.h
├── IFanController.h
├── ILEDController.h
├── ITemperatureController.h
├── LEDController.cpp
├── LEDController.h
├── RawHID.cpp
├── RawHID.h
├── TemperatureController.cpp
└── TemperatureController.h
================================================
FILE CONTENTS
================================================
================================================
FILE: .clang-format
================================================
BasedOnStyle: Google
ColumnLimit: 120
IndentWidth: 4
TabWidth: 4
UseTab: ForContinuationAndIndentation
AccessModifierOffset: -4
================================================
FILE: .editorconfig
================================================
root = true
[*]
indent_style = tab
indent_size = 4
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = true
[*.{yml,yaml}]
indent_style = space
indent_size = 2
================================================
FILE: .github/CONTRIBUTING.md
================================================
# How to contribute
You can contribute in many different ways, for example report a bug or come up with an idea for improvement.
If you are good at programming you could also provide a fix for bugs or Pull Requests with improvements.
If you want to help others using CLP you are welcome to extend the [Wiki on GitHub](https://github.com/Legion2/CorsairLightingProtocol/wiki).
## Finding information
General information can be found in the [Readme](https://github.com/Legion2/CorsairLightingProtocol) file at the root of the project.
Information about specific topics are written in the [Wiki](https://github.com/Legion2/CorsairLightingProtocol/wiki).
For developer there is also an [API documentation](https://legion2.github.io/CorsairLightingProtocol/) for all the public methods and types.
## Writing code
For writing code I recommend [VS Code](https://code.visualstudio.com/) with the [Clang-Format](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format) and [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) extensions.
For uploading to Arduino boards I use the ArduinoIDE.
This project consists of two major parts, the CLP library itself, for which the source code can be found in `src/` directory and the example sketches in the `examples/` subdirectories.
The main logic for processing commands and creating the LED colors is part of the library source code.
The examples only show how to use the library and what can be configured.
The library is modular so communication with iCUE and the processing of commands is decoupled and can be extended by other developers.
Single parts of the library, such as the LEDController can also be used without iCUE, by just calling the public API of these classes.
The examples are used by most users as a template which they only modified slightly, so the basic examples should be simple and explicitly show the main configuration options.
Not all users are developers and may not understand the syntax or semantics of the code, they just alter some values and upload the sketches.
Examples can also be used to show how some additional or special features can be used, these sketches are not meant to be used by the users directly.
To verify that the library can be compiled on all supported platforms, all the examples are compiled in the CI pipeline for different boards.
## Coding conventions
Public methods must be documented with JavaDoc style comments.
When introducing new methods you should think about if the method should be part of the public API or only used internally.
Always use descriptive names for variables, only use acronyms if they are well known and frequently used.
The coding style is defined using ClangFormat and automatically checked when you submit a Pull Request.
================================================
FILE: .github/FUNDING.yml
================================================
# These are supported funding model platforms
github: Legion2
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: paypal.me/LeonKiefer
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Change to '...'
2. Upload '....'
3. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**System (please complete the following information):**
- OS: [e.g. Windows 10]
- Board: [e.g. Arduino Leonardo]
- Device: [e.g. Lighting Node PRO]
- Version of IDE: [e.g. Arduino IDE 1.8.13]
- Version of CLP: [e.g. 0.15.0]
- Version of CLP Boards: [e.g. 0.2.0]
- Sketch: [e.g. RepeatAndScale]
**Code changes**
Did you changed the code of the library or the sketch?
================================================
FILE: .github/ISSUE_TEMPLATE/support.md
================================================
---
name: Support
about: You have a problem using this project and need help?
title: ''
labels: support
assignees: ''
---
**Describe the problem**
A clear and concise description of your problem.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**System (please complete the following information):**
- OS: [e.g. Windows 10]
- Board: [e.g. Arduino Leonardo]
- Device: [e.g. Lighting Node PRO]
- Version of IDE: [e.g. Arduino IDE 1.8.13]
- Version of CLP: [e.g. 0.15.0]
- Version of CLP Boards: [e.g. 0.2.0]
- Sketch: [e.g. RepeatAndScale]
**Code changes**
Did you changed the code of the library or the sketch?
================================================
FILE: .github/dependabot.yml
================================================
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
================================================
FILE: .github/workflows/documentation.yml
================================================
name: Deploy Documentation
on:
push:
branches:
- dev
jobs:
doxygen:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install doxygen
run: sudo apt install doxygen graphviz
- name: Fix Readme title
run: sed -i '1s/ \[/\n\[/' README.md
- name: Run doxygen
run: doxygen extra/doxygen.conf
- name: Deploy to gh-pages
uses: peaceiris/actions-gh-pages@v3.9.2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: doxygen/html
================================================
FILE: .github/workflows/lint.yml
================================================
name: Check Code Format
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check src format
uses: DoozyX/clang-format-lint-action@v0.18
with:
source: './src'
extensions: 'h,cpp'
clangFormatVersion: 9
- name: Check examples format
uses: DoozyX/clang-format-lint-action@v0.18
with:
source: './examples'
extensions: 'h,cpp,ino'
clangFormatVersion: 9
================================================
FILE: .github/workflows/push.yml
================================================
on: [push, pull_request, workflow_dispatch]
name: Test
jobs:
test:
name: Test for Board ${{ matrix.board }}
runs-on: ubuntu-latest
strategy:
matrix:
board:
[
"Legion2:avr:leonardoclp",
"Legion2:avr:promicro5vclp",
"Legion2:avr:promicro3vclp",
]
steps:
- uses: actions/checkout@v4
- name: Build for ${{ matrix.board }}
uses: ArminJo/arduino-test-compile@v3
with:
cli-version: 0.18.3
arduino-board-fqbn: ${{ matrix.board }}
platform-url: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json,https://raw.githubusercontent.com/Legion2/CorsairLightingProtocolBoards/master/package_Legion2_CorsairLightingProtocolBoards_index.json
arduino-platform: arduino:avr@1.8.3,SparkFun:avr@1.1.13,Legion2:avr@0.3.1
required-libraries: FastLED@3.5.0
sketch-names: LightingNodePRO.ino,
SingleStripLightingNodePRO.ino,
CommanderPRO.ino,
DeviceIDTool.ino,
RepeatAndScale.ino,
TransformLLFansFormatToStrip.ino,
LS100.ino,
LT100.ino,
LightingNodeCORE.ino,
NonAddressable.ino,
AdditionalFeatures.ino,
AmbientBacklight.ino,
MultipleFans.ino,
DebugSketch.ino,
NoEEPROM.ino
build-properties: '{"DebugSketch": "-DDEBUG -DVERBOSE -DPRINT_COMMAND=true -DPRINT_RESPONSE=true -DPRINT_LOOP=true -DPRINT_UPDATE=true"}'
testUnoMega:
name: Test Arduino Uno/Mega sketches for Board ${{ matrix.board }}
runs-on: ubuntu-latest
strategy:
matrix:
board: ["arduino:avr:uno", "arduino:avr:mega:cpu=atmega2560"]
steps:
- uses: actions/checkout@v4
- name: Build for ${{ matrix.board }}
uses: ArminJo/arduino-test-compile@v3
with:
cli-version: 0.18.3
arduino-board-fqbn: ${{ matrix.board }}
arduino-platform: arduino:avr@1.8.3
required-libraries: FastLED@3.5.0
sketch-names: HoodLoader2UnoMegaController.ino
test16u2:
name: Test 16u2 sketch for Board ${{ matrix.board }}
runs-on: ubuntu-latest
strategy:
matrix:
board: ["Legion2:avr:HoodLoader2atmega16u2clp"]
steps:
- uses: actions/checkout@v4
- name: Build for ${{ matrix.board }}
uses: ArminJo/arduino-test-compile@v3
with:
cli-version: 0.18.3
arduino-board-fqbn: ${{ matrix.board }}
platform-url: https://raw.githubusercontent.com/NicoHood/HoodLoader2/master/package_NicoHood_HoodLoader2_index.json,https://raw.githubusercontent.com/Legion2/CorsairLightingProtocolBoards/master/package_Legion2_CorsairLightingProtocolBoards_index.json
arduino-platform: arduino:avr@1.8.3,HoodLoader2:avr@2.0.5,Legion2:avr@0.3.1
required-libraries: FastLED@3.5.0
sketch-names: HoodLoader2CLPBridge.ino
testAdafruitSAMD:
name: Test for Board ${{ matrix.board }}
runs-on: ubuntu-latest
strategy:
matrix:
board:
[
"adafruit:samd:adafruit_feather_m0:usbstack=tinyusb",
"adafruit:samd:adafruit_metro_m0:usbstack=tinyusb",
"adafruit:samd:adafruit_circuitplayground_m0:usbstack=tinyusb",
"adafruit:samd:adafruit_gemma_m0:usbstack=tinyusb",
"adafruit:samd:adafruit_trinket_m0:usbstack=tinyusb",
"adafruit:samd:adafruit_qtpy_m0:usbstack=tinyusb",
"adafruit:samd:adafruit_itsybitsy_m0:usbstack=tinyusb",
"adafruit:samd:adafruit_itsybitsy_m4:usbstack=tinyusb",
"adafruit:samd:adafruit_metro_m4_airliftlite:usbstack=tinyusb",
# "adafruit:samd:adafruit_feather_m4:usbstack=tinyusb", #Should work but doesn't have the pins needed for the sketch
"adafruit:samd:adafruit_matrixportal_m4:usbstack=tinyusb"
]
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build for ${{ matrix.board }}
uses: ArminJo/arduino-test-compile@v3
with:
cli-version: 0.18.3
arduino-board-fqbn: ${{ matrix.board }}
platform-url: https://adafruit.github.io/arduino-board-index/package_adafruit_index.json
arduino-platform: adafruit:samd@1.7.8
required-libraries: FastLED@3.5.0,Adafruit TinyUSB Library@1.9.2
sketch-names: TinyUSB.ino
testAdafruitnRF52:
name: Test for Board ${{ matrix.board }}
runs-on: ubuntu-latest
strategy:
matrix:
board:
[
"adafruit:nrf52:feather52840",
"adafruit:nrf52:itsybitsy52840",
# "adafruit:nrf52:cplaynrf52840", #Should work but doesn't have the pins needed for the sketch
"adafruit:nrf52:metro52840"
]
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Get adafruit-nrfutil
run: |
pip3 install adafruit-nrfutil --user
- name: Build for ${{ matrix.board }}
uses: ArminJo/arduino-test-compile@v3
with:
cli-version: 0.18.3
arduino-board-fqbn: ${{ matrix.board }}
platform-url: https://adafruit.github.io/arduino-board-index/package_adafruit_index.json
arduino-platform: adafruit:nrf52@1.3.0
required-libraries: FastLED@3.5.0,Adafruit TinyUSB Library@1.9.2
sketch-names: TinyUSB.ino
================================================
FILE: .github/workflows/stale.yaml
================================================
name: 'Close stale issues and PRs'
on:
schedule:
- cron: '30 1 * * *'
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
with:
days-before-stale: 14
days-before-close: 7
exempt-issue-labels: bug,enhancement,refactoring,documentation
stale-issue-message: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
================================================
FILE: .gitignore
================================================
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
# User-specific files
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
# Visual Studio 2015 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUNIT
*.VisualState.xml
TestResult.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# DNX
project.lock.json
project.fragment.lock.json
artifacts/
*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# JustCode is a .NET coding add-in
.JustCode
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# TODO: Comment the next line if you want to checkin your web deploy settings
# but database connection strings (with potential passwords) will be unencrypted
#*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/packages/*
# except build/, which is used as an MSBuild target.
!**/packages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/packages/repositories.config
# NuGet v3's project.json files produces more ignoreable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
node_modules/
orleans.codegen.cs
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
# SQL Server files
*.mdf
*.ldf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# JetBrains Rider
.idea/
*.sln.iml
# CodeRush
.cr/
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
__vm/
# Visual Studio
*.sln
*.vcxproj
*.vcxproj.filters
*.vcxitems
/doxygen
# VS Code settings
.vscode/
# Arduino CLI
build/
================================================
FILE: LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: README.md
================================================
# Corsair Lighting Protocol [](https://www.ardu-badge.com/Corsair%20Lighting%20Protocol) [](https://github.com/Legion2/CorsairLightingProtocol/actions?query=workflow%3ATest+branch%3Adev+event%3Apush) [](https://isitmaintained.com/project/Legion2/CorsairLightingProtocol "Average time to resolve an issue")
<a href="https://www.corsair.com/icue"><img src="extra/images/iCUEDarkBadge.png" alt="iCUE" height="80" /></a>
<a href="https://rgbsync.com/"><img src="extra/images/RGBSyncDarkBadge.png" alt="RGBSync" height="80" /></a>
<a href="https://gitlab.com/CalcProgrammer1/OpenRGB"><img src="extra/images/OpenRGBBadge.png" alt="OpenRGB" height="80" /></a>
<a href="https://signalrgb.com"><img src="extra/images/SignalRGBBadge.png" alt="SignalRGB" height="80" /></a>
**This library can be used to integrate custom/unofficial RGB strips with iCUE.**
_This is not an official Corsair project._
## Features
* Add support of Corsair DIY device protocol to Arduino.
* Control LEDs with the [Corsair iCUE software](https://www.corsair.com/icue).
* [Support common LED chipsets](https://github.com/FastLED/FastLED/wiki/Overview#chipsets). (e.g. WS2812B, WS2801)
* Support [FastLED](http://fastled.io/).
* Supported platforms: Arduino AVR, [TinyUSB supported cores](https://github.com/adafruit/Adafruit_TinyUSB_Arduino#supported-cores)
* Hardware Lighting mode.
* Use multiple devices at the same time.
* Repeat or scale LED channels to arbitrary size.
### Supported Devices
* Lighting Node PRO
* Commander PRO
* Lighting Node CORE
* LS100 Smart Lighting Controller
* LT100 Smart Lighting Towers
# Getting started
This project is an Arduino library called "Corsair Lighting Protocol".
It can be used to control Arduino boards with iCUE.
This project provides example sketches for easy use with Arduino IDE.
- [Requirements](#requirements)
- [Install the libraries](#install-the-libraries)
- [Create a Lighting Node PRO with AVR](#create-a-lighting-node-pro-with-avr)
- [Create a Lighting Node PRO with TinyUSB](#create-a-lighting-node-pro-for-a-raspberry-pi-pico-with-tinyusb)
- [Use the Lighting Node PRO](#use-the-lighting-node-pro)
## Requirements
The library is compatible with all boards using the MCU ATmega32U4.
This includes **Arduino Leonardo**, **SparkFun Pro Micro**, **Arduino Micro**, and **Adafruit 32u4 AVR Boards**.
It also supports the Arduino Uno and Arduino Mega, **but** this requires the [HoodLoader2](https://github.com/NicoHood/HoodLoader2) bootloader, see [this wiki](https://github.com/Legion2/CorsairLightingProtocol/wiki/How-to-use-on-Arduino-Uno-and-Arduino-Mega) for more details.
In addition, any board compatible with **Adafruit TinyUSB for Arduino** is also supported without the use of custom board definitions. Be sure to define USE_TINYUSB, which is done automatically when using a supported core and selecting TinyUSB for the USB Stack. See the TinyUSB example for implementation details.
It is **not** compatible with ATmega328 (Arduino Nano), STM8S103F3, teensy, or ESP8266 see [list of architecture/platform](https://github.com/Legion2/CorsairLightingProtocol/issues?q=is%3Aissue+label%3Aarchitecture%2Fplatform) for a detailed description why they are not supported.
In the rest of the documentation "Arduino" is used as a synonym for all supported boards regardless of the manufacturer.
When you have problems with a board not listed here, please open an [Issue](https://github.com/Legion2/CorsairLightingProtocol/issues).
## Install the libraries
To use this library you must install it with the Library-Manager.
Open the Library-Manager in Arduino IDE via Tools->Manage Libraries...
Search for "Corsair Lighting Protocol" and install the Corsair Lighting Protocol library.
This library also requires the [FastLED](http://fastled.io/) library.
Search for "FastLED" in the Library-Manager and install the FastLED library.
If using TinyUSB, also install the latest "Adafruit TinyUSB Library" as it supersedes some of the core versions.
## Create a Lighting Node PRO with AVR
This guide will teach you how to create a Lighting Node PRO with an Arduino Leonardo compatible board.
If you have an Arduino Uno or Mega, see the [other guide](https://github.com/Legion2/CorsairLightingProtocol/wiki/How-to-use-on-Arduino-Uno-and-Arduino-Mega).
1. Open the example "LightingNodePRO", you can find it in Arduino IDE in the File menu->Examples->Corsair Lighting Protocol->LightingNodePRO.
If you can't open the LightingNodePRO example the Corsair Lighting Protocol library is not installed correctly.
1. Install the [CLP Boards](https://github.com/Legion2/CorsairLightingProtocolBoards).
They can be installed by following the [CLP Boards installation guide](https://github.com/Legion2/CorsairLightingProtocolBoards#how-to-use-these-boards-in-arduino).
After installation it should be possible to select the CLP Boards in the Arduino IDE as shown in the screenshot below.
If your are using a Sparkfun Pro Micro also install the [SparkFun Boards definition](https://github.com/sparkfun/Arduino_Boards#installation-instructions).
1. Upload the "LightingNodePRO" sketch to your Arduino.
1. Do the wiring.
For more information on [how to wire the LEDs](https://github.com/FastLED/FastLED/wiki/Wiring-leds) and [how to set up the LEDs in the code](https://github.com/FastLED/FastLED/wiki/Basic-usage#setting-up-the-leds) see the links.
1. Verify your device works as expected.
Open the Windows settings->devices->Other devices.
Somewhere in the list of devices, there should be a device called "Lighting Node PRO".
1. Now open [iCUE](https://www.corsair.com/icue) there you should see the "Lighting Node PRO".
> If you have any problem during setup you may find the solution in the [Troubleshooting section](https://github.com/Legion2/CorsairLightingProtocol/wiki/Troubleshooting).
## Create a Lighting Node PRO for a Raspberry Pi Pico with TinyUSB
This guide will teach you how to create a Lighting Node PRO with a Raspberry Pi Pico.
**Note:** FastLED currently does not support the RP2040 natively. You must manually merge support by modifying your library to include the [6 RP2040 platform files](https://github.com/FastLED/FastLED/pull/1261/files#diff-fda1710ad90fcc4b2f07be21a834da7d24b00008867655232c84fb0369cfc74b) in the FastLED/src/platforms/arm/rp2040 folder and `#elif defined(ARDUINO_ARCH_RP2040)` / `#include` statements in [led_sysdefs.h](https://github.com/FastLED/FastLED/pull/1261/files#diff-95f6b43a0e6b0e58988e1be3bc6415ded5284082a4f2ce2aaa90f5931d4194af) and [platforms.h](https://github.com/FastLED/FastLED/pull/1261/files#diff-255ea38a6573ed237ea1fe164d5e87ca46811eef21ba6e2cef120fda47c6e62f).
1. Install the [Raspberry Pi Pico Arduino core](https://github.com/earlephilhower/arduino-pico#installing-via-arduino-boards-manager).
1. Open the example "TinyUSB", you can find it in Arduino IDE in the File menu->Examples->Corsair Lighting Protocol->TinyUSB.
If you can't open the LightingNodePRO example the Corsair Lighting Protocol library is not installed correctly.
1. Select the Raspberry Pi Pico as shown in the screenshot below. Be sure to select the "Adafruit TinyUSB" USB Stack.
1. Upload the "TinyUSB" sketch to your Pico.
1. Do the wiring.
For more information on [how to wire the LEDs](https://github.com/FastLED/FastLED/wiki/Wiring-leds) and [how to set up the LEDs in the code](https://github.com/FastLED/FastLED/wiki/Basic-usage#setting-up-the-leds) see the links.
A level shifter or buffer, like [this one](https://www.ti.com/product/SN74AHCT1G126), is recommended in between the Pico and LEDs to translate the 3.3v logic level of the Pico IO to the 5v logic level of the LEDs. Your setup may not work reliably without one.
1. Verify your device works as expected.
Open the Windows settings->devices->Other devices.
Somewhere in the list of devices, there should be a device called "Lighting Node PRO".
1. Now open [iCUE](https://www.corsair.com/icue) there you should see the "Lighting Node PRO".
## Use the Lighting Node PRO
In iCUE open the "Lighting Setup" tab of the Lighting Node PRO(LNP) and set for both Lighting Channels the device to "RGB Light Strip" and the amount to a tenth of the LEDs you have.
iCUE groups the LEDs into groups of ten.
So if you have 20 LEDs, set the amount to 2.
Now you can create lighting effects in the "Lighting Channel #" tabs.
# Documentation
- [API Documentation](https://legion2.github.io/CorsairLightingProtocol/)
- [How it works](#how-it-works)
- [Use of multiple devices](#use-of-multiple-devices)
- [Repeat or scale LED channels](#repeat-or-scale-led-channels)
- [Increase the Brightness of the LEDs](#increase-the-brightness-of-the-leds)
- [Hardware Lighting mode](#hardware-lighting-mode)
## How it works
This library uses the USB HID interface of the ATmega32U4.
After uploading a sketch with the library and selected CLP Boards, iCUE recognizes the Arduino as a Corsair device, because the CLP Boards use USB IDs of Corsair.
In iCUE you can then select the device and set some lighting effects.
iCUE sends these via the HID protocol to the Arduino.
These commands are understood by the library and converted into lighting effects on the RGB strips connected to the Arduino.
The [FastLED](http://fastled.io/) library is used to control the LEDs.
## Use of multiple devices
Each device has two unique IDs, that is, they should be unique.
You must give each device a unique ID.
There are two IDs that must be changed `Serial Number` and `DeviceID`.
The Serial Number can be set in the constructor of `CorsairLightingProtocolHID` and `CLPUSBSerialBridge` as shown in the [example](examples/AdditionalFeatures/AdditionalFeatures.ino).
```C++
const char mySerialNumber[] PROGMEM = "202B6949A967";
CorsairLightingProtocolHID cHID(&cLP, mySerialNumber);
```
The Serial Number MAY only consist of HEX characters (0-9 and A-F).
The DeviceID can be set with the `setDeviceID` function of `CorsairLightingFirmware`.
```C++
void setup() {
DeviceID deviceId = { 0x9A, 0xDA, 0xA7, 0x8E };
firmware.setDeviceID(deviceId);
...
}
```
### Alternative
The `DeviceID` can be changed with the [DeviceIDTool](examples/DeviceIDTool/DeviceIDTool.ino).
Upload the DeviceIDTool sketch and then open the Serial monitor with baudrate 115200.
The tool displays the current DeviceID, you can type in a new DeviceID that is saved on the Arduino.
After that, you can upload another sketch.
## Repeat or scale LED channels
You can repeat or scale LED channel controlled by iCUE onto physical LED strips.
This is very useful if you have very long LED strips that are longer than 60/96/135 LEDs, which is the maximum number iCUE supports.
To repeat or scale a LED channel you must apply the `CLP::repeat` or the `CLP:scale` function in the update hook of the FastLEDController.
See the [RepeatAndScale](examples/RepeatAndScale/RepeatAndScale.ino) example for the complete code.
Both functions take the FastLEDController pointer and the channel index as arguments.
Additionally, the `repeat` function takes as an argument how often the LED channel should be repeated.
For example, if you want to duplicate the channel you must pass `2` as argument.
The `scale` function takes as third argument the length of the physical LED strip to which it scales the channel using integer scaling.
For example you have 144 physical LEDs on you strip and 60 on the LED channel.
Then the third argument of the `scale` function is `144`.
For both functions it's **important**, that the CRGB arrays have at least the length of the physical LED strip.
This means if your LED channel from iCUE has 50 LEDs and you use the `repeat` function to control 100 physical LEDs you MUST declare the CRGB array at least with a length of 100.
## Increase the Brightness of the LEDs
When using LS100 or LT100 iCUE only uses 50% of the LEDs brightness even if you set the brightness to max in the iCUE Device Settings.
But there are good news, we can increase the brightness with the Arduino so we can use the full brightness of our LEDs.
Add the `CLP::fixIcueBrightness` function to the `onUpdateHook` in the setup function as shown in the [example](examples/AmbientBacklight/AmbientBacklight.ino).
If there are multiple functions called in `onUpdateHook`, `fixIcueBrightness` should be the first.
Only use this function with LS100 and LT100 devices!
```C++
ledController.onUpdateHook(0, []() {
CLP::fixIcueBrightness(&ledController, 0);
});
```
## Reverse direction of LED Strip
If you want to change the direction of the LEDs of the Strip without physically change the strip, the `CLP::reverse` function can be used.
The reverse function must be called be for scaling.
```C++
ledController.onUpdateHook(0, []() {
CLP::reverse(&ledController, 0);
});
```
## Hardware Lighting mode
The [Hardware Lighting mode](https://forum.corsair.com/v3/showthread.php?t=182874) can be configured in iCUE.
It allows you the set lighting effects that will be active when iCUE **is not** running.
This is the case when the PC is off, in sleep mode, booting or the user is logged out.
So if you want to have lighting effects in all these situations, use the Hardware Lighting mode.
If you don't want it, configure a static black color.
# License
This project is licensed under the Apache 2.0 License.
# DISCLAIMERS
This is a DO IT YOURSELF project, use at your own risk!
# Credits
- [HoodLoader2](https://github.com/NicoHood/HoodLoader2)
- [Arduino HID Project](https://github.com/NicoHood/HID)
- [Protocol Information](https://github.com/audiohacked/OpenCorsairLink/issues/70)
## Related projects
- [CorsairArduinoController](https://github.com/TylerSeiford/CorsairArduinoController)
- [CorsairLightingProtocolBoards](https://github.com/Legion2/CorsairLightingProtocolBoards)
- [OpenCorsairLighting](https://github.com/McHauge/OpenCorsairLighting)
================================================
FILE: examples/.clang-format
================================================
BasedOnStyle: Google
ColumnLimit: 120
IndentWidth: 4
TabWidth: 4
UseTab: ForContinuationAndIndentation
AccessModifierOffset: -4
AllowShortBlocksOnASingleLine: false
AllowShortFunctionsOnASingleLine: false
AllowShortLambdasOnASingleLine: false
================================================
FILE: examples/AdditionalFeatures/AdditionalFeatures.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
CRGB ledsChannel1[60];
CRGB ledsChannel2[60];
// Define a custom SerialNumber for the device
const char mySerialNumber[] PROGMEM = "202B6949A967";
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
// Set the SerialNumber here
CorsairLightingProtocolHID cHID(&cLP, mySerialNumber);
void setup() {
// Disable the build in RX and TX LEDs of the Arduino
CLP::disableBuildInLEDs();
// enable reset on DeviceId (FF FF FF FF)
if (CLP::shouldReset(&firmware)) {
// reset DeviceId and generate new one
CLP::reset(&firmware);
// reset the LEDController Settings
ledController.reset();
}
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 60);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 60);
ledController.addLEDs(0, ledsChannel1, 60);
ledController.addLEDs(1, ledsChannel2, 60);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
CLP::printFps(5000);
}
}
================================================
FILE: examples/AmbientBacklight/AmbientBacklight.ino
================================================
/*
Copyright 2020 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
// Hint: The channels are swapped in iCUE, so the first channel in iCUE is here channel 2
#define DATA_PIN_CHANNEL_1 2 // For the monitor backlight
#define DATA_PIN_CHANNEL_2 3
CRGB ledsChannel1[84];
CRGB ledsChannel2[105];
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_SMART_LIGHTING_CONTROLLER, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 84);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 105);
ledController.addLEDs(0, ledsChannel1, 84);
ledController.addLEDs(1, ledsChannel2, 105);
ledController.onUpdateHook(0, []() {
// increase the brightness of channel 1 when using iCUE, because iCUE only set brightness to max 50%
CLP::fixIcueBrightness(&ledController, 0);
// gamma correction with gamma value 2.0. Use napplyGamma_video for other gamma values.
CLP::gammaCorrection(&ledController, 0);
// napplyGamma_video(ledsChannel1, 84, 2.2);
});
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/CommanderPRO/CommanderPRO.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#include "SimpleFanController.h"
#include "ThermistorTemperatureController.h"
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
#define TEMP_SENSOR_PIN_1 A6
#define TEMP_SENSOR_PIN_2 A8
#define FAN_UPDATE_RATE 500
#define PWM_FAN_PIN_1 5
#define PWM_FAN_PIN_2 6
#define PWM_FAN_PIN_3 9
#define PWM_FAN_PIN_4 10
#define CHANNEL_LED_COUNT 96
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_COMMANDER_PRO, &firmwareStorage);
ThermistorTemperatureController temperatureController;
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
SimpleFanController fanController(&temperatureController, FAN_UPDATE_RATE, EEPROM_ADDRESS + storage.getEEPROMSize());
CorsairLightingProtocolController cLP(&ledController, &temperatureController, &fanController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
CRGB ledsChannel1[CHANNEL_LED_COUNT];
CRGB ledsChannel2[CHANNEL_LED_COUNT];
PWMFan fan1(PWM_FAN_PIN_1, 0, 2000);
PWMFan fan2(PWM_FAN_PIN_2, 0, 2000);
PWMFan fan3(PWM_FAN_PIN_3, 0, 2000);
PWMFan fan4(PWM_FAN_PIN_4, 0, 2000);
void setup() {
CLP::disableBuildInLEDs();
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, CHANNEL_LED_COUNT);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, CHANNEL_LED_COUNT);
ledController.addLEDs(0, ledsChannel1, CHANNEL_LED_COUNT);
ledController.addLEDs(1, ledsChannel2, CHANNEL_LED_COUNT);
temperatureController.addSensor(0, TEMP_SENSOR_PIN_1);
temperatureController.addSensor(1, TEMP_SENSOR_PIN_2);
fanController.addFan(0, &fan1);
fanController.addFan(1, &fan2);
fanController.addFan(2, &fan3);
fanController.addFan(3, &fan4);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
fanController.updateFans();
}
================================================
FILE: examples/CommanderPRO/PWMFan.cpp
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "PWMFan.h"
PWMFan::PWMFan(uint8_t pwmPin, uint16_t minRPM, uint16_t maxRPM) : pwmPin(pwmPin), minRPM(minRPM), maxRPM(maxRPM) {
pinMode(pwmPin, OUTPUT);
analogWrite(pwmPin, 0);
switch (digitalPinToTimer(pwmPin)) {
case TIMER0B: /* 3 */
#ifdef DEBUG
Serial.println(F("Pin not supported as PWM fan pin"));
Serial.println(F("We don't want to mess up Arduino time functions"));
#endif // DEBUG
break;
case TIMER3A: /* 5 */
TCCR3B = (TCCR3B & B11111000) | 0x01;
break;
case TIMER4D: /* 6 */
// PLLFRQ = (PLLFRQ & B11001111) | (0x03 << PLLTM0);
TCCR4B = (TCCR4B & B11110000) | 0x01;
break;
case TIMER1A: /* 9 */
TCCR1B = (TCCR1B & B11111000) | 0x01;
break;
case TIMER1B: /* 10 */
TCCR1B = (TCCR1B & B11111000) | 0x01;
break;
default:
#ifdef DEBUG
Serial.println(F("Pin not supported as PWM fan pin"));
#endif // DEBUG
break;
}
}
void PWMFan::setPower(uint8_t percentage) {
analogWrite(pwmPin, percentage);
}
uint8_t PWMFan::calculatePowerFromSpeed(uint16_t rpm) {
rpm = constrain(rpm, minRPM, maxRPM);
return ((float)(rpm - minRPM) / (float)(maxRPM - minRPM)) * 255;
}
uint16_t PWMFan::calculateSpeedFromPower(uint8_t power) {
return map(power, 0, 255, minRPM, maxRPM);
}
================================================
FILE: examples/CommanderPRO/PWMFan.h
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#pragma once
#include "Arduino.h"
class PWMFan {
public:
/**
* PWM fan which maps speed to power using linear interpolation. This fan does not read the real RPM values. The
* Arduino timer for the given pin will be set to higher speed.
*
* @param pwmPin the Arduino pwm pin for this fan. Not all PWM pins are supported.
* @param minRPM the speed in RPM at 0% power
* @param maxRPM the speed in RPM at 100% power
*/
PWMFan(uint8_t pwmPin, uint16_t minRPM, uint16_t maxRPM);
virtual void setPower(uint8_t percentage);
virtual uint8_t calculatePowerFromSpeed(uint16_t rpm);
virtual uint16_t calculateSpeedFromPower(uint8_t power);
protected:
const uint8_t pwmPin;
const uint16_t minRPM;
const uint16_t maxRPM;
};
================================================
FILE: examples/CommanderPRO/SimpleFanController.cpp
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "SimpleFanController.h"
#include <EEPROM.h>
SimpleFanController::SimpleFanController(TemperatureController* temperatureController, uint16_t updateRate,
uint16_t eEPROMAdress)
: temperatureController(temperatureController), updateRate(updateRate), eEPROMAdress(eEPROMAdress) {
load();
}
void SimpleFanController::addFan(uint8_t index, PWMFan* fan) {
if (index >= FAN_NUM) {
return;
}
fans[index] = fan;
switch (fanData[index].mode) {
case FAN_CONTROL_MODE_FIXED_POWER:
fanData[index].speed = fan->calculateSpeedFromPower(fanData[index].power);
break;
case FAN_CONTROL_MODE_FIXED_RPM:
fanData[index].power = fan->calculatePowerFromSpeed(fanData[index].speed);
break;
}
}
bool SimpleFanController::updateFans() {
unsigned long currentUpdate = millis();
unsigned long lastUpdateNumber = lastUpdate / updateRate;
unsigned long currentUpdateNumber = currentUpdate / updateRate;
lastUpdate = currentUpdate;
if (lastUpdateNumber < currentUpdateNumber) {
if (triggerSave) {
triggerSave = false;
save();
}
for (uint8_t i = 0; i < FAN_NUM; i++) {
if (fans[i] == nullptr) {
continue;
}
if (fanData[i].mode == FAN_CONTROL_MODE_FIXED_RPM || fanData[i].mode == FAN_CONTROL_MODE_FIXED_POWER) {
fans[i]->setPower(fanData[i].power);
continue;
}
uint16_t temp;
const uint8_t& group = fanData[i].tempGroup;
if (group == FAN_CURVE_TEMP_GROUP_EXTERNAL) {
temp = externalTemp[i];
} else if (group < TEMPERATURE_NUM) {
temp = temperatureController->getTemperature(group);
}
const FanCurve& fanCurve = fanData[i].fanCurve;
uint16_t speed;
if (temp <= fanCurve.temperatures[0]) {
speed = fanCurve.rpms[0];
} else if (temp > fanCurve.temperatures[FAN_CURVE_POINTS_NUM - 1]) {
speed = fanCurve.rpms[FAN_CURVE_POINTS_NUM - 1];
} else {
for (uint8_t p = 0; p < FAN_CURVE_POINTS_NUM - 1; p++) {
if (temp > fanCurve.temperatures[p + 1]) {
continue;
}
speed = map(temp, fanCurve.temperatures[p], fanCurve.temperatures[p + 1], fanCurve.rpms[p],
fanCurve.rpms[p + 1]);
break;
}
}
fanData[i].speed = speed;
fanData[i].power = fans[i]->calculatePowerFromSpeed(speed);
fans[i]->setPower(fanData[i].power);
}
return true;
}
return false;
}
uint16_t SimpleFanController::getFanSpeed(uint8_t fan) {
return fanData[fan].speed;
}
void SimpleFanController::setFanSpeed(uint8_t fan, uint16_t speed) {
fanData[fan].speed = speed;
fanData[fan].mode = FAN_CONTROL_MODE_FIXED_RPM;
fanData[fan].power = fans[fan] != nullptr ? fans[fan]->calculatePowerFromSpeed(speed) : 0;
triggerSave = true;
}
uint8_t SimpleFanController::getFanPower(uint8_t fan) {
return fanData[fan].power;
}
void SimpleFanController::setFanPower(uint8_t fan, uint8_t percentage) {
fanData[fan].power = percentage;
fanData[fan].mode = FAN_CONTROL_MODE_FIXED_POWER;
fanData[fan].speed = fans[fan] != nullptr ? fans[fan]->calculateSpeedFromPower(percentage) : 0;
triggerSave = true;
}
void SimpleFanController::setFanCurve(uint8_t fan, uint8_t group, FanCurve& fanCurve) {
fanData[fan].fanCurve = fanCurve;
fanData[fan].tempGroup = group;
fanData[fan].mode = FAN_CONTROL_MODE_CURVE;
triggerSave = true;
}
void SimpleFanController::setFanExternalTemperature(uint8_t fan, uint16_t temp) {
externalTemp[fan] = temp;
}
void SimpleFanController::setFanForce3PinMode(bool flag) {
force3PinMode = flag;
}
FanDetectionType SimpleFanController::getFanDetectionType(uint8_t fan) {
return fanData[fan].detectionType;
}
void SimpleFanController::setFanDetectionType(uint8_t fan, FanDetectionType type) {
if (fanData[fan].detectionType != type) {
fanData[fan].detectionType = type;
triggerSave = true;
}
}
bool SimpleFanController::load() {
EEPROM.get(eEPROMAdress, fanData);
return true;
}
bool SimpleFanController::save() {
#ifdef DEBUG
Serial.println(F("Save fan data to EEPROM."));
#endif
EEPROM.put(eEPROMAdress, fanData);
return true;
}
================================================
FILE: examples/CommanderPRO/SimpleFanController.h
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#pragma once
#include "Arduino.h"
#include "FanController.h"
#include "PWMFan.h"
#include "TemperatureController.h"
#define FAN_CONTROL_MODE_FIXED_POWER 0
#define FAN_CONTROL_MODE_FIXED_RPM 1
#define FAN_CONTROL_MODE_CURVE 2
struct FanData {
uint8_t mode = FAN_CONTROL_MODE_FIXED_POWER;
uint8_t power = 0;
uint16_t speed = 0;
FanDetectionType detectionType = FanDetectionType::Disconnected;
uint8_t tempGroup;
FanCurve fanCurve;
};
/**
* This simple Fan Controller implementation does not implement all features of a Fan Controller.
* It should only demonstrate how to implement your own Fan Controller.
*/
class SimpleFanController : public FanController {
public:
/**
* Fan Controller must use the EEPROM else on startup the fans can't be controlled
*
* @param temperatureController the TemperatureController used to get the temperature to control the fans
* @param updateRate is the time between fan speed updates in ms
* @param eEPROMAdress the address where the data is stored in EEPROM
*/
SimpleFanController(TemperatureController* temperatureController, uint16_t updateRate, uint16_t eEPROMAdress);
/**
* Add a fan to the Controller.
*
* @param index the index of the fan
* @param fan the fan object
*/
void addFan(uint8_t index, PWMFan* fan);
/**
* Update the fan speeds based on the temperature and commands.
*/
virtual bool updateFans();
protected:
virtual uint16_t getFanSpeed(uint8_t fan) override;
virtual void setFanSpeed(uint8_t fan, uint16_t speed) override;
virtual uint8_t getFanPower(uint8_t fan) override;
virtual void setFanPower(uint8_t fan, uint8_t percentage) override;
virtual void setFanCurve(uint8_t fan, uint8_t group, FanCurve& fanCurve) override;
virtual void setFanExternalTemperature(uint8_t fan, uint16_t temp) override;
virtual void setFanForce3PinMode(bool flag) override;
virtual FanDetectionType getFanDetectionType(uint8_t fan) override;
virtual void setFanDetectionType(uint8_t fan, FanDetectionType type) override;
bool load();
bool save();
TemperatureController* const temperatureController;
PWMFan* fans[FAN_NUM] = {nullptr};
bool force3PinMode = false;
FanData fanData[FAN_NUM];
uint16_t externalTemp[FAN_NUM];
uint16_t updateRate;
uint16_t eEPROMAdress;
/**
* Indicates that the configuration of the fans has been changed and should be saved.
*/
bool triggerSave = false;
unsigned long lastUpdate = 0;
};
================================================
FILE: examples/CommanderPRO/ThermistorTemperatureController.cpp
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "ThermistorTemperatureController.h"
#define B_COEFFICIENT 3950
#define TEMPERATURE_REFERENCE (273.15 + 25)
#define RESISTENCE_REFERENCE 10000
#define RESISTENCE_DIVIDER 10000
#define MAX_TEMP 150
void ThermistorTemperatureController::addSensor(uint8_t index, uint8_t pin) {
if (index < sizeof(sensorPins)) {
pinMode(pin, INPUT);
sensorPins[index] = pin;
}
}
uint16_t ThermistorTemperatureController::getTemperatureValue(uint8_t temperatureSensor) {
if (!isTemperatureSensorConnected(temperatureSensor)) {
return 0;
}
int read = analogRead(sensorPins[temperatureSensor]);
double resistence = (RESISTENCE_DIVIDER * (double)(1023 - read)) / read;
double temp = resistence / RESISTENCE_REFERENCE; // (R/Ro)
temp = log(temp); // ln(R/Ro)
temp /= B_COEFFICIENT; // * (1/B)
temp += 1.0 / TEMPERATURE_REFERENCE; // + (1/To)
temp = 1.0 / temp; // invert
temp -= 273.15; // convert to °C
return constrain(temp, 0, MAX_TEMP) * 100;
}
bool ThermistorTemperatureController::isTemperatureSensorConnected(uint8_t temperatureSensor) {
return sensorPins[temperatureSensor] != 0;
}
uint16_t ThermistorTemperatureController::getVoltageRail12V() {
return 0;
}
uint16_t ThermistorTemperatureController::getVoltageRail5V() {
return 0;
}
uint16_t ThermistorTemperatureController::getVoltageRail3V3() {
return 0;
}
================================================
FILE: examples/CommanderPRO/ThermistorTemperatureController.h
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#pragma once
#include "TemperatureController.h"
/**
* This TemperatureController uses Thermistors and Resistors to messure the temperature. It does not implement the
* voltage rail measurements.
*
* Thermistor Schematic:
* <pre>
* | ---- [10k - Resistor] ---- | ---- [Thermistor] ---- |
* | | |
* [Ground] Analog Pin [+5v]
* </pre>
*/
class ThermistorTemperatureController : public TemperatureController {
public:
/**
* Add a Sensor to the TemperatureController using an Arduino analog pin connected as shown in {@link
* ThermistorTemperatureController}.
*
* @param index the index of the sensorPins
* @param pin the Arduino analog pin
*/
void addSensor(uint8_t index, uint8_t pin);
protected:
virtual uint16_t getTemperatureValue(uint8_t temperatureSensor) override;
virtual bool isTemperatureSensorConnected(uint8_t temperatureSensor) override;
virtual uint16_t getVoltageRail12V() override;
virtual uint16_t getVoltageRail5V() override;
virtual uint16_t getVoltageRail3V3() override;
uint8_t sensorPins[TEMPERATURE_NUM] = {0};
};
================================================
FILE: examples/DebugSketch/DebugSketch.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define CHANNEL_LED_COUNT 96
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cLPS(&cLP);
CRGB ledsChannel1[CHANNEL_LED_COUNT];
CRGB ledsChannel2[CHANNEL_LED_COUNT];
bool printLoop = PRINT_LOOP;
bool printUpdate = PRINT_UPDATE;
void setup() {
Serial.begin(115200);
Serial.setTimeout(100);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, CHANNEL_LED_COUNT);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, CHANNEL_LED_COUNT);
ledController.addLEDs(0, ledsChannel1, CHANNEL_LED_COUNT);
ledController.addLEDs(1, ledsChannel2, CHANNEL_LED_COUNT);
}
void loop() {
if (printLoop) Serial.println(F("loop"));
cLPS.update();
if (ledController.updateLEDs()) {
if (printUpdate) Serial.println(F("updateLEDs"));
FastLED.show();
CLP::printFps(5000);
}
if (Serial.available()) {
static String cmd = "";
cmd = Serial.readStringUntil('\n');
processCommand(cmd);
}
}
void processCommand(String& cmd) {
if (cmd == F("print DeviceID")) {
DeviceID deviceId;
firmware.getDeviceID(deviceId);
CLP::printDeviceID(deviceId);
Serial.println();
}
#ifdef VERBOSE
else if (cmd == F("toggle command")) {
printCommand = !printCommand;
} else if (cmd == F("toggle response")) {
printResponse = !printResponse;
}
#endif // VERBOSE
else if (cmd == F("toggle loop")) {
printLoop = !printLoop;
} else if (cmd == F("toggle update")) {
printUpdate = !printUpdate;
} else {
Serial.println(F("Unknown command"));
}
}
================================================
FILE: examples/DebugSketch/board.txt
================================================
# CorsairLightingProtocol build property overrides
build.vid=0x1b1c
build.pid=0x0c0b
build.usb_product="Lighting Node PRO"
build.usb_manufacturer="Corsair"
build.extra_flags={build.usb_flags} -DDEBUG -DVERBOSE -DPRINT_COMMAND=true -DPRINT_RESPONSE=true -DPRINT_LOOP=true -DPRINT_UPDATE=true
================================================
FILE: examples/DeviceIDTool/DeviceIDTool.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
//
// UPLOAD THIS TO THE ARDUINO AND OPEN SERIAL MONITOR WITH BOUDRATE 115200
//
#include <CLPUtils.h>
#include <CorsairLightingFirmwareStorageEEPROM.h>
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
void setup() {
Serial.begin(115200);
Serial.setTimeout(100);
DeviceID deviceID;
firmwareStorage.loadDeviceID(deviceID);
while (!Serial) {
; // wait for serial port to connect. Needed for native USB
}
Serial.print(F("Current DeviceID: "));
CLP::printDeviceID(deviceID);
Serial.println();
Serial.println(
F("Set a new DeviceID by typing it in the Serial Monitor. The new DeviceID must be in same format as above. 4 "
"Blocks with 2 digits separated by white space."));
Serial.println();
}
void loop() {
if (Serial.available()) {
String inputString = Serial.readStringUntil('\n');
if (inputString.length() < 11) {
Serial.println(F("Input is too short!"));
Serial.println(F("Do not forget the leading zeroes!"));
Serial.println();
} else {
DeviceID newDeviceID;
newDeviceID.data[0] = strtol(&inputString[0], nullptr, 16);
newDeviceID.data[1] = strtol(&inputString[3], nullptr, 16);
newDeviceID.data[2] = strtol(&inputString[6], nullptr, 16);
newDeviceID.data[3] = strtol(&inputString[9], nullptr, 16);
Serial.println(F("Set DeviceID to: "));
CLP::printDeviceID(newDeviceID);
Serial.println();
if (CLP::isNullID(newDeviceID)) {
Serial.println(
F("This is a special DeviceID, it will generate a new random DeviceID next time iCUE controls the "
"device!"));
}
if (CLP::isResetID(newDeviceID)) {
Serial.println(
F("This is a special DeviceID, it will reset the device and then generate a new DeviceID!"));
}
Serial.println();
firmwareStorage.saveDeviceID(newDeviceID);
}
}
}
================================================
FILE: examples/HoodLoader2CLPBridge/CLPUSBSerialBridge.cpp
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "CLPUSBSerialBridge.h"
#include <CorsairLightingProtocolConstants.h>
#include <RawHID.h>
void resetIOMCU() {
digitalWrite(RESET_PIN, LOW);
delay(10);
digitalWrite(RESET_PIN, HIGH);
#ifdef DEBUG
Serial.println(F("R"));
#endif // DEBUG
}
CLPUSBSerialBridge::CLPUSBSerialBridge(const char* serialNumber) {
CLP::RawHID.setSerialNumber(serialNumber);
}
void CLPUSBSerialBridge::begin() {
Serial1.begin(SERIAL_BAUD);
CLP::RawHID.begin(rawHIDAndSerialBuffer, sizeof(rawHIDAndSerialBuffer));
}
bool waitForSynchronization() {
while (Serial1.available()) {
Serial1.read();
}
Serial1.setTimeout(SERIAL_SYNCHRONIZATION_TIMEOUT);
byte value;
size_t read = Serial1.readBytes(&value, 1);
return read == 1 && value == 42;
}
void CLPUSBSerialBridge::sendError() {
memset(rawHIDAndSerialBuffer, 0, RESPONSE_SIZE_16U2);
rawHIDAndSerialBuffer[0] = PROTOCOL_RESPONSE_ERROR;
sendResponse();
}
void CLPUSBSerialBridge::sendResponse() {
#ifdef DEBUG
Serial.print(F("R"));
Serial.println(rawHIDAndSerialBuffer[0], HEX);
#endif // DEBUG
CLP::RawHID.write(rawHIDAndSerialBuffer, RESPONSE_SIZE_16U2);
// free the shared buffer to receive new data
CLP::RawHID.enable();
}
void CLPUSBSerialBridge::handleHID() {
if (CLP::RawHID.available()) {
#ifdef DEBUG
Serial.print(F("C"));
Serial.println(rawHIDAndSerialBuffer[0], HEX);
unsigned long time = micros();
#endif // DEBUG
if (!waitForSynchronization()) {
#ifdef DEBUG
Serial.println(F("S"));
#endif // DEBUG
sendError();
return;
}
Serial1.write(rawHIDAndSerialBuffer, COMMAND_SIZE);
Serial1.setTimeout(SERIAL_RESPONSE_TIMEOUT);
size_t read = Serial1.readBytes(rawHIDAndSerialBuffer, RESPONSE_SIZE);
if (read != RESPONSE_SIZE) {
#ifdef DEBUG
Serial.print(F("T"));
Serial.println(read);
Serial.println(rawHIDAndSerialBuffer[0], HEX);
#endif // DEBUG
sendError();
return;
}
sendResponse();
#ifdef DEBUG
unsigned long duration = micros() - time;
Serial.print(F("D"));
Serial.println(duration);
#endif // DEBUG
}
}
================================================
FILE: examples/HoodLoader2CLPBridge/CLPUSBSerialBridge.h
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#pragma once
#include <CorsairLightingProtocolConstants.h>
#include "Arduino.h"
#if (COMMAND_SIZE >= RESPONSE_SIZE)
#define RAWHID_AND_SERIAL_BUFFER_SIZE COMMAND_SIZE
#endif
// Workaround for 16 byte responses don't work on 16U2 see https://github.com/Legion2/CorsairLightingProtocol/pull/152
#define RESPONSE_SIZE_16U2 64
#define SERIAL_SYNCHRONIZATION_TIMEOUT 20
#define SERIAL_RESPONSE_TIMEOUT 10
#define SERIAL_BAUD 1000000
#define RESET_PIN IO_MCU_RESET_PIN
class CLPUSBSerialBridge {
public:
/**
* Create a new CLPUSBSerialBridge with the default Serial Number.
*/
CLPUSBSerialBridge(){};
/**
* Create a new CLPUSBSerialBridge and set a Serial Number.
*
* @param serialNumber the Serial Number of the USB device
*/
CLPUSBSerialBridge(const char* serialNumber);
/**
* Setup the bridge connections. Must be called in the Arduino setup function.
*/
virtual void begin();
/**
* Reads data from USB and sents it via Serial to the main MCU. Wait for the response and set it back to the USB
* host. MUST be called in the Arduino loop function.
*/
virtual void handleHID();
private:
byte rawHIDAndSerialBuffer[RAWHID_AND_SERIAL_BUFFER_SIZE];
void sendError();
void sendResponse();
};
================================================
FILE: examples/HoodLoader2CLPBridge/HoodLoader2CLPBridge.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "CLPUSBSerialBridge.h"
CLPUSBSerialBridge usbToSerialBridge;
void setup() {
#ifdef DEBUG
Serial.begin(1000000);
#endif // DEBUG
usbToSerialBridge.begin();
}
void loop() {
usbToSerialBridge.handleHID();
}
================================================
FILE: examples/HoodLoader2UnoMegaController/HoodLoader2UnoMegaController.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
// Hint: The Arduino Uno does not have as much memory as the Arduino Mega, it may be that problems occur when a higher
// value is set here.
#define CHANNEL_LED_COUNT 60
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolSerial cLPS(&cLP);
CRGB ledsChannel1[CHANNEL_LED_COUNT];
CRGB ledsChannel2[CHANNEL_LED_COUNT];
void setup() {
/*
YOU MUST NOT USE Serial!
Serial is used by CorsairLightingProtocolSerial!
*/
cLPS.setup();
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, CHANNEL_LED_COUNT);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, CHANNEL_LED_COUNT);
ledController.addLEDs(0, ledsChannel1, CHANNEL_LED_COUNT);
ledController.addLEDs(1, ledsChannel2, CHANNEL_LED_COUNT);
}
void loop() {
cLPS.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/LS100/LS100.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
// Hint: The channels of the LS100 are swapped in iCUE, so the first channel in iCUE is here channel 2
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
#define BUTTON_PIN 4
// Hint: The ATmega32U4 does not have enough memory for 135 leds on both channels
CRGB ledsChannel1[135];
CRGB ledsChannel2[54];
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_SMART_LIGHTING_CONTROLLER, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 135);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 54);
ledController.addLEDs(0, ledsChannel1, 135);
ledController.addLEDs(1, ledsChannel2, 54);
pinMode(BUTTON_PIN, INPUT_PULLUP);
}
void loop() {
static bool lightingEnabled = true;
cHID.update();
if (buttonClicked()) {
lightingEnabled = !lightingEnabled;
fill_solid(ledsChannel1, 135, CRGB::Black);
fill_solid(ledsChannel2, 54, CRGB::Black);
FastLED.show();
}
if (lightingEnabled && ledController.updateLEDs()) {
FastLED.show();
}
}
/**
* Handle button of the LS100. The button is optional.
*
* @return true if the button was pressed and then released.
*/
bool buttonClicked() {
static bool previousState = 1;
bool state = digitalRead(BUTTON_PIN);
if (previousState == 0 && state == 1) {
previousState = state;
return true;
}
previousState = state;
return false;
}
================================================
FILE: examples/LT100/LT100.ino
================================================
/*
Copyright 2020 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define DATA_PIN_CHANNEL_1 2
CRGB ledsChannel1[108];
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_SMART_LIGHTING_TOWERS, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 108);
ledController.addLEDs(0, ledsChannel1, 108);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/LightingNodeCORE/LightingNodeCORE.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define DATA_PIN_CHANNEL_1 2
CRGB ledsChannel1[204];
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_CORE, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 204);
ledController.addLEDs(0, ledsChannel1, 204);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/LightingNodePRO/LightingNodePRO.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
CRGB ledsChannel1[96];
CRGB ledsChannel2[96];
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 96);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 96);
ledController.addLEDs(0, ledsChannel1, 96);
ledController.addLEDs(1, ledsChannel2, 96);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/MultipleFans/MultipleFans.ino
================================================
/*
Copyright 2020 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define NUMBER_OF_LEDS_PER_FAN 8
#define DATA_PIN_FAN_1 2
#define DATA_PIN_FAN_2 3
#define DATA_PIN_FAN_3 4
#define DATA_PIN_FAN_4 5
#define DATA_PIN_FAN_5 6
#define DATA_PIN_FAN_6 7
#define DATA_PIN_CHANNEL_2 8
CRGB ledsChannel1[96];
CRGB ledsChannel2[96];
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
// 6 fans on channel 1
// FAN_PIN CRGB array offset number of leds per fan
FastLED.addLeds<WS2812B, DATA_PIN_FAN_1, GRB>(ledsChannel1, NUMBER_OF_LEDS_PER_FAN * 0, NUMBER_OF_LEDS_PER_FAN);
FastLED.addLeds<WS2812B, DATA_PIN_FAN_2, GRB>(ledsChannel1, NUMBER_OF_LEDS_PER_FAN * 1, NUMBER_OF_LEDS_PER_FAN);
FastLED.addLeds<WS2812B, DATA_PIN_FAN_3, GRB>(ledsChannel1, NUMBER_OF_LEDS_PER_FAN * 2, NUMBER_OF_LEDS_PER_FAN);
FastLED.addLeds<WS2812B, DATA_PIN_FAN_4, GRB>(ledsChannel1, NUMBER_OF_LEDS_PER_FAN * 3, NUMBER_OF_LEDS_PER_FAN);
FastLED.addLeds<WS2812B, DATA_PIN_FAN_5, GRB>(ledsChannel1, NUMBER_OF_LEDS_PER_FAN * 4, NUMBER_OF_LEDS_PER_FAN);
FastLED.addLeds<WS2812B, DATA_PIN_FAN_6, GRB>(ledsChannel1, NUMBER_OF_LEDS_PER_FAN * 5, NUMBER_OF_LEDS_PER_FAN);
// normal strip on channel 2
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 96);
ledController.addLEDs(0, ledsChannel1, 96);
ledController.addLEDs(1, ledsChannel2, 96);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/NoEEPROM/NoEEPROM.ino
================================================
/*
Copyright 2021 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
CRGB ledsChannel1[96];
CRGB ledsChannel2[96];
DeviceID deviceID = {0x9A, 0xDA, 0xA7, 0x8E};
CorsairLightingFirmwareStorageStatic firmwareStorage(deviceID);
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDController ledController(nullptr);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 96);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 96);
ledController.addLEDs(0, ledsChannel1, 96);
ledController.addLEDs(1, ledsChannel2, 96);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/NonAddressable/NonAddressable.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
// The Arduino pin where the physical LEDs are connected.
// Must be PWM pins
#define RED_PIN 3
#define GREEN_PIN 5
#define BLUE_PIN 6
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
CRGB ledsChannel1[10];
void setup() {
pinMode(RED_PIN, OUTPUT);
pinMode(GREEN_PIN, OUTPUT);
pinMode(BLUE_PIN, OUTPUT);
ledController.addLEDs(0, ledsChannel1, 10);
ledController.onUpdateHook(0, []() {
// use color of first LED of the first channel
set4PinLEDs(ledsChannel1[0]);
});
}
void loop() {
cHID.update();
ledController.updateLEDs();
}
void set4PinLEDs(const CRGB& color) {
analogWrite(RED_PIN, color.r);
analogWrite(GREEN_PIN, color.g);
analogWrite(BLUE_PIN, color.b);
}
================================================
FILE: examples/RepeatAndScale/RepeatAndScale.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
CRGB ledsChannel1[100];
CRGB ledsChannel2[144];
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 100);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 144);
ledController.addLEDs(0, ledsChannel1, 50);
ledController.addLEDs(1, ledsChannel2, 60);
ledController.onUpdateHook(0, []() {
CLP::repeat(&ledController, 0, 2);
});
ledController.onUpdateHook(1, []() {
CLP::scale(&ledController, 1, 144);
});
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/SingleStripLightingNodePRO/SingleStripLightingNodePRO.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
// The number of LEDs per channel.
#define CHANNEL_LED_COUNT 50
// Total count of LEDs on all channels, the value is calculated based on the LEDs per channel.
#define NUM_LEDS (CHANNEL_LED_COUNT * 2)
// The Arduino pin where the physical LEDs are connected.
// You can use two pins, one for each channel.
// In this example we use only one pin where both channel are connected in series.
#define DATA_PIN 2
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
// This array conatins all RGB values for the LEDs of the both channels.
CRGB leds[NUM_LEDS];
void setup() {
#ifdef DEBUG
Serial.begin(115200);
#endif
CLP::disableBuildInLEDs();
FastLED.addLeds<WS2812B, DATA_PIN, GRB>(leds, NUM_LEDS);
ledController.addLEDs(0, leds, CHANNEL_LED_COUNT);
ledController.addLEDs(1, &(leds[CHANNEL_LED_COUNT]), CHANNEL_LED_COUNT);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/TinyUSB/TinyUSB.ino
================================================
/*
Copyright 2021 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
CRGB ledsChannel1[96];
CRGB ledsChannel2[96];
// Most ARM devices do not contain an EEPROM; we will use static storage for the Device ID
DeviceID deviceID = {0x9A, 0xDA, 0xA7, 0x8E};
CorsairLightingFirmwareStorageStatic firmwareStorage(deviceID);
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDController ledController(nullptr);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolTinyUSBHID cHID(&cLP);
void setup() {
cHID.setup();
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 96);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 96);
ledController.addLEDs(0, ledsChannel1, 96);
ledController.addLEDs(1, ledsChannel2, 96);
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/TransformLLFansFormatToStrip/TransformLLFansFormatToStrip.ino
================================================
/*
Copyright 2019 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <CorsairLightingProtocol.h>
#include <FastLED.h>
#define DATA_PIN_CHANNEL_1 2
#define DATA_PIN_CHANNEL_2 3
CRGB ledsChannel1[96];
CRGB ledsChannel2[60];
CorsairLightingFirmwareStorageEEPROM firmwareStorage;
CorsairLightingFirmware firmware(CORSAIR_LIGHTING_NODE_PRO, &firmwareStorage);
FastLEDControllerStorageEEPROM storage;
FastLEDController ledController(&storage);
CorsairLightingProtocolController cLP(&ledController, &firmware);
CorsairLightingProtocolHID cHID(&cLP);
void setup() {
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_1, GRB>(ledsChannel1, 96);
FastLED.addLeds<WS2812B, DATA_PIN_CHANNEL_2, GRB>(ledsChannel2, 60);
ledController.addLEDs(0, ledsChannel1, 96);
ledController.addLEDs(1, ledsChannel2, 60);
ledController.onUpdateHook(0, []() {
CLP::transformLLFanToStrip(&ledController, 0);
});
}
void loop() {
cHID.update();
if (ledController.updateLEDs()) {
FastLED.show();
}
}
================================================
FILE: examples/UnitTests/UnitTests.ino
================================================
/*
Copyright 2020 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#line 17 "UnitTests.ino"
#include <AUnit.h>
#include "FastLEDControllerUtils.h"
using namespace aunit;
class FastLEDControllerTest : public TestOnce {
protected:
void assertCRGB(const CRGB& actual, const CRGB& expected) {
assertEqual(actual.r, expected.r);
assertEqual(actual.g, expected.g);
assertEqual(actual.b, expected.b);
}
void assertCRGBArray(const CRGB* const leds, int from, int to, const CRGB& expected) {
for (int i = from; i <= to; i++) {
assertCRGB(leds[i], expected);
}
}
};
test(getLEDs) {
CRGB leds[10];
FastLEDController ledController(nullptr);
ledController.addLEDs(0, leds, 10);
assertEqual(ledController.getLEDs(0), leds);
assertEqual(ledController.getLEDs(1), nullptr);
}
testF(FastLEDControllerTest, simpleScaleUp) {
CRGB leds[20];
FastLEDController ledController(nullptr);
fill_solid(leds, 20, CRGB::Black);
ledController.addLEDs(0, leds, 10);
fill_solid(leds, 10, CRGB::White);
CLP::scale(&ledController, 0, 20);
assertCRGBArray(leds, 0, 19, CRGB::White);
}
testF(FastLEDControllerTest, simpleScaleDown) {
CRGB leds[20];
FastLEDController ledController(nullptr);
fill_solid(leds, 20, CRGB::Black);
ledController.addLEDs(0, leds, 20);
fill_solid(leds, 10, CRGB::White);
CLP::scale(&ledController, 0, 10);
assertCRGBArray(leds, 0, 4, CRGB::White);
assertCRGBArray(leds, 5, 9, CRGB::Black);
}
testF(FastLEDControllerTest, simpleScaleDownBoundaries) {
CRGB leds[20];
FastLEDController ledController(nullptr);
fill_solid(leds, 20, CRGB::Black);
ledController.addLEDs(0, leds, 20);
leds[0] = CRGB::White;
leds[19] = CRGB::Red;
CLP::scale(&ledController, 0, 5);
assertCRGBArray(leds, 0, 0, CRGB::White);
assertCRGBArray(leds, 1, 3, CRGB::Black);
assertCRGBArray(leds, 4, 4, CRGB::Red);
}
testF(FastLEDControllerTest, simpleScaleIdentity) {
CRGB leds[20];
FastLEDController ledController(nullptr);
fill_solid(leds, 20, CRGB::Black);
ledController.addLEDs(0, leds, 10);
fill_solid(leds, 10, CRGB::White);
CLP::scale(&ledController, 0, 10);
assertCRGBArray(leds, 0, 9, CRGB::White);
assertCRGBArray(leds, 10, 19, CRGB::Black);
}
testF(FastLEDControllerTest, scaleLongStrip) {
CRGB leds[41];
FastLEDController ledController(nullptr);
fill_solid(leds, 41, CRGB::Black);
ledController.addLEDs(0, leds, 27);
fill_solid(leds, 27, CRGB::White);
CLP::scale(&ledController, 0, 41);
assertCRGBArray(leds, 0, 40, CRGB::White);
}
testF(FastLEDControllerTest, LT100) {
CRGB leds[30];
FastLEDController ledController(nullptr);
fill_solid(leds, 30, CRGB::Black);
ledController.addLEDs(0, leds, 30);
leds[0] = CRGB::White;
fill_solid(leds + 1, 26, CRGB::Blue);
CLP::SegmentScaling segments[2] = {{1, 4}, {26, 26}};
CLP::scaleSegments(&ledController, 0, segments, 2);
assertCRGBArray(leds, 0, 3, CRGB::White);
assertCRGBArray(leds, 4, 29, CRGB::Blue);
}
testF(FastLEDControllerTest, singleSegmentScaleUp) {
CRGB leds[20];
FastLEDController ledController(nullptr);
fill_solid(leds, 20, CRGB::Black);
ledController.addLEDs(0, leds, 10);
fill_solid(leds, 10, CRGB::White);
CLP::SegmentScaling segments[] = {{10, 20}};
CLP::scaleSegments(&ledController, 0, segments, 1);
assertCRGBArray(leds, 0, 19, CRGB::White);
}
testF(FastLEDControllerTest, multiScaleUp) {
CRGB leds[30];
FastLEDController ledController(nullptr);
fill_solid(leds, 30, CRGB::Black);
ledController.addLEDs(0, leds, 10);
fill_solid(leds + 5, 5, CRGB::White);
CLP::SegmentScaling segments[] = {{5, 10}, {5, 20}};
CLP::scaleSegments(&ledController, 0, segments, 2);
assertCRGBArray(leds, 0, 9, CRGB::Black);
assertCRGBArray(leds, 10, 29, CRGB::White);
}
testF(FastLEDControllerTest, multiScaleDown) {
CRGB leds[30];
FastLEDController ledController(nullptr);
fill_solid(leds, 30, CRGB::Black);
ledController.addLEDs(0, leds, 30);
fill_solid(leds + 10, 20, CRGB::White);
CLP::SegmentScaling segments[] = {{10, 5}, {20, 5}};
CLP::scaleSegments(&ledController, 0, segments, 2);
assertCRGBArray(leds, 0, 4, CRGB::Black);
assertCRGBArray(leds, 5, 9, CRGB::White);
}
testF(FastLEDControllerTest, singleSegmentScaleDown) {
CRGB leds[20];
FastLEDController ledController(nullptr);
fill_solid(leds, 20, CRGB::Black);
ledController.addLEDs(0, leds, 20);
fill_solid(leds, 10, CRGB::White);
CLP::SegmentScaling segments[] = {{20, 10}};
CLP::scaleSegments(&ledController, 0, segments, 1);
assertCRGBArray(leds, 0, 4, CRGB::White);
assertCRGBArray(leds, 5, 9, CRGB::Black);
}
testF(FastLEDControllerTest, SegmentScaleOverlap) {
CRGB leds[15];
FastLEDController ledController(nullptr);
fill_solid(leds, 15, CRGB::Black);
ledController.addLEDs(0, leds, 15);
fill_solid(leds, 5, CRGB::White);
CLP::SegmentScaling segments[] = {{5, 10}, {10, 5}};
CLP::scaleSegments(&ledController, 0, segments, 2);
assertCRGBArray(leds, 0, 9, CRGB::White);
assertCRGBArray(leds, 10, 14, CRGB::Black);
}
testF(FastLEDControllerTest, SegmentScaleOverlapInverted) {
CRGB leds[15];
FastLEDController ledController(nullptr);
fill_solid(leds, 15, CRGB::Black);
ledController.addLEDs(0, leds, 15);
fill_solid(leds, 10, CRGB::White);
CLP::SegmentScaling segments[] = {{10, 5}, {5, 10}};
CLP::scaleSegments(&ledController, 0, segments, 2);
assertCRGBArray(leds, 0, 4, CRGB::White);
assertCRGBArray(leds, 5, 14, CRGB::Black);
}
testF(FastLEDControllerTest, SegmentScaleMix) {
CRGB leds[30];
FastLEDController ledController(nullptr);
fill_solid(leds, 30, CRGB::Black);
ledController.addLEDs(0, leds, 30);
fill_solid(leds, 5, CRGB::White);
fill_solid(leds + 5, 20, CRGB::Red);
fill_solid(leds + 25, 5, CRGB::Blue);
CLP::SegmentScaling segments[] = {{5, 10}, {20, 5}, {5, 10}};
CLP::scaleSegments(&ledController, 0, segments, 3);
assertCRGBArray(leds, 0, 9, CRGB::White);
assertCRGBArray(leds, 10, 14, CRGB::Red);
assertCRGBArray(leds, 15, 24, CRGB::Blue);
}
testF(FastLEDControllerTest, SegmentScaleMixInverted) {
CRGB leds[30];
FastLEDController ledController(nullptr);
fill_solid(leds, 30, CRGB::Black);
ledController.addLEDs(0, leds, 25);
fill_solid(leds, 10, CRGB::White);
fill_solid(leds + 10, 5, CRGB::Red);
fill_solid(leds + 15, 10, CRGB::Blue);
CLP::SegmentScaling segments[] = {{10, 5}, {5, 20}, {10, 5}};
CLP::scaleSegments(&ledController, 0, segments, 3);
assertCRGBArray(leds, 0, 4, CRGB::White);
assertCRGBArray(leds, 5, 24, CRGB::Red);
assertCRGBArray(leds, 25, 29, CRGB::Blue);
}
testF(FastLEDControllerTest, SegmentScaleMonitor) {
CRGB leds[130];
FastLEDController ledController(nullptr);
fill_solid(leds, 130, CRGB::Black);
ledController.addLEDs(0, leds, 84);
fill_solid(leds, 15, CRGB::White);
fill_solid(leds + 15, 27, CRGB::Red);
fill_solid(leds + 42, 15, CRGB::Blue);
fill_solid(leds + 57, 27, CRGB::Green);
CLP::SegmentScaling segments[] = {{15, 24}, {27, 41}, {15, 24}, {27, 41}};
CLP::scaleSegments(&ledController, 0, segments, 4);
assertCRGBArray(leds, 0, 23, CRGB::White);
assertCRGBArray(leds, 24, 64, CRGB::Red);
assertCRGBArray(leds, 65, 88, CRGB::Blue);
assertCRGBArray(leds, 89, 129, CRGB::Green);
}
testF(FastLEDControllerTest, SegmentScaleLongStrip) {
CRGB leds[41];
FastLEDController ledController(nullptr);
fill_solid(leds, 41, CRGB::Black);
ledController.addLEDs(0, leds, 27);
fill_solid(leds, 27, CRGB::White);
CLP::SegmentScaling segments[] = {{27, 41}};
CLP::scaleSegments(&ledController, 0, segments, 1);
assertCRGBArray(leds, 0, 40, CRGB::White);
}
void setup() {
delay(1000);
Serial.begin(115200);
while (!Serial)
;
}
void loop() {
TestRunner::run();
}
================================================
FILE: examples/UnitTests2/UnitTests2.ino
================================================
/*
Copyright 2020 Leon Kiefer
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#line 17 "UnitTests2.ino"
#include <AUnit.h>
#include "FastLEDController.h"
#include "FastLEDControllerUtils.h"
using namespace aunit;
class FastLEDControllerTest : public TestOnce {
protected:
void assertCRGB(const CRGB& actual, const CRGB& expected) {
assertEqual(actual.r, expected.r);
assertEqual(actual.g, expected.g);
assertEqual(actual.b, expected.b);
}
void assertCRGBArray(const CRGB* const leds, int from, int to, const CRGB& expected) {
for (int i = from; i <= to; i++) {
assertCRGB(leds[i], expected);
}
}
};
class TestFastLEDController : public FastLEDController {
public:
TestFastLEDController() : FastLEDController(nullptr) {
}
void setLastUpdate(unsigned long time) {
lastUpdate = time;
}
void setCurrentUpdate(unsigned long time) {
currentUpdate = time;
}
using FastLEDController::animation_step;
using FastLEDController::animation_step_count;
};
test(getLEDs) {
CRGB leds[10];
FastLEDController ledController(nullptr);
ledController.addLEDs(0, leds, 10);
assertEqual(ledController.getLEDs(0), leds);
assertEqual(ledController.getLEDs(1), nullptr);
}
testF(FastLEDControllerTest, simpleScaleUp) {
CRGB leds[20];
FastLEDController ledController(nullptr);
fill_solid(leds, 20, CRGB::Black);
ledController.addLEDs(0, leds, 20);
fill_solid(leds, 10, CRGB::White);
CLP::reverse(&ledController, 0);
assertCRGBArray(leds, 0, 9, CRGB::Black);
assertCRGBArray(leds, 10, 19, CRGB::White);
}
test(animation_step) {
TestFastLEDController ledController;
ledController.setLastUpdate(155);
ledController.setCurrentUpdate(165);
assertEqual(ledController.animation_step(5, 100), 0);
assertEqual(ledController.animation_step(10, 100), 50);
assertEqual(ledController.animation_step(20, 100), 25);
assertEqual(ledController.animation_step(40, 100), 12);
assertEqual(ledController.animation_step(5000, 100), 3);
}
test(animation_step_long) {
TestFastLEDController ledController;
ledController.setLastUpdate(3000000000);
ledController.setCurrentUpdate(300000005);
assertEqual(ledController.animation_step(5, 100), 0);
assertEqual(ledController.animation_step(10, 100), 50);
assertEqual(ledController.animation_step(20, 100), 25);
assertEqual(ledController.animation_step(40, 100), 12);
assertEqual(ledController.animation_step(5000, 100), 0);
}
test(animation_step_count) {
TestFastLEDController ledController;
ledController.setLastUpdate(155);
ledController.setCurrentUpdate(165);
assertEqual(ledController.animation_step_count(5, 100), 200);
assertEqual(ledController.animation_step_count(10, 100), 100);
assertEqual(ledController.animation_step_count(20, 100), 50);
assertEqual(ledController.animation_step_count(40, 100), 25);
assertEqual(ledController.animation_step_count(5000, 100), 0);
}
test(animation_step_count_offset) {
TestFastLEDController ledController;
ledController.setLastUpdate(195);
ledController.setCurrentUpdate(205);
assertEqual(ledController.animation_step_count(10000, 100), 1);
}
test(animation_step_count_long) {
TestFastLEDController ledController;
ledController.setLastUpdate(3000000000);
ledController.setCurrentUpdate(3000000010);
assertEqual(ledController.animation_step_count(5, 100), 200);
assertEqual(ledController.animation_step_count(10, 100), 100);
assertEqual(ledController.animation_step_count(20, 100), 50);
assertEqual(ledController.animation_step_count(40, 100), 25);
assertEqual(ledController.animation_step_count(5000, 100), 0);
}
void setup() {
delay(1000);
Serial.begin(115200);
while (!Serial)
;
}
void loop() {
TestRunner::run();
}
================================================
FILE: extra/doxygen.conf
================================================
# Doxyfile 1.8.13
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "Corsair Lighting Protocol"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 0.15.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "Control LEDs connected to an Arduino with iCUE"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = doxygen
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
ALLOW_UNICODE_NAMES = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 0.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
TOC_INCLUDE_HEADINGS = 0
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
GROUP_NESTED_COMPOUNDS = NO
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
# included in the documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES, upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
# scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.
HIDE_COMPOUND_REFERENCE= NO
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES, the
# list will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation.
# The default value is: NO.
WARN_NO_PARAMDOC = YES
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# The default value is: NO.
WARN_AS_ERROR = NO
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = src examples README.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.idl \
*.ddl \
*.odl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.cs \
*.d \
*.php \
*.php4 \
*.php5 \
*.phtml \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.py \
*.pyw \
*.f90 \
*.f95 \
*.f03 \
*.f08 \
*.f \
*.for \
*.tcl \
*.vhd \
*.vhdl \
*.ucf \
*.qsf
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
EXAMPLE_PATH = examples
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS = *
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = YES
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH = extra/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE = README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = YES
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse-libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
# to YES can help to show when doxygen was last run and thus if the
# documentation is up to date.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = YES
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the master .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = YES
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS
# When MathJax is enabled you need to specify the location relative to the HTML
# output directory using the MATHJAX_RELPATH option. The destination directory
# should contain the MathJax.js script. For instance, if the mathjax directory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when enabling USE_PDFLATEX this option is only used for generating
# bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
# by its name or with the correct syntax as to be used with the LaTeX
# \usepackage command. To get the times font for instance you can specify :
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
# To use the option intlimits with the amsmath package you can specify:
# EXTRA_PACKAGES=[intlimits]{amsmath}
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
# string, for the replacement values of the other commands the user is referred
# to HTML_HEADER.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# generated LaTeX document. The footer should contain everything after the last
# chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_HEADER for more information on how to generate a default footer and what
# special commands can be used inside the footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# LaTeX style sheets that are included after the standard style sheets created
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
# will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_STYLESHEET =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
# higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help. This option is also used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
# code with syntax highlighting in the LaTeX output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_TIMESTAMP = NO
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
# file, i.e. a series of assignments. You only have to provide replacements,
# missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's config file. A template extensions file can be generated
# using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
# with syntax highlighting in the RTF output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
# program listings (including syntax highlighting and cross-referencing
# information) to the DOCBOOK output. Note that enabling this will significantly
# increase the size of the DOCBOOK output.
# The default value is: NO.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate
gitextract_ctaqa293/
├── .clang-format
├── .editorconfig
├── .github/
│ ├── CONTRIBUTING.md
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── support.md
│ ├── dependabot.yml
│ └── workflows/
│ ├── documentation.yml
│ ├── lint.yml
│ ├── push.yml
│ └── stale.yaml
├── .gitignore
├── LICENSE
├── README.md
├── examples/
│ ├── .clang-format
│ ├── AdditionalFeatures/
│ │ └── AdditionalFeatures.ino
│ ├── AmbientBacklight/
│ │ └── AmbientBacklight.ino
│ ├── CommanderPRO/
│ │ ├── CommanderPRO.ino
│ │ ├── PWMFan.cpp
│ │ ├── PWMFan.h
│ │ ├── SimpleFanController.cpp
│ │ ├── SimpleFanController.h
│ │ ├── ThermistorTemperatureController.cpp
│ │ └── ThermistorTemperatureController.h
│ ├── DebugSketch/
│ │ ├── DebugSketch.ino
│ │ └── board.txt
│ ├── DeviceIDTool/
│ │ └── DeviceIDTool.ino
│ ├── HoodLoader2CLPBridge/
│ │ ├── CLPUSBSerialBridge.cpp
│ │ ├── CLPUSBSerialBridge.h
│ │ └── HoodLoader2CLPBridge.ino
│ ├── HoodLoader2UnoMegaController/
│ │ └── HoodLoader2UnoMegaController.ino
│ ├── LS100/
│ │ └── LS100.ino
│ ├── LT100/
│ │ └── LT100.ino
│ ├── LightingNodeCORE/
│ │ └── LightingNodeCORE.ino
│ ├── LightingNodePRO/
│ │ └── LightingNodePRO.ino
│ ├── MultipleFans/
│ │ └── MultipleFans.ino
│ ├── NoEEPROM/
│ │ └── NoEEPROM.ino
│ ├── NonAddressable/
│ │ └── NonAddressable.ino
│ ├── RepeatAndScale/
│ │ └── RepeatAndScale.ino
│ ├── SingleStripLightingNodePRO/
│ │ └── SingleStripLightingNodePRO.ino
│ ├── TinyUSB/
│ │ └── TinyUSB.ino
│ ├── TransformLLFansFormatToStrip/
│ │ └── TransformLLFansFormatToStrip.ino
│ ├── UnitTests/
│ │ └── UnitTests.ino
│ └── UnitTests2/
│ └── UnitTests2.ino
├── extra/
│ └── doxygen.conf
├── keywords.txt
├── library.properties
└── src/
├── CLPAdditionalFeatures.cpp
├── CLPAdditionalFeatures.h
├── CLPUtils.cpp
├── CLPUtils.h
├── CorsairLightingFirmware.cpp
├── CorsairLightingFirmware.h
├── CorsairLightingFirmwareStorageEEPROM.cpp
├── CorsairLightingFirmwareStorageEEPROM.h
├── CorsairLightingFirmwareStorageStatic.cpp
├── CorsairLightingFirmwareStorageStatic.h
├── CorsairLightingProtocol.h
├── CorsairLightingProtocolConstants.h
├── CorsairLightingProtocolController.cpp
├── CorsairLightingProtocolController.h
├── CorsairLightingProtocolHID.cpp
├── CorsairLightingProtocolHID.h
├── CorsairLightingProtocolResponse.cpp
├── CorsairLightingProtocolResponse.h
├── CorsairLightingProtocolSerial.cpp
├── CorsairLightingProtocolSerial.h
├── CorsairLightingProtocolTinyUSBHID.cpp
├── CorsairLightingProtocolTinyUSBHID.h
├── FanController.cpp
├── FanController.h
├── FastLEDController.cpp
├── FastLEDController.h
├── FastLEDControllerStorage.h
├── FastLEDControllerStorageEEPROM.cpp
├── FastLEDControllerStorageEEPROM.h
├── FastLEDControllerUtils.cpp
├── FastLEDControllerUtils.h
├── IFanController.h
├── ILEDController.h
├── ITemperatureController.h
├── LEDController.cpp
├── LEDController.h
├── RawHID.cpp
├── RawHID.h
├── TemperatureController.cpp
└── TemperatureController.h
SYMBOL INDEX (60 symbols across 34 files)
FILE: examples/CommanderPRO/PWMFan.h
function class (line 20) | class PWMFan {
FILE: examples/CommanderPRO/SimpleFanController.cpp
function FanDetectionType (line 133) | FanDetectionType SimpleFanController::getFanDetectionType(uint8_t fan) {
FILE: examples/CommanderPRO/SimpleFanController.h
type FanData (line 27) | struct FanData {
function class (line 40) | class SimpleFanController : public FanController {
FILE: examples/CommanderPRO/ThermistorTemperatureController.h
function class (line 30) | class ThermistorTemperatureController : public TemperatureController {
FILE: examples/HoodLoader2CLPBridge/CLPUSBSerialBridge.cpp
function resetIOMCU (line 22) | void resetIOMCU() {
function waitForSynchronization (line 40) | bool waitForSynchronization() {
FILE: examples/HoodLoader2CLPBridge/CLPUSBSerialBridge.h
function class (line 35) | class CLPUSBSerialBridge {
FILE: src/CLPAdditionalFeatures.h
function namespace (line 21) | namespace CLP {
FILE: src/CLPUtils.h
function namespace (line 32) | namespace CLP {
function namespace (line 41) | namespace CLP {
function namespace (line 131) | namespace CLP {
FILE: src/CorsairLightingFirmware.h
type DeviceID (line 40) | struct DeviceID {
function class (line 47) | class CorsairLightingFirmwareStorage {
function class (line 53) | class CorsairLightingFirmware {
FILE: src/CorsairLightingFirmwareStorageEEPROM.h
function class (line 26) | class CorsairLightingFirmwareStorageEEPROM : public CorsairLightingFirmw...
FILE: src/CorsairLightingFirmwareStorageStatic.h
function class (line 20) | class CorsairLightingFirmwareStorageStatic : public CorsairLightingFirmw...
FILE: src/CorsairLightingProtocolConstants.h
type corsair_product_enum_t (line 101) | typedef enum {
type Command (line 110) | struct Command {
FILE: src/CorsairLightingProtocolController.cpp
function CorsairLightingFirmware (line 59) | CorsairLightingFirmware* CorsairLightingProtocolController::getFirmware(...
FILE: src/CorsairLightingProtocolController.h
function class (line 31) | class CorsairLightingProtocolController {
FILE: src/CorsairLightingProtocolHID.h
function class (line 35) | class CorsairLightingProtocolHID : CorsairLightingProtocolResponse {
FILE: src/CorsairLightingProtocolResponse.h
function class (line 20) | class CorsairLightingProtocolResponse {
FILE: src/CorsairLightingProtocolSerial.h
function class (line 31) | class CorsairLightingProtocolSerial : CorsairLightingProtocolResponse {
FILE: src/CorsairLightingProtocolTinyUSBHID.cpp
function get_report_callback (line 31) | uint16_t get_report_callback(uint8_t report_id, hid_report_type_t report...
function set_report_callback (line 42) | void set_report_callback(uint8_t report_id, hid_report_type_t report_typ...
FILE: src/CorsairLightingProtocolTinyUSBHID.h
function class (line 12) | class CorsairLightingProtocolTinyUSBHID : CorsairLightingProtocolResponse {
FILE: src/FanController.cpp
function isValidFanMask (line 20) | bool isValidFanMask(const FanMask fanMask) {
function isValidFanDetectionType (line 24) | bool isValidFanDetectionType(const FanDetectionType type) {
FILE: src/FanController.h
type class (line 33) | enum class
type class (line 49) | enum class
type FanCurve (line 73) | struct FanCurve {
function class (line 88) | class FanController : public IFanController {
FILE: src/FastLEDController.cpp
function CRGB (line 47) | CRGB* FastLEDController::getLEDs(uint8_t channel) {
function CRGB (line 88) | CRGB FastLEDController::randomColor() { return ColorFromPalette(RainbowC...
FILE: src/FastLEDControllerStorage.h
function class (line 20) | class FastLEDControllerStorage {
FILE: src/FastLEDControllerStorageEEPROM.h
function class (line 26) | class FastLEDControllerStorageEEPROM : public FastLEDControllerStorage {
FILE: src/FastLEDControllerUtils.cpp
function scaleIndex (line 51) | inline int scaleIndex(const int index, const float scaleFactor) { return...
function scaleFactorOf (line 53) | float scaleFactorOf(const int numberLEDsBefore, const int numberLEDsAfte...
FILE: src/FastLEDControllerUtils.h
function namespace (line 21) | namespace CLP {
FILE: src/IFanController.h
function class (line 25) | class IFanController {
FILE: src/ILEDController.h
function class (line 25) | class ILEDController {
FILE: src/ITemperatureController.h
function class (line 25) | class ITemperatureController {
FILE: src/LEDController.cpp
function LEDChannel (line 215) | const LEDChannel& LEDController::getChannel(uint8_t channelIndex) { retu...
FILE: src/LEDController.h
type class (line 37) | enum class
function isValidChannelMode (line 48) | bool inline isValidChannelMode(const ChannelMode channelMode) {
type class (line 57) | enum class
function isValidPortType (line 64) | bool inline isValidPortType(const PortType portType) {
type class (line 84) | enum class
function isValidGroupSpeed (line 86) | bool inline isValidGroupSpeed(const GroupSpeed groupSpeed) {
type class (line 93) | enum class
function isValidGroupDirection (line 95) | bool inline isValidGroupDirection(const GroupDirection groupDirection) {
type class (line 102) | enum class
function isValidGroupExtra (line 104) | bool inline isValidGroupExtra(const GroupExtra groupExtra) {
type LEDGroup (line 114) | struct LEDGroup {
type LEDChannel (line 141) | struct LEDChannel {
function class (line 161) | class LEDController : public ILEDController {
FILE: src/RawHID.cpp
type CLP (line 167) | namespace CLP {
FILE: src/RawHID.h
function namespace (line 58) | namespace CLP {
FILE: src/TemperatureController.h
function class (line 38) | class TemperatureController : public ITemperatureController {
Condensed preview — 87 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (366K chars).
[
{
"path": ".clang-format",
"chars": 128,
"preview": "BasedOnStyle: Google\nColumnLimit: 120\nIndentWidth: 4\nTabWidth: 4\nUseTab: ForContinuationAndIndentation\nAccessModifierOff"
},
{
"path": ".editorconfig",
"chars": 182,
"preview": "root = true\n\n[*]\nindent_style = tab\nindent_size = 4\ncharset = utf-8\ntrim_trailing_whitespace = false\ninsert_final_newlin"
},
{
"path": ".github/CONTRIBUTING.md",
"chars": 2795,
"preview": "# How to contribute\n\nYou can contribute in many different ways, for example report a bug or come up with an idea for imp"
},
{
"path": ".github/FUNDING.yml",
"chars": 590,
"preview": "# These are supported funding model platforms\n\ngithub: Legion2\npatreon: # Replace with a single Patreon username\nopen_co"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"chars": 818,
"preview": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: bug\nassignees: ''\n\n---\n\n**Describe the "
},
{
"path": ".github/ISSUE_TEMPLATE/support.md",
"chars": 651,
"preview": "---\nname: Support\nabout: You have a problem using this project and need help?\ntitle: ''\nlabels: support\nassignees: ''\n\n-"
},
{
"path": ".github/dependabot.yml",
"chars": 117,
"preview": "version: 2\nupdates:\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"daily\"\n"
},
{
"path": ".github/workflows/documentation.yml",
"chars": 594,
"preview": "name: Deploy Documentation\n\non:\n push:\n branches:\n - dev\n\njobs:\n doxygen:\n runs-on: ubuntu-latest\n\n step"
},
{
"path": ".github/workflows/lint.yml",
"chars": 497,
"preview": "name: Check Code Format\n\non: [push, pull_request]\n\njobs:\n lint:\n runs-on: ubuntu-latest\n\n steps:\n - uses: acti"
},
{
"path": ".github/workflows/push.yml",
"chars": 5513,
"preview": "on: [push, pull_request, workflow_dispatch]\nname: Test\njobs:\n test:\n name: Test for Board ${{ matrix.board }}\n ru"
},
{
"path": ".github/workflows/stale.yaml",
"chars": 553,
"preview": "name: 'Close stale issues and PRs'\non:\n schedule:\n - cron: '30 1 * * *'\n\njobs:\n stale:\n runs-on: ubuntu-latest\n "
},
{
"path": ".gitignore",
"chars": 4437,
"preview": "## Ignore Visual Studio temporary files, build results, and\n## files generated by popular Visual Studio add-ons.\n\n# User"
},
{
"path": "LICENSE",
"chars": 11357,
"preview": " Apache License\n Version 2.0, January 2004\n "
},
{
"path": "README.md",
"chars": 14586,
"preview": "# Corsair Lighting Protocol [![arduino-library-badge](https://www.ardu-badge.com/badge/Corsair%20Lighting%20Protocol.svg"
},
{
"path": "examples/.clang-format",
"chars": 244,
"preview": "BasedOnStyle: Google\nColumnLimit: 120\nIndentWidth: 4\nTabWidth: 4\nUseTab: ForContinuationAndIndentation\nAccessModifierOff"
},
{
"path": "examples/AdditionalFeatures/AdditionalFeatures.ino",
"chars": 1873,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/AmbientBacklight/AmbientBacklight.ino",
"chars": 1911,
"preview": "/*\n Copyright 2020 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/CommanderPRO/CommanderPRO.ino",
"chars": 2452,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/CommanderPRO/PWMFan.cpp",
"chars": 1827,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/CommanderPRO/PWMFan.h",
"chars": 1320,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/CommanderPRO/SimpleFanController.cpp",
"chars": 4574,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/CommanderPRO/SimpleFanController.h",
"chars": 3006,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/CommanderPRO/ThermistorTemperatureController.cpp",
"chars": 2056,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/CommanderPRO/ThermistorTemperatureController.h",
"chars": 1745,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/DebugSketch/DebugSketch.ino",
"chars": 2432,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/DebugSketch/board.txt",
"chars": 293,
"preview": "# CorsairLightingProtocol build property overrides\n\nbuild.vid=0x1b1c\nbuild.pid=0x0c0b\nbuild.usb_product=\"Lighting Node P"
},
{
"path": "examples/DeviceIDTool/DeviceIDTool.ino",
"chars": 2368,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/HoodLoader2CLPBridge/CLPUSBSerialBridge.cpp",
"chars": 2619,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/HoodLoader2CLPBridge/CLPUSBSerialBridge.h",
"chars": 1809,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/HoodLoader2CLPBridge/HoodLoader2CLPBridge.ino",
"chars": 805,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/HoodLoader2UnoMegaController/HoodLoader2UnoMegaController.ino",
"chars": 1772,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/LS100/LS100.ino",
"chars": 2241,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/LT100/LT100.ino",
"chars": 1249,
"preview": "/*\n Copyright 2020 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/LightingNodeCORE/LightingNodeCORE.ino",
"chars": 1246,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/LightingNodePRO/LightingNodePRO.ino",
"chars": 1409,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/MultipleFans/MultipleFans.ino",
"chars": 2344,
"preview": "/*\n Copyright 2020 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/NoEEPROM/NoEEPROM.ino",
"chars": 1424,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/NonAddressable/NonAddressable.ino",
"chars": 1598,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/RepeatAndScale/RepeatAndScale.ino",
"chars": 1574,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/SingleStripLightingNodePRO/SingleStripLightingNodePRO.ino",
"chars": 1833,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/TinyUSB/TinyUSB.ino",
"chars": 1538,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/TransformLLFansFormatToStrip/TransformLLFansFormatToStrip.ino",
"chars": 1501,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/UnitTests/UnitTests.ino",
"chars": 8125,
"preview": "/*\n Copyright 2020 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "examples/UnitTests2/UnitTests2.ino",
"chars": 4164,
"preview": "/*\n Copyright 2020 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "extra/doxygen.conf",
"chars": 108680,
"preview": "# Doxyfile 1.8.13\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org)"
},
{
"path": "keywords.txt",
"chars": 1208,
"preview": "#######################################\n# Syntax Coloring Map For Corsair Lighting Protocol\n############################"
},
{
"path": "library.properties",
"chars": 394,
"preview": "name=Corsair Lighting Protocol\nversion=0.15.0\nauthor=Leon Kiefer\nmaintainer=Leon Kiefer\nsentence=Control LED strips via "
},
{
"path": "src/CLPAdditionalFeatures.cpp",
"chars": 918,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CLPAdditionalFeatures.h",
"chars": 1090,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CLPUtils.cpp",
"chars": 2942,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CLPUtils.h",
"chars": 5766,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingFirmware.cpp",
"chars": 2207,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingFirmware.h",
"chars": 2428,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingFirmwareStorageEEPROM.cpp",
"chars": 966,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingFirmwareStorageEEPROM.h",
"chars": 974,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingFirmwareStorageStatic.cpp",
"chars": 987,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingFirmwareStorageStatic.h",
"chars": 954,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocol.h",
"chars": 1465,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolConstants.h",
"chars": 3482,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolController.cpp",
"chars": 2362,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolController.h",
"chars": 2949,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolHID.cpp",
"chars": 2123,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolHID.h",
"chars": 2158,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolResponse.cpp",
"chars": 1639,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolResponse.h",
"chars": 1476,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolSerial.cpp",
"chars": 1714,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolSerial.h",
"chars": 1804,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/CorsairLightingProtocolTinyUSBHID.cpp",
"chars": 3472,
"preview": "#include \"CorsairLightingProtocolTinyUSBHID.h\"\n\n#if defined(USE_TINYUSB)\n\nconst char* corsairProducts[] = {CORSAIR_LNP_P"
},
{
"path": "src/CorsairLightingProtocolTinyUSBHID.h",
"chars": 1400,
"preview": "#pragma once\n\n#include \"CLPUtils.h\"\n#include \"CorsairLightingProtocolConstants.h\"\n#include \"CorsairLightingProtocolContr"
},
{
"path": "src/FanController.cpp",
"chars": 5872,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/FanController.h",
"chars": 4027,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/FastLEDController.cpp",
"chars": 16535,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/FastLEDController.h",
"chars": 6815,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/FastLEDControllerStorage.h",
"chars": 801,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/FastLEDControllerStorageEEPROM.cpp",
"chars": 1230,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/FastLEDControllerStorageEEPROM.h",
"chars": 1109,
"preview": "/*\n Copyright 2021 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/FastLEDControllerUtils.cpp",
"chars": 6157,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/FastLEDControllerUtils.h",
"chars": 4401,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/IFanController.h",
"chars": 1147,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/ILEDController.h",
"chars": 1111,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/ITemperatureController.h",
"chars": 1097,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/LEDController.cpp",
"chars": 7948,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/LEDController.h",
"chars": 9026,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/RawHID.cpp",
"chars": 5703,
"preview": "/*\nCopyright (c) 2014-2015 NicoHood\nmodified by Leon Kiefer\nSee the readme for credit to other people.\nPermission is her"
},
{
"path": "src/RawHID.h",
"chars": 4527,
"preview": "/*\nCopyright (c) 2014-2015 NicoHood\nmodified by Leon Kiefer\nSee the readme for credit to other people.\nPermission is her"
},
{
"path": "src/TemperatureController.cpp",
"chars": 2543,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
},
{
"path": "src/TemperatureController.h",
"chars": 2341,
"preview": "/*\n Copyright 2019 Leon Kiefer\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use "
}
]
About this extraction
This page contains the full source code of the Legion2/CorsairLightingProtocol GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 87 files (336.1 KB), approximately 89.3k tokens, and a symbol index with 60 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.