Arduino-IRremote/README.md

51 lines
2.1 KiB
Markdown
Raw Normal View History

2015-03-08 07:22:29 +08:00
# IRremote Arduino Library
2015-06-26 06:59:19 +08:00
2016-02-21 13:47:27 +08:00
[![Build Status](https://travis-ci.org/z3t0/Arduino-IRremote.svg?branch=dev)](https://travis-ci.org/z3t0/Arduino-IRremote)
2015-08-11 04:41:13 +08:00
[![Join the chat at https://gitter.im/z3t0/Arduino-IRremote](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/z3t0/Arduino-IRremote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2015-07-12 05:43:18 +08:00
2015-07-30 14:01:37 +08:00
This library enables you to send and receive using infra-red signals on an Arduino.
2015-03-10 08:54:25 +08:00
2015-08-11 04:41:13 +08:00
Check [here](http://z3t0.github.io/Arduino-IRremote/) for tutorials and more information.
2015-03-08 07:22:29 +08:00
2016-02-21 13:46:02 +08:00
## Version - 2.1.0
2015-03-08 07:22:29 +08:00
## Installation
2015-08-11 04:41:13 +08:00
1. Navigate to the [Releases](https://github.com/z3t0/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-09-09 16:47:28 +08:00
5. Make sure to delete Arduino_Root/libraries/RobotIRremote. Where Arduino_Root refers to the install directory of Arduino. The library RobotIRremote has similar definitions to IRremote and causes errors.
2015-03-08 07:22:29 +08:00
## Supported Boards
- Arduino Uno / Mega / Leonardo / Duemilanove / Diecimila / LilyPad / Mini / Fio / Nano etc.
- Teensy 1.0 / 1.0++ / 2.0 / 2++ / 3.0 / 3.1 / Teensy-LC; Credits: @PaulStoffregen (Teensy Team)
- Sanguino
- Atmega8
- ATtiny 84 / 85
We are open to suggestions for adding support to new boards, however we highly recommend you contact your supplier first and ask them to provide support from their side.
2015-03-16 10:41:46 +08:00
## Usage
2015-07-12 05:43:18 +08:00
- TODO (Check examples for now)
2015-03-16 10:41:46 +08:00
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-07-17 09:47:11 +08:00
- Contribute new protocols
2015-09-29 10:45:55 +08:00
2016-02-21 14:13:00 +08:00
Check [here](Contributing.md) for some guidelines.
2015-09-29 10:45:55 +08:00
## Contact
The only way to contact me at the moment is by email: zetoslab@gmail.com
I am not currently monitoring any PRs or Issues due to other issues but will respond to all emails. If anyone wants contributor access, feel free to email me. Or if you find any Issues/PRs to be of importance that my attention is needed please email me.
2015-03-08 07:22:29 +08:00
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