Rearrange the file layout in preparation of becoming a monorepo

Move the documentation to `doc/plugin/LEDEffect-Chase.md`, sources under
`src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of
merging plugins into a single monorepo.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
pull/365/head
Gergely Nagy 6 years ago
parent 6b097f1773
commit 663b2bb2f1
No known key found for this signature in database
GPG Key ID: AC1E90BAC433F68F

@ -5,30 +5,4 @@
[travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-LEDEffect-Chase.svg?branch=master
[travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-LEDEffect-Chase
A simple LED effect where one color chases another across the keyboard and back,
over and over again. Playful colors they are.
## Using the extension
To use the plugin, include the header, and tell the firmware to use it:
```c++
#include <Kaleidoscope-LEDControl.h>
#include <Kaleidoscope-LEDEffect-Chase.h>
KALEIDOSCOPE_INIT_PLUGINS(LEDControl,
LEDEffect-Chase);
void setup() {
Kaleidoscope.setup();
}
```
## Plugin methods
The plugin provides the `LEDChaseEffect` object, which has no public methods or
properties, outside of those provided by all LED modes.
## Dependencies
* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl)
See [doc/plugin/LEDEffect-Chase.md](doc/plugin/LEDEffect-Chase.md) for documentation.

@ -0,0 +1,29 @@
# Kaleidoscope-LEDEffect-Chase
A simple LED effect where one color chases another across the keyboard and back,
over and over again. Playful colors they are.
## Using the extension
To use the plugin, include the header, and tell the firmware to use it:
```c++
#include <Kaleidoscope-LEDControl.h>
#include <Kaleidoscope-LEDEffect-Chase.h>
KALEIDOSCOPE_INIT_PLUGINS(LEDControl,
LEDEffect-Chase);
void setup() {
Kaleidoscope.setup();
}
```
## Plugin methods
The plugin provides the `LEDChaseEffect` object, which has no public methods or
properties, outside of those provided by all LED modes.
## Dependencies
* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl)

@ -16,24 +16,4 @@
#pragma once
#include "Kaleidoscope-LEDControl.h"
#include "LEDUtils.h"
namespace kaleidoscope {
class LEDChaseEffect : public LEDMode {
public:
LEDChaseEffect(void) {}
protected:
void update(void) final;
private:
uint8_t pos = 0;
int8_t chase_sign = 1; //negative values when it's going backwar
uint8_t chase_pixels = 5;
uint8_t current_chase_counter = 0;
static const uint8_t chase_threshold = 150;
};
}
extern kaleidoscope::LEDChaseEffect LEDChaseEffect;
#include "kaleidoscope/plugin/LEDEffect-Chase.h"

@ -17,6 +17,7 @@
#include "Kaleidoscope-LEDEffect-Chase.h"
namespace kaleidoscope {
namespace plugin {
void LEDChaseEffect::update(void) {
// Check to see if it's time to change the positions of the red and blue lights
if (current_chase_counter++ < chase_threshold) {
@ -58,6 +59,8 @@ void LEDChaseEffect::update(void) {
if (pos2 < LED_COUNT)
::LEDControl.setCrgbAt(pos2, {255, 0, 0});
}
}
}
kaleidoscope::LEDChaseEffect LEDChaseEffect;
kaleidoscope::plugin::LEDChaseEffect LEDChaseEffect;

@ -0,0 +1,40 @@
/* Kaleidoscope-LEDEffect-Chase - A Chase LED effect for Kaleidoscope.
* Copyright (C) 2017-2018 Keyboard.io, Inc.
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation, version 3.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along with
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include "Kaleidoscope-LEDControl.h"
namespace kaleidoscope {
namespace plugin {
class LEDChaseEffect : public LEDMode {
public:
LEDChaseEffect(void) {}
protected:
void update(void) final;
private:
uint8_t pos = 0;
int8_t chase_sign = 1; //negative values when it's going backwar
uint8_t chase_pixels = 5;
uint8_t current_chase_counter = 0;
static const uint8_t chase_threshold = 150;
};
}
}
extern kaleidoscope::plugin::LEDChaseEffect LEDChaseEffect;
Loading…
Cancel
Save