0.2.8 BH1750FVI_RT

Author: RobTillaart

libraries/BH1750FVI_RT/.arduino-ci.yml

@@ -2,6 +2,10 @@ compile:
   # Choosing to run compilation tests on 2 different Arduino platforms
   platforms:
     - uno
-    - leonardo
-    - due
-    - zero
+    # - due
+    # - zero
+    # - leonardo
+    - m4
+    - esp32
+    # - esp8266
+    # - mega2560

libraries/BH1750FVI_RT/.github/workflows/arduino_test_runner.yml

@@ -4,10 +4,14 @@ name: Arduino CI
 on: [push, pull_request]
 
 jobs:
-  arduino_ci:
+  runTest:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-      - uses: Arduino-CI/action@master
-          #   Arduino-CI/[email protected]
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: |
+          gem install arduino_ci
+          arduino_ci.rb

libraries/BH1750FVI_RT/BH1750FVI.cpp

@@ -1,24 +1,26 @@
 //
 //    FILE: BH1750FVI.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.7
+// VERSION: 0.2.8
 // PURPOSE: library for BH1750FVI lux sensor Arduino
 //     URL: https://github.com/RobTillaart/BH1750FVI
 //
+//  HISTORY
 //  0.1.0   2020-02-02  initial version
 //  0.1.1   2020-03-28  refactor
 //  0.1.2   2020-03-29  unique name in repo, and new release tag.
 //  0.1.3   2020-06-05  fix library.json file
-//  0.1.4   2020-08-14  cleanup tabs/spaces;
+//  0.1.4   2020-08-14  clean up tabs/spaces;
 //  0.2.0   2020-08-18  implement logic for LOW & HIGH2;
-//                      implement correctionfactor;  examples;
+//                      implement correction factor;  examples;
 //  0.2.1   2020-08-31  implement angle factor
 //  0.2.2   2020-09-04  implement temperature compensation
 //  0.2.3   2020-09-04  implement wavelength compensation
 //  0.2.4   2020-11-27  fix #10 rename _sensitivityFactor for ESP32
 //  0.2.5   2020-12-12  add Arduino-CI and unit tests
 //  0.2.6   2021-01-16  add reset()
-//  0.2.7   2021-06-08  add unit tests, improved correction factor code.
+//  0.2.7   2021-06-08  add unit tests, improved correction factor code
+//  0.2.8   2021-10-19  update Arduino-CI, badges in readme
 
 
 #include "BH1750FVI.h"
@@ -274,4 +276,6 @@ void BH1750FVI::command(uint8_t value)
   _error = _wire->endTransmission();
 }
 
+
 // --- END OF FILE ---
+

libraries/BH1750FVI_RT/BH1750FVI.h

@@ -2,7 +2,7 @@
 //
 //    FILE: BH1750FVI.h
 //  AUTHOR: Rob dot Tillaart at gmail dot com
-// VERSION: 0.2.7
+// VERSION: 0.2.8
 // PURPOSE: Arduino library for BH1750FVI (GY-30) lux sensor
 // HISTORY: See BH1750FVI.cpp
 //
@@ -28,7 +28,7 @@
 #include "Arduino.h"
 
 
-#define BH1750FVI_LIB_VERSION       (F("0.2.7"))
+#define BH1750FVI_LIB_VERSION       (F("0.2.8"))
 
 
 #define BH1750FVI_DEFAULT_ADDRESS   0x23

libraries/BH1750FVI_RT/README.md

@@ -1,5 +1,7 @@
 
 [![Arduino CI](https://github.com/RobTillaart/BH1750FVI_RT/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![Arduino-lint](https://github.com/RobTillaart/BH1750FVI_RT/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/BH1750FVI_RT/actions/workflows/arduino-lint.yml)
+[![JSON check](https://github.com/RobTillaart/BH1750FVI_RT/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/BH1750FVI_RT/actions/workflows/jsoncheck.yml)
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/BH1750FVI_RT/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/BH1750FVI_RT.svg?maxAge=3600)](https://github.com/RobTillaart/BH1750FVI_RT/releases)
 
@@ -60,8 +62,8 @@ The sensor works on 2.4 - 3.6 volt so be careful not to connect directly to 5.0
 
 ### Constructor
 
-- **BH1750FVI(address, dataPin, clockPin)**  ESP constructor with I2C parameters
-- **BH1750FVI(address, TwoWire \*wire = &Wire)** constructor for other platforms
+- **BH1750FVI(uint8_t address, uint8_t dataPin, uint8_t clockPin)**  ESP constructor with I2C parameters
+- **BH1750FVI(uint8_t address, TwoWire \*wire = &Wire)** constructor for other platforms
 - **bool begin()** resets some internal variables to default. Use with care.
 - **bool isConnected()** returns true if address is on I2C bus.
 
@@ -112,7 +114,7 @@ Note: experimental - use carefully
 
 The lux sensor is really sensitive for the angle of the light.
 If one makes measurements outside, the position of the sun changes
-during the day. The **setAngle(degrees)** function provides a mean to correct that.
+during the day. The **setAngle(int degrees)** function provides a mean to correct that.
 
 The angle adjustments is based upon the figure 4 and 5 (directional characteristics.)
 which describe **Lambert’s Cosine Law**. (details see  Wikipedia)
@@ -124,7 +126,7 @@ If the light is perpendicular on the sensor the angle to use is 0 degrees.
 Light coming from the side is 90 degrees.
 
 - **float setAngle(int degrees = 0)** adjust the lux to incoming angle in degrees (-89..89). Returns the angle correction factor.
-- **int getAngle()** returns set angle in degrees, 0 by default is perpendicular
+- **int getAngle()** returns set angle in degrees, 0 by default is perpendicular.
 
 
 ### Temperature Compensation
@@ -134,7 +136,7 @@ The effect of temperature is small, about 3% per 60°C ==> 1% per 20°C
 so only on either a hot roof or on a icy cold day the effect is substantial.
 
 - **float setTemperature(int temp = 20)**  see datasheet P3 fig7  Returns the temperature correction factor
-- **int getTemperature()** returns temperature set, default = 20°C
+- **int getTemperature()** returns temperature set, default = 20°C.
 
 
 ### Spectral Compensation ! EXPERIMENTAL !

libraries/BH1750FVI_RT/examples/BH1750FVI_angle_measurement/BH1750FVI_angle_measurement.ino

@@ -22,9 +22,9 @@
    Lux level compared to the references.
 
    First trials are not not too bad, roughly within 15° accuracy
-
 */
 
+
 #include "BH1750FVI.h"
 
 BH1750FVI myLux(0x23);
@@ -71,6 +71,7 @@ void setup()
   Serial.println(ref2);
 }
 
+
 void loop()
 {
   float val = measure(1, false);
@@ -91,4 +92,6 @@ void loop()
   Serial.println();
 }
 
+
 // -- END OF FILE --
+

libraries/BH1750FVI_RT/examples/BH1750FVI_async/BH1750FVI_async.ino

@@ -6,13 +6,15 @@
 //    DATE: 2020-08-20
 //
 
+
 #include "BH1750FVI.h"
 
 BH1750FVI myLux(0x23);
 
 float correctionFactor = 0.45;     // min value see datasheet
 uint32_t count = 0;
 
+
 void setup()
 {
   Serial.begin(115200);
@@ -26,6 +28,7 @@ void setup()
   myLux.setContHighRes();
 }
 
+
 void loop()
 {
   if (myLux.isReady())
@@ -47,7 +50,7 @@ void loop()
     Serial.print("\t");
     Serial.println(val / myLux.getCorrectionFactor(), 1);
 
-    // note correctionfactor are steps of 1/69 internally, see datasheet
+    // note correction factor are steps of 1/69 internally, see datasheet
     correctionFactor += 0.05;
     if (correctionFactor > 3.68)  // 0.45 - 3.68 = 45 steps of 0.05
     {
@@ -62,4 +65,6 @@ void loop()
   // do other things here
 }
 
+
 // -- END OF FILE --
+

libraries/BH1750FVI_RT/examples/BH1750FVI_cont_high_res/BH1750FVI_cont_high_res.ino

@@ -9,6 +9,7 @@
 // using mylux.getRaw() instead of myLux.getLux();  line38
 // gain on UNO: ~350 bytes smaller
 
+
 #include "BH1750FVI.h"
 
 BH1750FVI myLux(0x23);
@@ -29,6 +30,7 @@ void setup()
   myLux.setContHighRes();
 }
 
+
 void loop()
 {
   uint16_t interval = 100;
@@ -41,4 +43,5 @@ void loop()
 
 }
 
+
 // -- END OF FILE --

libraries/BH1750FVI_RT/examples/BH1750FVI_cont_low_res/BH1750FVI_cont_low_res.ino

@@ -5,8 +5,7 @@
 // PURPOSE: demo of BH1750FVI lux scanner library
 //    DATE: 2020-02-02
 //
-// Released to the public domain
-//
+
 
 #include "BH1750FVI.h"
 
@@ -28,6 +27,7 @@ void setup()
   myLux.setContLowRes();
 }
 
+
 void loop()
 {
   uint16_t interval = 100;
@@ -40,4 +40,6 @@ void loop()
 
 }
 
-// END OF FILE
+
+// -- END OF FILE --
+

libraries/BH1750FVI_RT/examples/BH1750FVI_setAngle/BH1750FVI_setAngle.ino

@@ -6,10 +6,12 @@
 //    DATE: 2020-08-31
 //
 
+
 #include "BH1750FVI.h"
 
 BH1750FVI myLux(0x23);
 
+
 void setup()
 {
   Serial.begin(115200);
@@ -23,6 +25,7 @@ void setup()
   myLux.setContHighRes();
 }
 
+
 void loop()
 {
   for (int x = -90; x < 90; x += 1)
@@ -40,4 +43,6 @@ void loop()
   Serial.println();
 }
 
+
 // -- END OF FILE --
+