mwood77 / winderoo

Winderoo - Supercharge your Open Source Watch Winder (OSWW) build!
https://winderoo.com
Creative Commons Attribution Share Alike 4.0 International
23 stars 4 forks source link
arduino cc-by-sa esp32 hardware homeassistant homeassistant-integration watches

Product Links Markdown Link Checker

Winderoo

Open source firmware for microcontolled watch winders

Winderoo - The Open Source Watch Winder

Winderoo is open source firmware which adds smart functionality to your OSWW build or microcontroller equipped watch winder. Smart functionality includes a Web UI (fully-translated in 5 languages!), OLED screen support, start timer, and more!

[!NOTE] OSWW is an open source modular watch winder, which you can read more about on GitHub or Printables.

Key Features

Winderoo Requires a Different Microcontroller

User Manual

Prerequisites

[!IMPORTANT] This project is an add-on to your already built Open Source Watch Winder (OSWW)

Download and install the following on your computer:

  1. Visual Studio Code
  2. PlatformIO
    • Note: the "extensions" button has changed since Platformio has created their install guide. You can access the extensions pane with the following key combinations:
      • Windows: Ctrl+Shift+X
      • macOS: Command+Shift+X
  3. You may or may not need these drivers, but some 'knock off' ESP32 dev boards require them.

Build Instructions

  1. Bill of Materials (what you need to buy)
  2. Software Installation
  3. Winderoo Wiring Diagram

Contributing

This project welcomes contributions. Please follow the regular git workflow; fork + PR to contribute.

Translations / Localization

Winderoo has multi-language support, and we welcome adding more languages.

To add another language:

  1. Duplicate one of the current localizations, and translate the text:
    • src/angular/osww-frontend/src/assets/i18n/ stores the current localizations.
  2. Add a new language menu item here to enable your language:
    • src/angular/osww-frontend/src/app/header/header.component.html
  3. Open a Pull Request

Frontend

Backend

API Specification

The API has 4 endpoints. You can explore them in the attached Open API definition.