BlueMicro_Builder

Initializes and Builds your own BlueMicro_BLE firmware.

First Time: Initializating the firmware

  • Create your own repository using the “Use this template” button above.
  • Make sure that github actions is enabled
    • Go to settings (of your fork),
    • Go down to the “Actions” section,
    • Select “Allow all actions”
  • Edit one of the workflow files (located in .github\workflows) and edit the following entries (you can do this in the GitHub file editor):
    • keyboard: [‘4x4Tutorials’]
    • keymap: [‘base’]
    • keyboard_config: [‘single’]
    • hardware_config: [‘4x4Backpack’]
    • compile_with: [‘4x4macropad_nrf52832’]
  • Go to “Actions” at the top of your repo
  • Select the workflow you just edited, you should see a “Run Workflow” menu to the right
  • Trigger Workflow. This will run a GitHub Action to copy the necessary files from the BlueMicro_BLE firmware and copy over the keyboard and configuration files you have selected above.
  • Once the action has completed, go back to the top of your repository, you should now see a folder that contains all the files you need to compile your own firmware.
  • For nRF52832 boards, you will need to download the firmware to your computer, compile and flash it using the Arcuino IDE or Arduino CLI. To do so, you can clone the repository or download it in a zip file.
  • For nRF52840 boards, an artifact was created with the action which will contain the UF2 file you can upload to your nRF52840 board. Download the artifact zip file, uncompress and upload the UF2 file to yourboard.

Next Time: Re-build your firmware

  • Go to “Actions” at the top of your repo
  • Select the workflow you want to run and build, you should see a “Run Workflow” menu to the right.
  • Trigger Workflow. This will run a GitHub Action. If the firmware folder already exist, the workflow will skip the initialization steps and will go directly to compiling and building your firmware.
  • For nRF52840 boards, an artifact was created with the action which will contain the UF2 file you can upload to your nRF52840 board. Download the artifact zip file, uncompress and upload the UF2 file to yourboard.

GitHub

View Github