[](https://github.com/mainsail-crew/crowsnest/blob/master/LICENSE) [](https://github.com/mainsail-crew/crowsnest/search?l=shell) [](https://github.com/mainsail-crew/crowsnest/commits) [](https://github.com/mainsail-crew/crowsnest/issues) [](https://discord.gg/mainsail)
# crowsnest
A webcam daemon for Raspberry Pi OS Lite images like mainsailOS
---
## It inherited his name from Sail 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.
### Install on Raspberry Pi OS
cd ~
git clone https://github.com/mainsail-crew/crowsnest.git
cd ~/crowsnest
make install
_This is not tested on other Distributions. If you test that on other Distributions,\
feel free to open a Pull Request to enhance Documentation._
After successful Instalation you should consider to add
[update_manager crowsnest]
type: git_repo
path: ~/crowsnest
origin: https://github.com/mainsail-crew/crowsnest.git
to your moonraker.conf, to get latest and possibly greatest Features.
### To unsinstall 'crowsnest'
cd ~/crowsnest
make uninstall
### Are there more options?
Yes.
cd ~/crowsnest
make
or
make help
---
## Simple Configuration
---
All you need to get your Camera up and running is a small block of code in your _webcam.conf_\
In MainsailOS you can do that in mainsail Web Interface.\
Open the 'config' section, there should be the mentioned file.
By default it look like this:
[crowsnest]
log_path: ~/klipper_logs/crowsnest.log
log_level: quiet
[cam 1]
mode: mjpg
port: 8080
device: /dev/video0
resolution: 640x480
max_fps: 15
What that basicly means is:
log_path: ~/klipper_logs/crowsnest.log
Where crowsnest (webcamd) should store its Logfile.
You can choose:
log_level: quiet
This Option shows a bare minimum Logfile.\
For example:
[06/16/22 09:57:01] crowsnest: crowsnest - A webcam Service for multiple Cams and Stream Services.
[06/16/22 09:57:01] crowsnest: Version: v2.4.0-15-ge42799b
[06/16/22 09:57:01] crowsnest: Prepare Startup ...
[06/16/22 09:57:01] crowsnest: INFO: Checking Dependencys
[06/16/22 09:57:01] crowsnest: Dependency: 'crudini' found in /usr/bin/crudini.
[06/16/22 09:57:02] crowsnest: Dependency: 'find' found in /usr/bin/find.
[06/16/22 09:57:02] crowsnest: Dependency: 'logger' found in /usr/bin/logger.
[06/16/22 09:57:02] crowsnest: Dependency: 'xargs' found in /usr/bin/xargs.
[06/16/22 09:57:02] crowsnest: Dependency: 'ffmpeg' found in /usr/bin/ffmpeg.
[06/16/22 09:57:02] crowsnest: Dependency: 'ustreamer' found in bin/ustreamer/ustreamer.
[06/16/22 09:57:02] crowsnest: Dependency: 'rtsp-simple-server' found in bin/rtsp-simple-server/rtsp-simple-server.
[06/16/22 09:57:02] crowsnest: INFO: Detect available Devices
[06/16/22 09:57:02] crowsnest: INFO: Found 1 total available Device(s)
[06/16/22 09:57:02] crowsnest: Detected 'Raspicam' Device -> /dev/video0
[06/16/22 09:57:02] crowsnest: INFO: No usable CSI Devices found.
[06/16/22 09:57:02] crowsnest: V4L2 Control:
[06/16/22 09:57:02] crowsnest: No parameters set for [cam 1]. Skipped.
[06/16/22 09:57:02] crowsnest: Try to start configured Cams / Services...
[06/16/22 09:57:03] crowsnest: INFO: Configuration of Section [cam 1] looks good. Continue...
[06/16/22 09:57:03] crowsnest: Starting ustreamer with Device /dev/video0 ...
[06/16/22 09:57:05] crowsnest: ... Done!
The next option is
log_level: verbose
This gives you a little more Informations.
It prints out you existing webcam.conf and shows
a detailed info about your configured ( and connected ) cams.\
You will find an example log [here](log-example.md).
This is useful to determine what the Hardware Encoder of your Camera is capable of.\
In this case a "cheap" raspicam for about 7€ was used.\
So, truly made for 'Helper for Setup' purposes.
If you want to get the full Details, please use
log_level: debug
This will show you barely the same as 'verbose' but it prints also your\
configured Start Parameters ( and the defaults ), also it shows\
the Output of your choosen Streamer.\
This option ist more for debugging purposes and has a tendency to overwhelm you if you are not familiar with that.
---
Another Option that affects the 'logging' behavior is
delete_log: true
If you enable that option, everytime you restart, your existing log file will be deleted.
Now the more interessting part.
[cam 1]
mode: mjpg
port: 8080
device: /dev/video0
resolution: 640x480
max_fps: 15
> _Note: You can name the cam, how you want!_\
> _ex.: [cam raspicam]_
---
This section should be pretty much self explantory.
mode: mjpg
means your choosen streamservice will be ustreamer with the well known mjpg-protocol.\
You can choose:
mode: rtsp
This let you use external viewer like vlc for example.\
To view the stream use a proper player like [VLC](https://www.videolan.org/).\
**The stream url will be _rtsp://\:8554/\_** \
As an example: _rtsp://mainsail.local:8554/1_ \
_NOTE: There will be no preview in your Browser!_
---
port: 8080
This will only affect the used port of ustreamer.
**_NOTE: Ports 8080 - 8084 are covered by nginx reverse proxy in MainsailOS \
According to that 8080 will be /webcam, port 8081 will be /webcam2 and so on._**
---
device: /dev/video0
The Videodevice (Camera) what should be used by choosen Streamservice.
device: /dev/v4l/by-id/usb-PixArt_Imaging_Inc._USB2.0_Camera-video-index0
is also valid. Your devices are listed in your log-file on every run.\
So, you can easily copy it from there.
---
resolution: 640x480
Your desired FPS Settings has to match what your Camera able to deliver!
_NOTE: For the most part ignored in rtsp mode!_
max_fps: 15
This last option only affects ustreamer:\
This needs some to read further Information.
custom_flags:
If you enable this in your [cam whatevernameyouset],\
you can add parameters according to your needs.\
Those will be appended to the default/preconfigured parameters.
**_Note: These are seperated by a single space not comma seperated!_**
To setup Services to your need you have to take a closer look to the documentation of the Project.\
As a pointer in the right direction:
- ustreamer
- For sake of simplicity I converted ustreamers manpage to
[ustreamer's manpage](./ustreamer_manpage.md)
---
### Feature V4L2 Control:
v4l2ctl:
This optional parameter allows you to setup your Cam due v4l2-ctl options.
Unfortunatly this is a complex topic. But I try to explain it, as good I can.
### As an Example
You own a Logitech C920 Camera, these camera needs some tweaks to get a sharp picture.\
A solution was to use a cronjob (timed actions due scripts) that runs a script with some v4l2-ctl commands.
v4l2-ctl -d /dev/video0 -c focus_auto=0
v4l2-ctl -d /dev/video0 -c focus_absolute=30
That script gets executed when th Pi boots up.\
Not a comfortable solution.
alexz from the mainsail-crew mentioned it would be a good move when \
this could happen by crowsnest, hassle free for the user.
Take a look at [alexz webcam.conf](https://github.com/zellneralex/klipper_config/blob/11f4f8db8ac0e273e25134b571d0a93291f3511e/webcam.conf)
So, here we go.
Simply add
v4l2ctl: focus_auto=0,focus_absolute=30
to your camera setup section. \
Restart webcamd via mainsail (or your used UI) and you're good to go.
To determine which options or better said parameters your Webcam provides, set at least
log_level: verbose
This will show you a list with available options. Like this:
[04/02/22 15:07:44] webcamd: Supported Controls:
[04/02/22 15:07:44] webcamd: brightness 0x00980900 (int) : min=1 max=255 step=1 default=128 value=128
[04/02/22 15:07:44] webcamd: contrast 0x00980901 (int) : min=1 max=255 step=1 default=128 value=128
[04/02/22 15:07:44] webcamd: saturation 0x00980902 (int) : min=1 max=255 step=1 default=128 value=128
[04/02/22 15:07:44] webcamd: white_balance_temperature_auto 0x0098090c (bool) : default=1 value=1
[04/02/22 15:07:44] webcamd: gain 0x00980913 (int) : min=1 max=100 step=1 default=50 value=50
[04/02/22 15:07:45] webcamd: power_line_frequency 0x00980918 (menu) : min=0 max=2 default=1 value=1
[04/02/22 15:07:45] webcamd: 0: Disabled
[04/02/22 15:07:45] webcamd: 1: 50 Hz
[04/02/22 15:07:45] webcamd: 2: 60 Hz
[04/02/22 15:07:45] webcamd: white_balance_temperature 0x0098091a (int) : min=2800 max=6500 step=1 default=4650 value=4650 flags=inactive
[04/02/22 15:07:45] webcamd: sharpness 0x0098091b (int) : min=1 max=255 step=1 default=128 value=128
[04/02/22 15:07:45] webcamd: exposure_auto 0x009a0901 (menu) : min=0 max=3 default=0 value=0
[04/02/22 15:07:45] webcamd: 0: Auto Mode
[04/02/22 15:07:45] webcamd: 2: Shutter Priority Mode
[04/02/22 15:07:46] webcamd: exposure_absolute 0x009a0902 (int) : min=5 max=2500 step=1 default=5 value=5 flags=inactive
[04/02/22 15:07:46] webcamd: exposure_auto_priority 0x009a0903 (bool) : default=0 value=0
You have to "play around" with those settings if it matches your needs.
simply repeat the commands as mentioned earlier in your ssh connection.
If you have discoverd your setup write that to your webcam.conf as described.
---
## CustomPIOS Module
I have decided to provide an [CustomPiOS Module](https://github.com/guysoft/CustomPiOS) to make it easier to integrate to other Distributions like MainsailOS or similar.
Please see [README.md](./custompios/README.md) in the module folder for\
further Informations.
---
## What 'Backends' uses crowsnest?
- ustreamer - A streamserver from Pi-KVM Project\
active maintained by [Maxim Devaev](https://github.com/mdevaev)\
[ustreamer on github](https://github.com/pikvm/ustreamer)
- rtsp-simple-server
- This server provides rtsp streams and more\
at this point of development are only 'rtsp' features enabled\
More features are planned.
[rtsp-simple-server](https://github.com/aler9/rtsp-simple-server) is written in Go by [aler9](https://github.com/aler9)
---
## 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](https://github.com/pedrolamas), for the ISSUE_TEMPLATES.
---
**So, with all that said, get your position seaman! Prepare to get wet feets on your Journey.**
## ARRRR yooo rrready to sail?