Overlay

Placing values, indicators, tables and charts on the stream.

The overlay editor is the main page of the RAVidEn interface. It shows a snapshot from the camera with your elements drawn on top. The editor uses the same font and the same measurements as the camera, so text and boxes sit in the video where the editor shows them. Placement can still differ a little from the preview, so check the stream after you change a layout.

The snapshot is a still image. It does not play video.

The overlay editor: the camera snapshot with elements placed on it, and the element properties beside it.The overlay editor: the camera snapshot with elements placed on it, and the element properties beside it.
The overlay editor.

Elements

Choose Add and pick an element. The elements come in four groups, and the panels bound to a device come after them.

Text and values

ElementDescription
Static textDisplays a fixed label.
Tag valueDisplays one tag's current value, with an optional prefix and suffix. Color rules can change the text color depending on the value, and a state tag takes its state color.
IndicatorDisplays a colored lamp driven by rules on a tag, for example green above a value and red below it.
Tag tableDisplays a list of up to 20 tags with their values, one per row.

Charts of measurements

ElementDescription
Tick chartDraws the value over a window of time as a line, with an optional time axis.
GaugeShows the current value against a range, as a horizontal bar, a vertical bar or an arc.
Metric tileShows the current value, the change over the window, and a sparkline.

State charts, for state tags

ElementDescription
Current stateShows the state's label and color in large type.
State stripShows the sequence of states over the window as a colored strip, horizontal or vertical.
DonutShows the share of the window spent in each state, with the productive share in the middle.
State tableLists the time, share, count and average dwell for each state over the window.
Hourly barsDraws one bar per hour, split by state.
AvailabilityAn arc gauge preset that shows the productive share of the window.

Panels, bound to a device. Choose Add panel… to place one on an existing device or a new one. The panels create the tags they read. See Devices.

ElementDescription
Robot panelShows the robot's state, operating mode and speed as chips. The full version adds the running routine, the tool, and the latest alarm.
Pose figureDraws a schematic of the arm, posed from the live joint positions.
CNC panelShows the machine's execution, mode and door as chips with the program line. The full version adds the overrides, the spindle, and the alarm row.
Axis panelDraws one bar per spindle and axis for the load, position, feedrate or temperature.
UPS panelShows the output source, the battery, the runtime and the load as chips. The full version adds the input, output and test rows and the alarm row.
ATS / PDU panelShows the source in use and the available sources as chips with an outlet strip. The full version adds the output row and the alarm row.

Chart and state elements draw over a window. A rolling window covers the last 15 minutes, hour, 8 hours, day or week. An anchored window covers this hour, this shift or today, and fills in as the period goes on. You set shift start times under Settings. See History and charts for what the camera keeps.

Placing and sizing

  • Drag an element to move it. Turn on Snap to grid to align elements to a 10-pixel grid. Guide lines appear when an edge or a center lines up with another element.
  • Drag the handle on charts and tables to resize them. Tables and the device panels set their own height from their rows, so you set only their width.
  • The arrow keys nudge the selected element by one pixel, or by ten pixels with Shift held. Delete removes the element. Ctrl+D or Cmd+D duplicates it.
  • Send back and Bring forward change the drawing order where elements overlap. A layout reads better when they do not, so use these to fix an overlap rather than to design around one.

The camera stores positions relative to the frame, so one layout serves every stream resolution. Font sizes are for 1080p and scale with the stream.

Appearance

Settings → Theme sets the defaults for every element's box: the background color and its transparency, the text color, the corner radius, and the border. Any element can override its radius and border, or turn its box off entirely.

The camera draws a RAVidEn watermark in one corner by default. Settings → Overlay chooses the corner, the size and the opacity, or turns the watermark off.

Visibility rules

Every element can have a visibility rule. The rule shows the element only while a tag compares in a certain way with a value. Use it for an alarm banner that appears only while an alarm bit is set, or for a different layout for each operating mode.

In the editor, elements hidden by their rule appear dimmed so that you can still select them.

Streams

The camera draws the overlay on every H.264 and H.265 stream it produces, at every resolution. JPEG snapshots and MJPEG streams have no overlay. The redraw rate is five frames per second by default, and you can change it under Settings. A lower rate saves camera CPU. See Performance.