Skip to content

Commit

Permalink
nice!oled support, dongle_display support, readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
mctechnology17 committed Dec 19, 2024
1 parent d029dfe commit 5167d96
Show file tree
Hide file tree
Showing 28 changed files with 135 additions and 1,955 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
Changelog file for Structures extra.
https://github.com/mctechnology17/zmk-config/blob/main/CHANGELOG.txt

# FEATURES 0.0.2-beta1 (Nov 08, 2024)
# FEATURES 0.0.2-beta1 (Dec 19, 2024)
=======================================
+ NEW FEATURES
- [x] nice!oled support
- [x] dongle_display as modul support
- [x] oled display changed 128x32 to 128x64 for xiao
- [x] readme updated

# FEATURES 0.0.1-beta1 (Aug 22, 2024)
=======================================
Expand Down
57 changes: 38 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,34 @@

----

If you already have your corne configured with this repository and want to make
- If you already have your corne configured with this repository and want to make
a modification to your keymap, you can do it with the online [ZMK-STUDIO](https://zmk.studio/).

If you already have your corne configured with this repository and want to make
- If you already have your corne configured with this repository and want to make
a modification to your keymap, you can do it with the online [keymap-editor](https://nickcoutsos.github.io/keymap-editor/).

- If you already have a repository and you want only the dongle option of this repository with support for `zmk-studio`, just add this repository as a module to your configuration, here is a basic example (just copy and paste into your file `west.yml`):

```yaml
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
# include corne with dongle pro_micro and xiao compatible
- name: mctechnology17
url-base: https://github.com/mctechnology17
projects:
- name: zmk
remote: zmkfirmware
revision: main
import: app/west.yml
# include corne with dongle pro_micro and xiao compatible
- name: zmk-config
remote: mctechnology17
revision: main
self:
path: config
```
# INTRO
Expand Down Expand Up @@ -111,7 +133,7 @@ peripherals), **[nice_nano_v2]** (used as a dongle and as peripherals),
> by default they are all activated.
### zmk-studio
### zmk-studio (quick start)
This repository includes the necessary configuration to use zmk-studio without
the need to configure anything else. You just have to follow the steps below:
- fork this repository y flash the firmware to the keyboard with the uf2 files (see as below en normal procedure)
Expand Down Expand Up @@ -166,16 +188,6 @@ documentation.
Example of an advanced configuration hier -> [^4]
Below is a list of features currently included in this branch[^5] _on top of_
the official ZMK master branch.

- **pointer movement/scrolling** - PR #2027
- **tri-state (aka swapper)** - PR [#1366](https://github.com/zmkfirmware/zmk/pull/1366)
- **smart-word** (PR [#1451](https://github.com/zmkfirmware/zmk/pull/1451))
- **on-release-for-tap-preferred** - [tweak](https://github.com/celejewski/zmk/commit/d7a8482712d87963e59b74238667346221199293) by Andrzej
- **zen-tweaks** - [display & battery improvements](https://github.com/caksoylar/zmk/tree/caksoylar/zen-v1%2Bv2) by Cem Aksoylar


1. Clone _your fork_ of this repository.
```bash
Expand Down Expand Up @@ -469,13 +481,13 @@ host OS, app/browser details, keyboard used, link to your config repo, etc.
# MODULE INTEGRATION
> [!TIP]
>
> 1. You can activate or deactivate the animation with: CONFIG_NICE_VIEW_GEM_ANIMATION=n
> the animation is not activated by default in this repository for saving
> battery. This is activated only in the peripheries and the corne master, not
> in the dongles, because this module shows the status of the batteries in the
> peripheries
> 1. Remember that animations consume energy, so if you want to conserve your battery, turn off the animations!
> 2. Please consult the documentation of each module that you are going to use, here I leave you the links for each one.
See module details here for more information and more configurations: [nice-view-gem](https://github.com/M165437/nice-view-gem)
See module details here for more information and more configurations:
- [nice_view_gem](https://github.com/M165437/nice-view-gem)
- [nice_oled](https://github.com/mctechnology17/zmk-nice-oled)
- [dongle_display](https://github.com/englmaxi/zmk-dongle-display)
# INSPIRATIONS
Expand All @@ -487,6 +499,13 @@ See module details here for more information and more configurations: [nice-view
- [urob/zmk-config](https://github.com/urob/zmk-config)
# MY OTHER PROJECTS:
- [nice!oled](https://github.com/mctechnology17/zmk-nice-oled): nice_oled
vertical widgets for oled screens with zmk (for split and non-split
keyboards)
- [dongle_display!view](https://github.com/mctechnology17/zmk-dongle-display-view): This is a mix between display_dongle and nice!view that allows you to use the nice!view display with your dongle.
- [oled_adapter](https://github.com/mctechnology17/zmk-oled-adapter): This
module is an adapter for 128x32, 128x64 and 128x128 OLED screens, to be used
on keyboards with ZMK without having to modify the shields of the keyboards.
- [qmk-config] will be updated soon
- [qmk_userspace] will be updated soon
- [vimtools] swiss army knife for vim (features and settings that will make your life easier)
Expand Down
14 changes: 8 additions & 6 deletions boards/shields/corne/corne_dongle_xiao.overlay
Original file line number Diff line number Diff line change
Expand Up @@ -79,22 +79,24 @@ RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5) RC(2,6) RC(2,7) RC(2,8) RC(2,9) RC(2,10
// TODO: per-key RGB node(s)?
};

// 128x64 OLED
&xiao_i2c {
status = "okay";
oled: sh1106@3c {
compatible = "sinowealth,sh1106";

oled: ssd1306@3c {
compatible = "solomon,ssd1306fb";
reg = <0x3c>;
width = <120>;
height = <128>;
width = <128>;
height = <64>;
segment-offset = <0>;
page-offset = <0>;
display-offset = <0>;
multiplex-ratio = <119>;
multiplex-ratio = <63>;
segment-remap;
com-invdir;
inversion-on;
prechargep = <0x22>;
};
};
};

/*
Expand Down
18 changes: 0 additions & 18 deletions boards/shields/dongle_display/CMakeLists.txt

This file was deleted.

41 changes: 0 additions & 41 deletions boards/shields/dongle_display/Kconfig.defconfig

This file was deleted.

5 changes: 0 additions & 5 deletions boards/shields/dongle_display/Kconfig.shield

This file was deleted.

63 changes: 0 additions & 63 deletions boards/shields/dongle_display/custom_status_screen.c

This file was deleted.

12 changes: 0 additions & 12 deletions boards/shields/dongle_display/custom_status_screen.h

This file was deleted.

17 changes: 0 additions & 17 deletions boards/shields/dongle_display/dongle_display.conf

This file was deleted.

5 changes: 0 additions & 5 deletions boards/shields/dongle_display/dongle_display.overlay

This file was deleted.

7 changes: 0 additions & 7 deletions boards/shields/dongle_display/dongle_display.zmk.yml

This file was deleted.

Loading

0 comments on commit 5167d96

Please sign in to comment.