Commit ede45c61 authored by Eric Fossum's avatar Eric Fossum

Add readme.md

parent 771ec4ea
# EMC1072
This EMC1072 library will control the EMC1072 dual temp. I2C integrated circuit.
Currently the library offers just a Linux I2C interface, but hopefully soon this
will support:
- Linux
- Particle/Arduino
- MBed
## Usage
Most commands return a success boolean which tells if the call was successful.
It is very important to check this on every call.
### Linux
Note: Don't forget to include the built library in your linker and header in
your source.
```c++
#include <iostream>
#include "emc1072.h"
Emc1072 temp_device("/dev/i2c-1");
char id;
if (temp_device.get_id(id)) {
std::cout << "Device ID: " << id << std::endl;
}
```
## Hardware
The EMC1072 chip can be purchased from any major retailer (i.e. Digikey, Mouser,
etc.). If you'd like a breakout board, I have a board schematic on
[OSHPark.com](https://oshpark.com/shared_projects/laEUdOmy).
They will make a board in about 2 weeks and you'll have to attach the chip
yourself. Note: you'll probably need pull-up resistors for the I2C bus as well
(like 5k, no more than 10k).
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment