diff --git a/LICENSE.TXT b/LICENSE.TXT new file mode 100644 index 0000000..c5d26b9 --- /dev/null +++ b/LICENSE.TXT @@ -0,0 +1,22 @@ +Copyright (c) 2021 Mats van Reenen + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a6dd37 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Rotory Encoder for arduino + +Description comming soon. + +## Licence + +This software is licened under the MIT licence + +Copyright (c) 2021 Mats van Reenen + +## Pinout + +### Arduino Uno + +| pin | goes to | +|----:|---------------------| +| 2 | light gate 0 | +| 3 | light gate 1 | +| 10 | home switch | +| 11 | analog out (filter) | + +The analog out is a PWM signal of 31 kHz it you add a low pass filter 1 kΩ en 1 nF. \ No newline at end of file diff --git a/rotoryEncoder.ino b/rotoryEncoder.ino index f547322..659da03 100644 --- a/rotoryEncoder.ino +++ b/rotoryEncoder.ino @@ -1,3 +1,9 @@ +/** Rotory Encoder + * + * @author: Mats van Reenen + * @license: MIT + */ + #define SENS0_PIN 2 #define SENS1_PIN 3 #define ANALOGOUT_PIN 11