From eeb6a30f2988efec76fe9210f027d5ae00a6a862 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Tue, 10 Jan 2017 11:58:06 -0500 Subject: [PATCH] samples: apds9960: move under sensors and update docs Change-Id: I8e5735f15dbba5b9fead8f677104843a947b28ca Signed-off-by: Anas Nashif --- .../apds9960}/Makefile | 0 samples/sensor/apds9960/README.rst | 50 +++++++++++++++++++ .../apds9960}/prj.conf | 0 .../apds9960}/src/Makefile | 0 .../apds9960}/src/main.c | 25 ---------- .../apds9960}/testcase.ini | 0 6 files changed, 50 insertions(+), 25 deletions(-) rename samples/{drivers/sensor_apds9960 => sensor/apds9960}/Makefile (100%) create mode 100644 samples/sensor/apds9960/README.rst rename samples/{drivers/sensor_apds9960 => sensor/apds9960}/prj.conf (100%) rename samples/{drivers/sensor_apds9960 => sensor/apds9960}/src/Makefile (100%) rename samples/{drivers/sensor_apds9960 => sensor/apds9960}/src/main.c (86%) rename samples/{drivers/sensor_apds9960 => sensor/apds9960}/testcase.ini (100%) diff --git a/samples/drivers/sensor_apds9960/Makefile b/samples/sensor/apds9960/Makefile similarity index 100% rename from samples/drivers/sensor_apds9960/Makefile rename to samples/sensor/apds9960/Makefile diff --git a/samples/sensor/apds9960/README.rst b/samples/sensor/apds9960/README.rst new file mode 100644 index 00000000000..597e4c7d150 --- /dev/null +++ b/samples/sensor/apds9960/README.rst @@ -0,0 +1,50 @@ +RGB and Gesture Sensor +###################### + +Overview +======== + +This sample utilizes APDS-9960 Sensor and reads RGB values from the sensor +then displays the color through the APA102C LED. + + +.. note:: + This sample does not use the Zephyr sensor APIs + +Wiring +====== + +The SparkFun RGB and Gesture Sensor was being used: + +- https://www.sparkfun.com/products/12787 +- https://www.adafruit.com/product/2343 + +For APA102C, on the sensor subsystem (ARC) side of Arduino 101: + +1. GPIO_SS_2 is on AD0 (for APA102C data) +2. GPIO_SS_3 is on AD1 (for APA102C clock) + +The GPIO driver is being used for bit-banging to control the APA102C LED. + +The APA102/C requires 5V data and clock signals, so logic level shifter +(preferred) or pull-up resistors are needed. Make sure the pins are 5V +tolerant if using pull-up resistors. + +.. important:: + + The APA102C are very bright even at low settings. Protect your eyes + and do not look directly into those LEDs. + +Building and Running +==================== + +This sample can be built for multiple boards, in this example we will build it +for the Arduino 101 board: + +.. code-block:: console + + $ cd samples/sensors/apds9960 + $ make BOARD=arduino_101_sss + $ make BOARD=arduino_101_sss flash # with JTAG + .. or + $ dfu-util -a sensor_core -D outdir/arduino_101_sss/zephyr.bin # with DFU diff --git a/samples/drivers/sensor_apds9960/prj.conf b/samples/sensor/apds9960/prj.conf similarity index 100% rename from samples/drivers/sensor_apds9960/prj.conf rename to samples/sensor/apds9960/prj.conf diff --git a/samples/drivers/sensor_apds9960/src/Makefile b/samples/sensor/apds9960/src/Makefile similarity index 100% rename from samples/drivers/sensor_apds9960/src/Makefile rename to samples/sensor/apds9960/src/Makefile diff --git a/samples/drivers/sensor_apds9960/src/main.c b/samples/sensor/apds9960/src/main.c similarity index 86% rename from samples/drivers/sensor_apds9960/src/main.c rename to samples/sensor/apds9960/src/main.c index 70e035738f7..4edb6e2af7e 100644 --- a/samples/drivers/sensor_apds9960/src/main.c +++ b/samples/sensor/apds9960/src/main.c @@ -14,31 +14,6 @@ * limitations under the License. */ -/** - * @file Sample app to utilize APDS-9960 Sensor on Arduino 101 (ARC). - * - * The SparkFun RGB and Gesture Sensor was being used: - * https://www.sparkfun.com/products/12787 - * - * This sample app is to read RGB value from the APDS-9960 sensor - * and to display the color through the APA102C LED. - * - * For APA102C, on ARC side of Arduino 101: - * 1. GPIO_SS_2 is on AD0 (for APA102C data) - * 2. GPIO_SS_3 is on AD1 (for APA102C clock) - * - * The gpio_dw driver is being used for bit-banging to control - * the APA102C LED.. - * - * The APA102/C requires 5V data and clock signals, so logic - * level shifter (preferred) or pull-up resistors are needed. - * Make sure the pins are 5V tolerant if using pull-up - * resistors. - * - * WARNING: the APA102C are very bright even at low settings. - * Protect your eyes and do not look directly into those LEDs. - */ - #include #include #include diff --git a/samples/drivers/sensor_apds9960/testcase.ini b/samples/sensor/apds9960/testcase.ini similarity index 100% rename from samples/drivers/sensor_apds9960/testcase.ini rename to samples/sensor/apds9960/testcase.ini