Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup Satisfaction75 Firmware and add new revisions #22082

Merged
merged 29 commits into from
Feb 26, 2024

Conversation

awkannan
Copy link
Contributor

@awkannan awkannan commented Sep 20, 2023

Description

There are a few changes in this PR.
If necessary, I can break it up further - but I think the changes are generally pretty straightforward.

  • Changed Satisfaction75 to use core QMK backlight code instead of its own custom code
  • Added a new revision of Satisfaction75 PCB with fewer keys
  • Moved core Satisfaction75 code to a CannonKeys-specific library folder
  • Updated core Satisfaction75 code to be more resilient to disabled features (backlight, oled)
  • Added a new Satisfaction75 Hotswap PCB to QMK, relying on CannonKeys-specific library folder
  • Updated readmes, keymaps, and copyright notices as necessary to pair with these changes

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).

@github-actions github-actions bot added keyboard keymap via Adds via keymap and/or updates keyboard for via support labels Sep 20, 2023
@awkannan
Copy link
Contributor Author

awkannan commented Sep 20, 2023

Note: CI will likely fail due to user keymaps (and the new rev2 Sat75 PCB not having the layouts used in those keymaps)

Copy link
Member

@drashna drashna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be targeting develop due to the changes.

Otherwise, LGTM.

@awkannan awkannan changed the base branch from master to develop September 25, 2023 15:37
@awkannan
Copy link
Contributor Author

Retargeted to Develop. Thanks for review @drashna !

@drashna drashna requested a review from a team September 25, 2023 19:42
keyboards/cannonkeys/satisfaction75/rev2/readme.md Outdated Show resolved Hide resolved
void breathing_disable(void);
void custom_config_load(void);
void backlight_config_save(void);
#include "satisfaction_keycodes.h"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file can be deleted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is necessary in order to not have to import the keycodes in each keymap file. (See drashna's feedback above)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keyboards/cannonkeys/satisfaction75/readme.md Outdated Show resolved Hide resolved
Comment on lines +5 to -6
{"pin_a": "B9", "pin_b": "B8", "resolution": 2}
]
},
"matrix_pins": {
"cols": ["B1", "B2", "B10", "B11", "B12", "B13", "B14", "A8", "A9", "A10", "B0", "A7", "A5", "B5", "A15", "A1"],
"rows": ["B3", "B4", "A0", "A2", "A4", "A3"]
},
"usb": {
"device_version": "0.0.1",
"pid": "0x57F5"
},
"layouts": {
"LAYOUT_all": {
"layout": [
{"label": "K000", "matrix": [0, 0], "x": 0, "y": 0},

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep the spacing here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The info.json auto-formatter removes these - I think that should be the standard.

keyboards/cannonkeys/satisfaction75/config.h Outdated Show resolved Hide resolved
keyboards/cannonkeys/satisfaction75_hs/readme.md Outdated Show resolved Hide resolved
"layout": [
{"matrix": [0, 0], "x": 0, "y": 0},

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep the spacing here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The info.json auto-formatter removes these - I think that should be the standard.

Copy link

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 bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@github-actions github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Jan 14, 2024
@awkannan
Copy link
Contributor Author

Could I get the “awaiting review” tag added? I believe I’ve done as much as I can on the PR so far but I’m happy to address any further feedback

@zvecr zvecr added awaiting review and removed stale Issues or pull requests that have become inactive without resolution. labels Jan 17, 2024
@tzarc tzarc merged commit 4906413 into qmk:develop Feb 26, 2024
3 checks passed
dlip added a commit to dlip/qmk_firmware that referenced this pull request Mar 6, 2024
* upstream/master: (245 commits)
  Attempt to fix changed files on CI workflow (qmk#23205)
  Bump peter-evans/create-pull-request from 5 to 6 (qmk#22995)
  Iron180 V2 H: correct key sizes (qmk#23214)
  `mntre_v3`: correct layout data (qmk#23216)
  Iron180 V2 S: correct ANSI Enter key sizes (qmk#23215)
  Workaround for uart makefile issues (qmk#23192)
  Normalise .editorconfig. (qmk#23186)
  Remove cd suggestion from new-keyboard (qmk#23194)
  CLI Speed improvements. (qmk#23189)
  Fix up AVR production build target. (qmk#23190)
  Fixing typos for OSAv2 and OSAv2_Topre (qmk#23161)
  geistmaschine/geist: enable mousekey, fix issues in default/via keymap (qmk#23187)
  Merge point for 2024q1 Breaking Change
  2024q1 `develop` changelog. (qmk#23150)
  Update Atmel DFU driver assignments for dfu-programmer 1.x (qmk#23165)
  Merge upstream uf2conv.py changes (qmk#23163)
  Satisfaction75 post merge updates (qmk#23158)
  Ensmallification of `helix/rev3_5rows:via`. (qmk#23159)
  Cleanup Satisfaction75 Firmware and add new revisions (qmk#22082)
  cipulot/common: Fix for multiple AMUX usage (qmk#23155)
  ...
peepeetee pushed a commit to peepeetee/qmk_firmware that referenced this pull request Mar 12, 2024
nuess0r pushed a commit to nuess0r/qmk_firmware that referenced this pull request Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review keyboard keymap via Adds via keymap and/or updates keyboard for via support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants