updated library

- added new function(I2C_ReadFirmwareData16bit)
- updated function(getFwVersion)
- updated comment line in examples

Author: zeynepdicle

README.md

@@ -43,6 +43,8 @@ This Arduino library allows you to use Deneyap Infrarad Receiver Transmitter wit
 - `library.properties ` General library properties for the Arduino package manager
 
 ## Version History
+1.0.2 - added new function(I2C_ReadFirmwareData16bit), updated function(getFwVersion) and comment lines
+
 1.0.1 - changed example file names (KizilOtesiAlici -> KizilotesiAlici, KizilOtesiVerici -> KizilotesiVerici )
 
 1.0.0 - initial release

docs/README_tr.md

@@ -42,6 +42,8 @@ Bu Arduino kütüphanesi Deneyap Kızılötesi Alıcı&Verici'nin I2C çevre bir
 - `library.properties` Arduino yöneticisi için genel kütüphane özellikleri
 
 ## Sürüm Geçmişi
+1.0.2 - yeni fonksiyon eklendi(I2C_ReadFirmwareData16bit), fonksiyon güncellendi(getFwVersion), yorum satırları güncellendi
+
 1.0.1 - örnek uygulama dosyalarının isimleri değiştirildi (KizilOtesiAlici -> KizilotesiAlici, KizilOtesiVerici -> KizilotesiVerici )
 
 1.0.0 - ilk sürüm

examples/KizilotesiAlici/KizilotesiAlici.ino

@@ -1,16 +1,14 @@
 /*
  *   Kızılötesi alıcı örneği,
- *
  *   Bu örnekte temel konfigürasyon ayarları yapılmaktadır.
- *   Kızılötesi alıcıdan gelen veriyi seri terminale yazdırmaktadır. 
+ *   Kızılötesi alıcıdan gelen veriyi seri port ekranına yazdırmaktadır. 
  *
  *   Bu algılayıcı I2C haberleşme protokolü ile çalışmaktadır.
  *
  *   Bu örnek Deneyap Kızılötesi Alıcı&Verici için oluşturulmuştur
  *      ------>  https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-modul-deneyap-kzlotesi-alc-ve-verici-m53  <------
  *      ------>  https://github.com/deneyapkart/deneyap-kizilotesi-alici-verici-arduino-library  <------
- *
- */
+*/
 #include <Deneyap_KizilotesiAliciVerici.h>              // Deneyap Kızılötesi Alıcı&Verici kutuphanesi eklenmesi
 
 Transceiver IR;                                         // Transceiver için class tanımlaması
@@ -20,11 +18,11 @@ void setup() {
     if (!IR.begin(0x22)) {                              // begin(slaveAdress) fonksiyonu ile cihazların haberleşmesi başlatılması
         delay(3000);
         Serial.println("I2C bağlantısı başarısız ");    // I2C bağlantısı başarısız olursa seri monitore yazdırılması
-        while (1) ;
+        while (1);
     }
 }
 
 void loop() {
-    IR.transceiverRead();                               // Alıcıdan alınan veri seri terminale yazdırıldı
+    IR.transceiverRead();                               // Alıcıdan alınan veri seri port ekranına yazdırılması
     delay(100);                                         // Veri alındıktan sonra 100 ms beklemesi gerekmektedir
 }

examples/KizilotesiVerici/KizilotesiVerici.ino

@@ -1,6 +1,5 @@
 /*
  *   Kızılötesi verici örneği,
- *
  *   Bu örnekte temel konfigürasyon ayarları yapılmaktadır.
  *   Kızılötesi alıcı butona basıldığında seçilen veriyi göndermektedir. 
  *
@@ -9,8 +8,7 @@
  *   Bu örnek Deneyap Kızılötesi Alıcı&Verici için oluşturulmuştur
  *      ------>  https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-modul-deneyap-kzlotesi-alc-ve-verici-m53  <------
  *      ------>  https://github.com/deneyapkart/deneyap-kizilotesi-alici-verici-arduino-library  <------
- *
- */
+*/
 #include <Deneyap_KizilotesiAliciVerici.h>            // Deneyap Kızılötesi Alıcı&Verici kutuphanesi eklenmesi
 
 Transceiver IR;                                       // Transceiver için class tanımlaması

library.properties

@@ -1,5 +1,5 @@
 name=Deneyap Kizilotesi Alici Verici
-version=1.0.1
+version=1.0.2
 author=Turkish Technnology Team Foundation (T3)
 maintainer=Turkish Technnology Team Foundation (T3)
 sentence=Arduino library for Deneyap Infrarad Receiver Transmitter

src/Deneyap_KizilotesiAliciVerici.cpp

@@ -1,10 +1,10 @@
 /*
 *****************************************************************************
-@file         Deneyap_KizilOtesiAliciVerici.cpp
+@file         Deneyap_KizilotesiAliciVerici.cpp
 @mainpage     Deneyap Infrarad Receiver Transmitter Arduino library source file
 @maintainer   RFtek Electronics <[email protected]>
-@version      v1.0.0
-@date         June 29, 2022
+@version      v1.0.2
+@date         November 07, 2022
 @brief        Includes functions to controlDeneyap Infrarad Receiver Transmitter
               Arduino library
 
@@ -26,8 +26,12 @@ Library includes:
  */
 bool Transceiver::begin(uint8_t address, TwoWire &port) {
     Wire.begin();
+#if defined(ARDUINO_DYM)
+    Wire.setClock(100000);
+#else
     Wire.setClock(50000);
-    _i2cAddress = address;
+#endif
+    _i2cAddress  = address;
     _i2cPort = &port;
     _dataPacket = {0};
 
@@ -55,7 +59,7 @@ bool Transceiver::isConnected() {
 uint16_t Transceiver::getFwVersion() {
     _dataPacket.command = TRANSCEIVER_REQUEST_FW_VERSION;
     _dataPacket.dataSize = 0;
-    return I2C_ReadData16bit(&_dataPacket);
+    return I2C_ReadFirmwareData16bit(&_dataPacket);
 }
 
 /**
@@ -164,6 +168,11 @@ uint8_t Transceiver::I2C_ReadData(Transceiver_DataPacket_TypeDef *dataPacket) {
     return 1;
 }
 
+/**
+ * @brief  Reads 8bit data from I2C interface
+ * @param  dataPacket: includes protocol to request data
+ * @retval I2C 8bit data
+ */
 uint8_t Transceiver::I2C_ReadData8bit(Transceiver_DataPacket_TypeDef *dataPacket) {
     _i2cPort->beginTransmission(_i2cAddress);
     _i2cPort->write(dataPacket->command);
@@ -179,8 +188,7 @@ uint8_t Transceiver::I2C_ReadData8bit(Transceiver_DataPacket_TypeDef *dataPacket
  * @param  dataPacket: includes protocol to request data
  * @retval I2C 16bit data
  */
-uint16_t Transceiver::I2C_ReadData16bit(Transceiver_DataPacket_TypeDef *dataPacket)
-{
+uint16_t Transceiver::I2C_ReadData16bit(Transceiver_DataPacket_TypeDef *dataPacket) {
     _i2cPort->beginTransmission(_i2cAddress);
     _i2cPort->write(dataPacket->command);
     _i2cPort->endTransmission();
@@ -193,6 +201,24 @@ uint16_t Transceiver::I2C_ReadData16bit(Transceiver_DataPacket_TypeDef *dataPack
     return 0;
 }
 
+/**
+ * @brief  Reads 16bit data from I2C interface
+ * @param  dataPacket: includes protocol to request data
+ * @retval I2C 16bit data
+ */
+uint16_t Transceiver::I2C_ReadFirmwareData16bit(Transceiver_DataPacket_TypeDef *dataPacket) {
+    _i2cPort->beginTransmission(_i2cAddress);
+    _i2cPort->write(dataPacket->command);
+    _i2cPort->endTransmission();
+
+    if (_i2cPort->requestFrom(_i2cAddress, static_cast<uint8_t>(2)) != 0) {
+        i2cData2 = _i2cPort->read();
+        i2cData1 = _i2cPort->read();
+        Serial.print("v"); Serial.print(i2cData1); Serial.print("."); Serial.println(i2cData2);
+    }
+    return 0;
+}
+
 /**
  * @brief  Sends data packet based on a custom defined protocol
  * @param  dataPacket: includes all related data
@@ -209,4 +235,4 @@ bool Transceiver::I2C_SendDataPacket(Transceiver_DataPacket_TypeDef *dataPacket)
     if (_i2cPort->endTransmission() == 0)
         return true;
     return false;
-}
+}

src/Deneyap_KizilotesiAliciVerici.h

@@ -1,9 +1,9 @@
 /*
 *****************************************************************************
-@file         Deneyap_KizilOtesiAliciVerici.h
+@file         Deneyap_KizilotesiAliciVerici.h
 @mainpage     Deneyap Infrarad Receiver Transmitter Arduino library header file
-@version      v1.0.0
-@date         June 29, 2022
+@version      v1.0.2
+@date         November 07, 2022
 @brief        This file contains all function prototypes and macros
               for Deneyap Infrarad Receiver Transmitter Arduino library
 *****************************************************************************
@@ -54,6 +54,9 @@ class Transceiver {
     uint32_t transceiverRead();
     bool transceiverWrite(uint8_t data, uint8_t address = 0x44);
 
+    uint8_t i2cData2;
+    uint8_t i2cData1;
+
 private:
     TwoWire *_i2cPort;                          // Port selection (0 or 1)
     uint8_t _i2cAddress;                        // Device I2C address
@@ -63,7 +66,8 @@ class Transceiver {
     uint8_t I2C_ReadData(Transceiver_DataPacket_TypeDef *dataPacket);
     uint8_t I2C_ReadData8bit(Transceiver_DataPacket_TypeDef *dataPacket);
     uint16_t I2C_ReadData16bit(Transceiver_DataPacket_TypeDef *dataPacket);
+    uint16_t I2C_ReadFirmwareData16bit(Transceiver_DataPacket_TypeDef *dataPacket);
     bool I2C_SendDataPacket(Transceiver_DataPacket_TypeDef *dataPacket);
 };
 
-#endif /* __Deneyap_KizilotesiAliciVerici_H */
+#endif /* __Deneyap_KizilotesiAliciVerici_H */