Skip to content

Commit c52cf40

Browse files
KwadFanKwadFan
committed
chore(docs): updates readme to latest changes.
Signed-off-by: Stephan Wendel <[email protected]>
1 parent e42799b commit c52cf40

File tree

3 files changed

+251
-62
lines changed

3 files changed

+251
-62
lines changed

‎.github/crowsnest-logo.png

27.2 KB
Loading

‎README.md

+40-62
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
[![license](https://img.shields.io/github/license/mainsail-crew/crowsnest?style=flat-square&color=green)](https://github.com/mainsail-crew/crowsnest/blob/master/LICENSE) [![language](https://img.shields.io/github/languages/top/mainsail-crew/crowsnest?style=flat-square&logo=gnubash&logoColor=white)](https://github.com/mainsail-crew/crowsnest/search?l=shell) [![commit-activity](https://img.shields.io/github/commit-activity/m/mainsail-crew/crowsnest?style=flat-square)](https://github.com/mainsail-crew/crowsnest/commits) [![issue-search](https://img.shields.io/github/issues/mainsail-crew/crowsnest?style=flat-square)](https://github.com/mainsail-crew/crowsnest/issues) ![downloads](https://img.shields.io/github/downloads/mainsail-crew/crowsnest/total?style=flat-square) [![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/skWTwTD)
1+
[![license](https://img.shields.io/github/license/mainsail-crew/crowsnest?style=flat-square&color=green)](https://github.com/mainsail-crew/crowsnest/blob/master/LICENSE) [![language](https://img.shields.io/github/languages/top/mainsail-crew/crowsnest?style=flat-square&logo=gnubash&logoColor=white)](https://github.com/mainsail-crew/crowsnest/search?l=shell) [![commit-activity](https://img.shields.io/github/commit-activity/m/mainsail-crew/crowsnest?style=flat-square)](https://github.com/mainsail-crew/crowsnest/commits) [![issue-search](https://img.shields.io/github/issues/mainsail-crew/crowsnest?style=flat-square)](https://github.com/mainsail-crew/crowsnest/issues) [![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/skWTwTD)
2+
3+
<p align="center">
4+
<img src=".github/crowsnest-logo.png" style="width:30%">
5+
</p>
26

37
# crowsnest
48

@@ -16,7 +20,7 @@ So, this will be the 'lookout point' for your Printer.
1620
### Install on Raspberry Pi OS
1721

1822
cd ~
19-
git clone --recurse-submodules https://github.com/mainsail-crew/crowsnest.git
23+
git clone https://github.com/mainsail-crew/crowsnest.git
2024
cd ~/crowsnest
2125
make install
2226

@@ -25,7 +29,7 @@ feel free to open a Pull Request to enhance Documentation._
2529

2630
After successful Instalation you should consider to add
2731

28-
[update_manager webcamd]
32+
[update_manager crowsnest]
2933
type: git_repo
3034
path: ~/crowsnest
3135
origin: https://github.com/mainsail-crew/crowsnest.git
@@ -48,8 +52,6 @@ or
4852

4953
make help
5054

51-
## _NOTE: This project has WIP Status! Changes may occure and possibly break things!_
52-
5355
---
5456

5557
## Simple Configuration
@@ -62,8 +64,8 @@ Open the 'config' section, there should be the mentioned file.
6264

6365
By default it look like this:
6466

65-
[webcamd]
66-
log_path: ~/klipper_logs/webcamd.log
67+
[crowsnest]
68+
log_path: ~/klipper_logs/crowsnest.log
6769
log_level: quiet
6870

6971
[cam 1]
@@ -75,7 +77,7 @@ By default it look like this:
7577

7678
What that basicly means is:
7779

78-
log_path: ~/klipper_logs/webcamd.log
80+
log_path: ~/klipper_logs/crowsnest.log
7981

8082
Where crowsnest (webcamd) should store its Logfile.
8183

@@ -86,24 +88,27 @@ You can choose:
8688
This Option shows a bare minimum Logfile.\
8789
For example:
8890

89-
[11/02/21 20:47:52] webcamd: webcamd - A webcam Service for multiple Cams and Stream Services.
90-
[11/02/21 20:47:53] webcamd: Version: v0.1.3-9-g7e278cd
91-
[11/02/21 20:47:53] webcamd: Prepare Startup ...
92-
[11/02/21 20:47:53] webcamd: INFO: Checking Dependencys
93-
[11/02/21 20:47:53] webcamd: Dependency: 'crudini' found in /usr/bin/crudini.
94-
[11/02/21 20:47:53] webcamd: Dependency: 'mjpg_streamer' found in /usr/local/bin/mjpg_streamer.
95-
[11/02/21 20:47:53] webcamd: Dependency: 'ustreamer' found in /usr/local/bin/ustreamer.
96-
[11/02/21 20:47:53] webcamd: Dependency: 'v4l2rtspserver' found in /usr/local/bin/v4l2rtspserver.
97-
[11/02/21 20:47:54] webcamd: INFO: Detect available Cameras
98-
[11/02/21 20:47:54] webcamd: INFO: Found 2 available Camera(s)
99-
[11/02/21 20:47:54] webcamd: /dev/v4l/by-id/usb-USB_Camera_USB_Camera_SN0001-video-index0 -> /dev/video1
100-
[11/02/21 20:47:54] webcamd: Detected 'Raspicam' Device -> /dev/video0
101-
[11/02/21 20:47:54] webcamd: Try to start configured Cams / Services...
102-
[11/02/21 20:47:55] webcamd: INFO: Configuration of Section [cam 1] looks good. Continue...
103-
[11/02/21 20:47:55] webcamd: Starting mjpeg-streamer with Device /dev/video0 ...
104-
[11/02/21 20:48:03] webcamd: INFO: Configuration of Section [cam usb_black] looks good. Continue...
105-
[11/02/21 20:48:04] webcamd: Starting ustreamer with Device /dev/v4l/by-id/usb-USB_Camera_USB_Camera_SN0001-video-index0 ...
106-
[11/02/21 20:48:11] webcamd: ... Done!
91+
[06/16/22 09:57:01] crowsnest: crowsnest - A webcam Service for multiple Cams and Stream Services.
92+
[06/16/22 09:57:01] crowsnest: Version: v2.4.0-15-ge42799b
93+
[06/16/22 09:57:01] crowsnest: Prepare Startup ...
94+
[06/16/22 09:57:01] crowsnest: INFO: Checking Dependencys
95+
[06/16/22 09:57:01] crowsnest: Dependency: 'crudini' found in /usr/bin/crudini.
96+
[06/16/22 09:57:02] crowsnest: Dependency: 'find' found in /usr/bin/find.
97+
[06/16/22 09:57:02] crowsnest: Dependency: 'logger' found in /usr/bin/logger.
98+
[06/16/22 09:57:02] crowsnest: Dependency: 'xargs' found in /usr/bin/xargs.
99+
[06/16/22 09:57:02] crowsnest: Dependency: 'ffmpeg' found in /usr/bin/ffmpeg.
100+
[06/16/22 09:57:02] crowsnest: Dependency: 'ustreamer' found in bin/ustreamer/ustreamer.
101+
[06/16/22 09:57:02] crowsnest: Dependency: 'rtsp-simple-server' found in bin/rtsp-simple-server/rtsp-simple-server.
102+
[06/16/22 09:57:02] crowsnest: INFO: Detect available Devices
103+
[06/16/22 09:57:02] crowsnest: INFO: Found 1 total available Device(s)
104+
[06/16/22 09:57:02] crowsnest: Detected 'Raspicam' Device -> /dev/video0
105+
[06/16/22 09:57:02] crowsnest: INFO: No usable CSI Devices found.
106+
[06/16/22 09:57:02] crowsnest: V4L2 Control:
107+
[06/16/22 09:57:02] crowsnest: No parameters set for [cam 1]. Skipped.
108+
[06/16/22 09:57:02] crowsnest: Try to start configured Cams / Services...
109+
[06/16/22 09:57:03] crowsnest: INFO: Configuration of Section [cam 1] looks good. Continue...
110+
[06/16/22 09:57:03] crowsnest: Starting ustreamer with Device /dev/video0 ...
111+
[06/16/22 09:57:05] crowsnest: ... Done!
107112

108113
The next option is
109114

@@ -112,40 +117,8 @@ The next option is
112117
This gives you a little more Informations.
113118
It prints out you existing webcam.conf and shows
114119
a detailed info about your configured ( and connected ) cams.\
115-
Like that:
116-
117-
[10/24/21 02:46:00] webcamd: INFO: Detect available Cameras
118-
[10/24/21 02:46:00] webcamd: INFO: Found 1 available Camera(s)
119-
[10/24/21 02:46:00] webcamd: Detected 'Raspicam' Device -> /dev/video0
120-
[10/24/21 02:46:00] webcamd: Supported Formats:
121-
[10/24/21 02:46:00] webcamd: [0]: 'YU12' (Planar YUV 4:2:0)
122-
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
123-
[10/24/21 02:46:01] webcamd: [1]: 'YUYV' (YUYV 4:2:2)
124-
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
125-
[10/24/21 02:46:01] webcamd: [2]: 'RGB3' (24-bit RGB 8-8-8)
126-
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
127-
[10/24/21 02:46:01] webcamd: [3]: 'JPEG' (JFIF JPEG, compressed)
128-
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
129-
[10/24/21 02:46:01] webcamd: [4]: 'H264' (H.264, compressed)
130-
[10/24/21 02:46:01] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
131-
[10/24/21 02:46:02] webcamd: [5]: 'MJPG' (Motion-JPEG, compressed)
132-
[10/24/21 02:46:02] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
133-
[10/24/21 02:46:02] webcamd: [6]: 'YVYU' (YVYU 4:2:2)
134-
[10/24/21 02:46:02] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
135-
[10/24/21 02:46:02] webcamd: [7]: 'VYUY' (VYUY 4:2:2)
136-
[10/24/21 02:46:02] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
137-
[10/24/21 02:46:02] webcamd: [8]: 'UYVY' (UYVY 4:2:2)
138-
[10/24/21 02:46:02] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
139-
[10/24/21 02:46:02] webcamd: [9]: 'NV12' (Y/CbCr 4:2:0)
140-
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
141-
[10/24/21 02:46:03] webcamd: [10]: 'BGR3' (24-bit BGR 8-8-8)
142-
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
143-
[10/24/21 02:46:03] webcamd: [11]: 'YV12' (Planar YVU 4:2:0)
144-
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
145-
[10/24/21 02:46:03] webcamd: [12]: 'NV21' (Y/CrCb 4:2:0)
146-
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
147-
[10/24/21 02:46:03] webcamd: [13]: 'RX24' (32-bit XBGR 8-8-8-8)
148-
[10/24/21 02:46:03] webcamd: Size: Stepwise 32x32 - 2592x1944 with step 2/2
120+
121+
You will find an example log [here](log-example.md).
149122

150123
This is useful to determine what the Hardware Encoder of your Camera is capable of.\
151124
In this case a "cheap" raspicam for about 7€ was used.\
@@ -191,7 +164,10 @@ You can choose:
191164

192165
mode: rtsp
193166

194-
This let you use external viewer like vlc for example.
167+
This let you use external viewer like vlc for example.\
168+
To view the stream use a proper player like [VLC](https://www.videolan.org/).\
169+
**The stream url will be _rtsp://\<printeriporname\>:8554/\<yourcamerasectionname\>_** \
170+
As an example: _rtsp://mainsail.local:8554/1_ \
195171
_NOTE: There will be no preview in your Browser!_
196172

197173
---
@@ -232,6 +208,8 @@ If you enable this in your [cam whatevernameyouset],\
232208
you can add parameters according to your needs.\
233209
Those will be appended to the default/preconfigured parameters.
234210

211+
**_Note: These are seperated by a single space not comma seperated!_**
212+
235213
To setup Services to your need you have to take a closer look to the documentation of the Project.\
236214
As a pointer in the right direction:
237215

@@ -340,7 +318,7 @@ Thanks to [Pedro Lamas](https://github.com/pedrolamas), for the ISSUE_TEMPLATES.
340318
---
341319

342320
<p align="center">
343-
<img src="https://raw.githubusercontent.com/meteyou/mainsail/master/docs/assets/img/logo.png">
321+
<img src="https://github.com/mainsail-crew/docs/raw/master/assets/img/logo.png">
344322
</p>
345323

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

0 commit comments

Comments
 (0)