diff --git a/README.md b/README.md index 027272e..e015769 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ with additional features not yet in upstream master. - MQTT - Motion Detection - Paused Streams (when no rtsp client or no motion detected) +- Save a still image to disk **Minor Features**: @@ -167,6 +168,20 @@ in multiple architectures. The latest tag tracks master while each branch gets i docker pull quantumentangledandy/neolink ``` +### Image + +You can write an image from the stream to disk using: + + +```bash +neolink image --config=config.toml --file-path=filepath CameraName +``` + +Where filepath is the path to save the image to and CameraName is the name of the camera +from the config to save the image from. + +File is always jpeg and the extension given in filepath will be added or changed to reflect this. + ## License Neolink is free software, released under the GNU Affero General Public License diff --git a/src/image/mod.rs b/src/image/mod.rs index 7eb30a5..0a9bcba 100644 --- a/src/image/mod.rs +++ b/src/image/mod.rs @@ -1,12 +1,12 @@ /// /// # Neolink Image /// -/// This module can be used to send dump a still image from the camera +/// This module can be used to dump a still image from the camera /// /// /// # Usage /// ```bash -/// neolink image --config=config.toml --finename=filepath CameraName +/// neolink image --config=config.toml --file-path=filepath CameraName /// ``` /// use anyhow::{Context, Result}; @@ -37,7 +37,7 @@ pub(crate) async fn main(opt: Opt, config: Config) -> Result<()> { .await .context("Failed to start video")?; - // Get one iframe as the start while also getting the getting the video type + // Get one iframe at the start while also getting the the video type let buf; let vid_type; loop {