Skip to content

Silverreed Firmware Documentation

Open-source firmware for automating Silver Reed knitting machines using Arduino and the AYAB protocol.

Overview

A modern, open-source solution for programming patterns on Silver Reed electronic knitting machines.

Key Features: - Arduino UNO / UNO R4 WiFi support - AYAB Protocol v6 implementation - Real-time control - Full hardware and software documentation

Quick Start

git clone https://github.com/MathKnitting/silverreed-firmware.git
cd silverreed-firmware
curl -LsSf https://astral.sh/uv/install.sh | sh
uv sync --all-groups
uv run task init
uv run task build && uv run task upload

See Installation Guide for details.

Documentation Sections

Getting Started Installation, building, and uploading firmware

Concepts Project purpose and how knitting machines work

Hardware Shield design, pin mapping, and connections

Firmware Architecture, components, and implementation

Development Testing, debugging, and contributing

Technology used

  • Platform: Arduino UNO / UNO R4 WiFi
  • Language: C++11
  • Build: PlatformIO + uv + taskipy
  • Protocol: AYAB v6 with SLIP encoding
  • Testing: Unity + simavr
  • Board Design: Kicad 6

Contributing

Contributions welcome! Report issues or submit PRs on GitHub.

License

MIT License - see LICENSE