Skip to content

Commit fa541fe

Browse files
ArndArnd
Arnd
authored and
Arnd
committed
Moved repository from "SV-Zanshin" to "Zanduino"
Changed references to URL
1 parent a5996da commit fa541fe

File tree

9 files changed

+51
-469
lines changed

9 files changed

+51
-469
lines changed

.clang-format

-156
This file was deleted.

.gitattributes

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
# the "Arduino" language was chosen, but that is no longer considered #
55
# a language so everything has been reverted to "c++" #
66
# #
7-
# Date Author Comments #
8-
# ========== ============================= =========================== #
9-
# 2018-06-24 https://github.com/SV-Zanshin Changed file #
7+
# Date Author Comments #
8+
# ========== ========== ============================================== #
9+
# 2018-06-24 SV-Zanshin Changed file #
1010
# #
1111
########################################################################
1212
examples/ linguist-documentation=false

.github/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22

33
# RotaryEncoder<br>
44

5-
<img src="https://github.com/SV-Zanshin/RotaryEncoder/blob/master/Images/RotaryEncoder.jpg" width="175" align="right"/> *Arduino* library which defines methods for accessing the 3-Color LED Rotary Encoder. This is manufactured by Top-Up and other companies and is available from many sources on the internet. The manufacturer's serial number is EC12PSD-017 and it can be found referenced at sources such as
6-
https://www.sparkfun.com/products/10982 or https://www.proto-pic.co.uk/rotary-encoder-illuminated-rgb.html along with numerous other
5+
<img src="https://github.com/Zanduino/RotaryEncoder/blob/master/Images/RotaryEncoder.jpg" width="175" align="right"/> *Arduino* library which defines methods for accessing the 3-Color LED Rotary Encoder. This is manufactured by Top-Up and other companies and is available from many sources on the internet. The manufacturer's serial number is EC12PSD-017 and it can be found referenced at sources such as
6+
https://www.sparkfun.com/products/10982 or https://www.proto-pic.co.uk/rotary-encoder-illuminated-rgb.html along with numerous other
77
places on eBay or Amazon. The encoder sends out rotational information on 2 pins using a quadrature system and also has a pushbutton.
88

99
While I've seen a couple of libraries that will work for this encoder, I wanted to use this in a project and opted to create a specific
10-
library for it. It not only supports setting colors for the clockwise, counterclockwise and pushbutton along with a pleasing fade; but
10+
library for it. It not only supports setting colors for the clockwise, counter clockwise and pushbutton along with a pleasing fade; but
1111
is also designed to work with Atmel's/Arduino's interrupts so that any program using this class can process normally and only query the
12-
pushbutton state and the current rotational value when it needs to. Using interrupts limits the class to those pins which support
12+
pushbutton state and the current rotational value when it needs to. Using interrupts limits the class to those pins which support
1313
hardware interrupt, but that limitation is offset by the efficiency with which the class works.
1414

15-
The hardware interrupt pins vary from one Atmel processor to another and need to be checked; the example programs for this class use
15+
The hardware interrupt pins vary from one Atmel processor to another and need to be checked; the example programs for this class use
1616
those pins available for the Arduino Micro (ATmega32U4). Newer processors impose less restrictions on which pins support hardware interrupts.
1717

1818
Likewise the 3 pins used for the Red, Green and Blue LED lights need to be PWM-capable pins, which vary from processor to processor. The
19-
rotary encoder uses a common cathode (+) pin, so the 3 lights are driven to ground for full power and high for "OFF"; meaning an analog
19+
rotary encoder uses a common cathode (+) pin, so the 3 lights are driven to ground for full power and high for "OFF"; meaning an analog
2020
write of "255" turns the respective LED off and an analog write of "0" turns it on at full power.
2121

22-
Fading of the colored encoder LEDs is done by using the timer0, which is used by the Arduino millis() function and fires approximately every millisecond.
22+
Fading of the colored encoder LEDs is done by using the timer0, which is used by the Arduino millis() function and fires approximately every millisecond.
2323

24-
See the [Wiki pages for details](https://github.com/SV-Zanshin/RotaryEncoder/wiki) of the class and the variables / functions accessible in it.
24+
See the [Wiki pages for details](https://github.com/Zanduino/RotaryEncoder/wiki) of the class and the variables / functions accessible in it.
2525

2626
[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)

.github/workflows/ci-doxygen.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ name: 'Doxygen'
1313
####################################################################################################
1414
## Action runs when committing (push), doing a pull request, or a workflow_dispatch ##
1515
####################################################################################################
16-
on:
16+
on:
1717
push:
1818
pull_request:
1919
workflow_dispatch:
@@ -37,7 +37,7 @@ jobs:
3737
##########################################################################################
3838
PRETTYNAME: "Rotary Encoder Library"
3939
PROJECT_NAME: "RotaryEncoder"
40-
PROJECT_NUMBER: "v1.0.3"
40+
PROJECT_NUMBER: "v1.0.6"
4141
PROJECT_BRIEF: "Arduino Library for reading a 3-LED Rotary Encoder"
42-
PROJECT_LOGO: ""
43-
run: bash ${GITHUB_WORKSPACE}/Common/Scripts/doxy_gen_and_deploy.sh
42+
PROJECT_LOGO: ""
43+
run: bash ${GITHUB_WORKSPACE}/Common/Scripts/doxy_gen_and_deploy.sh

.gitignore

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
########################################################################
2-
# This file defines which file types are to be ignroed and skipped by #
2+
# This file defines which file types are to be ignored and skipped by #
33
# git so that they are not transferred and committed. #
44
# #
5-
# Date Author Comments #
6-
# ========== ============================= =========================== #
7-
# 2019-01-24 https://github.com/SV-Zanshin Ignores for Doxygen #
8-
# 2018-09-22 https://github.com/SV-Zanshin Ignores for MS VS 2017 #
9-
# 2018-06-24 https://github.com/SV-Zanshin Changed file #
5+
# Date Author Comments #
6+
# ========== ========== =========================== #
7+
# 2020-12-11 SV-Zanshin Added ignores for Doxyfile and clang-format #
8+
# 2019-01-24 SV-Zanshin Ignores for Doxygen #
9+
# 2018-09-22 SV-Zanshin Ignores for MS VS 2017 #
10+
# 2018-06-24 SV-Zanshin Changed file #
1011
# #
1112
########################################################################
1213

@@ -93,3 +94,9 @@ Release
9394
# Files and directories from Doxygen #
9495
########################################################################
9596
html
97+
Doxyfile
98+
99+
########################################################################
100+
# Clang-format files #
101+
########################################################################
102+
.clang-format

0 commit comments

Comments
 (0)