Arduino-IRremote/README.md

36 lines
1.6 KiB
Markdown
Raw Normal View History

2015-05-15 06:32:48 +08:00
NOTE: THIS NEEDS TO BE FIXED.... PLEASE JUST USE THE LATEST RELEASE AND NOT THE MASTER BRANCH!!!!
2015-03-08 07:22:29 +08:00
# IRremote Arduino Library
2015-06-26 06:59:19 +08:00
[![Join the chat at https://gitter.im/shirriff/Arduino-IRremote](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shirriff/Arduino-IRremote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2015-03-10 08:54:25 +08:00
This library enables you to send and receive using infra-red signals on an arduino.
Check [here](http://shirriff.github.io/Arduino-IRremote/) for tutorials and more information.
2015-03-08 07:22:29 +08:00
## Version - 1.00
## Installation
1. Navigate to the [Releases](https://github.com/shirriff/Arduino-IRremote/releases) page.
2. Download the latest release.
3. Extract the zip file
4. Move the "IRremote" folder that has been extracted to your libraries directory.
2015-03-08 07:22:29 +08:00
2015-03-16 10:41:46 +08:00
## Usage
We get a lot of support for different device types. To keep the size of the library manageable we're moving to a model where different device types use a #define statement, for instance:
```#define SHARP```
You'd put this at the top of your sketch to include the sendSharp() and decodeSharp() methods in your code. This way your sketch only uses the Sharp functions but not the LG, JVC, Sony, etc functions, thus saving you program space that you might want to use for other things. This allows us to support lots of devices without making the library too big.
2015-03-08 07:22:29 +08:00
## Contributing
If you want to contribute to this project:
- Report bugs and errors
- Ask for enhancements
- Create issues and pull requests
- Tell other people about this library
2015-03-09 06:03:41 +08:00
## Contributors
2015-03-09 09:42:47 +08:00
Check [here](Contributors.md)
2015-03-09 06:03:41 +08:00
2015-03-08 07:22:29 +08:00
## Copyright
Copyright 2009-2012 Ken Shirriff