Skip to content

Updates for synchronous and externally triggered cameras #4089

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

Merged
merged 1 commit into from
May 14, 2025

Conversation

njhollinghurst
Copy link
Contributor

Update synchronized cameras documentation to:

  • Deprecate the XVS sync method for GS Cam, in favour of XTRIG

  • Recommend "always-on" property instead of using pull-ups

  • Recommend "trigger-mode" for IMX477 be set using the new OF property (better for source and sink on same Pi) while noting that the module parameter still works and that "trigger-mode" means something quite different for IMX296!

  • Document the need to edit the pipeline config file for timeout

  • Some attempt to tidy the structure while covering all the options

  • Remove $ prompts from scripts/commands, so they can be copy-pasted

@lurch lurch requested a review from naushir April 30, 2025 15:20
@lurch
Copy link
Contributor

lurch commented Apr 30, 2025

  • Remove $ prompts from scripts/commands, so they can be copy-pasted

If you use the [source,console] above a code-block, then the $ is automatically non-copyable, see e.g. https://www.raspberrypi.com/documentation/computers/camera_software.html#rpicam-jpeg

@njhollinghurst
Copy link
Contributor Author

It's a bit messy, but hard to make it simpler without omitting required information (indeed it does omit repeating the "timeout-defeat" instructions for GS external trigger, but presumably people will infer that it needs to be done as in the previous section).

I feel this stuff would be better as a separate Application Note rather than part of the generic camera documentation?

Conspicuous by is absence is any mention of the new S/W synchronization method!

@lurch lurch self-requested a review April 30, 2025 15:45
@njhollinghurst
Copy link
Contributor Author

njhollinghurst commented Apr 30, 2025

Ah, I've belatedly noticed that we do already document Software Camera Synchronisation, although it's well hidden under rpicam-apps and could maybe do with being bumped a bit up the hierarchy.

I should definitely link there from here.

Update synchronized cameras documentation to:

- Suggest software synchronisation instead

- Deprecate the XVS sync method for GS Cam, in favour of XTRIG

- Recommend "always-on" property instead of using pull-ups

- Recommend that trigger-mode for IMX477 be set using the new
  dtoverlay parameters "sync-source" and "sync-sink", while noting
  that these parameters mean something quite different for IMX296.

- Document the need to edit the pipeline config file for timeout

- Some attempt to tidy the structure while covering all the options
@njhollinghurst njhollinghurst changed the title Updates for synchronous and externally triggered cameras (WIP) Updates for synchronous and externally triggered cameras May 7, 2025
@njhollinghurst njhollinghurst marked this pull request as ready for review May 7, 2025 09:24
Copy link
Contributor

@naushir naushir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@naushir naushir merged commit 5780e46 into raspberrypi:develop May 14, 2025
1 check passed
@njhollinghurst njhollinghurst deleted the camera_sync_again branch May 22, 2025 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants