diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..35b5167093 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 43b07efb7e..f99124b56b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -23,7 +23,7 @@ jobs: - name: Setup Node uses: actions/setup-node@v3 with: - node-version: 18 + node-version: 20 - name: Install dependencies run: | diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 9e08e8bc41..39933f444a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,7 +15,7 @@ jobs: - name: Install node uses: actions/setup-node@v3 with: - node-version: 18 + node-version: 20 - name: Install deps run: npm ci --no-optional diff --git a/.node-version b/.node-version index 3e558c9b3c..f3f52b42d3 100644 --- a/.node-version +++ b/.node-version @@ -1 +1 @@ -18.12.0 +20.9.0 diff --git a/docs/features/cameras.md b/docs/features/cameras.md index 1795a4f670..a7a18d7eb6 100644 --- a/docs/features/cameras.md +++ b/docs/features/cameras.md @@ -9,67 +9,60 @@ permalink: /features/cameras # Cameras {: .no_toc } ---- +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} -Fluidd (and FluiddPI) has built in support for web cameras and allows configuring -your cameras from the same place as your other configuration files. +--- -To get started, open the `webcam.txt` config file in Fluidd's configuration editor. -Instructions on how to get started as well as option references are included in this file. +Fluidd offers robust support for displaying camera streams, providing users +with real-time monitoring capabilities for their 3D printing projects. -You can add up to four cameras to display on your dashboard. +The current supported types are: -Currently supported types are: +- **MJPEG Stream** + - Traditional mjpegstream/ustreamer service. + - Pushes images to Fluidd at the configured resolution and FPS. + - Requires substantial bandwidth and may encounter issues with unstable + network connections. -- MJPEG Stream - This is the traditional mjpegstream/ustreamer service. The service pushes images to - fluidd at the configured resolution and FPS you have setup. This requires - a lot of bandwidth, and can cause issues with unstable network connections. +- **MJPEG Adaptive** + - Pulls images from the mjpegstream/ustreamer service using the snapshot URL. + - Allows setting a target FPS, enabling your browser to maintain the intended + frame rate. + - A more reliable approach in certain scenarios. -- MJPEG Adaptive - This will PULL images from the mjpegstream/ustreamer service, using the snapshot URL. - You can set a target FPS, and your browser will try to keep up with the - intended target. This can be a more reliable approach for some. +- **HLS Stream** + - Loads an HLS (HTTP Live Streaming) video stream via [HLS.js](https://hlsjs.video-dev.org/). + - Utilizes HTML5 video and MediaSource Extensions for playback, requiring a + modern browser. -- HLS Stream - This will load an HLS (HTTP Live Streaming) video stream via [HLS.js](https://hlsjs.video-dev.org/). - It relies on HTML5 video and MediaSource Extensions for playback, so you will - need a modern browser that supports it. +- **WebRTC (camera-streamer)** + - A highly bandwidth-efficient stream type. + - **IMPORTANT:** Currently only available on Raspberry devices. -- IP Camera - This is an experimental option. Effectively, it swaps out the `` tag - for a `