Add WS2812B Example Guide and API

Author: M-ichae-l

source/_common/ameba_d/Example_Guides/WS2812B/WS2812B - Patterns.rst

@@ -19,7 +19,7 @@ Example
 
 In this example, we will be using the AmebaD board to control the WS2812B RGB LED, using the SPI peripheral to create the waveform necessary for the LEDs. 
 
-WS2812B basics allows you to control a single LED with a color or fill all the LED with the same color.
+WS2812B patterns controls LED (Strip / Ring / Stick / Board) with different colors with different LED patterns.
 
 Procedure
 -----------

source/_static/amebapro2/Example_Guides/WS2812B/WS2812B_Basics/image01.png

@@ -120,6 +120,16 @@ A class of SPI implementation for Ameba.
 +---------------------------------+------------------------------------------+
 | SPIClass::end                   | Stop SPI master mode                     |
 +---------------------------------+------------------------------------------+
+| SPIClass::slaveRead             | Slave receive one frame use SPI          |
++---------------------------------+------------------------------------------+
+| SPIClass::slaveWrite            | Slave send one frame use SPI             |
++---------------------------------+------------------------------------------+
+| SPIClass::masterWrite           | Master send one frame use SPI            |
++---------------------------------+------------------------------------------+
+| SPIClass::pSpiMaster            | Pointer of SPI master project            |
++---------------------------------+------------------------------------------+
+| SPIClass::pSpiSlave             | Pointer of SPI slave project             |
++---------------------------------+------------------------------------------+
 
 **SPIClass::SPIClass**
 ----------------------
@@ -519,3 +529,166 @@ NA
 NA
 
 .. note :: After calling end(), you need to use begin() again to enable SPI function. "SPI.h" must be included to use the class function.
+
+**SPIClass::slaveRead**
+-----------------
+
+**Description**
+~~~~~~~~~~~~~~~
+
+This function retrieves data from receive buffer as slave. Slave receive one frame use SPI.
+
+**Syntax**
+~~~~~~~~~~
+
+.. code-block:: c++
+
+    int slaveRead(void);
+
+**Parameters**
+~~~~~~~~~~~~~~
+
+NA
+
+**Returns**
+~~~~~~~~~~~
+
+This function returns the data received from master.
+
+**Example Code**
+~~~~~~~~~~~~~~~~
+
+NA
+
+.. note :: "SPI.h" must be included to use the class function.
+
+**SPIClass::slaveWrite**
+-----------------
+
+**Description**
+~~~~~~~~~~~~~~~
+
+This function use slave send one frame use SPI.
+
+**Syntax**
+~~~~~~~~~~
+
+.. code-block:: c++
+
+    void slaveWrite(int value);
+    void slaveWrite(spi_t *pSpiObj, int value);
+
+**Parameters**
+~~~~~~~~~~~~~~
+
+value: the data to transmit
+
+pSpiObj: spi slave object define in application software
+
+**Returns**
+~~~~~~~~~~~
+
+NA
+
+**Example Code**
+~~~~~~~~~~~~~~~~
+
+NA
+
+.. note :: "SPI.h" must be included to use the class function.
+
+**SPIClass::masterWrite**
+-----------------
+
+**Description**
+~~~~~~~~~~~~~~~
+
+This function use master send one frame use SPI.
+
+**Syntax**
+~~~~~~~~~~
+
+.. code-block:: c++
+
+    int masterWrite(int value);
+
+**Parameters**
+~~~~~~~~~~~~~~
+
+value: the data to transmit
+
+**Returns**
+~~~~~~~~~~~
+
+This function returns the data received from slave.
+
+**Example Code**
+~~~~~~~~~~~~~~~~
+
+NA
+
+.. note :: "SPI.h" must be included to use the class function.
+
+**SPIClass::pSpiMaster**
+-----------------
+
+**Description**
+~~~~~~~~~~~~~~~
+
+It is a pointer of SPI master project.
+
+**Syntax**
+~~~~~~~~~~
+
+.. code-block:: c++
+
+    spi_t *pSpiMaster;
+
+**Parameters**
+~~~~~~~~~~~~~~
+
+NA
+
+**Returns**
+~~~~~~~~~~~
+
+NA
+
+**Example Code**
+~~~~~~~~~~~~~~~~
+
+NA
+
+.. note :: "SPI.h" must be included to use the class function.
+
+**SPIClass::pSpiMaster**
+-----------------
+
+**Description**
+~~~~~~~~~~~~~~~
+
+It is a pointer of SPI slave project.
+
+**Syntax**
+~~~~~~~~~~
+
+.. code-block:: c++
+
+    spi_t *pSpiSlave;
+
+**Parameters**
+~~~~~~~~~~~~~~
+
+NA
+
+**Returns**
+~~~~~~~~~~~
+
+NA
+
+**Example Code**
+~~~~~~~~~~~~~~~~
+
+NA
+
+.. note :: "SPI.h" must be included to use the class function.