From df8c02cd7badbc82c74e4f0d8f8c1fbfe09f48ea Mon Sep 17 00:00:00 2001 From: George Hilliard Date: Thu, 26 Aug 2021 00:25:28 -0500 Subject: [PATCH] Reorganize readme (#201) * Reorganize readme Remove obsolete note about format, and move usage info to the top. * Add the bash tag in the readme Co-authored-by: Andrew King --- README.md | 69 ++++++++++++++++++++++++++----------------------------- 1 file changed, 32 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index e3f239d..d35c082 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,38 @@ Currently it has been tested on the following cameras: Neolink does not support other cameras such as the RLC-420, since they already [provide native RTSP](https://support.reolink.com/hc/en-us/articles/360007010473-How-to-Live-View-Reolink-Cameras-via-VLC-Media-Player). -## Installation +## Usage + +1. First, write a configuration yaml file describing your cameras. See the +Configuration section below or the provided sample config. + +2. Launch Neolink: +```bash +neolink rtsp --config=your_config.yaml + +3. Then, connect your RTSP viewer to `rtsp://127.0.0.1:8554/your_camera_name`! + +### Additional commands + +Neolink also has some additional command line tools +for controlling the camera. They are all used through neolink subcommands like this: + +```bash +neolink subcommand --config=... +``` + +The currently supported subcommands are + +- **rtsp**: The standard neolink rtsp bridge +- **status-light**: Control the LED status light +- **reboot**: Reboot a camera +- **talk**: Enable talk back through either the microphone or by + reading a sound file. + +For a full list of commands use `neolink help`, or use +`neolink help ` for details on a subcommand of interest. + +## Download & Installation In the future Neolink will be much easier to install. For now, follow these steps. @@ -159,11 +190,6 @@ path you should connect your client to. Currently Neolink cannot auto-detect cameras like the official clients do; you must specify their IP addresses directly. -By default the H265 video format is used. Some cameras, for example E1, provide -H264 streams. To use these you must specify `format = "h264"` in the -`[[cameras]]` config. Soon this will be auto-detected, and you will not have to know or care about -the format. - By default, the HD stream is available at the RTSP path `/name` or `/name/mainStream`, and the SD stream is available at `/name/subStream`. You can use only the HD stream by adding `stream = "mainStream"` to the @@ -295,37 +321,6 @@ Currently the dissector does not attempt to decode the Baichuan "extension" messages except `binaryData`. This will change in the future as reverse engineering needs require. -## Additional Commands - -Neolink also has some additional command line tools -for controlling the camera. They are all used through neolink subcommands like this: - - -```bash -neolink subcommand --config=... -``` - -The currently supported subcommands are - -- **rtsp**: The standard neolink rtsp bridge -- **status-light**: A command to control the LED status light -- **reboot**: Will reboot a camera -- **talk**: Will enable talk back through either the microphone or by - reading a sound file. - -For a full list of commands please use - -```bash -neolink help -``` - -For further details on the subcommands please use the following -where `` is replaced with the subcommand of interest - -```bash -neolink help -``` - ## License Neolink is free software, released under the GNU Affero General Public License