Skip to content

dani007200964/Shellminator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Shellminator

๐Ÿš€ About

Shellminator is an easy-to-use terminal interface library designed for microcontroller environments. Thanks to its low resource usage, it can run on almost any microcontroller. Itโ€™s Arduino-compatible out of the box, making it accessible for both hobbyists and beginner programmers.

๐Ÿ”„ What's New?

๐ŸŒ Wireless Device Support

Weโ€™re super proud of this one! It wasnโ€™t easy, but we made it happen. Instead of relying on existing generic libraries (which werenโ€™t flexible enough), we built our own WebSocket and TCP support for ESP8266, ESP32, Raspberry Pi Pico W, and Arduino Uno R4 WiFi.
๐Ÿ’ก Bonus: Bluetooth Low Energy (BLE) is now supported for ESP32, Arduino Uno R4, and nRF52840 (Arduino Nano 33 BLE) platforms!

๐Ÿ–ฅ Built-in Web Server for WebSocket

If your device is offline, you can now host the necessary web pages directly from the microcontroller. No external server needed!

๐Ÿ“– Better Documentation & More Examples

If we had to highlight one area where we put tons of effort, itโ€™s the documentation. We knew it wasnโ€™t great beforeโ€”so we fixed it. Now, itโ€™s interactive, example-rich, and beginner-friendly. Hope you like it! ๐Ÿ˜Š

๐Ÿ–ผ GUI (Because Why Not?)

Totally unnecessary, but super cool! You donโ€™t have to use it, but now you can create progress bars, buttons, selection lists, plots, level meters, and even notifications! ๐ŸŽจ

๐Ÿ” Password Protection

With wireless support, security became a must. Now, you can password-protect your terminal and keep unwanted fingers away.

๐Ÿ–ผ Neofetch Support

A real developerโ€™s terminal isnโ€™t complete without Neofetch! We provide a built-in solution, but feel free to customize it. We can't wait to see your awesome ASCII art in the Show & Tell section! ๐ŸŽจ

๐Ÿš€ Enhanced Commander-API Integration

With Commander-API evolving, we needed to step up our game. Now, Shellminator plays even better with Commander-API!

๐ŸŽจ Prompt Colorizer & Syntax Highlighting

Now you can create your own syntax highlighter or use ours, which is fully compatible with the new Commander-API argument parser.

๐Ÿ“ฆ Abstraction Layers

Shellminator reached a critical size where better abstraction was needed. This change made the GUI possible and keeps the project scalable.

๐Ÿ›  Major Refactoring

We know "refactoring" isn't what you want to hear when it comes to backward compatibility, but trust us, it was worth it.

  • Buffering system reworked
  • Memory issues in formatting commands fixed
  • Performance & scalability improvements

๐Ÿ“š Documentation

The Shellminator documentation is packed with examples and covers how to use it alongside Commander-API.

๐Ÿ’ก Tip: If you're new to Shellminator, go through the examples in orderโ€”they build on each other.

๐ŸŽฎ Interactive Demos: Every example comes with a browser-based interactive demo, so you can test things out instantly! No setup needed.

We hope you like it! ๐Ÿ˜Š

๐Ÿค Feedback and Contributions

We've poured a lot of time and effort into making this project stable and easy to use, but no software is perfect. Bugs happen. Features can improve. And thatโ€™s where you come in!

If you have feature suggestions, bug reports, or ideas for enhancements, weโ€™d love to hear from you. Your feedback makes Commander-API better for everyone!

Ways to contribute:

Every contribution, big or small, helps us grow!

โค๏ธ Support

If this project has been helpful to you and youโ€™d like to buy us a coffee, weโ€™d really appreciate it! โ˜• Every little bit helps keep this small team motivated. Support

๐ŸŒ Useful Links

๐Ÿ—จ๏ธ Contact

Have a question? Need help? Just want to say hi?

Weโ€™d love to hear from you! ๐Ÿš€

๐Ÿ“ƒ License

Shellminator is licensed under the MIT License.

ยฉ Daniel Hajnal

โœ‰๏ธ hajnal.daniel96@gmail.com

About

Shellminator is a shimple shell interface for embedded devices

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages