From 4680ec4c2b7049656febc03c099102ae350f007a Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Mon, 2 Aug 2021 13:41:40 +0700 Subject: [PATCH] Some imporved documentation for the subcommand modules --- src/rtsp/mod.rs | 24 ++++++++++++++++++++++++ src/statusled/mod.rs | 12 ++++++++++++ 2 files changed, 36 insertions(+) diff --git a/src/rtsp/mod.rs b/src/rtsp/mod.rs index 1e47998..210bdc2 100644 --- a/src/rtsp/mod.rs +++ b/src/rtsp/mod.rs @@ -4,6 +4,30 @@ /// This module serves the rtsp streams for the /// `neolink rtsp` subcommand /// +/// All camera specified in the config.toml will be served +/// over rtsp. By default it bind to all local ip addresses +/// on the port 8554. +/// +/// You can view the streams with any rtsp compliement program +/// such as ffmpeg, vlc, blue-iris, home-assistant, zone-minder etc. +/// +/// Each camera has it own endpoint based on its name. For example +/// a camera named `"Garage"` in the config can be found at. +/// +/// `rtsp://my.ip.address:8554/Garage` +/// +/// With the lower resolution stream at +/// +/// `rtsp://my.ip.address:8554/Garage/subStream` +/// +/// # Usage +/// +/// To start the subcommand use the following in a shell. +/// +/// ```bash +/// neolink rtsp --config=config.toml +/// ``` +/// use gio::TlsAuthenticationMode; use log::*; use neolink_core::bc_protocol::BcCamera; diff --git a/src/statusled/mod.rs b/src/statusled/mod.rs index 267d1ef..03572c5 100644 --- a/src/statusled/mod.rs +++ b/src/statusled/mod.rs @@ -3,6 +3,18 @@ /// /// This module handles the controls of the blue led status light /// +/// The subcommand attepts to set the LED status light not the IR +/// lights or the flood lights. +/// +/// # Usage +/// +/// ```bash +/// # To turn the light on +/// neolink status-light --config=config.toml CameraName on +/// # Or off +/// neolink status-light --config=config.toml CameraName off +/// ``` +/// use log::*; use neolink_core::bc_protocol::BcCamera; use std::fs;