anchor

KO | EN

gitlite — search

#ai #typescript #llm #android #rust #linux #macos #windows #awesome #cli #security #ios #mcp #open-source

(★ 80)

Anchor, a Rust Klipper protocol implementation

File Explorer

Download Latest Version (.zip)

- - docs.yml
- - encoding.rs
  - fifo_buffer.rs
  - input_buffer.rs
  - lib.rs
  - output_buffer.rs
  - transport.rs
  - transport_output.rs
- Cargo.toml
- - command.rs
  - enumeration.rs
  - generate.rs
  - lib.rs
  - msg_desc.rs
  - output.rs
  - reply.rs
  - static_string.rs
  - utils.rs
- Cargo.toml
- - lib.rs
- Cargo.toml
- - config.toml
- - clock.rs
  - commands.rs
  - main.rs
  - usb.rs
- build.rs
- Cargo.toml
- README.md
- - config.toml
- - lib.rs
- .gitignore
- build.rs
- Cargo.toml
- memory.x
- README.md
- rust-toolchain.toml
- - config.toml
- - clock.rs
  - commands.rs
  - main.rs
  - usb.rs
- .gitignore
- build.rs
- Cargo.toml
- memory.x
- README.md
- - main.rs
  - test.rs
- build.rs
- Cargo.toml
- README.md
.gitignore
Cargo.toml
LICENSE.txt
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Anchor

Anchor is an implementation of the Klipper protocol.

You can use Anchor to create custom Klipper MCUs. It's written in Rust and
provides only the protocol implementation, giving you full control over how you
want to tie the protocol handling in to your program. You can even implement a
Klipper MCU that runs over a PTY, like the Linux `klipper_mcu` program.

This repo contains the following folders:

* `anchor`  
    The runtime support library for Anchor. It includes all the functionality
    that is used during runtime.

* `anchor_codegen`  
    The Klipper protocol requires exchanging an initial data dictionary, and
    command IDs need to be hooked up. `anchor_codegen` creates this data
    dictionary, message handlers, serializers, etc. and generates a Rust module
    that will be included by the `klipper_generate_config` macro in your
    project.

* `rp2040_demo`  
    A simple demo showing how one could integrate Anchor in an rp2040 project,
    communicating over USB.

* `esp32c3_demo`  
    A simple demo showing how one could integrate Anchor in an esp32c3 project,
    communicating over USB.

* `testjig`  
    A development tool and example of how to use Anchor for implementing a very
    simple PTY based MCU that can talk to Klipper.

* `anchor_macro`  
    Implements the `proc_macro`s needed by `anchor`. You shouldn't have to mess
    with this.

Anchor powers the [Beacon3D Surface Scanner](https://beacon3d.com/).

## Documentation

Documentation can be found [here](https://anchor.annex.engineering).

## Licensing

Anchor is licensed under the MIT license, which means you can do pretty much
whatever you want with it. Please see [LICENSE.txt](LICENSE.txt) for more
information.

## Anchor Projects

We want to showcase new and interesting uses of Anchor as we are very excited
about this new implementation. If you've made something with Anchor, drop a
line. We'd love to add you to this list.

* [Beacon3D](https://beacon3d.com/) is a novel eddy current surface scanner
    that can scan your bed in seconds.

* [Crampon](https://github.com/Annex-Engineering/crampon_anchor) This nozzle
    based accelerometer was reimplemented in Anchor to demonstrate how quickly
    one can bring up a new device.

* [Rampon](https://github.com/rogerlz/rampon_anchor) The popular KUSBA
    resonance measuring device firmware was reimplemented using Anchor as well,
    fixing some minor firmware bugs in the original implementation.

## Acknowledgements

This project is in no way endorsed by the Klipper project. Please do not direct
any support requests to the Klipper project.

* [Klipper](https://www.klipper3d.org/) by [Kevin O'Connor](https://www.patreon.com/koconnor)

anchor

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

anchor

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README