A camera with no camera behind it.
A complete BB.Sensor + BB.Camera driver that produces real JPEG frames
from a built-in cycle of images. Drop it anywhere a real camera would go: in
tests, in a preview UI on a machine with no hardware attached, or as the
worked example to copy when writing a driver that does talk to something.
topology do
link :head do
sensor :eye, {BB.Camera.Synthetic, clock: :external}
end
endClocking
{:rate, hertz} runs a BB.Loop and produces frames on its own, which is
what you want behind a UI.
:external produces a frame only when capture_frame/2 is called, which is
what you want in a test. It makes the whole pipeline deterministic: ask for a
frame, produce one, assert you received it, with no sleeps and nothing
racing. Every test in this package is written that way.
{:ok, sub} = BB.Camera.subscribe(MyRobot, :eye)
:ok = BB.Camera.request(sub)
:ok = BB.Camera.Synthetic.capture_frame(MyRobot, :eye)
assert_receive {:bb_camera, ^ref, %BB.Camera.Frame{}}Geometry, and why it might not be what you asked for
The built-in frames are 160x120. Asking for another size without supplying
your own :frames gets you 160x120 anyway - there is no JPEG encoder here to
resize anything with - and the camera says so: it reports the dimensions it
parsed out of the actual frame through
BB.Camera.Hub.capture_started/2, so the live stream info is right even
though the declared one isn't.
That is not a workaround. It is exactly what a real camera does when it negotiates something other than what it was asked for, and having a driver that exercises the path on demand is worth more than one that pretends the question never comes up.
Summary
Functions
@spec builtin_frames() :: [binary()]
The JPEG frames this camera cycles through by default.
Produce one frame now.
Only meaningful with clock: :external. Synchronous: it returns once the hub
has taken the frame, so a test can request, capture and assert without
waiting on anything.
Returns {:error, %BB.Error.State.Camera.NotCapturing{}} until a consumer
has subscribed and this driver has confirmed capture started. Subscribing
is not enough: the hub asks the driver to start and the driver answers
asynchronously, so a test that opens a session and immediately captures will
race that answer.
Wait for the event rather than guessing at the gap:
BB.subscribe(MyRobot, [:sensor, :head, :eye])
{:ok, session} = BB.Camera.Media.open(MyRobot, :eye)
assert_receive {:bb, _, %BB.Message{payload: %BB.Message.Camera.BeginCapture{}}}
:ok = BB.Camera.Synthetic.capture_frame(MyRobot, :eye)Anything driving an externally clocked camera from behind a consumer needs
this, so it is worth doing once in a test setup.