update library function

Author: zeynepdicle

README.md

@@ -1,4 +1,4 @@
-# Deneyap ToF Range Finder Sensor VL53L0X Arduino Library
+# Deneyap ToF Range Finder Sensor Arduino Library
 [FOR TURKISH VERSION](docs/README_tr.md) ![trflag](https://github.com/deneyapkart/deneyapkart-arduino-core/blob/master/docs/tr.png)
 
 ***** Add photo ****
@@ -7,23 +7,27 @@ Arduino library for Deneyap ToF Range Finder Sensor VL53L0X
 
 ## :mag_right:Specifications 
 - `Product ID` **M06**, **mpv1.0**
-- `MCU` VL53L0X
+- `MCU` ST Microelectronics VL53L0CXV0DH/1
 - `Weight` 
-- `Module Dimension`
+- `Module Dimension` 25,4 mm x 25,4 mm
 - `I2C address` 0x29
 
 | Address |  | 
 | :---    | :---     |
 | 0x29    | default address |
 
 ## :closed_book:Documentation
-Deneyap ToF Range Finder Sensor VL53L0X
+[Deneyap ToF Range Finder Sensor](https://docs.deneyapkart.org/en/content/contentDetail/deneyap-module-deneyap-tof-m03)
 
-[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)
+[Deneyap ToF Range Finder Sensor Shematic](https://cdn.deneyapkart.org/media/upload/userFormUpload/2BzP7yaI6mR6uKiXusAbPDFn6WJYzYyN.pdf)
+
+[Deneyap ToF Range Finder Sensor Mechanical Drawing](https://cdn.deneyapkart.org/media/upload/userFormUpload/N7QALHBGi8NnzE6OPQASMRvJpT15uQDI.pdf)
+
+[VL53L0X-dataheet](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)
 
 [How to install a Arduino Library](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
 
-## :pushpin:Deneyap ToF Range Finder Sensor VL53L0X
+## :pushpin:Deneyap ToF Range Finder Sensor
 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
@@ -34,12 +38,14 @@ This Arduino library allows you to use Deneyap ToF Range Finder Sensor VL53L0X w
 - `library.properties ` General library properties for the Arduino package manager
 
 ## Version History
-1.0.0 - initial release
+1.0.2 - update library function(`begin`)
 
 1.0.1 - bug fix
 
+1.0.0 - initial release
+
 ## :rocket:Hardware Connections
-- Deneyap ToF Range Finder Sensor VL53L0X and Board can be connected with I2C cable
+- Deneyap ToF Range Finder Sensor and Board can be connected with I2C cable
 - or 3V3, GND, SDA and SCL pins can be connected with jumper cables
 
 |ToF Range Finder| Function | Board pins | 

docs/README_tr.md

@@ -1,30 +1,33 @@
-# Deneyap Derinlik Ölçer VL53L0X Arduino Kütüphanesi
+# Deneyap Derinlik Ölçer Arduino Kütüphanesi
 
 ***** Fotoğraf eklenecek ****
 
 Deneyap Derinlik Ölçer VL53L0X için Arduino kütüphanesidir.
 
 ## :mag_right:Özellikler 
 - `Ürün ID` **M06**, **mpv1.0**
-- `MCU` VL53L0X
+- `MCU` ST Microelectronics VL53L0CXV0DH/1
 - `Ağırlık`
-- `Modul Boyutları` 
+- `Modul Boyutları` 25,4 mm x 25,4 mm
 - `I2C Adres` 0x29
 
 | Adres |  | 
 | :--- | :---     |
 | 0x29 | varsayılan adres |
 
 ## :closed_book:Dokümanlar
-Deneyap Derinlik Ölçer VL53L0X
+[Deneyap Derinlik Ölçer](https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-module-deneyap-tof-m03)
 
-[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)
+[Deneyap Derinlik Ölçer Şematik](https://cdn.deneyapkart.org/media/upload/userFormUpload/2BzP7yaI6mR6uKiXusAbPDFn6WJYzYyN.pdf)
 
+[Deneyap Derinlik Ölçer Teknik Resim](https://cdn.deneyapkart.org/media/upload/userFormUpload/N7QALHBGi8NnzE6OPQASMRvJpT15uQDI.pdf)
+
+[VL53L0X-dataheet](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 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.
+## :pushpin:Deneyap Derinlik Ölçer
+Bu Arduino kütüphanesi Deneyap Derinlik Ölçer'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.
 
 ## :globe_with_meridians:Repo İçeriği
 - `/docs` README_tr.md ve ürün fotoğrafları
@@ -34,20 +37,22 @@ Bu Arduino kütüphanesi Deneyap Derinlik Ölçer VL53L0X'nin I2C çevre birimi
 - `library.properties` Arduino yöneticisi için genel kütüphane özellikleri
 
 ## Sürüm Geçmişi
-1.0.0 - ilk sürüm
+1.0.2 - kütüphane fonksiyonu(`begin`) güncellendi
 
 1.0.1 - hata giderildi
 
+1.0.0 - ilk sürüm
+
 ## :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 3V3, GND, SDA ve SCL bağlantıları yapılabilir. 
 
 | Derinlik Ölçer | Fonksiyon| Kart pinleri |
 | :---     | :---   |   :---  |
-| 3.3V     | Güç    | 3.3V    |
+| 3.3V     |3.3V Besleme Gerilimi| 3.3V    |
 | GND      | Toprak |GND      |
-| SDA      | I2C Data  | SDA pini |
-| SCL      | I2C Clock | SCL pini|
+| SDA      |Çift Yönlü Veri Hattı| SDA pini |
+| SCL      |Veri Hattı Zaman Senkronizasyon İşaret| SCL pini|
 | XSHT | Shut Down | | 
 | GPIO | Çıktı Kesmesi | | 
 

examples/DerinlikOlcme/DerinlikOlcme.ino

@@ -1,30 +1,25 @@
 /*
- *   Derinlik Ölçme örneği,
- *   
+ *   DerinlikOlcme örneği,  
  *   Bu örnekte temel konfigürasyon ayarları yapılmaktadır. 
- *   Sensörden gelen mesafe verilerini okumaktadır. Mesafe verilerini seri terminale yazdırmaktadır. 
+ *   Sensörden gelen mesafe verilerini okumaktadır. Mesafe verilerini seri port ekranına yazdırmaktadır. 
  *   
  *   Bu algılayıcı I2C haberleşme protokolü ile çalışmaktadır.
  *   
  *   Bu örnek Deneyap Derinlik Ölçer için oluşturulmuştur
- *      ------> www.....com <------ //docs
- *      ------> https://github.com/deneyapkart/deneyap-derinlik-olcer-arduino-library <------
- *     
+ *      ------> https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-module-deneyap-tof-m03 <------
+ *      ------> https://github.com/deneyapkart/deneyap-derinlik-olcer-arduino-library <------  
 */
-#include <Deneyap_DerinlikOlcer.h>                              // Deneyap_DerinlikOlcer.h kütüphanesi eklenmesi
+#include <Deneyap_DerinlikOlcer.h>                  // Deneyap Derinlik Ölçer kütüphanesi eklenmesi
 
-TofRangeFinder Mesafe;                                          // TofRangeFinder için class tanımlanması
+TofRangeFinder TofRangeFinder;                      // TofRangeFinder için class tanımlanması
 
 void setup() {
-    Serial.begin(115200);                                       // Seri haberleşme başlatılması
-    if (!Mesafe.begin(0x29)) {                                  // begin(slaveAdress) fonksiyonu ile cihazların haberleşmesi başlatılması
-        Serial.println("VL53L0X I2C bağlantısı başarısız ");    // I2C bağlantısı başarısız olursa seri terminale yazdırılması
-        while(1);
-    }
+    Serial.begin(115200);                           // Seri haberleşme başlatılması
+    TofRangeFinder.begin(0x29);                     // begin(slaveAdress) fonksiyonu ile cihazların haberleşmesi başlatılması
 }
 
 void loop() {
-    Serial.print("Uzaklık: ");
-    Serial.println(Mesafe.ReadDistance());                      // Ölçüm yapılması ve Seri Terminale veri gönderilmesi
-    delay(50);
-}
+    Serial.print("Derinlik: ");
+    Serial.println(TofRangeFinder.ReadDistance());  // Derinliğin okunması ve seri port ekranına yazdırılması
+    delay(50);                                      // 50 milisaniye bekleme süresi
+}

keywords.txt

@@ -18,7 +18,6 @@ TofRangeFinder	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 begin	KEYWORD2
-init	KEYWORD2
 ReadDistance	KEYWORD2
 
 #######################################

library.properties

@@ -1,5 +1,5 @@
 name=Deneyap Derinlik Olcer
-version=1.0.1
+version=1.0.2
 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.1
-@date         August 18, 2022
+@version      v1.0.2
+@date         September 21, 2022
 @brief        Includes functions to control Deneyap ToF Range Finder Sensor VL53L0X
               Arduino library
 
@@ -22,47 +22,45 @@ Library includes:
  * @param   adress: Device adress
  * @retval  None
  **/
-bool TofRangeFinder::begin(uint8_t i2c_addr) {
-  uint8_t x;
-  DevAddr = I2C_DevAddr;
+void TofRangeFinder::begin(uint8_t address, TwoWire &wirePort) {
+  _address = address;
   Wire.begin();
-  x = read8(TofRangeFinder_REG_IDENTIFICATION_MODEL_ID);
+  //uint8_t x = readRegister(IDENTIFICATION_MODEL_ID);
   //  Serial.print("Device ID: "); Serial.println(x,HEX);
   //  Serial.println("");
-  //  if(x != 0xEE)
-  //  {
+  //  if(x != 0xEE) {
   //    Serial.print("Read Chip ID fail!");
   //  }
 
-  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);
+  writeRegister(0x88, 0x00);
+  writeRegister(0x80, 0x01);
+  writeRegister(0xFF, 0x01);
+  writeRegister(0x00, 0x00);
+  readRegister(0x91);
+  writeRegister(0x91, 0x3c);
+  writeRegister(0x00, 0x01);
+  writeRegister(0xFF, 0x00);
+  writeRegister(0x80, 0x00);
 
-  write8(0x80, 0x01);
-  write8(0xFF, 0x01);
-  write8(0x00, 0x00);
-  write8(0x91, 0x3c);
-  write8(0x00, 0x01);
-  write8(0xFF, 0x00);
-  write8(0x80, 0x00);
+  writeRegister(0x80, 0x01);
+  writeRegister(0xFF, 0x01);
+  writeRegister(0x00, 0x00);
+  writeRegister(0x91, 0x3c);
+  writeRegister(0x00, 0x01);
+  writeRegister(0xFF, 0x00);
+  writeRegister(0x80, 0x00);
 
-  write8(TofRangeFinder_REG_SYSRANGE_START, TofRangeFinder_REG_SYSRANGE_MODE_BACKTOBACK);
-  return 1;
+  writeRegister(SYSRANGE_START, SYSRANGE_MODE_BACKTOBACK);
+  //return true;
 }
 
 /**
  * @brief
  * @param
  * @retval
  **/
-void TofRangeFinder::write8(unsigned char Reg, unsigned char byte) {
-  Wire.beginTransmission(DevAddr);
+void TofRangeFinder::writeRegister(unsigned char Reg, unsigned char byte) {
+  Wire.beginTransmission(_address);
   Wire.write(Reg);
   Wire.write((uint8_t)byte);
   Wire.endTransmission();
@@ -74,10 +72,10 @@ void TofRangeFinder::write8(unsigned char Reg, unsigned char byte) {
  * @retval
  **/
 void TofRangeFinder::readData(unsigned char Reg, unsigned char Num) {
-  Wire.beginTransmission(DevAddr);
+  Wire.beginTransmission(_address);
   Wire.write((uint8_t)Reg);
   Wire.endTransmission();
-  Wire.requestFrom((uint8_t)DevAddr, (uint8_t)Num);
+  Wire.requestFrom((uint8_t)_address, (uint8_t)Num);
 
   for (int i = 0; i < Num; i++) {
     Data[i] = Wire.read();
@@ -90,12 +88,12 @@ void TofRangeFinder::readData(unsigned char Reg, unsigned char Num) {
  * @param
  * @retval
  **/
-uint8_t TofRangeFinder::read8(unsigned char Reg) {
+uint8_t TofRangeFinder::readRegister(unsigned char Reg) {
 
-  Wire.beginTransmission(DevAddr);
+  Wire.beginTransmission(_address);
   Wire.write((uint8_t)Reg);
   Wire.endTransmission();
-  Wire.requestFrom((uint8_t)DevAddr, (uint8_t)1);
+  Wire.requestFrom((uint8_t)_address, (uint8_t)1);
 
   return Wire.read();
 }
@@ -106,10 +104,10 @@ uint8_t TofRangeFinder::read8(unsigned char Reg) {
  * @retval
  **/
 float TofRangeFinder::ReadDistance() {
-  readData(TofRangeFinder_REG_RESULT_RANGE_STATUS, 12);
+  readData(RESULT_RANGE_STATUS, 12);
   distance = ((Data[10] & 0xFF) << 8) |
              (Data[11] & 0xFF);
-  write8(TofRangeFinder_REG_SYSTEM_RANGE_CONFIG, 1);
+  writeRegister(SYSTEM_RANGE_CONFIG, 1);
   if (distance == 20)
     distance = _distance;
   else

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.1
-@date         August 18, 2022
+@version      v1.0.2
+@date         September 21, 2022
 @brief        This file contains all function prototypes and macros
               for Deneyap ToF Range Finder Sensor VL53L0X Arduino library
 ***********************************************************************************
@@ -15,38 +15,39 @@
 #include <Arduino.h>
 #include <Wire.h>
 
-#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 IDENTIFICATION_MODEL_ID 0x00c0
+#define IDENTIFICATION_REVISION_ID 0x00c2
+#define PRE_RANGE_CONFIG_VCSEL_PERIOD 0x0050
+#define FINAL_RANGE_CONFIG_VCSEL_PERIOD 0x0070
+#define SYSRANGE_START 0x0000
+#define RESULT_INTERRUPT_STATUS 0x0013
+#define RESULT_RANGE_STATUS 0x0014
+#define I2C_SLAVE_DEVICE_ADDRESS 0x008a
+#define I2C_ADDR 0x0029
+#define SYSTEM_RANGE_CONFIG 0x0009
+#define VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV 0x0089
+#define SYSRANGE_MODE_SINGLESHOT 0x0000
+#define SYSRANGE_MODE_START_STOP 0x0001
+#define SYSRANGE_MODE_BACKTOBACK 0x0002
+#define SYSRANGE_MODE_TIMED 0x0004
+
+#define DEVICEMODE_SINGLE_RANGING ((uint8_t)0)
+#define DEVICEMODE_CONTINUOUS_RANGING ((uint8_t)1)
+#define DEVICEMODE_CONTINUOUS_TIMED_RANGING ((uint8_t)3)
+#define DEFAULT_MAX_LOOP 200
 
 #define I2C_DevAddr 0x29
 
 class TofRangeFinder {
 public:
-  bool begin(uint8_t i2c_addr);
+  void begin(uint8_t address, TwoWire &wirePort = Wire);
   float ReadDistance();
 
 private:
+  uint8_t _address;
   uint16_t _distance;
-  void write8(unsigned char Reg, unsigned char byte);
-  uint8_t read8(unsigned char Reg);
+  void writeRegister(unsigned char Reg, unsigned char byte);
+  uint8_t readRegister(unsigned char Reg);
   void readData(unsigned char Reg, unsigned char Num);
 
   unsigned char DevAddr;