Skip to content

Commit bc4e766

Browse files
authored
Merge pull request #96 from Legion2/update-readme
Improve the installation guide structure in Readme
2 parents 7333c75 + 8f20a41 commit bc4e766

File tree

3 files changed

+27
-13
lines changed

3 files changed

+27
-13
lines changed

README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![arduino-library-badge](https://www.ardu-badge.com/badge/Corsair%20Lighting%20Protocol.svg?)](https://www.ardu-badge.com/Corsair%20Lighting%20Protocol)
2-
![Test Status](https://github.com/Legion2/CorsairLightingProtocol/workflows/Test/badge.svg)
2+
[![Test Status](https://github.com/Legion2/CorsairLightingProtocol/workflows/Test/badge.svg)](https://github.com/Legion2/CorsairLightingProtocol/actions?query=workflow%3ATest+branch%3Adev+event%3Apush)
33

44
**This library can be used to integrate custom/unofficial RGB strips with iCUE.**
55

@@ -21,9 +21,12 @@
2121
![Overview](extra/images/overview.png)
2222

2323
# Getting started
24+
This project is an Arduino library called "Corsair Lighting Protocol".
25+
It can be used to control Arduino boards with iCUE.
26+
This project provides example sketches for easy use with Arduino IDE.
2427

2528
- [Requirements](#requirements)
26-
- [Install the library](#install-the-library)
29+
- [Install the libraries](#install-the-libraries)
2730
- [Create a Lighting Node PRO](#create-a-lighting-node-pro)
2831
- [Use the Lighting Node PRO](#use-the-lighting-node-pro)
2932

@@ -34,28 +37,39 @@ It also supports the Arduino Uno and Arduino Mega, **but** this requires the [Ho
3437
It is **not** compatible with Arduino Nano.
3538
In the rest of the documentation "Arduino" is used as a synonym for all supported boards regardless of the manufacturer.
3639

37-
You have problems with a board not listed here, please open an [Issue](https://github.com/Legion2/CorsairLightingProtocol/issues).
40+
When you have problems with a board not listed here, please open an [Issue](https://github.com/Legion2/CorsairLightingProtocol/issues).
3841

39-
## Install the library
40-
Use the [Library-Manager](https://www.ardu-badge.com/Corsair%20Lighting%20Protocol/ide) to install this library (Corsair Lighting Protocol).
41-
Additionally, the [FastLED](http://fastled.io/) library must be installed.
42+
## Install the libraries
43+
To use this library you must install it with the Library-Manager.
44+
Open the Library-Manager in Arduino IDE via Tools->Manage Libraries...
45+
Search for "Corsair Lighting Protocol" and install the Corsair Lighting Protocol library.
46+
This library also requires the [FastLED](http://fastled.io/) library.
47+
Search for "FastLED" in the Library-Manager and install the FastLED library.
4248

4349
## Create a Lighting Node PRO
4450
This guide will teach you how to create a Lighting Node PRO with an Arduino Leonardo compatible board.
4551
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).
4652

47-
1. Open the example "LightingNodePRO", you can find it in Arduino IDE in the File menu->Examples->Corsair Lighting Protocol->LightingNodePRO or in the [examples directory](examples) if you download this project.
53+
1. Open the example "LightingNodePRO", you can find it in Arduino IDE in the File menu->Examples->Corsair Lighting Protocol->LightingNodePRO.
54+
If you can't open the LightingNodePRO example the Corsair Lighting Protocol library is not installed correctly.
4855

4956
![open example sketch](extra/images/open-example.png)
50-
1. Follow [these steps](https://github.com/Legion2/CorsairLightingProtocolBoards#how-to-use-these-boards-in-arduino) to install the CLP Boards and upload the sketch to your Arduino.
57+
1. Install the [CLP Boards](https://github.com/Legion2/CorsairLightingProtocolBoards).
58+
They can be installed by following the [CLP Boards installation guide](https://github.com/Legion2/CorsairLightingProtocolBoards#how-to-use-these-boards-in-arduino).
59+
After installation it should be possible to select the CLP Boards in the Arduino IDE as shown in the screenshot below.
60+
61+
![select CLP Board](extra/images/select-board.png)
62+
1. Upload the "LightingNodePRO" sketch to your Arduino.
63+
64+
![upload sketch](extra/images/upload-sketch.png)
5165
1. Do the wiring.
5266
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.
5367

5468
![the wiring](extra/images/board-wiring.jpg)
55-
1. Verify that your device works as expected.
69+
1. Verify your device works as expected.
5670
Open the Windows settings->devices->Other devices.
5771
Somewhere in the list of devices, there should be a device called "Lighting Node PRO".
58-
1. Now open [iCUE](https://www.corsair.com/icue) there should be the "Lighting Node PRO".
72+
1. Now open [iCUE](https://www.corsair.com/icue) there you should see the "Lighting Node PRO".
5973

6074
## Use the Lighting Node PRO
6175

@@ -66,11 +80,11 @@ iCUE groups the LEDs into groups of ten.
6680
So if you have 20 LEDs, set the amount to 2.
6781
Now you can create lighting effects in the "Lighting Channel #" tabs.
6882

69-
# Misc
83+
# Documentation
7084

7185
- [API Documentation](https://legion2.github.io/CorsairLightingProtocol/)
7286
- [How it works](#how-it-works)
73-
- [Use multiple Devices](#use-multiple-devices)
87+
- [Use of multiple devices](#use-of-multiple-devices)
7488
- [Repeat or scale LED channel](#repeat-or-scale-led-channel)
7589

7690
## How it works
@@ -82,7 +96,7 @@ iCUE sends these via the CorsairLightingProtocol to the Arduino.
8296
These commands are understood by the library and converted into lighting effects on the RGB strips connected to the Arduino.
8397
The [FastLED](http://fastled.io/) library is used to control the LEDs.
8498

85-
## Use multiple Devices
99+
## Use of multiple devices
86100
Each device has two unique IDs, that is, they should be unique.
87101
You must give each device a unique ID.
88102
There are two IDs that must be changed `Serial Number` and `DeviceID`.

extra/images/select-board.png

48.4 KB
Loading

extra/images/upload-sketch.png

42.6 KB
Loading

0 commit comments

Comments
 (0)