11.. _pub_edgeai_configuration :
22
3- ========================
3+ ########################
44Configuring applications
5- ========================
5+ ########################
66
77The demo config file uses YAML format to define input sources, models, outputs
8- and finally the flows which defines how everything is connected. Config files
9- for out-of-box demos are kept in :file: `edgeai-gst-apps/configs ` folder. The
10- folder contains config files for all the use cases and also multi-input and
8+ and finally the flows, which define how components connect to each other. The
9+ :file: `edgeai-gst-apps/configs ` directory has the config files for out-of-box demos.
10+ The folder has config files for all the use cases and also multi-input and
1111multi-inference case. The folder also has a template YAML file
12- :file: `app_config_template.yaml ` which has detailed explanation of all the
12+ :file: `app_config_template.yaml `, which has detailed explanation of all the
1313parameters supported in the config file.
1414
1515Config file is divided in 4 sections:
@@ -19,8 +19,9 @@ Config file is divided in 4 sections:
1919#. Outputs
2020#. Flows
2121
22+ ******
2223Inputs
23- ======
24+ ******
2425
2526The input section defines a list of supported inputs like camera, video files etc.
2627Their properties like shown below.
@@ -55,7 +56,7 @@ Below are the details of most commonly used inputs.
5556.. _pub_edgeai_camera_sources :
5657
5758Camera sources (v4l2)
58- ---------------------
59+ =====================
5960
6061**v4l2src ** GStreamer element is used to capture frames from camera sources
6162which are exposed as v4l2 devices. In Linux, there are many devices which are
@@ -79,9 +80,8 @@ and prints the detail like below in the console:
7980
8081 script can also be run manually later to get the camera details.
8182
82- From the above log we can determine that 1 USB camera is connected
83- (:file: `/dev/video-usb-cam0 `), and 1 CSI camera is connected (:file: `/dev/video-imx219-cam0 `) which is IMX219 raw
84- sensor and needs ISP.
83+ The console shows one USB camera at :file: `/dev/video-usb-cam0 ` and
84+ one CSI camera at :file: `/dev/video-imx219-cam0 ` (an IMX219 raw sensor that requires ISP)
8585
8686Using this method, you can configure correct device for camera capture in the
8787input section of config file.
@@ -109,10 +109,10 @@ camera to allow GStreamer to negotiate the format. ``rggb`` for sensor
109109that needs ISP.
110110
111111Video sources
112- -------------
112+ =============
113113
114114H.264 and H.265 encoded videos can be provided as input sources to the demos.
115- Sample video files are provided under :file: `/opt/edgeai-test-data/videos/ `
115+ The :file: `/opt/edgeai-test-data/videos/ ` directory has sample video files.
116116
117117.. code-block :: yaml
118118
@@ -135,12 +135,11 @@ By default the format is set to ``auto`` which will then use the GStreamer
135135bin ``decodebin `` instead.
136136
137137Image sources
138- -------------
138+ =============
139139
140- JPEG compressed images can be provided as inputs to the demos. A sample set of
141- images are provided under :file: `/opt/edgeai-test-data/images `. The names of the
142- files are numbered sequentially and incrementally and the demo plays the files
143- at the fps specified by the user.
140+ The demos accept JPEG-compressed images as inputs. The :file: `/opt/edgeai-test-data/images `
141+ directory has sample images. The filenames use sequential numbering, and the demo plays them
142+ at the user‑specified frame rate.
144143
145144.. code-block :: yaml
146145
@@ -152,7 +151,7 @@ at the fps specified by the user.
152151 framerate : 1
153152
154153 RTSP sources
155- ------------
154+ ============
156155
157156H.264 encoded video streams either coming from a RTSP compliant IP camera or
158157via RTSP server running on a remote PC can be provided as inputs to the demo.
@@ -165,8 +164,9 @@ via RTSP server running on a remote PC can be provided as inputs to the demo.
165164 height : 720
166165 framerate : 30
167166
167+ ******
168168Models
169- ======
169+ ******
170170
171171The model section defines a list of models that are used in the demo. Path to
172172the model directory is a required argument for each model and rest are optional
@@ -200,9 +200,9 @@ Below are some of the use case specific properties:
200200The content of the model directory and its structure is discussed in detail in
201201:ref: `pub_edgeai_import_custom_models `
202202
203-
203+ *******
204204Outputs
205- =======
205+ *******
206206
207207The output section defines a list of supported outputs.
208208
@@ -239,7 +239,7 @@ All supported outputs are listed in template config file.
239239Below are the details of most commonly used outputs
240240
241241Display sink (kmssink)
242- ----------------------
242+ ======================
243243
244244When you have only one display connected to the SK, kmssink will try to use
245245it for displaying the output buffers. In case you have connected multiple
@@ -261,7 +261,7 @@ Following command finds out the connected displays available to use.
261261 Configure the required connector ID in the output section of the config file.
262262
263263Video sinks
264- -----------
264+ ===========
265265The post-processed outputs can be encoded in H.264 format and stored on disk.
266266Please specify the location of the video file in the configuration file.
267267
@@ -273,7 +273,7 @@ Please specify the location of the video file in the configuration file.
273273 height : 1080
274274
275275 Image sinks
276- -----------
276+ ===========
277277The post-processed outputs can be stored as JPEG compressed images.
278278Please specify the location of the image files in the configuration file.
279279The images will be named sequentially and incrementally as shown.
@@ -286,7 +286,7 @@ The images will be named sequentially and incrementally as shown.
286286 height : 1080
287287
288288 Remote sinks
289- ------------
289+ ============
290290Post-processed frames can be encoded as jpeg or h264 frames and send as udp packets
291291to a port. Please specify the sink as remote in the configuration file. The udp port and
292292host to send packets to can be defined. If not, default port is 8081 and host
@@ -302,17 +302,16 @@ is 127.0.0.1.
302302 host : 127.0.0.1
303303 encoding : jpeg # (jpeg or h264)
304304
305- A NodeJS server is provided under :file: `/opt/edgeai-gst-apps/scripts/remote_streaming `
306- which establishes a node server on the target and listens to the udp port (8081)
307- on localhost (127.0.0.1) and can be used to view the frames remotely.
305+ The EdgeAI filesystem includes a Node.js server at :file: `/opt/edgeai-gst-apps/scripts/remote_streaming `.
306+ The server starts a local UDP listener on localhost (127.0.0.1) port 8081 and streams frames for remote viewing.
308307
309308.. code-block :: bash
310309
311310 /opt/edgeai-gst-apps# node scripts/remote_streaming/server.js
312311
313-
312+ *****
314313Flows
315- =====
314+ *****
316315
317316The flows section defines how inputs, models and outputs are connected.
318317Multiple flows can be defined to achieve multi input, multi inference as shown
@@ -338,17 +337,15 @@ for optimization. Along with input, models and outputs it is required to define
338337plane. This is needed because multiple inference outputs can be rendered to same
339338output (Ex: Display).
340339
341-
342340GStreamer plugins
343341=================
344342
345343The edgeai-gst-apps essentially constructs GStreamer pipelines for dataflow.
346344This pipeline is constructed optimally and dynamically based on a pool of
347- specific plugins available on the platform. The defined pool of plugins for
348- different platform can be found in :file: `edgeai-gst-apps/configs/gst_plugin_maps.yaml `
349- file.
345+ specific plugins available on the platform. See :file: `edgeai-gst-apps/configs/gst_plugin_maps.yaml `
346+ for the pool of plugins defined per platform.
350347
351- This file contains the plugin used for certain task and the property of plugin
348+ This file has the plugin used for certain task and the property of plugin
352349(if applicable).
353350
354351Default GStreamer plugins map for |__PART_FAMILY_NAME__ |
0 commit comments