crowsnest

A wrapper script for webcam streaming on Raspberry Pi OS Lite images like MainsailOS. Mainly written in bash.

• Why is it called crowsnest?
• Support
• Documentation
• Compatibility
• Contribute
• How to support us?
• CustomPiOS-module
• What 'Backends' does crowsnest use
• Credits

Why is it called crowsnest?

It inherited his name from sailing ships crow's nest.

A crow's nest is a structure in the upper part of the main mast of a ship or a structure that is used as a lookout point.
See https://en.wikipedia.org/wiki/Crow's_nest

So, this will be the 'lookout point' for your printer.

Support

Please read carefully on how to configure crowsnest to your needs! Check out the FAQ section for first aid or join our Discord server if you need further help. For some topics that are not covered in the documentation, just read below.

PS: Do not open issues that are based on misconfiguration! This makes it harder for me to keep track of problems in my code.

Documentation

We have decided to move crowsnest's documentation to a new location.
Please go to https://crowsnest.mainsail.xyz/

If there is something in our documentation that is not covered, is described in a way that is misunderstood, or simply is missing, please let us know!

Compatibility

Tested on the following distributions:

Legend:
Tested and work as intended: ✔️
Tested and/or did not work: ❌
Should work but not tested: ❓
Not available: ➖

If you test that on other distributions, feel free to open a Pull Request to enhance documentation.

Hint

OS images that are based on Debian 10 (codename 'buster') are no longer supported with Crowsnest version 4 (current master branch)!

Please use the legacy/v3 branch for these OS types.
See the README.md of this branch for usage instructions.

Contribute

1. Create an Issue related to your topic.
2. Prepare an tested Pull Request against the develop branch
   • Please use commits formatted according to Conventional Commits
   • Make sure you do not ignore the code formatting as provided by the .editorconfig of this repo
3. Be patient. Every PR has to go through some sort of "internal gates" before it reaches the master branch, unless an immediate response is crucial.

How to support us

Buy KwadFan a coffee at ko-fi.com or support the mainsail project

Please consider hitting the ⭐ button in the upper right hand corner to show some love for this project.

CustomPIOS Module

I have decided to provide a CustomPiOS Module to make it easier to integrate with other distributions like MainsailOS or similar.
Please see README.md in the module folder for more information.

What 'Backends' does crowsnest use?

Please see the according FAQ section in our documentation.

Credits

I want to give a huge shoutout to lixxbox and alexz from the mainsail-crew.
Without these guys it simply were not possible to get that done.

They both mentioned improvements and tested a heck out of there machines to get this all functioning well.
Thank you, mates :) Proud to be a part of.

Thanks to Pedro Lamas, for the ISSUE_TEMPLATES.

Thanks to ayufan for keep going on camera-streamer, even I stressed him to get rid of some bugs ;)

So, with all that said, get your position seaman! Prepare to get wet feets on your journey.

Are you ready to sail?