eospi / rtsp

RTSP Url paths for cameras and NVRs

rtsp

This repo contains RTSP url paths for cameras and NVRs.

The OUI (Organization Unique Identifier) of the MAC address is used to help narrow the list of candidate camera/NVR models when scanning the local network for devices. Even though multiple manufacturers may share the same OUI, because they use the same supplier of network interface cards/chipsets, the use of the OUI makes scanning faster.

Fields

Field	Description	Required
company	The name of the company associated with the OUI (Organization Unique Identifier) of the MAC address	required
type	camera for standalone IP cameras, or nvr for Network Video Recorders	required
model	The model name	required
oui_regex	The regular expression that matches the OUI of the MAC Address. It's OK to assume uppercase only with colon separators like (00:80:F0)	required
rtsp_url	The full url that reaches the H.264 RTSP video stream	required
stream_name_template	A user-facing description of a particular stream_number	optional
video_encoding	H.264 and MPEG4 are the only encodings currently	required
port	The default network port of the RTSP stream, typically 554	optional
min_stream_number	The lowest channel/stream number (e.g. 0 or 1)	optional
max_stream_number	The highest channel/stream number (e.g. 15 or 16)	optional
low_res_stream_number	The stream_number with the preferred low-bandwidth encoding	optional
high_res_stream_number	The stream_number with the preferred hi-bandwidth encoding	optional
username	The factory-default username	optional
password	The factory-default password	optional
user_manual_url	The url for the latest User Manual	optional

Field Template Variables

The paths.csv file uses mustache syntax to connote variable values in each field. The current variables recognized include:

Variable	Description
ip_address	The local network IP address like 192.168.1.37
username	The value supplied in the username field
password	The value supplied in the password field
port	The value supplied in the port field
stream_number	The channel/stream number like 0, 1,... 31
#base64	The start of a segment that must be Base64 encoded. For example, {{#base64}}encode this{{/base64}} will Base64 encode the portion encode this.

Pull Requests

Ideally, test all submissions prior to submitting Pull Requests:

1. Use VLC to open the rtsp_url using the default values specified by username, password and port. For example, the tested url path would look like rtsp://admin:1234@192.168.1.26:554/live/ch1 for rtsp_url for the rtsp_url template rtsp://{{username}}:{{password}}@{{ip_address}}:{{port}}/live/ch{{stream_number}}.
2. Create a branch to edit the paths.csv.
3. Submit a Pull Request for the master branch.