OrreryDriver/README.md

# OrreryDriver
![Human made](https://img.shields.io/badge/human-made-green?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IiNmZmZmZmYiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBjbGFzcz0ibHVjaWRlIGx1Y2lkZS1wZXJzb24tc3RhbmRpbmctaWNvbiBsdWNpZGUtcGVyc29uLXN0YW5kaW5nIj48Y2lyY2xlIGN4PSIxMiIgY3k9IjUiIHI9IjEiLz48cGF0aCBkPSJtOSAyMCAzLTYgMyA2Ii8+PHBhdGggZD0ibTYgOCA2IDIgNi0yIi8+PHBhdGggZD0iTTEyIDEwdjQiLz48L3N2Zz4=)
[![License: CERN-OHL-S](https://img.shields.io/badge/Hardware%20License-CERN--OHL--S%20v2-blueviolet)](https://ohwr.org/cern_ohl_s_v2.pdf)
[![License: GNU General Public License v3.0](https://img.shields.io/badge/Firmware%20License-GNU%20GPL--v3.0-yellow)](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text)
[![License: CC BY-SA 4.0](https://img.shields.io/badge/Documentation%20License-CC_BY--SA_4.0-lightgrey)](https://creativecommons.org/licenses/by-sa/4.0/)


This repository contains all the files and documentation for the LEGO Orrery Driver Mod!
- [Visit the DIY guide](https://gorkem.cc/projects/LegoOrreryMod) for details.


File structure:
+  `Firmware` contains the code and necessary drivers.
+  `CAD` contains print ready .stl files.
+  `PCB` contains gerber files.

Components list:
- ESP32-C3 Super mini
- DS3231 mini RTC Module
- 2 x TM1637 4 digit Display Module
- Nema 17 Bipolar 0.9deg 11Ncm 1.2A 42x42x22mm 4 Wires
- 10K Panel Mount Pot with a center detent
- TMC 2208 Silent Stepper Driver Module
- 2.54 PCB mount DC Jack
- JST-EH 1x04 P2.50mm Horizontal Connector
- JST-EH 1x06 P2.50mm Horizontal Connector
- B3F-3152 Button
- Male header pins

## Contributing
Changes to the code repo is currently only open for registered users to avoid bots. Register for an account from the rop right and send me an email at: **gorkem.bozkrt[at]gmail.com** so I can approve your registration!

Pull requests are welcome!