Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Compare: Image Pipe Daemon 1.1

Showing with 132 additions and 1 deletion.
  1. +132 −1 Image-Pipe-Daemon-1.1.mediawiki
View
133 Image-Pipe-Daemon-1.1.mediawiki
@@ -81,4 +81,135 @@ Ipipe-client's command is init-aew
;Stop aew
Ends the automatic adjustments, free all the memory located for the librraew usage.
-Ipipe-client's command is stop-aew
+Ipipe-client's command is stop-aew
+
+==Usage==
+=== Running Ipiped ===
+Ipiped must run in background. If you are using RidgeRun's SDK and enabled ipiped it will be setup to start automatically when the system boots.
+<pre>
+ ipiped &
+</pre>
+
+Ipiped registers with D-Bus and waits until ipipe-client or other application requests to execute a method.
+
+If you already have an ipiped running, you will get the error
+<pre>
+Ipiped: Failed to obtain primary ownership of the service
+This usually means there is another instance of ipiped already running
+</pre>
+
+If you enabled ipiped on RidgeRun's SDK you can stop the ipiped server by writing:
+<pre>
+/etc/init.d/ipiped stop
+</pre>
+
+=== Ipipe-client: command line application ===
+Ipipe-client is a Dbus client that use commands to invoke methods of the ipiped, so ipiped must be running to use ipipe-client. A command can required arguments depending of the functionality. Ipipe-client has two operation modes, you can ask to execute a single command or you can open an interactive console to execute a group of commands.
+
+To execute a single command, you can use the following command line syntax
+<pre>
+ ipipe-client <command> <argument 1> ... <argument n>
+</pre>
+
+To get into the interactive console, you have to run ipipe-client without any command. Then to execute a command you only need to use the command and the required arguments.
+<pre>
+ipipe-client
+ipipe-client$ <command 1> <argument 1> ... <argument n>
+ipipe-client$ <command 2> <argument 1> ... <argument n>
+</pre>
+To quit the interactive console you can use quit or exit.
+
+In order to know the commands that are available run:
+<pre>
+ipipe-client help
+</pre>
+or get into the interactive console and execute help.
+
+<pre>
+ipipe-client help
+
+COMMANDS supported:
+Request the syntax of an specific command with "help [command]".
+This is the list of supported commands:
+
+Command Description
+
+help Displays the help text for all the possible commands or a specific command.
+set-debug Enable/Disable debug messages.
+shell Execute a shell command(shell_cmd) using interactive console.
+ping Show if ipipe-daemon is alive.
+quit Quit from the interactive console.
+exit Exit from the interactive console.
+get-video-processor Show the video processor that is being used.
+get-sensor Show the sensor that is being used.
+run-config-script Execute a group of ipipe-client commands.
+set-awb Set the configuration of auto white balance(awb).
+set-ae Set the configuration of auto exposure.
+init-aew Initialize aew algorithms.
+stop-aew End aew algorithm.
+get-awb-config Get auto white balance current configuration.
+get-ae-config Get auto exposure current configuration.
+get-aew-config Get aew current status and configuration.
+get-rectangle Get current rectangle coordinates.
+set-previewer-mode Configure previewer on continuous or one-shot mode.
+set-bayer-pattern Sets R/Gr/Gb/B color pattern to the previewer.
+set-digital-gain Sets red (R), green (G) and blue gains (G) on the ipipe.
+get-digital-gain Returns the gain value for each color component(RGB).
+set-luminance Brightness(Br) and contrast(C) adjustment.
+get-luminance Returns the value of the Brightness(Br) and contrast(C) adjustment.
+flip-vertical Flips the image vertically(on the sensor).
+flip-horizontal Flips the image horizontally (on the sensor).
+set-exposure Sets the effective shutter time of the sensor for the light integration.
+get-exposure Gets the exposure time of the sensor in us.
+set-sensor-gain Sets red(R), green(G) and blue(B) gain directly on the sensor.
+get-sensor-gain Gets sensor red(R), green(G) and blue(B).
+</pre>
+
+If you want more detailed information about a command execute:
+<pre>
+ipipe-client help <command>
+</pre>
+
+ipipe-client includes the command run-config-script that is capable of running a group of ipipe-client's commands. This command is useful when you run a repetitive group of commands.
+<pre>
+ipipe-client run-config-script <script>
+</pre>
+This command is going to execute the commands that are indicated in the file (script) you pass as parameter. For example RidgeRun's sdk includes two ipipe-client's scripts: dm365_mt9p011_config and dm365_mt9p031_config. These files contains the commands that chain the ipipe, define the image orientation and the corresponding Bayer pattern for the mt9p11 or mt9p031 sensors.
+<pre>
+ipipe-client run-config-script dm365_mt9p031_config
+</pre>
+The scripts must be installed on the path /usr/share/ipiped/
+
+=== Controlling librraew ===
+
+In order to get the automatic adjustments running, first you should configure the auto white balance and the auto exposure using set-awb and set-ae, respectively.
+
+General format:
+<pre>
+ipipe-client set-awb algorithm [gain]
+ipipe-client set-ae algorithm metering [rect_percentage] [xrect] [yrect]
+</pre>
+
+Then run init-aew to establish the automatic adjustments loop. If auto white balance and auto exposure aren't configured before you run init-aew, none adjustment will be made but the rraew will be in a loop taking image's statistics.
+
+<pre>
+ipipe-client init-aew time<us> width height segmentation
+</pre>
+When you want to stop the automatic adjustments you can run stop-aew.
+<pre>
+stop-aew
+</pre>
+You can run set-awb and set-ae whenever you want, but the changes in the configuration will be applied until you run init-aew. If you want to change the rraew's configuration you can re-run init-aew and the current rraew instance will be automatically closed and a new instance will be created. So you don't need to run the command stop-aew.
+
+Example:
+Once your board has started, run the following commands:
+<pre>
+ipipe-client set-previewer-mode cont
+ipipe-client set-awb gray-world digital
+ipipe-client set-ae electronic-centric weighted 40 -1 -1
+ipipe-client$ init-aew 200000 640 480 100
+</pre>
+
+This example shows one of the configurations for the librraew using a 640x480 video. The first command chain the ipipe and configures the previewer to use continuous mode. Then configures librraew to use the gray world as a white balance algorithm working over the dm365's gain. Then, it is set the librraew to use the rectangle weighted metering system, taking into account a 40% centered image's area as the rectangle of interest.
+Finally the automatic adjustments are started with the command init-aew. The interval between algorithm's iterations is 200ms and 100% of the segmentation is used.
+Once you have the ipiped and the AEW algorithms running you can run any image/video capture GStreamer pipeline to test it.
Something went wrong with that request. Please try again.