Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of expert camera parameters #3207

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions param-docs/parameter-pages/TakeImage/CamAeLevel.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
# Parameter `CamAeLevel`

**Auto-Exposure-Level**

range on OV2640 (`-2` .. `2`)<br>
range on OV3660 and OV5640 (`-5` .. `5`)

Default Value: `0`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!

!!! Note
This parameter can also be set on the Reference Image configuration page!
The exposure offset for automatic exposure, lower values produce darker image.

**Auto Exposure Level**

The exposure offset for automatic exposure, lower values produce darker image.

available range on OV2640 (`-2` .. `2`)
available range on OV3660 and OV5640 (`-5` .. `5`)
!!! Note
This parameter can also be set on the Reference Image configuration page!
17 changes: 10 additions & 7 deletions param-docs/parameter-pages/TakeImage/CamAec.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Parameter `CamAec`

**Auto-Exposure-Control**

- When **true**, the camera attempts to automatically control the exposure.
- When **false**, the **CamAecValue** setting is used instead.

Default Value: `true`


See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!
!!! Note
This parameter can also be set on the Reference Image configuration page!

**Auto-Exposure Control**

When **true**, the camera attempts to automatically control the exposure.

When **false**, the **CamAecValue** setting is used instead.
20 changes: 13 additions & 7 deletions param-docs/parameter-pages/TakeImage/CamAec2.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# Parameter `CamAec2`

**Auto-Exposure-Control2**

- When **true**, the sensor’s "night mode" is enabled, extending the range of automatic gain control.
- When **false**, the sensor’s "night mode" is disabled.

Default Value: `true`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!

!!! Note
This may resolve some over-exposure and under-exposure issues.

!!! Note
This parameter can also be set on the Reference Image configuration page!

**Auto-Exposure Control 2**

When **true**, the sensor’s "night mode" is enabled, extending the range of automatic gain control.

This may resolve some over-exposure and under-exposure issues.
21 changes: 13 additions & 8 deletions param-docs/parameter-pages/TakeImage/CamAecValue.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# Parameter `CamAecValue`

**Auto-Exposure-Value**

Range (`0` .. `1200`)

Default Value: `160`


See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!
!!! Note
This parameter can also be set on the Reference Image configuration page!

**Auto Exposure Value**

Access the exposure value of the camera, higher values produce brighter images.
!!! Note
Access the exposure value of the camera, higher values produce brighter images.

Range (`0` .. `1200`)
!!! Note
This parameter can also be set on the Reference Image configuration page!
15 changes: 9 additions & 6 deletions param-docs/parameter-pages/TakeImage/CamAgc.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# Parameter `CamAgc`

**Auto-Gain-Control**

- When **true**, the camera attempts to automatically control the sensor gain, up to the value in the **CamGainceiling** property.
- When **false**, the **CamAgcGain** setting is used instead.

Default Value: `true`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!

**Auto Gain**

When **true**, the camera attempts to automatically control the sensor gain, up to the value in the **CamGainceiling** property.

When **false**, the **CamAgcGain** setting is used instead.
15 changes: 10 additions & 5 deletions param-docs/parameter-pages/TakeImage/CamAgcGain.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Parameter `CamAgcGain`

**Auto-Gain-Control-Value**

Range (`0` .. `30`)

Default Value: `15`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

Expand All @@ -9,8 +17,5 @@ Default Value: `15`
!!! Note
This is used when **CamAgc** is off.

**Gain Manual Value**

Access the gain level of the sensor, higher values produce brighter images.

Range (`0` .. `30`)
!!! Note
Access the gain level of the sensor, higher values produce brighter images.
17 changes: 11 additions & 6 deletions param-docs/parameter-pages/TakeImage/CamAutoSharpness.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
# Parameter `CamAutoSharpness`

**Auto-Sharpness**

- When **true**, the camera attempts to automatically adjusts the sharpness.
- When **false**, the **CamSharpness** setting is used instead.

Default Value: `false`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!

!!! Note
This parameter can also be set on the Reference Image configuration page!

!!! Note
The OV2640 does not officially support auto sharpness, this is an experimental parameter!

**AutoSharpness**

When **true**, the camera attempts to automatically adjusts the sharpness.
!!! Note
This parameter can also be set on the Reference Image configuration page!
15 changes: 9 additions & 6 deletions param-docs/parameter-pages/TakeImage/CamAwb.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# Parameter `CamAwb`

**Auto-White-Balance**

- When **true**, the camera attempts to automatically control white balance.
- When **false**, the **CamWbMode** setting is used instead.

Default Value: `true`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!

**Auto White Balance**

When **true**, the camera attempts to automatically control white balance.

When **false**, the **CamWbMode** setting is used instead.
16 changes: 10 additions & 6 deletions param-docs/parameter-pages/TakeImage/CamAwbGain.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Parameter `CamAwbGain`
Default Value: ` `


**Auto-White-Balance-Gain**

- Enable/Disable **CamAwbGain** control.

Default Value: `true`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!

**Auto White Balance Gain**

Access the **CamAwbGain** property of the camera sensor.
14 changes: 9 additions & 5 deletions param-docs/parameter-pages/TakeImage/CamBpc.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Parameter `CamBpc`

**Black-Pixel-Correction**

- Enable/Disable **black point compensation**, this can make black parts of the image darker.

Default Value: `true`


See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

After changing this parameter you need to update your reference image and alignment markers!

**Black Pixel Correction**

Enable/Disable **black point compensation**, this can make black parts of the image darker.
14 changes: 8 additions & 6 deletions param-docs/parameter-pages/TakeImage/CamBrightness.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Parameter `CamBrightness`

**Image-Brightness**

Range (`-2` .. `2`)

Default Value: `0`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
After changing this parameter you need to update your reference image and alignment markers!

!!! Note
This parameter can also be set on the Reference Image configuration page!

**Brightness**

Positive values increase brightness, negative values lower it.

Range (`-2` .. `2`)
12 changes: 8 additions & 4 deletions param-docs/parameter-pages/TakeImage/CamColorbar.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Parameter `CamColorbar`
Default Value: `false`

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

**Colorbar**

currently not implemented.

Default Value: `false`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
14 changes: 8 additions & 6 deletions param-docs/parameter-pages/TakeImage/CamContrast.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Parameter `CamContrast`

**Image-Contrast**

Range (`-2` .. `2`)

Default Value: `0`

See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
After changing this parameter you need to update your reference image and alignment markers!

!!! Note
This parameter can also be set on the Reference Image configuration page!

**Contrast**

Positive values increase contrast, negative values lower it.

Range (`-2` .. `2`)
19 changes: 11 additions & 8 deletions param-docs/parameter-pages/TakeImage/CamDcw.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Parameter `CamDcw`

**Image-Downsize**

- When **CamDcw** is on, the image that you receive will be the size that you requested (VGA, QQVGA, etc).
- When **CamDcw** is off, the image that you receive will be one of UXGA, SVGA, or CIF.

Default Value: `true`


See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!

Expand All @@ -9,10 +18,4 @@ Default Value: `true`
If **CamZoom** is used, this must be activated.

!!! Note
When **CamDcw** is on, the image that you receive will be the size that you requested (VGA, QQVGA, etc).
When **CamDcw** is off, the image that you receive will be one of UXGA, SVGA, or CIF. In other words, literally the actual image size as read from the sensor without any scaling.
Note that if **CamDcw** is off, and you pick a different image size, this implicitly turns **CamDcw** back on again (although this isn't reflected in the options).

**Downsize**

Enable/Disable camera image scaling.
If **CamDcw** is off, and you pick a different image size, this implicitly turns **CamDcw** back on again.
16 changes: 10 additions & 6 deletions param-docs/parameter-pages/TakeImage/CamDenoise.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Parameter `CamDenoise`
Default Value: `0`

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
**Image-Denoise**

- Denoise Image, is only supported by OV3660 and OV5640

**Denoise**
range on OV3660 and OV5640 (0 .. 8)

Denoise Image, is only supported by OV3660 and OV5640
Default Value: `true`

Range (`0` .. `8`)
See [here](../datasheets/Camera.ov2640_ds_1.8_.pdf) for the ov2640 camera datasheet.<br>
See [here](../datasheets/OV5640_datasheet.pdf) for the ov5640 camera datasheet.

!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Loading