diff --git a/makefile b/makefile
index 925cb91..d98f732 100644
--- a/makefile
+++ b/makefile
@@ -57,4 +57,5 @@ gpio:
make -C hardware/gpio
push_wiki:
- cd wiki && git add . && git commit -m "wiki" && git push && cd ..
+ node doc.js
+ cd wiki && git add . && git commit -m "wiki" && git push
diff --git a/plugins/components/Encoder2Component.h b/plugins/components/Encoder2Component.h
index 7ed4164..d655755 100644
--- a/plugins/components/Encoder2Component.h
+++ b/plugins/components/Encoder2Component.h
@@ -8,9 +8,9 @@
/*md
## Encoder2
-
+
-Encoders are used to control values.
+Encoder2 is used to display current audio plugin value for a given parameter.
*/
class Encoder2Component : public Component {
protected:
@@ -273,7 +273,7 @@ class Encoder2Component : public Component {
/*md
- `TYPE: ...` is used to set the encoder type
- `TYPE: BROWSE` TBD..
- - `TYPE: TWO_SIDED` is use for centered values like PAN 
+ - `TYPE: TWO_SIDED` is use for centered values like PAN
*/
if (strcmp(key, "TYPE") == 0) {
if (strcmp(params, "BROWSE") == 0) {
diff --git a/plugins/components/Sample.png b/plugins/components/Sample.png
new file mode 100644
index 0000000..3b48799
Binary files /dev/null and b/plugins/components/Sample.png differ
diff --git a/plugins/components/Sample2.png b/plugins/components/Sample2.png
new file mode 100644
index 0000000..b80e8b8
Binary files /dev/null and b/plugins/components/Sample2.png differ
diff --git a/plugins/components/SampleComponent.h b/plugins/components/SampleComponent.h
index ad2d0f4..b2dba9d 100644
--- a/plugins/components/SampleComponent.h
+++ b/plugins/components/SampleComponent.h
@@ -7,6 +7,15 @@
#include "./component.h"
#include
+/*md
+## Sample
+
+
+
+
+Sample is used to display an audio sample, sustain position, and start/end position.
+The little green dot are the current playing positions of the sample.
+*/
class SampleComponent : public Component {
protected:
AudioPlugin* plugin;
@@ -168,17 +177,20 @@ class SampleComponent : public Component {
bool config(char* key, char* value)
{
+ /*md - `COLOR: #FFFFFF` set color of the waveform */
if (strcmp(key, "COLOR") == 0) {
colors = getColorsFromColor(draw.getColor(value));
wave.setColors(draw.getColor(value));
return true;
}
+ /*md - `BACKGROUND_COLOR: #000000` set background color */
if (strcmp(key, "BACKGROUND_COLOR") == 0) {
colors.background = draw.getColor(value);
return true;
}
+ /*md - `KEYS: BROWSER START END SUSTAIN LENGTH` set the key parameter to use from plugin */
if (strcmp(key, "KEYS") == 0) {
valueKeys[0] = strtok(value, " ");
valueKeys[1] = strtok(NULL, " ");
@@ -188,6 +200,7 @@ class SampleComponent : public Component {
return true;
}
+ /*md - `AUDIO_PLUGIN: pluginName bufferDataId` set the plugin to use from plugin */
if (strcmp(key, "AUDIO_PLUGIN") == 0) {
char* pluginName = strtok(value, " ");
bufferDataId = atoi(strtok(NULL, " "));
diff --git a/wiki b/wiki
index b81b41a..d061367 160000
--- a/wiki
+++ b/wiki
@@ -1 +1 @@
-Subproject commit b81b41aa3e3b738349350549a5d45e5a18313ac1
+Subproject commit d0613671561cd5dd4c29217279979a4cf893c862