Add option to set the encoder A and B pins on the MCU to use internal pull-down, pull-up, or leave floating

[Croktopus]

Description

Added 3 toggles: ENC_PUP, ENC_PDOWN, and ENC_FLOAT. When ENC_PUP is defined, it sets the internal resistor on the encoder pins to be pulled up, and the same sort of behavior for the others. If none of these are defined, then it defaults to the current behavior of having the internal pull-up.

My optical encoder needs a pull down on these pins to work right, and the values also need to be finely tuned which might be possible even with an internal pull-up, but it's way easier if I can just set the pin to be floating.

I'm not much of a coder, so while I did test it and it works on my hardware, it looks super inelegant and I'm sure theres like a billion ways to optimize the code. I'm also not married to the names of those toggle things.

I also tried my hand at putting in some documentation based on existing docs.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Issues Fixed or Closed by This PR

Checklist

• My code follows the code style of this project: C, Python
• I have read the PR Checklist document and have made the appropriate changes.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

[drashna]

It would be better to have something like ENCODER_PIN_CFG and have that set to the different types.

Much like the col2row stuff. This way, we can check to see if it's defined or not, and default to pullup.

However, ENCODER_PIN_CFG is probably a horrible name, and something better should be used.

[drashna]

Also, ideally, this should probably be targeting develop.

[Croktopus]

alright so i basically combined your suggestions and it looks much cleaner now, thank you both. how can i redirect it to develop, or should i close this and open a new one?

[Croktopus]

alright so i basically combined your suggestions and it looks much cleaner now, thank you both. how can i redirect it to develop, or should i close this and open a new one?

Ok slight problem it doesnt work now lol. getting on discord

[drashna]

To redirect it to develop, edit the title. That should let you choose what branch to target.

[zvecr]

clang-format

Suggested change

	for (int i = 0; i < NUMBER_OF_ENCODERS; i++) {
	setEncPinInput(encoders_pad_a[i]);
	setEncPinInput(encoders_pad_b[i]);
	encoder_state[i] = (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1);
	}
	for (int i = 0; i < NUMBER_OF_ENCODERS; i++) {
	setEncPinInput(encoders_pad_a[i]);
	setEncPinInput(encoders_pad_b[i]);
	encoder_state[i] = (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1);
	}

[zvecr]

Naming things is difficult, however i'm cautious of too much crossover to existing setting, eg BACKLIGHT_PINS. While docs exists, it leads to questions like "why doesn't #define ENCODER_PINS {A1, B2} work?"

I cant find an existing setting to align to, but the closest thing that come to mind would be ENCODER_PIN_MODE, maybe ENCODER_PAD_MODE.

[tzarc]

Sorry about that, GitHub decided to delete the develop branch from upstream when we merged it, despite being told otherwise. Reopened.

[stale]

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

[stale]

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

[stale]

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.