search

QiTech-Industries / Winder

Filament winding machine powererd by ESPdruino
GNU General Public License v3.0
27 stars 7 forks source link

readme

Contributors Issues Last Commit GPL-3.0 License


Logo

JARVIS Winder

Control Code of the Jarvis Winder running on an ESP32
Explore the docs »

Report Bug · Request Feature · Related Projects

Table of Contents
  1. About The Project
  2. Getting Started
  3. Common Issues
  4. Roadmap
  5. Contributing
  6. Build your own Winder
  7. License
  8. Contact

About The Project

Jarvis Winder

This project covers the code for the Jarvis Winder, which is a machine for winding filaments used for 3D-printing. The winder is used to wind freshly extruded filament on spools and rewind filament from one spool to another. The machine can be controlled via Webinterface, which can be accessed with mobile devices, too. The winder can either log into an existing wifi or create its own on the fly.

(back to top)

Built With

Currently the following libraries are in use:

Library Info License
ArduinoJson https://arduinojson.org/ MIT
Timer https://github.com/brunocalou/Timer MIT
ESPAsyncWebServer https://github.com/me-no-dev/ESPAsyncWebServer GNU-2.1
LittleFS https://github.com/lorol/LittleFS.git GPL-2.0
HardwareControl https://github.com/QiTech-Industries/HardwareControl GPL-3.0

And the following main hardware components:

(back to top)

Getting Started

Usage

Installation is easiest via our own updater tool: https://update.qitech.de. You can just install the software to your ESP via the Browser.

Alternativly you can flash a copy of the firmware-full.bin file also via any local ESP flashing utility. You might use the Espressif online flashing tool as well:

  1. Download the latest firmware-full.bin file from the releases section.
  2. Use the ESP Web flashing tool: https://espressif.github.io/esptool-js/ (recent Chrome or Edge Version)
    • install correct drivers so the ESP is recognized by the PC
    • select baude 115200 and click connect
    • grant access to the serial port your esp is connected to
    • set "flash address" to 0x0 and upload firmware-full.bin
    • click the program button
    • once finished press the reset button on the esp once and you should be all set ready to go 🏎️

Installation

These steps are only required if you want to develop the library. In case you just want to use it in one of your projects refer to Usage

  1. Install the PlatformIO extension in VsCode platformio.platformio-ide
  2. Install the C++ extension in VsCode ms-vscode.cpptools
  3. Install ESP32 drivers (depending on the USB-UART Chip)
  4. Clone the repo 
    git clone --recurse-submodules https://github.com/QiTech-Industries/Winder.git
  5. Install the project dependencies 
    cd Winder && pio pkg install

    When using Windows you need to add pio to your path first or use the full path C:\Users\<username>\.platformio\penv\Scripts\platformio.exe

  6. Upload the code and open Serial Monitor 
    pio run --target upload --target monitor --environment src

    Alternatively you can use PlatformIO->src->Upload and Monitor in the left Sidebar

(back to top)

Common Issues

(back to top)

Roadmap

This project should slowly adapt to the new Winder versions. This means apart from the WS interface there will also be a Serial interface implemented and an option for DC Motor control as well as the possibility of multiple hardware versions.

For the coming releases a new code structure is planned to make the code more modular and object oriented. Some refactored classes and a glimpse of the new code organization can be found in the big-refactoring branch that will slowly get merged into main.

Apart from that all upcoming features are created and discussed as issues first. See open issues for a full list. This is the most up to date roadmap you can get. Feel free to report new issues or fix existing ones.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please open a issue with the tag "enhancement" to discuss whether your idea is in line with our Roadmap and we can find the best way of implementing it.

Than:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Check whether your code complies with the coding guidelines
  6. Open a Pull Request

(back to top)

Build your own Winder

All the documentation for the hardware of the JARVIS WINDER including CAD models and a part list can be found in this repository: https://github.com/QiTech-Industries/winder-parts

Please have in mind that we don't have the resources to provide support for custom builds. We just published our interal documentation as-is.

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

QiTech Industries - https://qitech.de/industries - contact@qitech.de

Project Link: https://github.com/QiTech-Industries/Winder

(back to top)