DataBorder

Enabling and configuring the DataBorder.

The DataBorder is a ring of light and dark blocks that the camera draws around the edge of the picture. It carries the tag values inside the video. Across successive frames it also carries the record names, the camera's identity, history and signatures. Any recording of the stream carries the data with it, and the decoder reads it back. The DataBorder is patent pending.

Open DataBorder from the navigation bar.

Enabling

The DataBorder panel: the format, thickness and record settings, with the ring preview and its round-trip check.The DataBorder panel: the format, thickness and record settings, with the ring preview and its round-trip check.
The DataBorder panel.
  1. Turn Enabled on.
  2. Leave Sync with overlay on. Every tag on the overlay then gets a DataBorder record. When the overlay stops using the tag, the camera removes the record.
  3. Choose Save & apply.

The DataBorder appears on the camera's native 1920 × 1080 stream. Streams at other resolutions carry the overlay but not the DataBorder. See Recording for what this means for the recorder.

The panel draws the ring it would encode and decodes it again in the browser. This round-trip check shows that the encoding works before you record any video.

Thickness

The thickness is the number of blocks the ring is wide. A thicker ring carries more data per update and is more visible in the picture.

ThicknessCapacity per updateUse
1173 bytesUse it for the least visible ring with few records.
2242 bytesUse it for a less visible ring with a moderate number of records. It survives every tested recording tier.
3484 bytesThe default. Use it when you carry many records or robot data, or want the history to cycle faster.
4695 bytesUse it for the same reasons as thickness 3. It uses the outer 16 pixels of the frame, so read the warning below.
5 and 6865 and 1,034 bytesUse them only with recorders that keep 540p or better at 1 Mbit/s or more. They fail at 480p.

The panel shows how long a clip must be to carry each part of the DataBorder. For the saved settings, the camera measures the clip length. For an unsaved edit, the panel projects it from the measured record traffic and labels it projected.

Both figures reflect the current tags and update rate. Adding or removing tags, or changing what the DataBorder carries, changes the clip length a recording needs.

Contents

Each update carries the values that changed since the last one. Every few seconds the camera sends a full snapshot of every record, so that a decoder that starts mid-stream catches up. The space left over carries a slice of a carousel that cycles through the record names, the camera's identity and state labels, recent history, strings and signatures.

The following options change what is carried.

OptionEffect
RecordsThe list of records the DataBorder carries. With sync on, the list mirrors the overlay. Add rows for tags you want in the data but not on the picture, or for fixed values such as a line name or a clock.
PinnedA pinned record is included in every update, not only when it changes. Use it for records that must be readable from a single frame, such as a line name or a state. Sync pins the state tags it adds.
History in streamCarries the last 24 hours of state runs for up to eight state tags, so that a decoded clip shows what the machine was doing before the clip began. It is on by default.
Full history in streamCycles the camera's full stored history through the DataBorder, newest first. A longer clip reconstructs more of it in the decoder. It is on by default and uses all spare capacity.
ProfileThe history profile is the default. It keeps the carousel cycling and fills the rest of each update with history. The snapshot profile puts the whole record dictionary in every update, for archives that keep only keyframes. See below.
SigningChains each update to the previous one and signs the chain with a key created on the camera. The decoder uses the signatures to tell a genuine clip from an edited one.
Alarm burstFor a device. Adds a group with the alarm's code, severity and text whenever a new alarm arrives, and forces a snapshot. For a robot or CNC, the group also carries the program position at the alarm. See Device records.

In the snapshot profile the dictionary must fit in one update, so use few records or a thick ring. If it does not fit, the camera refuses the save.

Device records

The DataBorder carries a device's managed tags as records named d, the device's position among the devices, and the field: d0.rollup, d0.state, d1.charge. Deleting a device shifts the indices of the devices after it. A few fields are the same for every device.

FieldContents
_pThe profile id, for example raviden/apc-ups@1. Pinned.
_fThe family label: Robot, CNC, UPS or ATS / PDU.
rollupThe roll-up. Pinned.
stateThe device's own state label.
almcode, almseq, almsev, almtext, almliveThe alarm context: the alarm's code, pinned, its sequence number, its severity, its text, and whether it is live. A robot adds the routine, line and statement, and a CNC the program and line.

The other fields are the managed tags the panel reads. Their names are on the profiles page. A decoder that has never seen the profile still reads every record, because the DataBorder carries the names, types and state labels itself.

Camera overlays

The camera's own overlays, meaning the clock and any text or image overlay set under the camera's Video → Overlays page, are drawn on top of RAVidEn. If one of them sits on the ring, its changing pixels corrupt the blocks under it. With the camera's default clock at the top left, the damage shows up at thickness 4 as unrecoverable frames.

Before relying on thickness 4 or more, move the camera's overlays inward or turn them off. Thickness 2 and 3 clear the default clock, but check anything you add later.

Records and tag names

A record's name is the tag's name, limited to the first 16 characters. Keep tag names distinct within those characters so that the decoder can tell them apart.

The signing key

The camera creates an Ed25519 signing key the first time RAVidEn starts and keeps it on the camera. The DataBorder carries the public half. The camera also serves it at /local/raviden/api/signing-key so that you can check the fingerprint without the video. See Verification.