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
parent
6b097f1773
commit
663b2bb2f1
@ -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)
|
@ -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…
Reference in new issue