Merge branch 'dev'

Author: francois-berder

CMakeLists.txt

@@ -1,11 +1,11 @@
 cmake_minimum_required(VERSION 2.8)
 
-project(LetMeCreate)
+project(LetMeCreate C)
 
 
 set(LETMECREATE_MAJOR_VERSION 1)
-set(LETMECREATE_MINOR_VERSION 0)
-set(LETMECREATE_PATCH_VERSION 3)
+set(LETMECREATE_MINOR_VERSION 1)
+set(LETMECREATE_PATCH_VERSION 0)
 set(LETMECREATE_VERSION ${LETMECREATE_MAJOR_VERSION}.${LETMECREATE_MINOR_VERSION}.${LETMECREATE_PATCH_VERSION})
 set(PROJECT_VERSION ${LETMECREATE_VERSION})
 
@@ -15,11 +15,14 @@ option(BUILD_TESTS "Build tests" OFF)
 file(GLOB core_srcs src/core/*.c)
 file(GLOB click_srcs src/click/*.c)
 
+file(GLOB core_hdrs include/letmecreate/core/*.h)
+file(GLOB click_hdrs include/letmecreate/click/*.h)
+
 include_directories(include)
 
 # Create targets
-add_library(letmecreate_core SHARED ${core_srcs})
-add_library(letmecreate_click SHARED ${click_srcs})
+add_library(letmecreate_core SHARED ${core_srcs} ${core_hdrs})
+add_library(letmecreate_click SHARED ${click_srcs} ${click_hdrs})
 target_link_libraries(letmecreate_click letmecreate_core)
 
 target_compile_definitions(letmecreate_core PUBLIC "LETMECREATE_CORE_DEBUG=$<CONFIG:Debug>")
@@ -51,27 +54,16 @@ set(targets_export_name "${PROJECT_NAME}Targets")
 # Include module with fuction 'write_basic_package_version_file'
 include(CMakePackageConfigHelpers)
 
-# Configure '<PROJECT-NAME>ConfigVersion.cmake'
-# Note: PROJECT_VERSION is used as a VERSION
 write_basic_package_version_file(
     "${version_config}" COMPATIBILITY SameMajorVersion
 )
 
-# Configure '<PROJECT-NAME>Config.cmake'
-# Use variables:
-#   * targets_export_name
-#   * PROJECT_NAME
 configure_package_config_file(
     "cmake/Config.cmake.in"
     "${project_config}"
     INSTALL_DESTINATION "${config_install_dir}"
 )
 
-# Targets:
-#   * <prefix>/lib/libbar.a
-#   * <prefix>/lib/libbaz.a
-#   * header location after install: <prefix>/include/foo/Bar.hpp
-#   * headers can be included by C++ code `#include <foo/Bar.hpp>`
 install(
     TARGETS letmecreate_core letmecreate_click
     EXPORT "${targets_export_name}"
@@ -81,25 +73,17 @@ install(
     INCLUDES DESTINATION "${include_install_dir}"
 )
 
-# Headers:
-#   * Source/foo/Bar.hpp -> <prefix>/include/foo/Bar.hpp
-#   * Source/foo/Baz.hpp -> <prefix>/include/foo/Baz.hpp
 install(
     DIRECTORY "include/letmecreate"
     DESTINATION "${include_install_dir}"
     FILES_MATCHING PATTERN "*.h"
 )
 
-# Config
-#   * <prefix>/lib/cmake/Foo/FooConfig.cmake
-#   * <prefix>/lib/cmake/Foo/FooConfigVersion.cmake
 install(
     FILES "${project_config}" "${version_config}"
     DESTINATION "${config_install_dir}"
 )
 
-# Config
-#   * <prefix>/lib/cmake/Foo/FooTargets.cmake
 install(
     EXPORT "${targets_export_name}"
     DESTINATION "${config_install_dir}"

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "LetMeCreate"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.0.3
+PROJECT_NUMBER         = 1.1.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Readme.md

@@ -16,18 +16,38 @@ MikroClick board supported:
   - Thermo3
   - Proximity
   - Motion
-  - Relay
+  - Relay (partial support)
   - Relay2
   - Joystick
   - Air quality
-  - Accel (SPI only)
+  - Accel
   - 8x8R (Led Matrix)
   - Alcohol
   - IR eclipse
+  - IR distance
+  - Color
+  - Color2
+  - Bargraph
+  - 7Seg
+  - ADC
 
 Examples are installed in /usr/bin/letmecreate_examples.
 Tests are installed in /usr/bin/letmecreate_tests.
 
+## Contributing to LetMeCreate
+
+The master branch is the stable branch and the dev branch is merged to master just before doing a release. All pull requests must be done on dev branch.
+Before creating a wrapper for a click board, make sure that it is not already supported in the dev branch. To avoid any overlap, contact me my email ([email protected]).
+
+
+About code style, I follow roughly the [linux kernel coding style](https://www.kernel.org/doc/Documentation/CodingStyle) (two notable exceptions: indentation is set to 4 spaces and no 80 characters limit per line). Keep the style of your wrapper consistent with the rest of the code. For instance, most functions return 0 if they succeed and a negative number if not.
+
+
+Each wrapper must implement features provided by only one click board. Do not mix code related to different click boards in a wrapper. Add doxygen documentation to all of your functions and do not forget to add a doxygen header on top of your header file otherwise the documentation will not be generated by doxygen.
+
+
+Keep examples very simple and avoid parsing arguments. Examples are there to show one or two features of a **single** click board. Do not use multiple click boards in an example. The idea behind writing examples is to show how easy the library makes it using click boards. Hence, the shorter the example is, the better it is.
+
 ## Integration in Openwrt
 
 To add new packages, Openwrt relies on feeds: a collection of packages.

examples/7seg/main.c

@@ -0,0 +1,19 @@
+#include <letmecreate/letmecreate.h>
+#include "examples/common.h"
+
+
+int main(void)
+{
+    int i = 0;
+    spi_init();
+    seven_seg_click_set_intensity(MIKROBUS_1, 100.f);
+
+    for (; i < 100; ++i) {
+        seven_seg_click_display_decimal_number(i);
+        sleep_ms(100);
+    }
+
+    spi_release();
+
+    return 0;
+}

examples/CMakeLists.txt

@@ -1,5 +1,7 @@
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/examples/bin)
 
+add_library(examples_common OBJECT common.c)
+
 add_executable(letmecreate_proximity_example proximity/main.c)
 target_link_libraries(letmecreate_proximity_example letmecreate_click letmecreate_core)
 install(TARGETS letmecreate_proximity_example RUNTIME DESTINATION bin)
@@ -16,26 +18,42 @@ add_executable(letmecreate_joystick_example joystick/main.c)
 target_link_libraries(letmecreate_joystick_example letmecreate_click letmecreate_core)
 install(TARGETS letmecreate_joystick_example RUNTIME DESTINATION bin)
 
-add_executable(letmecreate_accel_example accel/main.c)
+add_executable(letmecreate_accel_example accel/main.c $<TARGET_OBJECTS:examples_common>)
 target_link_libraries(letmecreate_accel_example letmecreate_click letmecreate_core)
 install(TARGETS letmecreate_accel_example RUNTIME DESTINATION bin)
 
-add_executable(letmecreate_led_matrix_example led_matrix/main.c)
+add_executable(letmecreate_led_matrix_example led_matrix/main.c $<TARGET_OBJECTS:examples_common>)
 target_link_libraries(letmecreate_led_matrix_example letmecreate_click letmecreate_core)
 install(TARGETS letmecreate_led_matrix_example RUNTIME DESTINATION bin)
 
 add_executable(letmecreate_color_example color/main.c)
 target_link_libraries(letmecreate_color_example letmecreate_click letmecreate_core)
 install(TARGETS letmecreate_color_example RUNTIME DESTINATION bin)
 
-add_executable(letmecreate_led_example led/main.c)
+add_executable(letmecreate_led_example led/main.c $<TARGET_OBJECTS:examples_common>)
 target_link_libraries(letmecreate_led_example letmecreate_core)
 install(TARGETS letmecreate_led_example RUNTIME DESTINATION bin)
 
-add_executable(letmecreate_buzz_example buzz/main.c)
+add_executable(letmecreate_buzz_example buzz/main.c $<TARGET_OBJECTS:examples_common>)
 target_link_libraries(letmecreate_buzz_example letmecreate_core)
 install(TARGETS letmecreate_buzz_example RUNTIME DESTINATION bin)
 
-add_executable(letmecreate_motion_example motion/main.c)
+add_executable(letmecreate_motion_example motion/main.c $<TARGET_OBJECTS:examples_common>)
 target_link_libraries(letmecreate_motion_example letmecreate_click letmecreate_core)
 install(TARGETS letmecreate_motion_example RUNTIME DESTINATION bin)
+
+add_executable(letmecreate_color2_example color2/main.c)
+target_link_libraries(letmecreate_color2_example letmecreate_click letmecreate_core)
+install(TARGETS letmecreate_color2_example RUNTIME DESTINATION bin)
+
+add_executable(letmecreate_bargraph_example bargraph/main.c $<TARGET_OBJECTS:examples_common>)
+target_link_libraries(letmecreate_bargraph_example letmecreate_click letmecreate_core)
+install(TARGETS letmecreate_bargraph_example RUNTIME DESTINATION bin)
+
+add_executable(letmecreate_7seg_example 7seg/main.c $<TARGET_OBJECTS:examples_common>)
+target_link_libraries(letmecreate_7seg_example letmecreate_click letmecreate_core)
+install(TARGETS letmecreate_7seg_example RUNTIME DESTINATION bin)
+
+add_executable(letmecreate_adc_example adc/main.c)
+target_link_libraries(letmecreate_adc_example letmecreate_click letmecreate_core)
+install(TARGETS letmecreate_adc_example RUNTIME DESTINATION bin)

examples/accel/main.c

@@ -2,8 +2,8 @@
 #include <signal.h>
 #include <stdbool.h>
 #include <stdio.h>
-#include <time.h>
 #include <letmecreate/letmecreate.h>
+#include "examples/common.h"
 
 static volatile bool running = true;
 
@@ -12,16 +12,6 @@ static void exit_program(int signo)
     running = false;
 }
 
-static void sleep_100ms(void)
-{
-    struct timespec rem, req = {
-        .tv_sec = 0,
-        .tv_nsec = 100000000
-    };
-
-    while (nanosleep(&req, &rem))
-        req = rem;
-}
 
 int main(void)
 {
@@ -47,7 +37,7 @@ int main(void)
         printf("\33[2K\r");     /* Erase current line */
         printf("%-9.3f%-9.3f%-9.3f", x, y, z);
         fflush(stdout);
-        sleep_100ms();
+        sleep_ms(100);
     }
 
     accel_click_disable();

examples/adc/main.c

@@ -0,0 +1,18 @@
+#include <stdio.h>
+#include <letmecreate/letmecreate.h>
+
+
+int main(void)
+{
+    uint16_t value;
+    int i = 0;
+
+    spi_init();
+    for (; i < 4; ++i) {
+        adc_click_get_raw_value(i, &value);
+        printf("channel %d value: %u\n", i, value);
+    }
+    spi_release();
+
+    return 0;
+}

examples/bargraph/main.c

@@ -0,0 +1,22 @@
+#include <letmecreate/letmecreate.h>
+#include "examples/common.h"
+
+
+int main(void)
+{
+    uint16_t value = 1;
+    spi_init();
+
+    /* Set LED's to max intensity */
+    bargraph_click_set_intensity(MIKROBUS_1, 100.f);
+
+    /* Gradually turn on each LED. */
+    for (; value < 0x400; value <<= 1, value |= 1) {
+        bargraph_click_set_value(value);
+        sleep_ms(200);
+    }
+
+    spi_release();
+
+    return 0;
+}

examples/buzz/main.c

@@ -1,19 +1,7 @@
-#include <time.h>
 #include <letmecreate/letmecreate.h>
+#include "examples/common.h"
 
 
-static void sleep_ms(unsigned int ms)
-{
-    struct timespec req, rem;
-
-    req.tv_sec = ms / 1000;
-    ms -= req.tv_sec * 1000;
-    req.tv_nsec = ms * 1000000;
-
-    while (nanosleep(&req, &rem))
-        req = rem;
-}
-
 int main(void)
 {
     int x = 0;

examples/color2/main.c

@@ -0,0 +1,31 @@
+/*
+ * This example shows how to use the Color2 Click wrapper of the LetMeCreate
+ * library.
+ *
+ * The Color2 Click must be plugged in Mikrobus 1 of Ci40.
+ */
+
+#include <stdio.h>
+#include <letmecreate/letmecreate.h>
+
+
+int main(void)
+{
+    uint16_t r, g, b;
+
+    /* Initialise I2C and color2 click */
+    i2c_init();
+    color2_click_enable();
+
+    /* Read measurement from Colo2 Click */
+    color2_click_get_color(&r, &g, &b);
+    printf("red: %u\n", r);
+    printf("green: %u\n", g);
+    printf("blue: %u\n\n", b);
+
+    /* Disable color2 click and I2C */
+    color2_click_disable();
+    i2c_release();
+
+    return 0;
+}