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

Improved dev setup docs. #4

Merged
merged 13 commits into from
Jun 11, 2020
Merged

Conversation

petejohanson
Copy link
Contributor

Make the setup docs actually useful!

@petejohanson petejohanson added the documentation Improvements or additions to documentation label Jun 9, 2020
@petejohanson petejohanson self-assigned this Jun 9, 2020
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Show resolved Hide resolved
@petejohanson
Copy link
Contributor Author

Will probably want to review https://docs.zephyrproject.org/latest/getting_started/index.html#get-zephyr-and-install-python-dependencies and see what else is missing... At a minimum, seems udev rules and maybe different install path for the SDK ARM stuff.

docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Show resolved Hide resolved
docs/docs/dev-setup.md Show resolved Hide resolved
docs/docs/dev-setup.md Show resolved Hide resolved
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Outdated Show resolved Hide resolved
docs/docs/dev-setup.md Show resolved Hide resolved
@petejohanson petejohanson merged commit b83b8c6 into master Jun 11, 2020
@innovaker innovaker deleted the docs/better-dev-setup-instructions branch September 23, 2020 14:53
petejohanson pushed a commit that referenced this pull request Oct 12, 2020
MangoIV referenced this pull request in MangoIV/zmk Dec 18, 2020
MangoIV referenced this pull request in MangoIV/zmk Dec 18, 2020
@Retic1337 Retic1337 mentioned this pull request Jan 4, 2021
petejohanson referenced this pull request in petejohanson/zmk Jan 24, 2021
petejohanson referenced this pull request in petejohanson/zmk Jan 25, 2021
petejohanson referenced this pull request in petejohanson/zmk Jan 25, 2021
petejohanson referenced this pull request in petejohanson/zmk Jan 26, 2021
petejohanson referenced this pull request in petejohanson/zmk Jan 28, 2021
petejohanson referenced this pull request in petejohanson/zmk Jan 28, 2021
petejohanson referenced this pull request in petejohanson/zmk Jan 28, 2021
petejohanson referenced this pull request in petejohanson/zmk Jan 28, 2021
petejohanson added a commit that referenced this pull request Jan 28, 2021
tyalie pushed a commit to tyalie/zmk that referenced this pull request Nov 15, 2022
tyalie pushed a commit to tyalie/zmk that referenced this pull request Nov 15, 2022
laserscout added a commit to laserscout/zmk that referenced this pull request Jan 24, 2023
AakashDabas added a commit to AakashDabas/zmk that referenced this pull request Jul 2, 2023
AakashDabas added a commit to AakashDabas/zmk that referenced this pull request Jul 2, 2023
AakashDabas added a commit to AakashDabas/zmk that referenced this pull request Jul 2, 2023
AakashDabas added a commit to AakashDabas/zmk that referenced this pull request Jul 2, 2023
AakashDabas added a commit to AakashDabas/zmk that referenced this pull request Jul 2, 2023
AakashDabas added a commit to AakashDabas/zmk that referenced this pull request Jul 3, 2023
AakashDabas added a commit to AakashDabas/zmk that referenced this pull request Jul 3, 2023
Nauticus pushed a commit to Nauticus/zmk that referenced this pull request Jul 28, 2023
arabshapt pushed a commit to arabshapt/zmk that referenced this pull request Aug 12, 2023
arabshapt pushed a commit to arabshapt/zmk that referenced this pull request Aug 12, 2023
commit 93bf512
Author: David Dreschner <34408442+DerDreschner@users.noreply.github.com>
Date:   Mon Jul 31 11:37:10 2023 +0200

    Fix broken CI builds on Zephyr 3.2 (zmkfirmware#6)

    * fix(backlight/tests): Restore original behaviour to fix backlight tests

    * fix(build): Remove feature-specific code when SPLIT_BLE, RGB_UNDERGLOW or BACKLIGHT isn't enabled

    * refactor(bluetooth): Add battery reporting config.

    * Add dedicated battery reporting Kconfig that is `imply`d by
      enabling ZMK_BLE.

    * fix(rgb_underglow): Use correct condition in service.c

    * Revert "refactor(bluetooth): Add battery reporting config."

    This reverts commit 881da25.

    ---------

    Co-authored-by: Peter Johanson <peter@peterjohanson.com>

commit 4b5ecbc
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 19:48:01 2023 +0100

    Fix(leds): Update indicators code

commit 7f0f495
Author: Joel Spadin <joelspadin@gmail.com>
Date:   Sun May 14 11:55:21 2023 -0500

    refactor: Split endpoint to transport and instance

    Changed the endpoints code to rename the existing endpoint types to
    "endpoint transport" and add the concept of "endpoint instances". A
    transport is the method by which data is sent, while instances allow
    describing multiple endpoints that use the same transport (e.g.
    bluetooth profiles).

    Also added new APIs to get the total number of possible endpoint
    instances and assign each instance a unique index, which can be used
    for tracking separate state for each endpoint in other code files.

commit 04443ca
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    feat: handle LED indicators report

commit d73bd1c
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 11:32:54 2023 +0100

    refactor(ble): Match new kconfigs

commit 2797cc9
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 11:27:06 2023 +0100

    refactor(battery): disable BLE battery reporting

    Disable battery reporting, stops spurious wakeups on Macs

commit 1b6af51
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 10:42:57 2023 +0100

    fix(formatting): whitespace

commit 1660750
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 10:40:24 2023 +0100

    refactor(ble): Match new kconfigs

commit 493537a
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 10:05:28 2023 +0100

    fix(zephyr): update new includes

commit 5b396a5
Merge: 69cfa35 b276a3b
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 10:04:56 2023 +0100

    Merge branch 'main' into adv360-z3.2

commit 69cfa35
Merge: 715f44e 0239f18
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Apr 28 15:42:12 2023 +0100

    Merge branch 'main' into adv360-z3.2

commit 715f44e
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Apr 28 15:39:57 2023 +0100

    fix(formatting) fix pre-commit formatting

commit dea3e81
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Thu Apr 27 09:58:18 2023 +0100

    fix(underglow): fix RGB startup

commit 566212b
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Feb 24 15:21:02 2023 +0000

    Fix profile 5 behaviour

commit af1137e
Merge: 1dcda2f a82a0ec
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Thu Jan 12 16:05:48 2023 +0000

    Merge branch 'main' into adv360-z3

commit 1dcda2f
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Thu Jan 12 16:05:41 2023 +0000

    chore(bluetooth): Fix clang formatting

commit 479a6d5
Author: Frank Blanning <laserscout@gmail.com>
Date:   Thu Jan 12 17:35:43 2023 +0200

    remove undeclared struct warning (zmkfirmware#4)

commit 20782cd
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Nov 25 12:17:07 2022 +0000

    fix(bluetooth): Fix ble lights reporting

commit 2e8904e
Author: ReFil <harryherring@gmail.com>
Date:   Tue Oct 11 13:34:33 2022 +0100

    feat(split): filter known devices on scan

commit ef1ee7e
Merge: 7b559b5 c9eb631
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Wed Oct 19 15:02:01 2022 +0100

    Merge remote-tracking branch 'upstream/main' into adv360-z3

commit 7b559b5
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Sat Oct 15 14:56:02 2022 +0100

    fix(lighting): fix initial power on lighting

commit b3322a5
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Oct 7 21:42:02 2022 +0100

    Change default settings

    Dim brightness of LEDS for improved battery life, Decrease settings save timeout to 29.5 seconds so it occurs before idle timeout

commit a981282
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Sep 30 13:00:47 2022 +0100

    Battery life improvements

commit 10b605e
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue Sep 13 12:15:50 2022 +0100

    feat(lighting): Kinesis lighting functionality

    moved peripheral updating from behaviour bnased to dedicated bluetooth services, added custom lighting effects to the adv360

commit 9031dd9
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    docs: add LED indicators documentation

commit 42cb057
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    feat: LED indicators displaying

commit aa62fd3
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    feat: handle LED indicators report
arabshapt pushed a commit to arabshapt/zmk that referenced this pull request Aug 13, 2023
commit 93bf512
Author: David Dreschner <34408442+DerDreschner@users.noreply.github.com>
Date:   Mon Jul 31 11:37:10 2023 +0200

    Fix broken CI builds on Zephyr 3.2 (zmkfirmware#6)

    * fix(backlight/tests): Restore original behaviour to fix backlight tests

    * fix(build): Remove feature-specific code when SPLIT_BLE, RGB_UNDERGLOW or BACKLIGHT isn't enabled

    * refactor(bluetooth): Add battery reporting config.

    * Add dedicated battery reporting Kconfig that is `imply`d by
      enabling ZMK_BLE.

    * fix(rgb_underglow): Use correct condition in service.c

    * Revert "refactor(bluetooth): Add battery reporting config."

    This reverts commit 881da25.

    ---------

    Co-authored-by: Peter Johanson <peter@peterjohanson.com>

commit 4b5ecbc
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 19:48:01 2023 +0100

    Fix(leds): Update indicators code

commit 7f0f495
Author: Joel Spadin <joelspadin@gmail.com>
Date:   Sun May 14 11:55:21 2023 -0500

    refactor: Split endpoint to transport and instance

    Changed the endpoints code to rename the existing endpoint types to
    "endpoint transport" and add the concept of "endpoint instances". A
    transport is the method by which data is sent, while instances allow
    describing multiple endpoints that use the same transport (e.g.
    bluetooth profiles).

    Also added new APIs to get the total number of possible endpoint
    instances and assign each instance a unique index, which can be used
    for tracking separate state for each endpoint in other code files.

commit 04443ca
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    feat: handle LED indicators report

commit d73bd1c
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 11:32:54 2023 +0100

    refactor(ble): Match new kconfigs

commit 2797cc9
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 11:27:06 2023 +0100

    refactor(battery): disable BLE battery reporting

    Disable battery reporting, stops spurious wakeups on Macs

commit 1b6af51
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 10:42:57 2023 +0100

    fix(formatting): whitespace

commit 1660750
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 10:40:24 2023 +0100

    refactor(ble): Match new kconfigs

commit 493537a
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 10:05:28 2023 +0100

    fix(zephyr): update new includes

commit 5b396a5
Merge: 69cfa35 b276a3b
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue May 30 10:04:56 2023 +0100

    Merge branch 'main' into adv360-z3.2

commit 69cfa35
Merge: 715f44e 0239f18
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Apr 28 15:42:12 2023 +0100

    Merge branch 'main' into adv360-z3.2

commit 715f44e
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Apr 28 15:39:57 2023 +0100

    fix(formatting) fix pre-commit formatting

commit dea3e81
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Thu Apr 27 09:58:18 2023 +0100

    fix(underglow): fix RGB startup

commit 566212b
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Feb 24 15:21:02 2023 +0000

    Fix profile 5 behaviour

commit af1137e
Merge: 1dcda2f a82a0ec
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Thu Jan 12 16:05:48 2023 +0000

    Merge branch 'main' into adv360-z3

commit 1dcda2f
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Thu Jan 12 16:05:41 2023 +0000

    chore(bluetooth): Fix clang formatting

commit 479a6d5
Author: Frank Blanning <laserscout@gmail.com>
Date:   Thu Jan 12 17:35:43 2023 +0200

    remove undeclared struct warning (zmkfirmware#4)

commit 20782cd
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Nov 25 12:17:07 2022 +0000

    fix(bluetooth): Fix ble lights reporting

commit 2e8904e
Author: ReFil <harryherring@gmail.com>
Date:   Tue Oct 11 13:34:33 2022 +0100

    feat(split): filter known devices on scan

commit ef1ee7e
Merge: 7b559b5 c9eb631
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Wed Oct 19 15:02:01 2022 +0100

    Merge remote-tracking branch 'upstream/main' into adv360-z3

commit 7b559b5
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Sat Oct 15 14:56:02 2022 +0100

    fix(lighting): fix initial power on lighting

commit b3322a5
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Oct 7 21:42:02 2022 +0100

    Change default settings

    Dim brightness of LEDS for improved battery life, Decrease settings save timeout to 29.5 seconds so it occurs before idle timeout

commit a981282
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Sep 30 13:00:47 2022 +0100

    Battery life improvements

commit 10b605e
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue Sep 13 12:15:50 2022 +0100

    feat(lighting): Kinesis lighting functionality

    moved peripheral updating from behaviour bnased to dedicated bluetooth services, added custom lighting effects to the adv360

commit 9031dd9
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    docs: add LED indicators documentation

commit 42cb057
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    feat: LED indicators displaying

commit aa62fd3
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    feat: handle LED indicators report
arabshapt pushed a commit to arabshapt/zmk that referenced this pull request Dec 2, 2023
commit 8acbcd7
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Wed Nov 15 10:00:08 2023 +0000

    fix(ble): Fix race condition causing lockup

commit 0e7bcc3
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue Nov 7 10:11:59 2023 +0000

    Make Extended NKRO configurable

commit 8aba149
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Wed Nov 1 10:33:35 2023 +0000

    Increase behaviour queue size

commit 7dd98d7
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Wed Nov 1 10:32:43 2023 +0000

    Fix loading from flash

commit a32c67f
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Fri Oct 27 15:21:22 2023 +0100

    Change max NKRO usage

commit 1922d5f
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Sun Oct 22 22:07:21 2023 +0100

    Revert "fix(hid): Change max keyboard usage"

    This reverts commit 169aa90.

commit 169aa90
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Sat Oct 21 21:50:33 2023 +0100

    fix(hid): Change max keyboard usage

    This should now support F13-F24 and INTL keys with NKRO disabled

commit 3bc86af
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Wed Oct 18 09:10:46 2023 +0100

    feat(ble): Allow disabling BLE BAS reporting

    The battery reporting has been known to cause macOS computers to wakeup repeatedly. In some cases (e.g. display or custom lighting implementation) one might want to collect battery SOC without broadcasting over BLE

commit 00483fe
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Wed Oct 18 10:26:00 2023 +0100

    feat(underglow): Disable saving underglow state

    Half the flash saving functions are unnecessary and the other half are overridden anyway. This will save on flash wear

commit b508919
Author: David Dreschner <34408442+DerDreschner@users.noreply.github.com>
Date:   Mon Jul 31 11:37:10 2023 +0200

    Fix broken CI builds on Zephyr 3.2 (zmkfirmware#6)

    * fix(backlight/tests): Restore original behaviour to fix backlight tests

    * fix(build): Remove feature-specific code when SPLIT_BLE, RGB_UNDERGLOW or BACKLIGHT isn't enabled

    * refactor(bluetooth): Add battery reporting config.

    * Add dedicated battery reporting Kconfig that is `imply`d by
      enabling ZMK_BLE.

    * fix(rgb_underglow): Use correct condition in service.c

    * Revert "refactor(bluetooth): Add battery reporting config."

    This reverts commit 881da25.

    ---------

    Co-authored-by: Peter Johanson <peter@peterjohanson.com>

commit aa9ced1
Author: Frank Blanning <laserscout@gmail.com>
Date:   Thu Jan 12 17:35:43 2023 +0200

    remove undeclared struct warning (zmkfirmware#4)

commit fccbe80
Author: ReFil <31960031+ReFil@users.noreply.github.com>
Date:   Tue Sep 13 12:15:50 2022 +0100

    feat(lighting): Kinesis lighting functionality

    feat(lighting): Kinesis lighting functionality

    moved peripheral updating from behaviour bnased to dedicated bluetooth services, added custom lighting effects to the adv360

    Battery life improvements

    Change default settings

    Dim brightness of LEDS for improved battery life, Decrease settings save timeout to 29.5 seconds so it occurs before idle timeout

    fix(lighting): fix initial power on lighting

    Fix profile 5 behaviour

    fix(underglow): fix RGB startup

    fix(zephyr): update new includes

    refactor(ble): Match new kconfigs

    refactor(ble): Match new kconfigs

    Update Kconfig

commit 1ab6f51
Author: Alessandro Bortolin <bortolin.alessandro@outlook.it>
Date:   Tue Sep 6 12:29:07 2022 +0000

    feat: handle LED indicators report

commit ffecfd9
Author: Joel Spadin <joelspadin@gmail.com>
Date:   Sun May 14 11:55:21 2023 -0500

    refactor: Split endpoint to transport and instance

    Changed the endpoints code to rename the existing endpoint types to
    "transport" and add the concept of "endpoint instances". A transport is
    the method by which data is sent, while instances allow describing
    multiple endpoints that use the same transport (e.g. bluetooth profiles)

    Also added new APIs to get the total number of possible endpoint
    instances and assign each instance a unique index, which can be used
    for tracking separate state for each endpoint in other code files.
pijanowskim referenced this pull request in pijanowskim/zmk Feb 14, 2024
zchee pushed a commit to zchee/zmk that referenced this pull request Apr 17, 2024
zchee pushed a commit to zchee/zmk that referenced this pull request Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants