alex/GY-63_MS5611
1
0
Fork 0
mirror of https://github.com/RobTillaart/Arduino.git synced 2024-10-03 18:09:02 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

added readme.md file (no code change)

Browse Source
This commit is contained in:
RobTillaart 2017-07-26 11:54:09 +02:00
parent bc8c6b476d
commit 5012cec033
2 changed files with 55 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
libraries/DS18B20/DS18B20.h
View File

@ -6,20 +6,6 @@
//
// PUPROSE: library for DS18B20 temperature sensor with minimal footprint
//
// This library supports one single DS18B20 per pin only and no parasite mode.
// It is a minimalistic version of the Dallas Temperature Control Library of
// Miles Burton (kudo's to Miles for that great lib).
//
// As the DTC library is quite big to learn I rewrote it to this minimalistic
// version that allows the user to learn faster to do the most essential things.
// Effort has been taken to keep the code, variables and function names
// compatible with aforementioned library. This way people can step over to
// the DTC lib with relative few problems.
//
// This library only supports the asynch way of working in which one has to
// actively check for completion. This way people will learn how to work in
// a non-blocking way from the beginning.
//
#ifndef DS18B20_H
#define DS18B20_H

55
libraries/DS18B20/readme.md Normal file
View File

@ -0,0 +1,55 @@
# DS18B20 Library
## Arduino Temperature Control Library (ATCL)
This DS18B20 library is not a full featured library for the DS18B20 family.
If you need more functions or control over the DS18B20 family I refer to the library
of Miles Burton - https://github.com/milesburton/Arduino-Temperature-Control-Library
## Description
I'm a great fan of the above library however some time ago I needed to strip it down
to save a few dozen bytes. I reworked that minimalistic version into a library and I
added a number of Arduino examples to help you get started.
The DS18B20 library supports only the DS18B20, only one sensor per pin, no parasite
mode, no Fahrenheit and no alarm functions. The only feature the class supports is
the asynchrone reading of the temperature by means of three core functions:
* requestTemperatures()
* isConversionComplete()
* readTempC()
This allowed the class to be both minimal in size and non-blocking. In fact the class
has no support for a synchronuous read in one call. This choice will learn people
how to work in a non-blocking way from the start.
Effort has been taken to keep the code, variables and function names compatible with
ATCL library mentioned above. This way you can step over to that one with relative
few problems when you need more functionality like multiple sensors on one pin.
Finally this library will probably make it easier to use a DS18B20 with processing
boards or IC's with small memory footprint.
## Operation
This library supports only one DS18B20 per Arduino/ MCU pin.
Pin1 = Ground
Pin2 = Data
Pin3 = VCC
Connect a pull-up resistor 4.7 KOhm between pin3 and pin2. When the wires are longer
this resistor needs to be smaller.
## Credits
Miles Burton who originally developed the Arduino Temperature Control Library.
and all people who contributed to that lib.
## License
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.