bug fix

Author: zeynepdicle

README.md

@@ -7,7 +7,7 @@ Arduino library for Deneyap ToF Range Finder Sensor VL53L0X
 
 ## :mag_right:Specifications 
 - `Product ID` **M06**, **mpv1.0**
-- `MCU` VL53L0X, STM8S003F3
+- `MCU` VL53L0X
 - `Weight` 
 - `Module Dimension`
 - `I2C address` 0x29
@@ -24,7 +24,7 @@ Deneyap ToF Range Finder Sensor VL53L0X
 [How to install a Arduino Library](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
 
 ## :pushpin:Deneyap ToF Range Finder Sensor VL53L0X
-This Arduino library allows you to use DDeneyap ToF Range Finder Sensor VL53L0X with I2C peripheral. You can use this library in your projects with any Arduino compatible board with I2C peripheral.
+This Arduino library allows you to use Deneyap ToF Range Finder Sensor VL53L0X with I2C peripheral. You can use this library in your projects with any Arduino compatible board with I2C peripheral.
 
 ## :globe_with_meridians:Repository Contents
 - `/docs ` README_tr.md and product photos
@@ -36,6 +36,8 @@ This Arduino library allows you to use DDeneyap ToF Range Finder Sensor VL53L0X
 ## Version History
 1.0.0 - initial release
 
+1.0.1 - bug fix
+
 ## :rocket:Hardware Connections
 - Deneyap ToF Range Finder Sensor VL53L0X and Board can be connected with I2C cable
 - or 3V3, GND, SDA and SCL pins can be connected with jumper cables

docs/README_tr.md

@@ -6,7 +6,7 @@ Deneyap Derinlik Ölçer VL53L0X için Arduino kütüphanesidir.
 
 ## :mag_right:Özellikler 
 - `Ürün ID` **M06**, **mpv1.0**
-- `MCU` VL53L0X, STM8S003F3
+- `MCU` VL53L0X
 - `Ağırlık`
 - `Modul Boyutları` 
 - `I2C Adres` 0x29
@@ -21,7 +21,7 @@ Deneyap Derinlik Ölçer VL53L0X
 [VL53L0X](https://www.st.com/content/ccc/resource/technical/document/datasheet/group3/b2/1e/33/77/c6/92/47/6b/DM00279086/files/DM00279086.pdf/jcr:content/translations/en.DM00279086.pdf)
 
 
-[Arduino Kütüphanesi Nasıl İndirilir](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
+[Arduino IDE'de Kütüphane Nasıl İndirilir](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
 
 ## :pushpin:Deneyap Derinlik Ölçer VL53L0X
 Bu Arduino kütüphanesi Deneyap Derinlik Ölçer VL53L0X'nin I2C çevre birimi ile kullanılmasını sağlar. Arduino ile uyumlu, I2C çevre birimine sahip herhangi bir geliştirme kartı ile bu kütüphaneyi projelerinizde kullanabilirsiniz.
@@ -36,9 +36,11 @@ Bu Arduino kütüphanesi Deneyap Derinlik Ölçer VL53L0X'nin I2C çevre birimi
 ## Sürüm Geçmişi
 1.0.0 - ilk sürüm
 
+1.0.1 - hata giderildi
+
 ## :rocket:Donanım Bağlantıları
 - Deneyap Derinlik Ölçer ile kullanılan geliştirme kartı I2C kablosu ile bağlanabilir
-- veya jumper kablolar ile ile 3V3, GND, SDA ve SCL bağlantıları yapılabilir. 
+- veya jumper kablolar ile 3V3, GND, SDA ve SCL bağlantıları yapılabilir. 
 
 | Derinlik Ölçer | Fonksiyon| Kart pinleri |
 | :---     | :---   |   :---  |

library.properties

@@ -1,5 +1,5 @@
 name=Deneyap Derinlik Olcer
-version=1.0.0
+version=1.0.1
 author=RFtek Electronics <[email protected]>
 maintainer=Turkish Technnology Team Foundation (T3)
 sentence=Arduino library for Deneyap ToF Range Finder Sensor VL53L0X

src/Deneyap_DerinlikOlcer.cpp

@@ -3,8 +3,8 @@
 @file         Deneyap_DerinlikOlcer.cpp
 @mainpage     Deneyap ToF Range Finder Sensor VL53L0X Arduino library source file
 @maintainer   RFtek Electronics <[email protected]>
-@version      v1.0.0
-@date         June 23, 2022
+@version      v1.0.1
+@date         August 18, 2022
 @brief        Includes functions to control Deneyap ToF Range Finder Sensor VL53L0X
               Arduino library
 
@@ -18,103 +18,101 @@ Library includes:
 #include "Deneyap_DerinlikOlcer.h"
 
 /**
-  * @brief   I2C initialization and read check  
-  * @param   adress: Device adress 
-  * @retval  None
-**/
-bool TofRangeFinder::begin(uint8_t address, TwoWire &wirePort) {
-    _address = address;
-    Wire.begin();
-    Wire.beginTransmission(address);
-    if (!Wire.endTransmission())
-        return true;
-    return false;
-}
+ * @brief   I2C initialization and read check
+ * @param   adress: Device adress
+ * @retval  None
+ **/
+bool TofRangeFinder::begin(uint8_t i2c_addr) {
+  uint8_t x;
+  DevAddr = I2C_DevAddr;
+  Wire.begin();
+  x = read8(TofRangeFinder_REG_IDENTIFICATION_MODEL_ID);
+  //  Serial.print("Device ID: "); Serial.println(x,HEX);
+  //  Serial.println("");
+  //  if(x != 0xEE)
+  //  {
+  //    Serial.print("Read Chip ID fail!");
+  //  }
 
-/**
-  * @brief  
-  * @param  
-  * @retval
-**/
-bool TofRangeFinder::init() {
-    begin(_address);
-    write8(0x88, 0x00);
-    write8(0x80, 0x01);
-    write8(0xFF, 0x01);
-    write8(0x00, 0x00);
-    read8(0x91);
-    write8(0x91, 0x3c);
-    write8(0x00, 0x01);
-    write8(0xFF, 0x00);
-    write8(0x80, 0x00);
+  write8(0x88, 0x00);
+  write8(0x80, 0x01);
+  write8(0xFF, 0x01);
+  write8(0x00, 0x00);
+  read8(0x91);
+  write8(0x91, 0x3c);
+  write8(0x00, 0x01);
+  write8(0xFF, 0x00);
+  write8(0x80, 0x00);
 
-    write8(0x80, 0x01);
-    write8(0xFF, 0x01);
-    write8(0x00, 0x00);
-    write8(0x91, 0x3c);
-    write8(0x00, 0x01);
-    write8(0xFF, 0x00);
-    write8(0x80, 0x00);
+  write8(0x80, 0x01);
+  write8(0xFF, 0x01);
+  write8(0x00, 0x00);
+  write8(0x91, 0x3c);
+  write8(0x00, 0x01);
+  write8(0xFF, 0x00);
+  write8(0x80, 0x00);
 
-    write8(VL53L0X_REG_SYSRANGE_START, VL53L0X_REG_SYSRANGE_MODE_BACKTOBACK);
-    return 1;
+  write8(TofRangeFinder_REG_SYSRANGE_START, TofRangeFinder_REG_SYSRANGE_MODE_BACKTOBACK);
+  return 1;
 }
 
 /**
-  * @brief  
-  * @param  
-  * @retval
-**/
+ * @brief
+ * @param
+ * @retval
+ **/
 void TofRangeFinder::write8(unsigned char Reg, unsigned char byte) {
-    Wire.beginTransmission(_address);
-    Wire.write(Reg);
-    Wire.write((uint8_t)byte);
-    Wire.endTransmission();
+  Wire.beginTransmission(DevAddr);
+  Wire.write(Reg);
+  Wire.write((uint8_t)byte);
+  Wire.endTransmission();
 }
 
 /**
-  * @brief  
-  * @param  
-  * @retval
-**/
+ * @brief
+ * @param
+ * @retval
+ **/
 void TofRangeFinder::readData(unsigned char Reg, unsigned char Num) {
-    Wire.beginTransmission(_address);
-    Wire.write((uint8_t)Reg);
-    Wire.endTransmission();
-    Wire.requestFrom((uint8_t)_address, (uint8_t)Num);
+  Wire.beginTransmission(DevAddr);
+  Wire.write((uint8_t)Reg);
+  Wire.endTransmission();
+  Wire.requestFrom((uint8_t)DevAddr, (uint8_t)Num);
 
-    for (int i = 0; i < Num; i++) {
-        Data[i] = Wire.read();
-        delay(1);
-    }
+  for (int i = 0; i < Num; i++) {
+    Data[i] = Wire.read();
+    delay(1);
+  }
 }
 
 /**
-  * @brief  
-  * @param  
-  * @retval
-**/
+ * @brief
+ * @param
+ * @retval
+ **/
 uint8_t TofRangeFinder::read8(unsigned char Reg) {
-    Wire.beginTransmission(_address);
-    Wire.write((uint8_t)Reg);
-    Wire.endTransmission();
-    Wire.requestFrom((uint8_t)_address, (uint8_t)1);
-    return Wire.read();
+
+  Wire.beginTransmission(DevAddr);
+  Wire.write((uint8_t)Reg);
+  Wire.endTransmission();
+  Wire.requestFrom((uint8_t)DevAddr, (uint8_t)1);
+
+  return Wire.read();
 }
 
 /**
-  * @brief  
-  * @param  
-  * @retval
-**/
+ * @brief
+ * @param
+ * @retval
+ **/
 float TofRangeFinder::ReadDistance() {
-    readData(VL53L0X_REG_RESULT_RANGE_STATUS, 12);
-    distance = ((Data[10] & 0xFF) << 8) |
-               (Data[11] & 0xFF);
-    write8(VL53L0X_REG_SYSTEM_RANGE_CONFIG, 1);
-    if (distance == 20)
-        distance = _distance;
-    else
-        _distance = distance;
-    return distance / 40;
-}
+  readData(TofRangeFinder_REG_RESULT_RANGE_STATUS, 12);
+  distance = ((Data[10] & 0xFF) << 8) |
+             (Data[11] & 0xFF);
+  write8(TofRangeFinder_REG_SYSTEM_RANGE_CONFIG, 1);
+  if (distance == 20)
+    distance = _distance;
+  else
+    _distance = distance;
+  return distance / 40;
+}

src/Deneyap_DerinlikOlcer.h

@@ -2,8 +2,8 @@
 ***********************************************************************************
 @file         Deneyap_DerinlikOlcer.h
 @mainpage     Deneyap ToF Range Finder Sensor VL53L0X Arduino library header file
-@version      v1.0.0
-@date         June 23, 2022
+@version      v1.0.1
+@date         August 18, 2022
 @brief        This file contains all function prototypes and macros
               for Deneyap ToF Range Finder Sensor VL53L0X Arduino library
 ***********************************************************************************
@@ -15,43 +15,43 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#define VL53L0X_REG_IDENTIFICATION_MODEL_ID 0x00c0
-#define VL53L0X_REG_IDENTIFICATION_REVISION_ID 0x00c2
-#define VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD 0x0050
-#define VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD 0x0070
-#define VL53L0X_REG_SYSRANGE_START 0x0000
-#define VL53L0X_REG_RESULT_INTERRUPT_STATUS 0x0013
-#define VL53L0X_REG_RESULT_RANGE_STATUS 0x0014
-#define VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS 0x008a
-#define VL53L0X_I2C_ADDR 0x0029
-#define VL53L0X_REG_SYSTEM_RANGE_CONFIG 0x0009
-#define VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV 0x0089
-#define VL53L0X_REG_SYSRANGE_MODE_SINGLESHOT 0x0000
-#define VL53L0X_REG_SYSRANGE_MODE_START_STOP 0x0001
-#define VL53L0X_REG_SYSRANGE_MODE_BACKTOBACK 0x0002
-#define VL53L0X_REG_SYSRANGE_MODE_TIMED 0x0004
-
-#define VL53L0X_DEVICEMODE_SINGLE_RANGING ((uint8_t)0)
-#define VL53L0X_DEVICEMODE_CONTINUOUS_RANGING ((uint8_t)1)
-#define VL53L0X_DEVICEMODE_CONTINUOUS_TIMED_RANGING ((uint8_t)3)
-#define VL53L0X_DEFAULT_MAX_LOOP 200
+#define TofRangeFinder_REG_IDENTIFICATION_MODEL_ID 0x00c0
+#define TofRangeFinder_REG_IDENTIFICATION_REVISION_ID 0x00c2
+#define TofRangeFinder_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD 0x0050
+#define TofRangeFinder_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD 0x0070
+#define TofRangeFinder_REG_SYSRANGE_START 0x0000
+#define TofRangeFinder_REG_RESULT_INTERRUPT_STATUS 0x0013
+#define TofRangeFinder_REG_RESULT_RANGE_STATUS 0x0014
+#define TofRangeFinder_REG_I2C_SLAVE_DEVICE_ADDRESS 0x008a
+#define TofRangeFinder_I2C_ADDR 0x0029
+#define TofRangeFinder_REG_SYSTEM_RANGE_CONFIG 0x0009
+#define TofRangeFinder_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV 0x0089
+#define TofRangeFinder_REG_SYSRANGE_MODE_SINGLESHOT 0x0000
+#define TofRangeFinder_REG_SYSRANGE_MODE_START_STOP 0x0001
+#define TofRangeFinder_REG_SYSRANGE_MODE_BACKTOBACK 0x0002
+#define TofRangeFinder_REG_SYSRANGE_MODE_TIMED 0x0004
+
+#define TofRangeFinder_DEVICEMODE_SINGLE_RANGING ((uint8_t)0)
+#define TofRangeFinder_DEVICEMODE_CONTINUOUS_RANGING ((uint8_t)1)
+#define TofRangeFinder_DEVICEMODE_CONTINUOUS_TIMED_RANGING ((uint8_t)3)
+#define TofRangeFinder_DEFAULT_MAX_LOOP 200
+
+#define I2C_DevAddr 0x29
 
 class TofRangeFinder {
 public:
-    bool begin(uint8_t address, TwoWire &wirePort = Wire);
-    bool init();
-    float ReadDistance();
+  bool begin(uint8_t i2c_addr);
+  float ReadDistance();
 
 private:
-    uint8_t _address;
-    uint16_t _distance;
-    void write8(unsigned char Reg, unsigned char byte);
-    uint8_t read8(unsigned char Reg);
-    void readData(unsigned char Reg, unsigned char Num);
-
-    unsigned char DevAddr;
-    unsigned char Data[16];
-    uint16_t distance;
+  uint16_t _distance;
+  void write8(unsigned char Reg, unsigned char byte);
+  uint8_t read8(unsigned char Reg);
+  void readData(unsigned char Reg, unsigned char Num);
+
+  unsigned char DevAddr;
+  unsigned char Data[16];
+  uint16_t distance;
 };
 
 #endif