firmware-base/vendor/qitech/Winder/resources/WinderWebInterface

Jarvis Winder Webinterface

The control interface to operate your winding machine remotly from your phone
Explore the docs »

Report Bug · Request Feature · Related Projects

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Every machine needs an option to control it. Instead of using a HMI Display or going with an onboard LCD, we decided to make our Winder controllable via Wifi. This way you can use your existing devices for control and it becomes more easy to develop the UI as it is just a PWA.

(back to top)

Built With

Because the internal ESP flash is with 1MB rather memory constrained we decided to go with Preact as frontend framework as it does not have a virtual DOM (and you can write class instead of className ;) and Tailwind CSS for styling so unnecessary styles are not compiled in the final build. (see more technology explanation in Design Decisions)

Library	Info	License
Preact	https://preactjs.com/	MIT
Tailwind CSS	https://tailwindcss.com/	MIT
Chart.js	https://www.chartjs.org/	MIT
Zustand	https://github.com/pmndrs/zustand	MIT
FontAwesome	https://fontawesome.com/	CC BY 4.0
Icomoon	https://icomoon.io/	CC BY 4.0

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

   git clone https://github.com/QiTech-Industries/WinderWebInterface
   

2. Install NPM packages

   npm install
   

3. Start the application on port 8080 in hot-reload mode

   npm run dev
   

There is also a full mock server available to test the API interaction without having a connection to the Winder. To start it run:

1. Install NPM packages

   cd mock && npm install
   

2. Start the server on port 5001 in hot-reload mode

   npm run start
   

When reloading the webinterface a green toast should pop up notifying you that the socket connection was successful.

(back to top)

Roadmap

This project is planned to run out of service soon as we realized that most people enjoy operating there machine via cable more than over wifi. This will also make it easier for us to implement synchronization between all our devices, as the PC running the new Pro App can act as a central host. Given that perspective we have no additional features planned for the interface. However the new software will stay compatible with older machines.

Issues and feature requests will still be kept track of. See open issues for a full list. 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. Open a Pull Request

(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/WinderWebInterface

(back to top)