Configuration settings
This page is rendered from the configuration schema. Save & apply, the camera application and import all validate against the same schema, so an exported configuration always matches it.
The raw schema is served at /schema/config.schema.json. In the paths below, [] means each entry of a list. Each row gives the setting, its type or allowed values, and its default. When a setting is omitted, its default applies.
Connections
There is one entry per data source. Which fields apply depends on the protocol.
| Setting | Description |
|---|---|
connections[].idstring | A unique identifier for the connection. The interface generates it. |
connections[].namestring | The name shown in the tag library and used in the DataBorder. |
connections[].protocolab-eip, abb-rws, mazak-mtc, snmp, modbus, camera, demo, diag | The source. ab-eip is an Allen-Bradley PLC over EtherNet/IP, abb-rws is an ABB robot over Robot Web Services, mazak-mtc is a Mazak CNC over its MTConnect agent, snmp is an SNMP device, modbus is a Modbus TCP device, camera is the camera's own event system, demo is the simulated source, and diag is the diagnostics source. |
connections[].plcTypecontrollogix, compactlogix, micrologix, micro800, slc500, plc5default "controllogix" | The Allen-Bradley controller family. It applies to ab-eip connections only. |
connections[].gatewaystring | The address of the PLC or of its EtherNet/IP module. It applies to ab-eip connections only. |
connections[].cipPathstringdefault "1,0" | The path from the EtherNet/IP module to the controller, for example 1,0 for slot 0 of the backplane. Leave it empty for controllers without a backplane. |
connections[].pollIntervalMsinteger | How often the camera reads the tags, in milliseconds, from 100 to 60000. |
connections[].timeoutMsintegerdefault 2000 | How long a read may take before it counts as failed, in milliseconds. |
connections[].enabledbooleandefault true | Whether the connection is active. The camera keeps a disabled connection's tags but does not poll them. |
connections[].hoststring | The address of the robot controller, the MTConnect agent, the SNMP card or the Modbus device. It applies to abb-rws, mazak-mtc, snmp and modbus connections. |
connections[].portinteger | An optional port. For a robot controller, the camera detects it when omitted, using 80 for HTTP and 443 for HTTPS. When omitted, it is 5000 for an MTConnect agent, 161 for an SNMP device and 502 for a Modbus device. |
connections[].usernamestringdefault "Default User" | The robot controller user, or the SNMP v3 user. |
connections[].passwordstring | The robot controller password, the SNMP community for versions 1 and 2c, or the SNMP v3 authentication pass. The camera stores it and never exports it. An empty value on save keeps the stored password. |
connections[].verifyTlsbooleandefault false | Whether to verify the robot controller's TLS certificate. OmniCore controllers ship with a self-signed certificate, so this is off by default. |
connections[].devicestringdefault "" | For a mazak-mtc connection, the MTConnect device name or uuid on an agent that serves several machines. When it is empty, the camera reads the agent's first device. For a modbus connection, the unit id. When it is empty, the camera uses 1. |
connections[].profilegeneric, raviden/abb-rws, raviden/apc-ap9631, raviden/apc-ups, raviden/mazak-mtc, raviden/tripplite-pdu, raviden/ups-mibdefault "generic" | The device profile. It sets the catalog the connection reads, the state labels, the alarm conditions and the family of panels that can bind to the connection. generic is a source with user tags only. An abb-rws connection uses raviden/abb-rws and a mazak-mtc connection uses raviden/mazak-mtc. An snmp connection uses raviden/ups-mib, raviden/apc-ups or raviden/tripplite-pdu, and a modbus connection uses raviden/apc-ap9631. The profiles page lists what each one reads. |
connections[].snmpVersion1, 2c, 3default "2c" | The SNMP version: 1, 2c or 3. Versions 1 and 2c read the community from password. Version 3 uses username, password and privPassword. |
connections[].authProtocolmd5, sha1, sha224, sha256, sha384, sha512default "sha1" | The SNMP v3 authentication protocol. Authentication is off while password is empty. |
connections[].privProtocolnone, des, aes128, aes192, aes256default "aes128" | The SNMP v3 privacy protocol. Privacy is off while it is none or privPassword is empty. |
connections[].privPasswordstring | The SNMP v3 privacy pass. The camera stores it and never exports it. An empty value on save keeps the stored value. |
connections[].alarmsarray | The profile conditions that count as alarms. A listed condition raises the roll-up to ALARM, shows in the panel's alarm row and fires the alarm burst. A condition left out still changes its tag. When it is omitted, the profile's defaults apply. The profiles page lists each profile's conditions and their defaults. |
Tags
These are the tags that the camera polls or derives. State tags also carry a state map.
| Setting | Description |
|---|---|
tags[].idstring | A unique identifier for the tag. The interface generates it. |
tags[].namestring | The display name. The DataBorder uses it as the record name and keeps only the first 16 characters. |
tags[].connectionIdstring | The connection the camera reads the tag from. It is empty for derived tags. |
tags[].addressstring | The controller tag name for Logix controllers, the data-table address for SLC 500 and PLC-5, the catalog address for a device connection, an oid: address for an SNMP connection, or an hr: register for a Modbus connection. It is empty for derived tags. |
tags[].dataTypebool, sint, int, dint, lint, real, lreal, string | The data type. It must match the controller's type. |
tags[].scale.factornumberdefault 1 | A factor applied to the raw value before display. |
tags[].scale.offsetnumberdefault 0 | An offset added to the raw value after scaling. |
tags[].format.decimalsinteger | The number of decimals shown. |
tags[].format.unitsstring | The units shown after the value. |
tags[].format.templatestring | An optional display template, for example {value} {units}. The camera fills in the placeholders {name}, {value} and {units}. |
tags[].kindmeasurement, statedefault "measurement" | Either measurement, a number that the charts can plot, or state, a number that means a machine state. State tags carry a state map, and the camera stores them as transitions. |
tags[].derived.rules[].tagIdstring | The tag the rule tests. |
tags[].derived.rules[].opeq, ne, lt, le, gt, ge | The comparison: equal, not equal, less than, less than or equal, greater than, or greater than or equal. |
tags[].derived.rules[].valuenumber | The value the rule compares the tag with. |
tags[].derived.rules[].statenumber | The state value used when the rule matches. The first matching rule wins. |
tags[].derived.elseStatenumberdefault 0 | The state value used when no rule matches. |
tags[].states[].valuenumber | The raw value this state corresponds to. |
tags[].states[].labelstring | The label shown on the overlay. The overlay shortens it to fit, and the DataBorder carries only its first 24 bytes. |
tags[].states[].colorstring | The color, as #RRGGBB or #RRGGBBAA. |
tags[].states[].categorystring | The category this state belongs to, if any. |
tags[].defaultState.valuenumber | The value reported for the default state. |
tags[].defaultState.labelstring | The label shown for values that are not in the state map. |
tags[].defaultState.colorstring | The color of the default state, as #RRGGBB or #RRGGBBAA. |
tags[].defaultState.categorystring | The category of the default state, if any. |
tags[].stateCategories[].idstring | A unique identifier for the category. |
tags[].stateCategories[].labelstring | The category's name. |
tags[].stateCategories[].colorstring | The category's color, as #RRGGBB or #RRGGBBAA. |
tags[].stateCategories[].productivebooleandefault false | Whether time in this category counts as productive in the donut and availability charts. |
tags[].learnbooleandefault false | Learning mode. When it is on, the camera adds observed values that are missing from the state map, about once a minute. |
tags[].managedcnc, pdu, robot, ups | The family of the profile that owns the tag: robot, cnc, ups or pdu. It is set on the tags a panel created for its connection, and on the tags the driver created for the axes, inputs and outlets it found. The application owns their address, type and state map, refreshes them from the profile, and removes them with the connection. |
tags[].historyauto, on, offdefault "auto" | Whether the camera stores the tag's history. auto records the tag while it is used, except for managed addresses whose policy keeps them live only, such as joint positions. on polls and records the tag always. off keeps the live value only. |
tags[].streamauto, on, offdefault "auto" | Whether the DataBorder carries the tag. auto gives the tag a synced record while the overlay uses it, except for managed addresses whose policy keeps them out, such as strings. on always adds a record. off never does, and leaves the tag out of the full history in the stream. |
Overlay
These settings cover the theme, the watermark and the elements drawn on the video.
| Setting | Description |
|---|---|
overlay.maxFpsnumberdefault 5 | The maximum overlay redraw rate, in frames per second, from 0.5 to 10. |
overlay.motionbooleandefault false | Whether gauge and bar values ease toward new readings. While a value is moving, the overlay redraws at 5 frames per second. |
overlay.watermark.enabledbooleandefault true | Whether the camera draws the RAVidEn watermark. |
overlay.watermark.cornertl, tr, bl, brdefault "br" | The corner for the watermark: top left, top right, bottom left or bottom right. |
overlay.watermark.opacitynumberdefault 0.6 | The watermark opacity, from 0 to 1. |
overlay.watermark.sizenumberdefault 160 | The watermark size in pixels at 1080p. |
overlay.theme.radiusnumberdefault 0.3 | The default corner radius of element boxes, in em relative to the font size. |
overlay.theme.bgstringdefault "#00000099" | The default box background color, including transparency. |
overlay.theme.fgstringdefault "#ffffff" | The default text color. |
overlay.theme.borderstring | The default box border color. Omit it for no border. |
overlay.theme.borderWidthnumberdefault 1 | The default border width in pixels at 1080p. |
overlay.elements[].idstring | A unique identifier for the element. The interface generates it. |
overlay.elements[].typestaticText, tagValue, indicator, tagTable, tickChart, stateStrip, gauge, metricTile, stateTile, stateDonut, stateTable, stateBars, robotPanel, robotFigure, cncPanel, axisPanel, upsPanel, pduPanel | The element type. |
overlay.elements[].position.xnumber | The horizontal position of the element's top-left corner, as a fraction of the frame width from 0 to 1. |
overlay.elements[].position.ynumber | The vertical position of the element's top-left corner, as a fraction of the frame height from 0 to 1. |
overlay.elements[].size.xnumber | The element width as a fraction of the frame width. For tables, robot panels and CNC panels this is the only dimension used. |
overlay.elements[].size.ynumber | The element height as a fraction of the frame height. |
overlay.elements[].fontSizeintegerdefault 24 | The font size in pixels at 1080p, scaled for each stream. For a robot panel or a CNC panel it also sets the panel height. |
overlay.elements[].fgstring | The text color. Omit it to use the theme. |
overlay.elements[].bgstring | The box background color, including transparency. Omit it for no box. |
overlay.elements[].radiusnumber | The corner radius in em. Omit it to use the theme. |
overlay.elements[].windowinteger | The chart window in seconds, for rolling windows. |
overlay.elements[].anchorrolling, hour, shift, day | Whether the window is rolling, or anchored to this hour, this shift or today. |
overlay.elements[].range.minnumber | The lower end of the chart's value range, or of an axis panel's bars. Omit it to scale automatically. |
overlay.elements[].range.maxnumber | The upper end of the chart's value range, or of an axis panel's bars. Omit it to scale automatically. |
overlay.elements[].chartColorstring | The chart's base color. |
overlay.elements[].stateMap[].valuenumber | A raw value that the state strip maps. |
overlay.elements[].stateMap[].labelstring | The label for this value. |
overlay.elements[].stateMap[].colorstring | The color for this value, as #RRGGBB or #RRGGBBAA. |
overlay.elements[].showLabelboolean | Whether the element shows its title row. |
overlay.elements[].showAxisboolean | Whether the element shows its axis, legend or header row. Which of these it is depends on the element type. |
overlay.elements[].showStateValuebooleandefault false | Whether state labels carry the raw value in front, for example "15 - Waiting". |
overlay.elements[].timeAxisclock, offsetdefault "clock" | Whether the time axis shows wall-clock times or offsets from now. |
overlay.elements[].gaugeStylebar, vbar, arc | The gauge style: horizontal bar, vertical bar or arc. |
overlay.elements[].defaultLabelstring | For a state strip, the label for values that are not in its state map. |
overlay.elements[].tickPxnumber | For a tick chart, the tick width in pixels. |
overlay.elements[].orientationhorizontal, vertical | For a state strip, whether it runs horizontally or vertically. |
overlay.elements[].borderstring | The box border color. Omit it to use the theme. |
overlay.elements[].visibleWhen.tagIdstring | The tag the visibility rule tests. |
overlay.elements[].visibleWhen.opeq, ne, lt, le, gt, ge | The comparison used by the visibility rule. |
overlay.elements[].visibleWhen.valuenumber | The value the rule compares the tag with. The element shows only while the rule holds. |
overlay.elements[].connectionIdstring | For a robot panel, pose figure, CNC panel, axis panel, UPS panel or ATS / PDU panel, the device connection the element shows. The connection's profile belongs to the panel's family. The element creates the managed tags it reads. |
overlay.elements[].detailchip, compact, fulldefault "compact" | For a robot, CNC, UPS or ATS / PDU panel, the level of detail: a chip, a compact panel, or the full panel. |
overlay.elements[].metricposition, feed, load, tempdefault "load" | For an axis panel, the value each spindle and axis row shows: load, position, feed or temperature. Spindles show rpm for position and feed. |
overlay.elements[].figurenone, side, isodefault "iso" | For a pose figure, the drawing style: isometric, side view, or none. |
overlay.elements[].showAlarmbooleandefault true | For a full robot, CNC, UPS or ATS / PDU panel, whether the panel shows the alarm row. |
DataBorder (streamEncode)
These settings control the DataBorder. The DataBorder page explains how to choose them.
| Setting | Description |
|---|---|
streamEncode.enabledbooleandefault false | Whether the camera draws the DataBorder. |
streamEncode.syncOverlaybooleandefault true | Whether every tag the overlay uses automatically gets a record in the DataBorder. Sync keeps records you added by hand. |
streamEncode.tagIdsarray | A list of tag ids to embed, used only when the records list is empty. |
streamEncode.records[].namestring | The record name, up to 16 characters. |
streamEncode.records[].typebit, bitarr, bcd4, uint, int, chararr, real | The encoded type of the record. |
streamEncode.records[].tagIdstring | The tag that supplies the live value. Omit it for a manual or automatic value. |
streamEncode.records[].modemanual, hour, minute, second, millisdefault "manual" | Where the value comes from: a manual value, or the current hour, minute, second or millisecond. |
streamEncode.records[].valuestring | The manual value, interpreted according to the record type. |
streamEncode.records[].sizeinteger | The array size for bit-array and character-array records. |
streamEncode.records[].pinnedbooleandefault false | Whether every update includes the record, rather than only snapshots and changes, so that a single frame always carries it. |
streamEncode.records[].syncedbooleandefault false | Whether the record was created by overlay sync. Sync removes a synced record when the overlay stops using the tag, and never removes a record you added. |
streamEncode.updateFpsnumberdefault 10 | How many updates the DataBorder carries per second, from 1 to 10. The camera composes overlays ten times a second, so a higher setting cannot produce more updates. |
streamEncode.formatVersion1, 2default 2 | The DataBorder format. |
streamEncode.thickness1, 2, 3, 4, 5, 6default 3 | The ring thickness in blocks, from 1 to 6. The capacity per update is 173, 242, 484, 695, 865 and 1,034 bytes respectively. See the DataBorder page for guidance. |
streamEncode.signingbooleandefault true | Whether the camera chains updates and signs the chain with its key. |
streamEncode.snapshotPeriodMsintegerdefault 2000 | How often the camera sends a full snapshot of every record, in milliseconds. Between snapshots, updates carry only changed and pinned records. |
streamEncode.historyInStreambooleandefault true | Whether the carousel carries the last 24 hours of state runs. |
streamEncode.historyTagIdsarray | Which state tags the history carousel carries. When it is omitted, every state tag among the records. |
streamEncode.packedbooleandefault true | Whether the DataBorder uses the compact wire layout. |
streamEncode.profilehistory, snapshotdefault "history" | The history profile keeps the carousel cycling and fills the rest of each update with history. The snapshot profile makes every update self-contained, including the whole dictionary, for archives that keep only keyframes. |
streamEncode.fullHistoryInStreambooleandefault true | Whether the camera's full stored history cycles through the DataBorder, newest first. It applies to the history profile only. |
streamEncode.devices[].connectionIdstring | The device connection the alarm burst applies to. The DataBorder carries the connection's live values as records of its managed tags. |
streamEncode.devices[].onAlarmbooleandefault true | Whether a new alarm sends its context group and forces a snapshot. |
streamEncode.robotsarray | Kept for configurations written before devices existed. On load, the camera moves its entries into devices and empties it. |
Settings
These are the global settings: state categories, shifts and logging.
| Setting | Description |
|---|---|
settings.logLevelerror, warn, info, debugdefault "info" | How much the application logs: error, warn, info or debug. |
settings.stateCategories[].idstring | A unique identifier for the category. |
settings.stateCategories[].labelstring | The category's name. |
settings.stateCategories[].colorstring | The category's color, as #RRGGBB or #RRGGBBAA. |
settings.stateCategories[].productivebooleandefault false | Whether time in this category counts as productive in the donut and availability charts. |
settings.stateCategoriesEnabledbooleandefault true | Whether the global state categories apply. When it is off, tags may still carry their own. |
settings.shifts[].namestring | The shift's name. |
settings.shifts[].startstring | The shift start time as HH:MM. Shift start times define the "this shift" chart window. |
Other
| Setting | Description |
|---|---|
version | The configuration format version. It is always 1. |