diff --git a/docs/Setting Up Neolink For Use With Blue Iris.md b/docs/Setting Up Neolink For Use With Blue Iris.md index 8bbfc52..da9fe39 100644 --- a/docs/Setting Up Neolink For Use With Blue Iris.md +++ b/docs/Setting Up Neolink For Use With Blue Iris.md @@ -4,6 +4,7 @@ Stock Reolink cameras do not support use with non-proprietary surveillance softw **This guide applies to the following camera models:** - B800/D800 +- B400/D400 - E1 @@ -65,13 +66,22 @@ The config file tells Neolink how to connect to your camera and serve the video 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. 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. + 7. For multiple cameras, copy and paste the entire `[[cameras]]` block below the first. Each camera entry must begin with `[[cameras]]`. +Note: For **E1 Cameras**, refer to [the readme](https://github.com/thirtythreeforty/neolink/#configuration) for instructions on adding the `format =` line. This configuration will be done automatically in the future. + ### 3. Start Neolink 1. Open a command prompt in the directory that contains Neolink and your config file. 2. Run the following command (with your correct config file name): @@ -80,7 +90,7 @@ The config file tells Neolink how to connect to your camera and serve the video You should get login messages that look something like this: -![Login Messages](docs/screenshots/login_messages.JPG) +![Login Messages](screenshots/login_messages.JPG) Note: Neolink hosts all streams on localhost port 8554. Each camera has a designated path for the sub-stream and the main-stream. Neolink gets the name of the path from the name of the camera you set in the config file. So the path to the sample camera's main-stream would be `127.0.0.1:8554/cameraname/mainStream` and the path to the sample camera's sub-stream would be `127.0.0.1:8554/cameraname/subStream`. @@ -97,7 +107,7 @@ _There are a few tricks to getting Blue Iris to work properly with Neolink's RTS 3. Uncheck "Enable Motion Detector." 4. Enable "Direct to disc recording." -![New Camera Window](docs/screenshots/new_camera.JPG) +![New Camera Window](screenshots/new_camera.JPG) 5. Click "OK." @@ -120,6 +130,87 @@ _Once you click "OK" on the "New Camera" window, Blue Iris should dump you direc 7. Click "OK." -![](docs/screenshots/new_camera_config.JPG) +![](screenshots/new_camera_config.JPG) **Congrats, you have set up your first camera!** + +## Step Four: Run Everything at Startup + +_In the future, Neolink will support being a Windows Service. For now, you must manually set up Neolink to run at startup._ + +### 1. Enable Blue Iris as a Windows service + +_Blue Iris natively supports running as a Windows service._ + +1. In Blue Iris, click the "Main Menu" button, then click "Settings/Info." +2. In the "Startup" tab, under "Operating System," check "Run as a Windows Service (no UI, run again for console)." +3. Type in the username and password. +4. Once you click OK, you should see a popup window that says "Service has been installed..." + +5. Restart Blue Iris or your computer to start the Blue Iris service. + +### 2. Create a Scheduled Task that starts Neolink + +_The best way to have Neolink run at startup is create a Scheduled Task that starts the Neolink process at computer startup._ + +1. Create a simple bash file that starts Neolink. + + _For the Task Scheduler to successfully start Neolink, you must run the start commands in the same directory that contains Neolink and its config files. This is best accomplished by creating a bash file that "changes directories" to the directory that contains Neolink._ + 1. Navigate in Windows Explorer to the directory in which you placed Neolink and its config files. + + 2. Create a file with a `.cmd` file extension (e.g. `neolink.cmd`). + + _Note: You may need to create a text (`.txt`) file and run `ren neolink.txt neolink.cmd` in a command prompt to obtain the correct file extension._ + + 3. Edit the file. Copy the commands below, changing your respective directories and file names. + + `cd C:\Path\to\Neolink\Folder` + + `neolink --config config.toml` + + 4. Save the file and run it. Make sure Neolink successfully starts. + +2. Create Scheduled Task + + 1. Open the Task Scheduler + + 2. In the "Actions" pane, click "Create Basic Task." + + 3. Name and describe the task and click "Next." + + 4. Select "When the Computer Starts" in the trigger settings. Click "Next." + + 5. Select "Start a Program" in the action settings. Click "Next." + + 6. Under "Program/script:," navigate to the `.cmd` file that you created and select it. Click "Next." + + 7. Check "Open the properties dialog for this task when I click finish." Click "Finish." + + _Your Finish windows should look something like this:_ + + ![](screenshots/taskfinishwindow.JPG) + + 8. In the "Properties" window, in the "General" tab, select "Run whether or not the User is logged on." + + 9. Also check "Run with highest privileges." + + 10. In the "Settings tab," **_uncheck "Stop the task if it is running longer than:"_** + + 11. Check "Run Task as soon as possible..." + + 12. Check "If the task fails, restart every:" + + 13. For redundancy, enter `999` into the number of restart tries. + + _The Settings tab should look something like this:_ + + ![](screenshots/tasksettingstab.JPG) + + 14. In the "Conditions" tab, you may want to uncheck "Start the task only if the computer is on AC Power." + 15. You may also want to check "Start only if the following network connection is available." This may prevent Neolink from retrying to connect many times if your computer takes a long time to connect to its network. + + 16. Click "OK," and enter the Username and Password. + +### 3. Test everything. + +You have now completed all the setup steps! Restart your computer and check if all the programs start as desired. \ No newline at end of file diff --git a/docs/screenshots/taskfinishwindow.JPG b/docs/screenshots/taskfinishwindow.JPG new file mode 100644 index 0000000..1291545 Binary files /dev/null and b/docs/screenshots/taskfinishwindow.JPG differ diff --git a/docs/screenshots/tasksettingstab.JPG b/docs/screenshots/tasksettingstab.JPG new file mode 100644 index 0000000..b375dd6 Binary files /dev/null and b/docs/screenshots/tasksettingstab.JPG differ