{"id":19096240,"url":"https://github.com/cobular/keyclicky-embedded","last_synced_at":"2026-05-26T16:30:18.673Z","repository":{"id":119391382,"uuid":"515371429","full_name":"Cobular/keyclicky-embedded","owner":"Cobular","description":null,"archived":false,"fork":false,"pushed_at":"2022-07-19T01:56:26.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-03T00:17:18.091Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cobular.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-18T23:29:55.000Z","updated_at":"2022-07-18T23:30:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"edd7345b-675d-4584-b379-56cd52df6773","html_url":"https://github.com/Cobular/keyclicky-embedded","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"rp-rs/rp2040-project-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cobular%2Fkeyclicky-embedded","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cobular%2Fkeyclicky-embedded/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cobular%2Fkeyclicky-embedded/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cobular%2Fkeyclicky-embedded/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cobular","download_url":"https://codeload.github.com/Cobular/keyclicky-embedded/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240149486,"owners_count":19755727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T03:36:14.320Z","updated_at":"2026-05-26T16:30:18.638Z","avatar_url":"https://github.com/Cobular.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Project template for rp2040-hal\n\nThis template is intended as a starting point for developing your own firmware based on the rp2040-hal.\n\nIt includes all of the `knurling-rs` tooling as showcased in https://github.com/knurling-rs/app-template (`defmt`, `defmt-rtt`, `panic-probe`, `flip-link`) to make development as easy as possible.\n\n`probe-run` is configured as the default runner, so you can start your program as easy as\n```sh\ncargo run --release\n```\n\nIf you aren't using a debugger (or want to use cargo-embed/probe-rs-debugger), check out [alternative runners](#alternative-runners) for other options\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails open=\"open\"\u003e\n  \n  \u003csummary\u003e\u003ch2 style=\"display: inline-block\"\u003eTable of Contents\u003c/h2\u003e\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\u003ca href=\"#markdown-header-requirements\"\u003eRequirements\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#installation-of-development-dependencies\"\u003eInstallation of development dependencies\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#running\"\u003eRunning\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#alternative-runners\"\u003eAlternative runners\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#code-of-conduct\"\u003eCode of conduct\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- Requirements --\u003e\n\u003cdetails open=\"open\"\u003e\n  \u003csummary\u003e\u003ch2 style=\"display: inline-block\" id=\"requirements\"\u003eRequirements\u003c/h2\u003e\u003c/summary\u003e\n  \n- The standard Rust tooling (cargo, rustup) which you can install from https://rustup.rs/\n\n- Toolchain support for the cortex-m0+ processors in the rp2040 (thumbv6m-none-eabi)\n\n- flip-link - this allows you to detect stack-overflows on the first core, which is the only supported target for now.\n\n- probe-run. Upstream support for RP2040 was added with version 0.3.1.\n\n- A CMSIS-DAP probe. (J-Link and other probes will not work with probe-run)\n\n  You can use a second Pico as a CMSIS-DAP debug probe by installing the following firmware on it:\n  https://github.com/majbthrd/DapperMime/releases/download/20210225/raspberry_pi_pico-DapperMime.uf2\n\n  More details on supported debug probes can be found in [debug_probes.md](debug_probes.md)\n\n\u003c/details\u003e\n\n\u003c!-- Installation of development dependencies --\u003e\n\u003cdetails open=\"open\"\u003e\n  \u003csummary\u003e\u003ch2 style=\"display: inline-block\" id=\"installation-of-development-dependencies\"\u003eInstallation of development dependencies\u003c/h2\u003e\u003c/summary\u003e\n\n```sh\nrustup target install thumbv6m-none-eabi\ncargo install flip-link\n# This is our suggested default 'runner'\ncargo install probe-run\n# If you want to use elf2uf2-rs instead of probe-run, instead do...\ncargo install elf2uf2-rs --locked\n```\n\n\u003c/details\u003e\n\n\n\u003c!-- Running --\u003e\n\u003cdetails open=\"open\"\u003e\n  \u003csummary\u003e\u003ch2 style=\"display: inline-block\" id=\"running\"\u003eRunning\u003c/h2\u003e\u003c/summary\u003e\n  \nFor a debug build\n```sh\ncargo run\n```\nFor a release build\n```sh\ncargo run --release\n```\n\nIf you do not specify a DEFMT_LOG level, it will be set to `debug`.\nThat means `println!(\"\")`, `info!(\"\")` and `debug!(\"\")` statements will be printed.\nIf you wish to override this, you can change it in `.cargo/config.toml` \n```toml\n[env]\nDEFMT_LOG = \"off\"\n```\nYou can also set this inline (on Linux/MacOS)  \n```sh\nDEFMT_LOG=trace cargo run\n```\n\nor set the _environment variable_ so that it applies to every `cargo run` call that follows:\n#### Linux/MacOS/unix\n```sh\nexport DEFMT_LOG=trace\n```\n\nSetting the DEFMT_LOG level for the current session  \nfor bash\n```sh\nexport DEFMT_LOG=trace\n```\n\n#### Windows\nWindows users can only override DEFMT_LOG through `config.toml`\nor by setting the environment variable as a separate step before calling `cargo run`\n- cmd\n```cmd\nset DEFMT_LOG=trace\n```\n- powershell\n```ps1\n$Env:DEFMT_LOG = trace\n```\n\n```cmd\ncargo run\n```\n\n\u003c/details\u003e\n\u003c!-- ALTERNATIVE RUNNERS --\u003e\n\u003cdetails open=\"open\"\u003e\n  \u003csummary\u003e\u003ch2 style=\"display: inline-block\" id=\"alternative-runners\"\u003eAlternative runners\u003c/h2\u003e\u003c/summary\u003e\n\nIf you don't have a debug probe or if you want to do interactive debugging you can set up an alternative runner for cargo.  \n\nSome of the options for your `runner` are listed below:\n\n* **cargo embed**  \n  *Step 1* - Install [`cargo embed`](https://github.com/probe-rs/cargo-embed):\n\n  ```console\n  $ cargo install cargo-embed\n  ```\n\n  *Step 2* - Make sure your .cargo/config contains the following\n\n  ```toml\n  [target.thumbv6m-none-eabi]\n  runner = \"cargo embed\"\n  ```\n\n  *Step 3* - Update settings in [Embed.toml](./Embed.toml)  \n  - The defaults are to flash, reset, and start a defmt logging session\n  You can find all the settings and their meanings [in the cargo-embed repo](https://github.com/probe-rs/cargo-embed/blob/master/src/config/default.toml)\n\n  *Step 4* - Use `cargo run`, which will compile the code and start the\n  specified 'runner'. As the 'runner' is cargo embed, it will flash the device\n  and start running immediately\n\n  ```console\n  $ cargo run --release\n  ```\n\n* **probe-rs-debugger**\n\n  *Step 1* - Download [`probe-rs-debugger VSCode plugin 0.4.0`](https://github.com/probe-rs/vscode/releases/download/v0.4.0/probe-rs-debugger-0.4.0.vsix)\n\n  *Step 2* - Install `probe-rs-debugger VSCode plugin`\n  ```console\n  $ code --install-extension probe-rs-debugger-0.4.0.vsix\n  ```\n\n  *Step 3* - Install `probe-rs-debugger`\n  ```console\n  $ cargo install probe-rs-debugger\n  ```\n\n  *Step 4* - Open this project in VSCode\n\n  *Step 5* - Launch a debug session by choosing `Run`\u003e`Start Debugging` (or press F5)\n\n* **Loading a UF2 over USB**  \n  *Step 1* - Install [`elf2uf2-rs`](https://github.com/JoNil/elf2uf2-rs):\n\n  ```console\n  $ cargo install elf2uf2-rs --locked\n  ```\n\n  *Step 2* - Make sure your .cargo/config contains the following\n\n  ```toml\n  [target.thumbv6m-none-eabi]\n  runner = \"elf2uf2-rs -d\"\n  ```\n\n  The `thumbv6m-none-eabi` target may be replaced by the all-Arm wildcard\n  `'cfg(all(target_arch = \"arm\", target_os = \"none\"))'`.\n\n  *Step 3* - Boot your RP2040 into \"USB Bootloader mode\", typically by rebooting\n  whilst holding some kind of \"Boot Select\" button. On Linux, you will also need\n  to 'mount' the device, like you would a USB Thumb Drive.\n\n  *Step 4* - Use `cargo run`, which will compile the code and start the\n  specified 'runner'. As the 'runner' is the elf2uf2-rs tool, it will build a UF2\n  file and copy it to your RP2040.\n\n  ```console\n  $ cargo run --release\n  ```\n\n* **Loading with picotool**  \n  As ELF files produced by compiling Rust code are completely compatible with ELF\n  files produced by compiling C or C++ code, you can also use the Raspberry Pi\n  tool [picotool](https://github.com/raspberrypi/picotool). The only thing to be\n  aware of is that picotool expects your ELF files to have a `.elf` extension, and\n  by default Rust does not give the ELF files any extension. You can fix this by\n  simply renaming the file.\n\n  This means you can't easily use it as a cargo runner - yet.\n\n  Also of note is that the special\n  [pico-sdk](https://github.com/raspberrypi/pico-sdk) macros which hide\n  information in the ELF file in a way that `picotool info` can read it out, are\n  not supported in Rust. An alternative is TBC.\n\n\u003c/details\u003e\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\nNOTE These packages are under active development. As such, it is likely to\nremain volatile until a 1.0.0 release.\n\nSee the [open issues](https://github.com/rp-rs/rp2040-project-template/issues) for a list of\nproposed features (and known issues).\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nThe steps are:\n\n1. Fork the Project by clicking the 'Fork' button at the top of the page.\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Make some changes to the code or documentation.\n4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n5. Push to the Feature Branch (`git push origin feature/AmazingFeature`)\n6. Create a [New Pull Request](https://github.com/rp-rs/rp-hal/pulls)\n7. An admin will review the Pull Request and discuss any changes that may be required.\n8. Once everyone is happy, the Pull Request can be merged by an admin, and your work is part of our project!\n\n## Code of Conduct\n\nContribution to this crate is organized under the terms of the [Rust Code of\nConduct][CoC], and the maintainer of this crate, the [rp-rs team], promises\nto intervene to uphold that code of conduct.\n\n[CoC]: CODE_OF_CONDUCT.md\n[rp-rs team]: https://github.com/orgs/rp-rs/teams/rp-rs\n\n## License\n\nThe contents of this repository are dual-licensed under the _MIT OR Apache\n2.0_ License. That means you can chose either the MIT licence or the\nApache-2.0 licence when you re-use this code. See `MIT` or `APACHE2.0` for more\ninformation on each specific licence.\n\nAny submissions to this project (e.g. as Pull Requests) must be made available\nunder these terms.\n\n## Contact\n\nRaise an issue: [https://github.com/rp-rs/rp2040-project-template/issues](https://github.com/rp-rs/rp2040-project-template/issues)\nChat to us on Matrix: [#rp-rs:matrix.org](https://matrix.to/#/#rp-rs:matrix.org)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcobular%2Fkeyclicky-embedded","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcobular%2Fkeyclicky-embedded","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcobular%2Fkeyclicky-embedded/lists"}