3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update webcam documentation 

Add tables specifying known values for the "icon"
and "service" options.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2023-12-24 14:49:22 -05:00
parent cc5dea716b
commit ee0c641b08
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
1 changed files with 42 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/configuration.md
View File

@ -355,14 +355,18 @@ location: printer
# A description of the webcam location, ie: what the webcam is observing.
# The default is "printer".
icon:
# A name of the icon to use for the camera. The default is mdiWebcam.
# A name of the icon to use for the camera. See the tip following this
# example for known values. The default is mdiWebcam.
enabled: True
# An optional boolean value to indicate if this webcam should be enabled.
# Default is True.
service: mjpegstreamer
# The name of the application or service hosting the webcam stream. Front-
# ends may use this configuration to determine how to launch or start the
# program. The default is "mjpegstreamer".
# ends may use this configuration to determine how to connect to the service
# and interpret its stream. See the tip following this example for
# currently known values. The default is "mjpegstreamer".
location: printer
# A string describing the location of the camera. Default is printer.
target_fps: 15
# An integer value specifying the target framerate. The default is 15 fps.
target_fps_idle: 5
@ -391,6 +395,41 @@ aspect_ratio: 4:3
# The default is 4:3.
```
!!! Tip
The following are known `icon` values:
| Icon Description | [webcam] icon value | Supported Frontends |
| ---------------- | --------------------| -------- |
| Printer | `mdiPrinter3d` | Mainsail |
| Nozzle | `mdiPrinter3dNozzle` | Mainsail |
| Bed | `mdiRadiatorDisabled` | Mainsail |
| Webcam | `mdiWebcam` | Mainsail |
| Filament | `mdiAlbum` | Mainsail |
| Door | `mdiDoor` | Mainsail |
| MCU | `mdiRaspberryPi` | Mainsail |
| Hot | `mdiCampfire` | Mainsail |
The documentation for
[Mainsail](https://docs.mainsail.xyz/overview/settings/webcams#service)
and [Fluidd](https://docs.fluidd.xyz/features/cameras)
contain descriptions for their respective streaming service options.
Below is a table of values mapping currently known service types to
the values accepted by the webcam's `service` option:
| Service Type | [webcam] service value | Supported Frontends |
| ------------- | --------------------- | ------------------- |
| MJPEG-Streamer | `mjpegstreamer` | Mainsail, Fluidd |
| Adaptive MJPEG-Streamer | `mjpegstreamer-adaptive` | Mainsail, Fluidd |
| UV4L-MJPEG | `uv4l-mjpeg` | Mainsail |
| IP-Camera | `ipstream` | Mainsail, Fluidd |
| WebRTC (camera-streamer) | `webrtc-camerastreamer` | Mainsail, Fluidd |
| WebRTC (go2rtc) | `webrtc-go2rtc` | Mainsail, Fluidd |
| WebRTC (MediaMTX) | `webrtc-mediamtx` | Mainsail |
| WebRTC (Janus) | `webrtc-janus` | Mainsail |
| HLS Streamer | `hlsstream` | Mainsail, Fluidd |
| jMuxer | `jmuxer-stream` | Mainsail |
| HTTP Page | `iframe`| Fluidd |
## Optional Components
Optional Components are only loaded if present in `moonraker.conf`. This