Merge branch 'dev'

Author: francois-berder

.travis.yml

@@ -4,16 +4,18 @@ env:
   global:
     - CI40_SDK="OpenWrt-SDK-0.10.4-pistachio-marduk_gcc-5.3.0_musl-1.1.14.Linux-x86_64"
     - CI40_SDK_URL="https://downloads.creatordev.io/pistachio/marduk/"
+    - GIST_LOC="https://gist.githubusercontent.com/francois-berder/0082cf4b5633546edf20af0d9c74053c/raw/81c50a4f6d180721b56822b46a6c787c5e4f84e5/"
 before_install:
   - sudo apt-get -qq update
   - sudo apt-get install -y gnupg git-core build-essential libssl-dev libncurses5-dev unzip gawk subversion mercurial
 script:
   - mkdir -p $HOME/build/letmecreatefeed/letmecreate && ln -s $TRAVIS_BUILD_DIR $HOME/build/letmecreatefeed/letmecreate/LetMeCreate
-  - cp $TRAVIS_BUILD_DIR/miscellaneous/Makefile.devel $HOME/build/letmecreatefeed/letmecreate/Makefile
-  - cp $TRAVIS_BUILD_DIR/miscellaneous/Config.in.devel $HOME/build/letmecreatefeed/letmecreate/Config.in
+  - cd $HOME/build/letmecreatefeed/letmecreate/
+  - wget $GIST_LOC/Makefile
+  - wget $GIST_LOC/Config.in
   - export CI40_FILE_URL="$CI40_SDK_URL$CI40_SDK.tar.bz2"
-  - echo $CI40_FILE_URL
   - cd $HOME/build && wget $CI40_FILE_URL && tar xfj $CI40_SDK.tar.bz2
-  - cd $CI40_SDK && echo src-link custom $HOME/build/letmecreatefeed/ >> feeds.conf.default
+  - cd $CI40_SDK && sed --in-place '/Creator-feed/d' feeds.conf.default
+  - echo src-link custom $HOME/build/letmecreatefeed/ >> feeds.conf.default
   - ./scripts/feeds update -a && ./scripts/feeds install -a
   - make package/letmecreate/compile -j1 V=s

CMakeLists.txt

@@ -4,7 +4,7 @@ project(LetMeCreate)
 
 
 set(LETMECREATE_MAJOR_VERSION 1)
-set(LETMECREATE_MINOR_VERSION 3)
+set(LETMECREATE_MINOR_VERSION 4)
 set(LETMECREATE_PATCH_VERSION 0)
 set(LETMECREATE_VERSION ${LETMECREATE_MAJOR_VERSION}.${LETMECREATE_MINOR_VERSION}.${LETMECREATE_PATCH_VERSION})
 set(PROJECT_VERSION ${LETMECREATE_VERSION})

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.3.0
+PROJECT_NUMBER         = 1.4.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

@@ -1,57 +1,42 @@
+![logo](https://static.creatordev.io/logo-md-s.svg)
+
 # LetMeCreate library
 
 ## Build status
 
-Master
+**Master**  
 [![Build Status](https://travis-ci.org/francois-berder/LetMeCreate.svg?branch=master)](https://travis-ci.org/francois-berder/LetMeCreate)
 
-
-Dev
+**Dev**  
 [![Build Status](https://travis-ci.org/francois-berder/LetMeCreate.svg?branch=dev)](https://travis-ci.org/francois-berder/LetMeCreate)
 
 ## Introduction
 
-This library is a collection of small wrappers for some interfaces of the Ci40. It aims at making easier to develop on this platform. Also, it provides some wrappers for a few clicks. Notice that you cannot compile the library on Ci40 because cmake cannot run on it.
-
-Interface supported:
-  - I²C
-  - SPI
-  - UART
-  - LED's
-  - Switch
-  - GPIO (Mikrobus and Raspberry Pi interfaces)
-  - PWM
-  - ADC
-
-MikroClick board supported:
-  - 7Seg
-  - 8x8R (Led Matrix)
-  - Accel
-  - ADC
-  - Air quality
-  - Alcohol
-  - Alphanum
-  - Bargraph
-  - CO
-  - Color
-  - Color2
-  - EVE
-  - Fan
-  - GYRO
-  - IR distance
-  - IR eclipse
-  - Joystick
-  - Light
-  - Motion
-  - OLED
-  - Opto
-  - Proximity
-  - Relay (partial support)
-  - Relay2
-  - Relay4 (partial support)
-  - RTC
-  - Thermo3
-  - Weather
+This library is a collection of small wrappers for some interfaces of the Ci40. It aims at making easier to develop on this platform. Also, it provides some wrappers for a few clicks. Notice that you cannot compile the library on Ci40 because cmake cannot run on it. There exists a Python binding of this library called [PyLetMeCreate](https://github.com/francois-berder/PyLetMeCreate).
+
+Supported interfaces:  
+
+|Interface|-|
+|:------------| :-------------------|
+|I²C|SPI|
+|UART|LED's|
+|Switch|GPIO (Mikrobus and Raspberry Pi interfaces)|
+|PWM| ADC|
+
+MikroClick board supported:  
+ 
+|Interface|||
+|:------------|:-------------------|:-------------------|
+|7Seg|8x8R (Led Matrix)|Accel|
+|ADC|Air quality|Alcohol|
+|Alphanum|Bargraph|CO|
+|Color|Color2|EVE|
+|Fan|GYRO|IR distance|
+|IR eclipse|Joystick|Light|
+|LIN Hall|Motion|OLED|
+|Opto|Proximity|Relay (partial support)|
+|Relay2|Relay4 (partial support)|RTC|
+|Thermo3|UNI Hall|Weather|
 
 The Raspberry PI sense Hat is supported by the library, except the EEPROM because the pins are not connected on the I2C bus. The atmel chip is confusing the I2C driver of the Ci40 which makes it sometimes impossible to communicate with the hat. Inserting the hat after the board finished booting often solves the issue (assuming it does not cause a reset of the Ci40 because of a brown-out reset).
 
@@ -74,66 +59,61 @@ Keep examples very simple and avoid parsing arguments. Examples are there to sho
 
 ## Integration in Openwrt
 
-To add new packages, Openwrt relies on feeds: a collection of packages.
-
-### Installation steps
-
-Clone the library and openwrt somewhere on you computer:
+The library is already part of Imagination Technologies' OpenWrt.
+To compile the library (only possible once you built Openwrt once):
 
 ```sh
-$ mkdir ci-40
-$ cd ci-40
-$ git clone https://github.com/CreatorDev/openwrt.git
-$ mkdir -p custom/letmecreate
-$ cd custom/letmecreate
+$ make package/letmecreate/{clean,compile} -j1 V=s
 ```
 
-#### Stable release
-
-If you are only interested in getting the latest release of LetMeCreate library, then download a copy of Makefile.stable and Config.in.stable located in miscellaneous folder. Copy these files inside the letmecreate folder you have just created and rename it to Makefile and Config.in respectively.
-
-#### Development configuration
+### Installation steps
 
-If you are interested in modifying the library, getting the lastest changes, then clone it:
+You can install LetMeCreate package on OpenWRT executing:
 
 ```sh
-$ git clone https://github.com/francois-berder/LetMeCreate.git
+$ opkg install letmecreate
 ```
 
-Copy the Makefile and the Config.in to the right location:
+Each release has the ipk as an attachment. You can download the ipk, copy it to your Ci40 and install with opkg:
+
 ```sh
-$ cp LetMeCreate/miscellaneous/Makefile.devel Makefile
-$ cp LetMeCreate/miscellaneous/Config.in.devel Config.in
+$ opkg install path-to-the-ipk
 ```
 
-This project uses two branches. The dev branch contains all the latest changes and should not be considered as stable. The dev branch is sometimes merged to master once new features are considered stable.
+### Usage example
+```c
+/**
+ * This example shows how to use the Thermo3 Click wrapper of the LetMeCreate
+ * library.
+ *
+ * It reads the temperature from the sensor and exits.
+ *
+ * The Thermo3 Click must be inserted in Mikrobus 1 before running this program.
+ */
 
-#### Register the library in Openwrt
+#include <stdio.h>
+#include <letmecreate/letmecreate.h>
 
-To register the feed in openwrt, go back in openwrt folder and open feeds.conf.default.
-Add this line:
-```
-src-link custom /change/this/path/to/the/location/of/ci-40/custom/directory/
-```
 
-Update and install all feeds:
-```sh
-$ ./scripts/feeds update -a
-$ ./scripts/feeds install -a
-```
-In make menuconfig, select Libraries, you should see an entry for letmecreate library:
+int main(void)
+{
+    float temperature = 0.f;
 
-![Libraries menu](/miscellaneous/libraries_menu.png)
+    i2c_init();
+    i2c_select_bus(MIKROBUS_1);
 
-Select the letmecreate library in make menuconfig, and compile Openwrt:
+    thermo3_click_enable(0);
+    thermo3_click_get_temperature(&temperature);
+    printf("temperature: %.3f°C\n", temperature);
+    thermo3_click_disable();
 
-```sh
-$ make -j1 V=s
-```
-In the image (a tarball in bin/pistachio), you should see the examples in /usr/bin/letmecreate_examples.
-
-To compile only the library (only possible once you built Openwrt once):
+    i2c_release();
 
+    return 0;
+}
+```
+You can compile the C code example using **GCC**. Execute:
 ```sh
-$ make package/letmecreate/{clean,compile} -j1 V=s
+$ gcc thermo3.c -o thermo3 -lletmecreate_core -lletmecreate_click
+$ ./thermo3
 ```

examples/CMakeLists.txt

@@ -85,3 +85,7 @@ install(TARGETS letmecreate_alphanum_example RUNTIME DESTINATION bin)
 add_executable(letmecreate_oled_example oled/main.c)
 target_link_libraries(letmecreate_oled_example letmecreate_click letmecreate_core)
 install(TARGETS letmecreate_oled_example RUNTIME DESTINATION bin)
+
+add_executable(letmecreate_rpisensehat_example rpisensehat/main.c)
+target_link_libraries(letmecreate_rpisensehat_example letmecreate_rpisensehat letmecreate_core)
+install(TARGETS letmecreate_rpisensehat_example RUNTIME DESTINATION bin)

examples/accel/main.c

@@ -35,6 +35,7 @@ int main(void)
 
     spi_init();
     spi_select_bus(MIKROBUS_1);
+    accel_click_use_spi();
     accel_click_enable();
 
     printf("Press Ctrl+c to exit program.\n");

examples/motion/main.c

@@ -13,8 +13,12 @@
 #include "examples/common.h"
 
 
-void flash_leds(uint8_t __attribute__ ((unused))null)
+void flash_leds(uint8_t arg)
 {
+    /* Only flash LED's when motion starts getting detected. */
+    if (arg != 1)
+        return;
+
     int x = 0;
     for(; x < 10; ++x) {
         led_switch_on(ALL_LEDS);

examples/relay2/main.c

@@ -1,3 +1,16 @@
+/**
+ * This examples shows how to use the Relay2 Click wrapper of the LetMeCreate
+ *library.
+ *
+ * It switches on/off relays in the following order:
+ *    - relay 1 off, relay 2 off
+ *    - relay 1 on, relay 2 off
+ *    - relay 1 off, relay 2 on
+ *    - relay 1 on, relay 2 on
+ *
+ * Relay2 Click must be inserted in mikrobus 1 before running this program.
+ */
+
 #include <unistd.h>
 #include <letmecreate/letmecreate.h>
 
@@ -8,7 +21,7 @@ int main(void)
         switch (counter % 4) {
         case 0:
             relay2_click_disable_relay(MIKROBUS_1, RELAY2_CLICK_RELAY_1);
-            relay2_click_disable_relay(MIKROBUS_1, RELAY2_CLICK_RELAY_1);
+            relay2_click_disable_relay(MIKROBUS_1, RELAY2_CLICK_RELAY_2);
             break;
         case 1:
             relay2_click_enable_relay(MIKROBUS_1, RELAY2_CLICK_RELAY_1);

examples/rpisensehat/main.c

@@ -0,0 +1,28 @@
+#include <stdio.h>
+#include <unistd.h>
+#include <letmecreate/letmecreate.h>
+
+int main(void)
+{
+    float t = 0.f, h = 0.f, p = 0.f;
+
+    i2c_init();
+    rpisensehat_init();
+
+    rpisensehat_get_temperature(&t);
+    rpisensehat_get_humidity(&h);
+    rpisensehat_get_pressure(&p);
+
+    printf("temperature: %f degrees celsius\n", t);
+    printf("humidity: %f%%\n", h);
+    printf("pressure: %fhPa\n", p);
+
+    rpisensehat_display_rainbow();
+
+    sleep(5);
+
+    rpisensehat_release();
+    i2c_release();
+
+    return 0;
+}

examples/rtc/main.c

@@ -15,6 +15,30 @@
 #include <unistd.h>
 #include <letmecreate/letmecreate.h>
 
+enum WEEKDAY {
+    MONDAY,
+    TUESDAY,
+    WEDNESDAY,
+    THURSDAY,
+    FRIDAY,
+    SATURDAY,
+    SUNDAY
+};
+
+enum MONTH {
+    JANUARY,
+    FEBRUARY,
+    MARCH,
+    APRIL,
+    MAY,
+    JUNE,
+    JULY,
+    AUGUST,
+    SEPTEMBER,
+    OCTOBER,
+    NOVEMBER,
+    DECEMBER
+};
 
 static char *weekday_str[] = {
     "Monday",