README update

Author: QuantumEntangledAndy

.github/workflows/build.yml

@@ -261,7 +261,7 @@ jobs:
         id: toml
         run: |
           NEOLINK_VERSION="$(toml get Cargo.toml  package.version | sed 's|"||g')"
-          echo "version=${NEOLINK_VERSION}"  >> $GITHUB_OUTPUT 
+          echo "version=${NEOLINK_VERSION}"  >> $GITHUB_OUTPUT
       - name: Download Windows
         uses: actions/download-artifact@v3
         with:

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/doublify/pre-commit-rust
+    rev: eeee35a
+    hooks:
+    -   id: fmt
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0  # Use the ref you want to point at
+    hooks:
+    -   id: trailing-whitespace
+    -   id: check-case-conflict
+    -   id: check-merge-conflict
+    -   id: check-toml
+    -   id: mixed-line-ending
+

README.md

@@ -51,6 +51,7 @@ sudo apt install \
   libgstrtspserver-1.0-0 \
   libgstreamer1.0-0 \
   libgstreamer-plugins-bad1.0-0 \
+  gstreamer1.0-plugins-base \
   gstreamer1.0-plugins-good \
   gstreamer1.0-plugins-bad
 ```
@@ -102,7 +103,7 @@ The IP is discovered with four methods
 
 1. Local discovery: Here we send a broadcast on all visible networks asking the local
    network if there is a camera with this UID. This only works if the network supports broadcasts
-   
+
    If you know the ip address you can put it into the  `address` field of the config and attempt a
    direct connection without broadcasts. This requires a route from neolink to the camera.
 
@@ -115,9 +116,9 @@ The IP is discovered with four methods
    Once the camera either polls/recives a connect request from the reolink servers the camera will then
    initiate a connect to neolink. This requires that our IP and the reolink IPs are reacable from the camera.
 
-4. Relay: In this case we request that reolink relay our connection. Neolink nor the camera need to be able to 
+4. Relay: In this case we request that reolink relay our connection. Neolink nor the camera need to be able to
    direcly contact each other. But both neolink and the camera need to be able to contact reolink.
-   
+
 This can be controlled with the config
 
 ```toml
@@ -188,7 +189,6 @@ uid = "ABCDEF0123456789"
   [cameras.pause]
   on_motion = true # Should pause when no motion
   on_client = true # Should pause when no rtsp client
-  mode = "none"  # What to do when paused values are: none, black, still, test
   timeout = 2.1 # How long to wait after motion stops before pausing
 ```
 

docs/Setting Up Neolink For Use With Blue Iris.md

@@ -47,23 +47,23 @@ The config file tells Neolink how to connect to your camera and serve the video
 1. Create a simple text file (i.g. `config.toml`) in the same directory you have unpacked Neolink with the following format:
 
         bind = "0.0.0.0"
-        
+
         [[cameras]]
         name = "cameraname"
         username = "admin"
         password = "password"
         address = "192.168.1.10:9000"
         stream = "both"
-    
+
 2. Change `cameraname` to a legible, phonetic name that describes your camera. Leave the quotes around the name.
 
 3. The default username is `admin`; leave this unless you've created another user.
 
 4. Replace `password` with the password you set on the camera. If you chose to not use a password, remove this line from the config file. Again, leave the quotes.
 
-5. Replace `192.168.1.10:9000` with the IP address you set for your camera. 
+5. Replace `192.168.1.10:9000` with the IP address you set for your camera.
     Note: The port, `:9000`, should remain at the end of your IP address. This is the proprietary "media port" that Reolink uses.
-    
+
 6. The `stream` line allows you to choose which stream type to use. Neolink supports streaming two streams, the main-stream, and the sub-stream. It can stream either one, or both. If you wish to stream both streams, leave this line as is. If you wish to stream _only_ the main-stream, change `both` to `mainStream`. If you wish to stream only the sub-stream, change `both` to `subStream`.
 
     Note: Reolink D400/B400 Cameras **_do not support serving both streams at once_**, so you must manually choose which stream type to use. For best quality, choose the main stream.
@@ -190,7 +190,7 @@ _The best way to have Neolink run at startup is create a Scheduled Task that sta
 
    12. Check "If the task fails, restart every:"
 
-   13. For redundancy, enter `999` into the number of restart tries. 
+   13. For redundancy, enter `999` into the number of restart tries.
 
        _The Settings tab should look something like this:_
 

sample_config.toml

@@ -67,7 +67,7 @@ address = "192.168.1.187:9000"
 #
 # By default we hide these status messages from the user but you can instead requst that
 # they be printed to stdout using print_format
-# 
+#
 # Valid values are:
 # - None
 # - Human