Skip to content

Configuration

gtxaspec edited this page Mar 26, 2024 · 5 revisions

Configuration

This document provides an in-depth explanation of all configuration options available in the Prudynt streamer. Each option allows for customization to best fit your device's requirements.


General Settings

loglevel

Default: "INFO"
Options: DEBUG, INFO, WARNING, ERROR
Description: Sets the logging level for system operation. Adjust this setting based on the amount of detail you require in logs.


RTSP (Real-Time Streaming Protocol) Settings

port

Default: 554
Description: The port number on which the RTSP service will run.

name

Default: "thingino prudynt"
Description: Descriptive name for the RTSP service, visible in network discovery.

est_bitrate

Default: 5000 (kbps)
Description: Estimated bitrate for RTSP streaming, adjusting this can affect stream quality.

out_buffer_size

Default: 500000 (bytes)
Description: Output buffer size for RTSP streaming, impacting how much data can be buffered before transmission.

send_buffer_size

Default: 307200 (bytes)
Description: Send buffer size for RTSP streaming, affecting the throughput of data sending.

auth_required

Default: true
Description: Enable or disable authentication for the RTSP stream.

username

Default: "thingino"
Description: Username for RTSP authentication if enabled.

password

Default: "thingino"
Description: Password for RTSP authentication if enabled.


Sensor Settings

model

Default: "gc2053"
Description: Model of the camera sensor.

i2c_address

Default: 0x37
Description: I2C address of the camera sensor.

fps

Default: 24
Description: Frames per second captured by the sensor.

width

Default: 1920 (pixels)
Description: Width of the sensor's captured image.

height

Default: 1080 (pixels)
Description: Height of the sensor's captured image.


Stream0 Settings

rtsp_endpoint

Default: "ch0"
Description: Endpoint name for the RTSP URL stream.

format

Default: "H264"
Options: H264, H265
Description: Video format for the stream.

bitrate

Default: 1000 (kbps)
Description: Bitrate for the video stream.

width

Default: 1920 (pixels)
Description: Width of the video stream.

height

Default: 1080 (pixels)
Description: Height of the video stream.

buffers

Default: 2
Description: Number of buffers allocated for the stream.

fps

Default: 24
Description: Frames per second for the video stream.

gop

Default: 30
Description: Group of Pictures size, important for video compression.

max_gop

Default: 60
Description: Maximum Group of Pictures size for the video stream.

osd_pos_x

Default: 10
Description: X position (in pixels) for the On-Screen Display.

osd_pos_y

Default: 10
Description: Y position (in pixels) for the On-Screen Display.

osd_pos_user_text_x

Default: 900
Description: X position (in pixels) for user-defined text in the OSD.

osd_pos_user_text_y

Default: 5
Description: Y position (in pixels) for user-defined text in the OSD.

osd_pos_uptime_x

Default: 1600
Description: X position (in pixels) for the uptime display in the OSD.

osd_pos_uptime_y

Default: 5
Description: Y position (in pixels) for the uptime display in the OSD.

osd_pos_logo_x

Default: 1800
Description: X position (in pixels) for the logo in the OSD.

osd_pos_logo_y

Default: 1030
Description: Y position (in pixels) for the logo in the OSD.

rotation

Default: 0
Options: 0 (no rotation), 1 (90 degrees), 2 (270 degrees)
Description: Software Rotation of the video stream. ** Rotation is ONLY supported on T31 **

scale_enabled

Default: false
Description: Enable or disable scaling of the video stream.
Scale height and width should be equal to the stream height and width set above.

scale_width

Default: 640 (pixels)
Description: Width of the scaled video stream.

scale_height

Default: 360 (pixels)
Description: Height of the scaled video stream.


Stream1 Settings (JPEG snapshots)

jpeg_enabled

Default: true
Description: Enable or disable JPEG snapshots for Stream1.

jpeg_path

Default: "/tmp/snapshot.jpg"
Description: File path where JPEG snapshots are saved.

jpeg_quality

Default: 75
Description: Quality of JPEG snapshots (range 1-100).

jpeg_refresh

Default: 1000 (milliseconds)
Description: Interval at which JPEG snapshots are refreshed.


On-Screen Display (OSD) Settings

enabled

Default: true
Description: Enable or disable the On-Screen Display (OSD).

font_path

Default: "/usr/share/fonts/UbuntuMono-Regular2.ttf"
Description: Path to the font file used for OSD text.

font_size

Default: 64
Description: Font size used for OSD text.

font_color

Default: 0xFFFFFFFF
Description: Font color for OSD text in ARGB format.

font_stroke_enabled

Default: true
Description: Enable or disable a stroke (outline) for OSD text.

font_stroke_size

Default: 64
Description: Size of the stroke around OSD text.

font_stroke_color

Default: 0xFF000000
Description: Color of the stroke around OSD text in ARGB format.

time_enabled

Default: true
Description: Enable or disable the time display in the OSD.

time_format

Default: "%I:%M:%S%p %m/%d/%Y"
Description: Format string used for displaying time in the OSD.

user_text_enabled

Default: true
Description: Enable or disable the display of custom user text in the OSD.

user_text_string

Default: "thingino"
Description: Custom text to be displayed in the OSD.

uptime_display_enabled

Default: true
Description: Enable or disable the display of system uptime in the OSD.

uptime_display_format

Default: "Uptime: %02lu:%02lu:%02lu"
Description: Format string used for displaying system uptime in the OSD.

logo_enabled

Default: true
Description: Enable or disable the display of a logo image in the OSD.

logo_path

Default: "/usr/share/thingino_logo_1.bgra"
Description: Path to the logo image file used in the OSD.

logo_width

Default: 100 (pixels)
Description: Width of the logo image displayed in the OSD.
Must be specified for the logo to be correctly displayed

logo_height

Default: 30 (pixels)
Description: Height of the logo image displayed in the OSD.
Must be specified for the logo to be correctly displayed


Motion Detection Settings

enabled

Default: false
Description: Enable or disable motion detection feature.

script_path

Default: "/usr/sbin/motion.sh"
Description: Path to the script executed when motion is detected.

debounce_time

Default: 0 (seconds)
Description: Time to wait before re-triggering motion detection (debounce period).

post_time

Default: 0 (seconds)
Description: Time to continue recording after motion detection stops.

cooldown_time

Default: 5 (seconds)
Description: Time to wait after a motion event before detecting new motion events.

init_time

Default: 5 (seconds)
Description: Time for the motion detection system to initialize at startup.

sensitivity

Default: 1
Description: Sensitivity level for motion detection.

skip_frame_count

Default: 5
Description: Number of frames to skip for motion detection (reduces CPU load).

frame_width

Default: 1920 (pixels)
Description: Width of the frame used for motion detection.

frame_height

Default: 1080 (pixels)
Description: Height of the frame used for motion detection.

roi_0_x, roi_0_y, roi_1_x, roi_1_y

Defaults: 0, 0, 1920, 1080
Description: Coordinates defining the Region Of Interest (ROI) for motion detection. ROI_0 defines the top-left corner, ROI_1 defines the bottom-right corner.

roi_count

Default: 1
Description: Number of active Regions Of Interest (ROI) for motion detection.