Add Library + Docs

Author: karlsoderby

README.md

@@ -1,2 +1,3 @@
 # Arduino_GigaDisplayRBG
-Minimal library for controlling the RGB on the GIGA Display Shield.
+
+Minimal library for controlling the built-in RGB on the GIGA Display Shield via the IS31FL3197 driver (I2C).

docs/api.md

@@ -0,0 +1,73 @@
+# ArduinoLSM6DS3 library
+
+## Classes
+
+### `GigaDisplayRGB`
+
+Base class for all RGB functions.
+
+#### Syntax
+
+```
+GigaDisplayRGB rgb; //creates an object
+
+rgb.begin(); //using the object
+```
+
+## Methods
+
+### `begin()`
+
+Initialize the library.
+
+#### Syntax 
+
+```
+rgb.begin()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+None.
+
+### `on()`
+
+Set pixel color (r,g,b).
+
+#### Syntax 
+
+```
+rgb.on(r, g, b)
+```
+
+#### Parameters
+
+Accepts values in range of 0-255 (8-bit).
+
+- `uint8_t`, `uint8_t`, `uint8_t` 
+
+#### Returns
+
+None.
+
+### `off()`
+
+Turns off all pixels by setting all parameters to 0. Same effect as using `rgb.on(0,0,0)`
+
+#### Syntax 
+
+```
+rgb.off()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+None.

docs/readme.md

@@ -0,0 +1,29 @@
+# Arduino_GigaDisplayRGB Library
+
+Minimal library for controlling the built-in RGB on the GIGA Display Shield via the IS31FL3197 driver (I2C).
+
+To use this library:
+
+```
+#include <Arduino_GigaDisplayRGB.h>
+```
+
+
+Minimal example:
+
+```
+#include <Arduino_GigaDisplayRGB.h>
+
+GigaDisplayRGB rgb;
+
+void setup() {
+  rgb.begin();
+}
+
+void loop() {
+  rgb.on(255, 0, 0);
+  delay(100);
+  rgb.off();
+  delay(100);
+}
+```

examples/SimpleRGB/SimpleRGB.ino

@@ -0,0 +1,31 @@
+#include <Arduino_GigaDisplayRGB.h>
+
+//Create rgb object
+GigaDisplayRGB rgb;
+
+void setup() {
+  //init library
+  rgb.begin();
+}
+
+void loop() {
+  //all pixels off
+  rgb.on(0, 0, 0);
+  delay(100);
+
+  //red pixel on
+  rgb.on(255, 0, 0);
+  delay(100);
+
+  //green pixel on
+  rgb.on(0, 255, 0);
+  delay(100);
+
+  //blue pixel on
+  rgb.on(0, 0, 255);
+  delay(100);
+
+  //all pixels on
+  rgb.on(255, 255, 255);
+  delay(100);
+}

library.properties

@@ -0,0 +1,10 @@
+name=GigaDisplayRGB
+version=0.0.1
+author=Arduino
+maintainer=Arduino <info@arduino.cc>
+sentence=Controls the RGB on the GIGA Display Shield
+paragraph=
+category=Device Control
+url=https://www.arduino.cc/
+architectures=mbed_giga
+includes=GigaDisplayRGB.h

src/Arduino_GigaDisplayRGB.h

@@ -0,0 +1,6 @@
+#ifndef  _ARDUINO_GIGADISPLAYRGB_H_
+#define  _ARDUINO_GIGADISPLAYRGB_H_
+
+#include "GigaDisplayRGB.h"
+
+#endif

src/GigaDisplayRGB.cpp

@@ -0,0 +1,32 @@
+#include "GigaDisplayRGB.h"
+
+GigaDisplayRGB::GigaDisplayRGB(){
+}
+
+void GigaDisplayRGB::begin()
+{
+    Wire1.begin();
+    writeByte(0x1, 0xF1);
+    writeByte(0x2, 0xFF);
+}
+
+void GigaDisplayRGB::on(uint8_t r, uint8_t g, uint8_t b)
+{
+    writeByte(0x10, r);
+    writeByte(0x12, g);
+    writeByte(0x11, b);
+    writeByte(0x2b, 0xc5);
+}
+
+void GigaDisplayRGB::off()
+{
+    on(0, 0, 0);
+}
+
+void GigaDisplayRGB::writeByte(uint8_t subAddress, uint8_t data)
+{
+    Wire1.beginTransmission(0x50);
+    Wire1.write(subAddress);
+    Wire1.write(data);
+    Wire1.endTransmission();
+}

src/GigaDisplayRGB.h

@@ -0,0 +1,16 @@
+#ifndef GigaDisplayRGB_h
+#define GigaDisplayRGB_h
+
+#include "Wire.h"
+
+class GigaDisplayRGB {
+    public:
+        GigaDisplayRGB();
+        void begin();
+        void on(uint8_t,uint8_t,uint8_t);
+        void off();
+    private:
+        void writeByte(uint8_t,uint8_t);
+};
+
+#endif