Skip to content

Commit

Permalink
Notice from upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
QuantumEntangledAndy committed Aug 2, 2024
1 parent 99146a8 commit b0e009b
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# Development has moved

Neolink is now maintained at https://github.com/QuantumEntangledAndy/neolink as I no longer have time to dedicate to development.
Please direct your thanks and bug reports over there!

# Neolink

![CI](https://github.com/QuantumEntangledAndy/neolink/workflows/CI/badge.svg)
Expand Down Expand Up @@ -41,7 +36,7 @@ features not yet in upstream master.
- Protocol more closely follows official reolink format
- Possibly can handle more simulatenous connections
- More ways to connect to the camera. Including Relaying through reolink
servers
servers
- Camera battery levels can be displayed in the log

## Installation
Expand Down Expand Up @@ -72,9 +67,10 @@ sudo apt install \
```

- **Windows**: You may also need to
[install openssl](https://wiki.openssl.org/index.php/Binaries)
[install openssl](https://wiki.openssl.org/index.php/Binaries)
- **Macos**: You may also need to
[install openssl](https://wiki.openssl.org/index.php/Binaries) or `brew install [email protected]`
[install openssl](https://wiki.openssl.org/index.php/Binaries) or
`brew install [email protected]`
- **Ubuntu/Debian**: Install the `libssl` package

Make a config file see below.
Expand Down Expand Up @@ -119,7 +115,7 @@ using the terminal in the same folder the neolink binary is in.
### Discovery

To connect to a camera using a UID we need to find the IP address of the camera
with that UID
with that UID

The IP is discovered with four methods

Expand Down Expand Up @@ -254,15 +250,15 @@ Status Messages:
there will be no `/status/preview` message. Only published when
`enable_preview` is true in the config
- `/status/floodlight_tasks` The current status of the floodlight tasks
used updated every 2s by default
used updated every 2s by default

Query Messages:

- `/query/battery` Request that the camera reports its battery level
- `/query/pir` Request that the camera reports its pir status
- `/query/ptz/preset` Request that the camera reports its PTZ presets
- `/query/preview` Request that the camera post a base64 encoded jpeg
of the stream to `/status/preview` now, ignoring the timer
of the stream to `/status/preview` now, ignoring the timer

### Controlling RTSP from MQTT

Expand Down Expand Up @@ -461,8 +457,11 @@ docker pull quantumentangledandy/neolink
# network=host, notably macos lacks this option.
docker run --network host --volume=$PWD/config.toml:/etc/neolink.toml quantumentangledandy/neolink
```
#### Environmental Variables
There are currently 2 environmental variables available as part of the container:

#### Environmental Variables

There are currently 2 environmental variables available as part of the container:

- `NEO_LINK_MODE`: defaults to `"rtsp"` if not set, other options are "mqtt" or "mqtt-rtsp".
- `NEO_LINK_PORT`: defaults to `8554`, set this to your required port value.

Expand Down

0 comments on commit b0e009b

Please sign in to comment.