Skip to content

Commit 97bac67

Browse files
committed
doc: Add README to explain the project
In order to explain the project, a README is added.
1 parent 88e1d11 commit 97bac67

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# I2C Temperature Sensor (LM75A) Library for Arduino
2+
3+
## What is it?
4+
5+
This library (with example) is designed to be integrated in projects using LM75A sensors to get temperature.
6+
7+
<img src="device.png" width="300">
8+
9+
10+
## How to install
11+
12+
1) Download <a target="_blank" href="https://github.com/QuentinCG/Arduino-LM75A-Temperature-Sensor-Library/releases/download/1.0.0/LM75A_v1_0_0.zip">latest release</a>
13+
14+
2) On your Arduino IDE, click "Sketch" menu and then "Include Library > Add .ZIP Libraries"
15+
16+
3) You can now use the library for your project or launch an example ("File > Examples")
17+
18+
19+
## How to connect the sensor to your Arduino
20+
21+
LM75A sensor | Arduino
22+
-------- | --------
23+
VCC | 3.3V
24+
GND | GND
25+
SDA | A4 (SDA)
26+
SCL | A5 (SCL)
27+
A0 | GND (or VCC to increase I2C address of 1)
28+
A1 | GND (or VCC to increase I2C address of 2)
29+
A2 | GND (or VCC to increase I2C address of 4)
30+
OS | None
31+
32+
33+
<img src="schematics.png" width="400">
34+
35+
36+
## Examples
37+
38+
One example is provided with this library:
39+
40+
### Show temperature in degrees and fahrenheit every second
41+
42+
<a target="_blank" href="https://github.com/QuentinCG/Arduino-LM75A-Temperature-Sensor-Library/blob/master/LM75A/examples/LM75A_ShowTemperature/LM75A_ShowTemperature.ino">Link to source code</a>
43+
44+
45+
## License
46+
47+
This project is under MIT license. This means you can use it as you want (just don't delete the library header).
48+
49+
50+
## Contribute
51+
52+
If you want to add more examples or improve the library, just create a pull request with proper commit message and right wrapping.

0 commit comments

Comments
 (0)