updated comment line in sketches

deneyapkart · Dec 1, 2022 · 980f24c · 980f24c
1 parent 3e1b189
commit 980f24c
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Deneyap Real Time Clock MCP7940 Arduino Library
+# Deneyap Real Time Clock Arduino Library
 [FOR TURKISH VERSION](docs/README_tr.md) ![trflag](https://github.com/deneyapkart/deneyapkart-arduino-core/blob/master/docs/tr.png)
 
 ***** Add photo ****
@@ -9,22 +9,27 @@ Arduino library for Deneyap Real Time Clock MCP7940
 - `Product ID` **M50**, **mpv1.0**
 - `MCU` MCP79400
 - `Weight` 
-- `Module Dimension`
+- `Module Dimension` 25,4 mm x 25,4 mm
 - `I2C address` 0x6F, 0x57
 
 | Address |  | 
 | :---      | :---     |
 | 0x6F, 0x57 | default address |
 
 ## :closed_book:Documentation
-Deneyap Real Time Clock MCP7940
 
-[MCP7940](https://ww1.microchip.com/downloads/en/DeviceDoc/MCP79400-MCP79401-MCP79402-Data-Sheet-20005009G.pdf)
+[Deneyap Real Time Clock](https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-module-deneyap-rtc-m50)
+
+[Deneyap Real Time Clock Şematik](https://docs.deneyapkart.org/en/content/contentDetail/deneyap-module-deneyap-rtc-m50)
+
+[Deneyap Real Time Clock Teknik Çizim](https://cdn.deneyapkart.org/media/upload/userFormUpload/exe2a7in62EN7ZwVND0DpCVeDrsT47Km.pdf)
+
+[MCP7940-datasheet](https://ww1.microchip.com/downloads/en/DeviceDoc/MCP79400-MCP79401-MCP79402-Data-Sheet-20005009G.pdf)
 
 [How to install a Arduino Library](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
 
-## :pushpin:Deneyap Real Time Clock MCP7940
-This Arduino library allows you to use Deneyap Real Time Clock MCP7940 with I2C peripheral. You can use this library in your projects with any Arduino compatible board with I2C peripheral.
+## :pushpin:Deneyap Real Time Clock
+This Arduino library allows you to use Deneyap Real Time Clock 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
@@ -34,6 +39,8 @@ This Arduino library allows you to use Deneyap Real Time Clock MCP7940 with I2C
 - `library.properties ` General library properties for the Arduino package manager
 
 ## Version History
+1.0.1 - updated comment line in sketches
+
 1.0.0 - initial release
 
 ## :rocket:Hardware Connections
@@ -46,9 +53,10 @@ This Arduino library allows you to use Deneyap Real Time Clock MCP7940 with I2C
 |GND  | Ground  | GND | 
 |SDA  | I2C Data  | SDA pin |
 |SCL  | I2C Clock | SCL pin |
-|OUT  | OUTPUT pin|         |
+|OUT  | OUTPUT pin|PWM pin|
 
 ## :bookmark_tabs:License Information
+Based on Zanduino MCP7940 Arduino Library. Changed to work with Deneyap Real Time Clock MCP7940.
+
 Please review the [LICENSE](https://github.com/deneyapkart/deneyap-gercek-zamanli-saat-arduino-library/blob/master/LICENSE) file for license information.
 
-Based on Zanduino MCP7940 Arduino Library. Changed to work with Deneyap Real Time Clock MCP7940.
diff --git a/docs/README_tr.md b/docs/README_tr.md
@@ -1,4 +1,4 @@
-# Deneyap Gerçek Zamanlı Saat MCP7940 Arduino Kütüphanesi
+# Deneyap Gerçek Zamanlı Saat Arduino Kütüphanesi
 
 ***** Fotoğraf eklenecek ****
 
@@ -8,22 +8,26 @@ Deneyap Gerçek Zamanlı Saat MCP7940 için Arduino kütüphanesidir.
 - `Ürün ID` **M50**, **mpv1.0**
 - `MCU` MCP79400
 - `Ağırlık`
-- `Modul Boyutları` 
+- `Modul Boyutları` 25,4 mm x 25,4 mm
 - `I2C Adres` 0x6F, 0x57
 
 | Adres |  | 
 | :--- | :---     |
 | 0x6F, 0x57 | varsayılan adres |
 
 ## :closed_book:Dokümanlar
-Deneyap Gerçek Zamanlı Saat MCP7940
+[Deneyap Gerçek Zamanlı Saat](https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-module-deneyap-rtc-m50)
 
-[MCP7940](https://ww1.microchip.com/downloads/en/DeviceDoc/MCP79400-MCP79401-MCP79402-Data-Sheet-20005009G.pdf)
+[Deneyap Gerçek Zamanlı Saat Şematik](https://docs.deneyapkart.org/en/content/contentDetail/deneyap-module-deneyap-rtc-m50)
+
+[Deneyap Gerçek Zamanlı Saat Teknik Çizim](https://cdn.deneyapkart.org/media/upload/userFormUpload/exe2a7in62EN7ZwVND0DpCVeDrsT47Km.pdf)
+
+[MCP7940-datasheet](https://ww1.microchip.com/downloads/en/DeviceDoc/MCP79400-MCP79401-MCP79402-Data-Sheet-20005009G.pdf)
 
 [Arduino IDE'de Kütüphane Nasıl İndirilir](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
 
-## :pushpin:Deneyap Gerçek Zamanlı Saat MCP7940
-Bu Arduino kütüphanesi Deneyap Gerçek Zamanlı Saat MCP7940nin 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 Gerçek Zamanlı Saat
+Bu Arduino kütüphanesi Deneyap Gerçek Zamanlı Saatin 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ı
@@ -33,6 +37,8 @@ Bu Arduino kütüphanesi Deneyap Gerçek Zamanlı Saat MCP7940nin I2C çevre bir
 - `library.properties` Arduino yöneticisi için genel kütüphane özellikleri
 
 ## Sürüm Geçmişi
+1.0.1 - örnek uygulamalarındaki yorum satırları güncellendi
+
 1.0.0 - ilk sürüm
 
 ## :rocket:Donanım Bağlantıları
@@ -41,11 +47,11 @@ Bu Arduino kütüphanesi Deneyap Gerçek Zamanlı Saat MCP7940nin I2C çevre bir
 
 | Gerçek Zamanlı Saat | Fonksiyon| Kart pinleri |
 | :---     | :---   |   :---  |
-| 3.3V     | Güç    | 3.3V    |
-| GND      | Toprak |GND      |
-| SDA      | I2C Data  | SDA pini |
-| SCL      | I2C Clock | SCL pini|
-| OUT      | Çıkış pini |   |
+| 3.3V     |3.3V Besleme Gerilimi| 3.3V    |
+| GND      |Toprak|GND      |
+| SDA      |Çift Yönlü Veri Hattı| SDA pini |
+| SCL      |Veri Hatta Zaman Senkronivasyon İşareti| SCL pini|
+| OUT      |Genel Amaçlı Çıkış Pini|PWM pin|
 
 ## :bookmark_tabs:Lisans Bilgisi 
 Lisans bilgileri için [LICENSE](https://github.com/deneyapkart/deneyap-gercek-zamanli-saat-arduino-library/blob/master/LICENSE) dosyasını inceleyin.
diff --git a/examples/SimdikiTarihSaat/SimdikiTarihSaat.ino b/examples/SimdikiTarihSaat/SimdikiTarihSaat.ino
@@ -1,26 +1,24 @@
 /*
- *   Şimdiki tarih ve saat örneği,
+ *   SimdikiTarihSaat örneği,
  *
  *   Bu örnekte temel konfigürasyon ayarları yapılmaktadır.
- *   Şimdiki tarih ve saatten sonraki zaman akışını seri terminale yazdırmaktadır.
+ *   Şimdiki tarih ve saati seri port ekranına yazdırmaktadır.
  *
  *   Bu algılayıcı I2C haberleşme protokolü ile çalışmaktadır.
  *
  *   Bu örnek Deneyap Gerçek Zamanlı Saat için oluşturulmuştur
- *      ------>  www.....com  <------ //docs
- *      ------>  https://github.com/deneyapkart/deneyap-gercek-zamanli-saat-arduino-library  <------
- *
+ *      ------> https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-module-deneyap-rtc-m50 <------
+ *      ------> https://github.com/deneyapkart/deneyap-gercek-zamanli-saat-arduino-library <------
 */
-
-#include <Deneyap_GercekZamanliSaat.h>                                      // Deneyap_GercekZamanliSaat kutuphanesi eklenmesi
+#include <Deneyap_GercekZamanliSaat.h>                                      // Deneyap Gerçek Zamanlı Saat kutuphanesi eklenmesi
 
 RTC GercekZamanliSaat;                                                      // RTC için class tanımlaması
 
 void setup() {
     Serial.begin(115200);                                                   // Seri haberleşme başlatılması
     if (!GercekZamanliSaat.begin()) {                                       // 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ı
+        Serial.println("I2C bağlantısı başarısız ");                        // I2C bağlantısı başarısız olursa seri port ekranına yazdırılması
         while (1) ;
     }
     GercekZamanliSaat.deviceStart();
@@ -30,8 +28,8 @@ void setup() {
 void loop() {
     DateTime now = GercekZamanliSaat.now();
     Serial.print("\nTarih:");
-    Serial.printf("%02d/%02d/%04d", now.day(), now.month(), now.year());     // yıl, ay, günün seri terminale yazdırılması
+    Serial.printf("%02d/%02d/%04d", now.day(), now.month(), now.year());     // yıl, ay, günün seri port ekranına yazdırılması
     Serial.print("\tSaat:");
-    Serial.printf("%02d:%02d:%02d", now.hour(), now.minute(), now.second()); // saat, dakika, saniyeyi seri terminale yazdırılması
+    Serial.printf("%02d:%02d:%02d", now.hour(), now.minute(), now.second()); // saat, dakika, saniyeyi seri port ekranına yazdırılması
     delay(1000);
 } 
diff --git a/examples/TarihSaatAyarlama/TarihSaatAyarlama.ino b/examples/TarihSaatAyarlama/TarihSaatAyarlama.ino
@@ -2,36 +2,34 @@
  *   Tarih ve saat ayarlama örneği,
  *
  *   Bu örnekte temel konfigürasyon ayarları yapılmaktadır.
- *   Seçilen tarih ve saatten sonraki zaman akışını seri terminale yazdırmaktadır.
+ *   Seçilen tarih ve saatten sonraki zaman akışını seri port ekranına yazdırmaktadır.
  *
  *   Bu algılayıcı I2C haberleşme protokolü ile çalışmaktadır.
  *
  *   Bu örnek Deneyap Gerçek Zamanlı Saat için oluşturulmuştur
- *      ------>  www.....com  <------ //docs
- *      ------>  https://github.com/deneyapkart/deneyap-gercek-zamanli-saat-arduino-library  <------
- *
+ *      ------> https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-module-deneyap-rtc-m50 <------
+ *      ------> https://github.com/deneyapkart/deneyap-gercek-zamanli-saat-arduino-library <------
 */
+#include <Deneyap_GercekZamanliSaat.h>                                        // Deneyap Gerçek Zamanlı Saat kutuphanesi eklenmesi
 
-#include <Deneyap_GercekZamanliSaat.h>                                      // Deneyap_GercekZamanliSaat kutuphanesi eklenmesi
-
-RTC GercekZamanliSaat;                                                      // RTC için class tanımlaması
+RTC GercekZamanliSaat;                                                        // RTC için class tanımlaması
 
 void setup() {
-    Serial.begin(115200);                                                   // Seri haberleşme başlatılması
-    if (!GercekZamanliSaat.begin()) {                                       // begin(slaveAdress) fonksiyonu ile cihazların haberleşmesi başlatılması
+    Serial.begin(115200);                                                     // Seri haberleşme başlatılması
+    if (!GercekZamanliSaat.begin()) {                                         // 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ı
+        Serial.println("I2C bağlantısı başarısız ");                          // I2C bağlantısı başarısız olursa seri port ekranına yazdırılması
         while (1) ;
-    }
-    GercekZamanliSaat.adjust();
-    GercekZamanliSaat.adjust(DateTime(2008, 03, 03, 15, 45, 20));           // yıl, ay, gün, saat, dakika, saniyeni ayarlanması
-}
-
-void loop() {
+    } 
+    delay(3000);
     DateTime now = GercekZamanliSaat.now();
+    GercekZamanliSaat.adjust(DateTime(2008, 03, 03, 15, 45, 20));             // yıl, ay, gün, saat, dakika, saniyeni ayarlanması
     Serial.print("\nTarih:");
-    Serial.printf("%02d/%02d/%04d", now.day(), now.month(), now.year());     // yıl, ay, günün seri terminale yazdırılması
+    Serial.printf("%02d/%02d/%04d", now.day(), now.month(), now.year());      // yıl, ay, günün seri port ekranına yazdırılması
     Serial.print("\tSaat:");
-    Serial.printf("%02d:%02d:%02d", now.hour(), now.minute(), now.second()); // saat, dakika, saniyeyi seri terminale yazdırılması
+    Serial.printf("%02d:%02d:%02d", now.hour(), now.minute(), now.second());  // saat, dakika, saniyeyi seri port ekranına yazdırılması
     delay(1000);
 }
+
+void loop() {
+}
diff --git a/library.properties b/library.properties
@@ -1,6 +1,6 @@
-name=Deneyap Gercek Zamanli Saat MCP7940
-version=1.0.0
-author=RFtek Electronics <techsupport@rftek.com.tr>
+name=Deneyap Gercek Zamanli Saat
+version=1.0.1
+author=Turkish Technnology Team Foundation (T3)
 maintainer=Turkish Technnology Team Foundation (T3)
 sentence=Arduino library for Deneyap Real Time Clock MCP7940
 paragraph=A simple and efficient library to use Deneyap Real Time Clock MCP7940 via I2C peripheral.