Skip to content

Commit 238d0fc

Browse files
zeynepdiclezeynepdicle
committed
updated library
- updated function(ReadSmokeDigital) - updated comment line in examples
1 parent 34ba9e7 commit 238d0fc

File tree

7 files changed

+88
-57
lines changed

7 files changed

+88
-57
lines changed

‎README.md‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Arduino library for Deneyap Gas Sensor
77

88
## :mag_right:Specifications
99
- `Product ID` **M39**, **mpv1.0**
10-
- `MCU` STM8S003F3
10+
- `MCU` MQ-2, STM8S003F3
1111
- `Weight`
12-
- `Module Dimension`
12+
- `Module Dimension` 25,4 mm x 38,1 mm
1313
- `I2C address` 0x20, 0x4E, 0x57, 0x58
1414

1515
| Address | |
@@ -20,7 +20,13 @@ Arduino library for Deneyap Gas Sensor
2020
| 0x58 | address when ADR1 and ADR2 pads are shorted |
2121

2222
## :closed_book:Documentation
23-
Deneyap Gas Sensor
23+
[Deneyap Gas Sensor](https://docs.deneyapkart.org/en/content/contentDetail/deneyap-modul-deneyap-duman-dedektoru-m39)
24+
25+
[Deneyap Gas Sensor Shematic](https://cdn.deneyapkart.org/media/upload/userFormUpload/W0wwJGClTVDjdv9xZl9liTXfBbeG99Uo.pdf)
26+
27+
[Deneyap Gas Sensor Mechanical Drawing](https://cdn.deneyapkart.org/media/upload/userFormUpload/Mzb7brJaIeM7gkEY3G5w31l4TOAEWbT3.pdf)
28+
29+
[MQ-2_datasheet](https://www.winsen-sensor.com/d/files/PDF/Semiconductor%20Gas%20Sensor/MQ-2%20(Ver1.4)%20-%20Manual.pdf)
2430

2531
[How to install a Arduino Library](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
2632

@@ -35,6 +41,8 @@ This Arduino library allows you to use Deneyap Gas Sensor with I2C peripheral. Y
3541
- `library.properties ` General library properties for the Arduino package manager
3642

3743
## Version History
44+
1.0.1 - updated function(ReadSmokeDigital) and comment line in examples
45+
3846
1.0.0 - initial release
3947

4048
## :rocket:Hardware Connections
@@ -49,9 +57,9 @@ This Arduino library allows you to use Deneyap Gas Sensor with I2C peripheral. Y
4957
|SCL | I2C Clock | SCL pin |
5058
|SWIM | Debug | no connection |
5159
|RES | Debug | no connection |
52-
| AO |Analog Output|any Analog pin|
53-
| DO |Dijital Output|any GPIO pin|
54-
| H |||
60+
| AO |Analog Output|any Analog pin|
61+
| DO |Dijital Output|any GPIO pin|
62+
| H |Sensor's Heater Pin||
5563

5664
## :bookmark_tabs:License Information
5765
Please review the [LICENSE](https://github.com/deneyapkart/deneyap-duman-dedektoru-arduino-library/blob/master/LICENSE) file for license information.

‎docs/README_tr.md‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Deneyap Duman Dedektörü için Arduino kütüphanesidir.
66

77
## :mag_right:Özellikler
88
- `Ürün ID` **M39**, **mpv1.0**
9-
- `MCU` STM8S003F3
9+
- `MCU` MQ-2, STM8S003F3
1010
- `Ağırlık`
11-
- `Modul Boyutları`
11+
- `Modul Boyutları` 25,4 mm x 38,1 mm
1212
- `I2C Adres` 0x20, 0x4E, 0x57, 0x58
1313

1414
| Adres | |
@@ -19,7 +19,13 @@ Deneyap Duman Dedektörü için Arduino kütüphanesidir.
1919
| 0x58 | ADR1 ve ADR2 kısa devre yapıldığındaki adres |
2020

2121
## :closed_book:Dokümanlar
22-
Deneyap Duman Dedektörü
22+
[Deneyap Duman Dedektörü](https://docs.deneyapkart.org/en/content/contentDetail/deneyap-modul-deneyap-duman-dedektoru-m39)
23+
24+
[Deneyap Duman Dedektörü Shematic](https://cdn.deneyapkart.org/media/upload/userFormUpload/W0wwJGClTVDjdv9xZl9liTXfBbeG99Uo.pdf)
25+
26+
[Deneyap Duman Dedektörü Mechanical Drawing](https://cdn.deneyapkart.org/media/upload/userFormUpload/Mzb7brJaIeM7gkEY3G5w31l4TOAEWbT3.pdf)
27+
28+
[MQ-2_datasheet](https://www.winsen-sensor.com/d/files/PDF/Semiconductor%20Gas%20Sensor/MQ-2%20(Ver1.4)%20-%20Manual.pdf)
2329

2430
[Arduino Kütüphanesi Nasıl İndirilir](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
2531

@@ -34,23 +40,25 @@ Bu Arduino kütüphanesi Deneyap Duman Dedektörü I2C çevre birimi ile kullan
3440
- `library.properties` Arduino yöneticisi için genel kütüphane özellikleri
3541

3642
## Sürüm Geçmişi
43+
1.0.1 - fonkiyon(ReadSmokeDigital) ve örnek uygulamalardaki yorum satırları güncellendi
44+
3745
1.0.0 - ilk sürüm
3846

3947
## :rocket:Donanım Bağlantıları
4048
- Deneyap Duman Dedektörü ile kullanılan geliştirme kartı I2C kablosu ile bağlanabilir
41-
- veya jumper kablolar ile ile 3V3, GND, SDA ve SCL bağlantıları yapılabilir.
49+
- veya jumper kablolar ile 3V3, GND, SDA ve SCL bağlantıları yapılabilir.
4250

4351
| Duman Dedektörü | Fonksiyon| Kart pinleri |
4452
| :--- | :--- | :--- |
45-
| 3.3V | Güç | 3.3V |
53+
| 3.3V |3.3V Besleme Gerilimi| 3.3V |
4654
| GND | Toprak |GND |
47-
| SDA | I2C Data | SDA pini |
48-
| SCL | I2C Clock | SCL pini|
55+
| SDA |Çift Yönlü Veri Hattı| SDA pini |
56+
| SCL |Veri Hattı Zaman Senkronizasyon İşareti| SCL pini|
4957
| SWIM | Debug | bağlantı yok |
5058
| RES | Debug | bağlantı yok |
51-
| AO |Analog Output|herhangi Analog pini|
52-
| DO |Dijital Output|herhangi GPIO pini|
53-
| H |||
59+
| AO |Analog Çıkış Pini|herhangi Analog pini|
60+
| DO |Dijital Çıkış Pini|herhangi GPIO pini|
61+
| H |Algılayıcının Isıtıcı Pini||
5462

5563
## :bookmark_tabs:Lisans Bilgisi
5664
Lisans bilgileri için [LICENSE](https://github.com/deneyapkart/deneyap-duman-dedektoru-arduino-library/blob/master/LICENSE) dosyasını inceleyin.

‎examples/DumanAlgilama/DumanAlgilama.ino‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
11
/*
22
* Duman Algılama örneği,
3-
*
43
* Bu örnekte temel konfigürasyon ayarları yapılmaktadır.
5-
* Sensörden gelen duman değerleri okumaktadır. Bu değerleri seri monitöre yazdırmaktadır.
6-
* Duman algılayınca Duman Dedektörü kartındaki yeşil çıkış ledi yanmaktadır.
7-
* Not: Karta ilk güç verildiketn sonra yeşil çıkış led sönene kadar beklenilmeli. Led sönme süresi uzadığı takdirde üzerindeki pot değeri değiştirilmelidir.
8-
*
4+
* Deneyap Duman Detektöründen gelen analog duman değerlerini okumaktadır. Bu değerleri seri port ekranına yazdırmaktadır.
5+
* Duman algılanınca seri port ekranına "Duman Algılandı" yazmaktadır ve kartın üzerinde yer alan çıkış ledi yanmaktır.
6+
*
7+
* UYARI: Duman Algılama Değeri
8+
* -> Deneyap Duman Detektörü kartına ilk güç verildiğinde analog olarak 1024 değerini gözlemleyeceksiniz. Kart ısındıkca bu analog değer düşmeye başlayacaktır.
9+
* -> Duman değeri ortama göre değişebilmektedir. Değerin düşme hızı değişiklik gösterebilir. Analog duman değeri 300-500 kadar düşebilir.
10+
* -> Projenizi geliştirmeden önce değerleri gözlemlendirmelisiz. Gözlemlediğiniz değerleri baz alarak projelerinizi geliştirebilirsiniz.
11+
*
12+
* UYARI: Duman Algılama Durumu
13+
* -> Deneyap Duman Detektörü kartındaki trimpot ile eşik(threshold) değerini değiştirebilirsiniz.
14+
* -> Trimpot saat yönüne çevirilirse eşik değeri düşecektir.
15+
* -> Trimpot saat yönünün tersine çevirilirse eşik değeri yükselecektir.
16+
*
917
* Bu algılayıcı I2C haberleşme protokolü ile çalışmaktadır.
1018
*
1119
* Bu örnek Deneyap Duman Dedektörü için oluşturulmuştur
12-
* ------> www.....com <------ //docs
20+
* ------> https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-modul-deneyap-duman-dedektoru-m39 <------
1321
* ------> https://github.com/deneyapkart/deneyap-duman-dedektoru-arduino-library <------
14-
*
1522
*/
16-
17-
#include <Deneyap_DumanDedektoru.h> // Deneyap_DumanDedektoru kutuphanesi eklenmesi
23+
#include <Deneyap_DumanDedektoru.h> // Deneyap Duman Dedektörü kutuphanesi eklenmesi
1824

1925
SmokeDetector DumanSensor; // SmokeDetector için class tanımlaması
2026

2127
void setup() {
2228
Serial.begin(115200); // Seri haberlesme baslatılması
2329
if (!DumanSensor.begin(0x20)) { // begin(slaveAdress) fonksiyonu ile cihazların haberleşmesi başlatılması
2430
delay(3000);
25-
Serial.println("I2C bağlantısı başarısız "); // I2C bağlantısı başarısız olursa seri monitore yazdırılması
31+
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ı
2632
while (1);
2733
}
2834
}
2935

3036
void loop() {
31-
/* ReadSmokeDetectorDigital() = 0 ise "duman ALGILANDI"
32-
1 ise "duman ALGILANMADI" */
3337
bool dumanDurum = DumanSensor.ReadSmokeDigital(); // Duman durumu okunması
34-
Serial.print("Duman Durumu:");
35-
Serial.print(dumanDurum); // Duman durumu seri monitore yazdırılması
38+
if(dumanDurum == 1) {
39+
Serial.println("Duman Algılandı"); // Duman algılanınca çıkış ledi yanacaktır
40+
}
3641

3742
uint16_t dumanDeger = DumanSensor.ReadSmokeAnalog(); // Duman degeri okunması
38-
Serial.print("\t Duman Degeri:");
39-
Serial.println(dumanDeger); // Duman verisi seri monitore yazdırılması
40-
43+
Serial.print("Duman Degeri:");
44+
Serial.println(dumanDeger); // Duman verisi seri port ekranına yazdırılması
4145
delay(10);
4246
}

‎examples/DumanAlgilamaNoI2C/DumanAlgilamaNoI2C.ino‎

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
11
/*
22
* I2C haberleşme protokolü kullanılmadan Duman Algılama örneği,
3-
*
4-
* Sensörden gelen duman değerleri okumaktadır. Bu değerleri seri monitöre yazdırmaktadır.
5-
* Duman algılayınca Duman Dedektörü kartındaki yeşil çıkış ledi yanmaktadır.
6-
* Not: Karta ilk güç verildiketn sonra yeşil çıkış led sönene kadar beklenilmeli. Led sönme süresi uzadığı takdirde üzerindeki pot değeri değiştirilmelidir.
7-
*
3+
* Bu örnekte temel konfigürasyon ayarları yapılmaktadır.
4+
* Deneyap Duman Detektöründen gelen analog duman değerlerini okumaktadır. Bu değerleri seri port ekranına yazdırmaktadır.
5+
* Duman algılanınca seri port ekranına "Duman Algılandı" yazmaktadır ve kartın üzerinde yer alan çıkış ledi yanmaktır.
6+
*
7+
* UYARI: Duman Algılama Değeri
8+
* -> Deneyap Duman Detektörü kartına ilk güç verildiğinde analog olarak 4095(kullandığınız geliştirme kartına göre değişir) değerini gözlemleyeceksiniz.
9+
* Kart ısındıkca bu analog değer düşmeye başlayacaktır.
10+
* -> Duman değeri ortama göre değişebilmektedir. Değerin düşme hızı değişiklik gösterebilir.
11+
* Analog duman değeri 1200-2000(kullandığınız geliştirme kartına göre değişir) kadar düşebilir.
12+
* -> Projenizi geliştirmeden önce değerleri gözlemlendirmelisiz. Gözlemlediğiniz değerleri baz alarak projelerinizi geliştirebilirsiniz.
13+
*
14+
* UYARI: Duman Algılama Durumu
15+
* -> Deneyap Duman Detektörü kartındaki trimpot ile eşik(threshold) değerini değiştirebilirsiniz.
16+
* -> Trimpot saat yönüne çevirilirse eşik değeri düşecektir.
17+
* -> Trimpot saat yönünün tersine çevirilirse eşik değeri yükselecektir.
18+
*
819
* Bu algılayıcı I2C haberleşme protokolü ile çalışmaktadır.
920
* Bu örnek I2C haberleşme protokolü kullanılmadan yazılmıştır.
1021
*
1122
* Bu örnek Deneyap Duman Dedektörü için oluşturulmuştur
12-
* ------> www.....com <------ //docs
23+
* ------> https://docs.deneyapkart.org/tr/content/contentDetail/deneyap-modul-deneyap-duman-dedektoru-m39 <------
1324
* ------> https://github.com/deneyapkart/deneyap-duman-dedektoru-arduino-library <------
14-
*
1525
*/
16-
1726
#define DOUTPIN D0 // Duman Dedektörü kartındaki DO pininin D0 pinine baglanmalıdır
1827
#define AOUTPIN A0 // Duman Dedektörü kartındaki AO pininin A0 pinine baglanmalıdır
1928

@@ -23,10 +32,12 @@ void setup() {
2332

2433
void loop() {
2534
bool DumanDurum = digitalRead(DOUTPIN); // Duman durumu okunması
26-
Serial.print("Duman Durumu: ");
27-
Serial.print(DumanDurum); // Duman durumu seri monitore yazdırılması
35+
if(DumanDurum == 0) {
36+
Serial.println("Duman Algılandı"); // Duman algılanınca çıkış ledi yanacaktır
37+
}
2838

2939
uint16_t DumanDeger = analogRead(AOUTPIN); // Duman degerinin okunması
30-
Serial.print("\tDuman Degeri: ");
31-
Serial.println(DumanDeger); // Duman verisi seri monitore yazdırılması
40+
Serial.print("Duman Degeri: ");
41+
Serial.println(DumanDeger); // Duman verisi seri port ekranına yazdırılması
42+
delay(10);
3243
}

‎library.properties‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name=Deneyap Duman Dedektoru
2-
version=1.0.0
3-
author=RFtek Electronics <[email protected]>
2+
version=1.0.1
3+
author=Turkish Technnology Team Foundation (T3)
44
maintainer=Turkish Technnology Team Foundation (T3)
55
sentence=Arduino library for Deneyap Gas Sensor
6-
paragraph=A simple and efficient library to use Deneyap Gas Sensor via I2C peripheral.
7-
category=...
6+
paragraph=A simple and efficient library to use Deneyap Gas Sensor MQ 2 via I2C peripheral.
7+
category=sensor
88
url=https://github.com/deneyapkart/deneyap-duman-dedektoru-arduino-library
99
architectures=*

‎src/Deneyap_DumanDedektoru.cpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
@file Deneyap_DumanDedektoru.cpp
44
@mainpage Deneyap Gas Sensor Arduino library source file
55
@maintainer RFtek Electronics <[email protected]>
6-
@version v1.0.0
7-
@date June 23, 2022
6+
@version v1.0.1
7+
@date November 08, 2022
88
@brief Includes functions to control Deneyap Gas Sensor
99
Arduino library
1010
@@ -94,7 +94,7 @@ bool SmokeDetector::setI2Caddress(uint8_t newAddress) {
9494
bool SmokeDetector::ReadSmokeDigital() {
9595
_dataPacket.command = (uint8_t)DIG_READ_SMOKE;
9696
_dataPacket.dataSize = 0;
97-
return I2C_ReadData8bit(&_dataPacket);
97+
return !I2C_ReadData8bit(&_dataPacket);
9898
}
9999

100100
/**

‎src/Deneyap_DumanDedektoru.h‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
*****************************************************************************
33
@file Deneyap_DumanDedektoru.h
44
@mainpage Deneyap Gas Sensor Arduino library header file
5-
@version v1.0.0
6-
@date June 23, 2022
5+
@version v1.0.1
6+
@date November 08, 2022
77
@brief This file contains all function prototypes and macros
88
for Deneyap Gas Sensor Arduino library
99
*****************************************************************************
1010
*/
1111

12-
#ifndef __SMOKEDETECTOR_H
13-
#define __SMOKEDETECTOR_H
12+
#ifndef __DENEYAPDUMANDEDEKTOR_H
13+
#define __DENEYAPDUMANDEDEKTOR_H
1414

1515
#include <Wire.h>
1616
#include <Arduino.h>
@@ -64,4 +64,4 @@ class SmokeDetector
6464
bool I2C_SendDataPacket(SmokeDetector_DataPacket_TypeDef *dataPacket);
6565
};
6666

67-
#endif /* __SMOKEDETECTOR_H */
67+
#endif /* __DENEYAPDUMANDEDEKTOR_H */

0 commit comments

Comments
 (0)