Device profiles

What each device profile reads, records and raises.
Synced document
Copied at build time from raviden/profiles/compiled/profiles.json. Edit it there, not here.

This page is rendered from the device profiles built into the camera application. A profile binds a source to a device family. It sets the catalog of addresses the connection can read, which of them become managed tags and DataBorder records, the state labels, and the alarm conditions. The Devices section describes the panels and the roll-up.

In the tables, Record is the field name in the device's DataBorder records: d0. followed by the field for the first device. History and Stream are the defaults of the managed tag's switches. A pinned record rides in every update. Source is where the value comes from on the device, for profiles that read by OID or register.

Mazak CNC over MTConnect agent

Execution, mode, door, e-stop, program pointer, tool, parts, overrides, spindle and every axis the probe reports. Read-only, no credentials.

ItemDetails
Profileraviden/mazak-mtc
FamilyCNC
SourceMazak CNC (MTConnect)
BrandMazak
ModelsSmoothX / Smooth-G controls with the built-in MTConnect 1.x agent (port 5000)
Poll interval1,000 ms
Port5000

Status

AddressRecordTypeHistoryStreamSourceDescription
rollup#coderollupdintYesYesRoll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes.
rollupstringLabel of rollup#codeRoll-up label.
state#codestatedintYesYesMachine state. Worst-of machine state (0 running · 1 idle · 2 alarm · 3 feed hold / interrupted / wait · 4 e-stop · 5 no data · 6 offline). States: 0 RUNNING · 1 IDLE · 2 ALARM · 3 FEED HOLD (roll-up WARNING) · 4 E-STOP (roll-up ALARM) · 5 NO DATA · 6 OFFLINE.
statestringLabel of state#codeMachine state label.
exec#codeexecdintYesYesExecution. Execution code (1 running, 3 feed hold, 4 stopped …). States: 0 READY · 1 RUNNING · 2 INTERRUPTED · 3 FEED HOLD · 4 STOPPED · 5 OPT STOP · 6 PGM STOP · 7 PGM END · 8 WAIT · 9 OPT STOP.
execstringExecution (ACTIVE / READY / FEED_HOLD / STOPPED …).
mode#codemodedintYesYesController mode. Controller mode code (0 auto, 1 manual, 2 MDI, 3 semi-auto, 4 edit). States: 0 AUTO · 1 MANUAL · 2 MDI · 3 SEMI AUTO · 4 EDIT.
modestringController mode (AUTOMATIC / MANUAL / MANUAL_DATA_INPUT / EDIT).
estop#codeestopdintYesYesEmergency stop. Emergency stop code (0 armed, 1 triggered). States: 0 ARMED · 1 E-STOP.
estopstringEmergency stop (ARMED / TRIGGERED).
door#codedoordintYesYesDoor. Door code (0 closed, 1 open, 2 unlatched). States: 0 DOOR CLOSED · 1 DOOR OPEN · 2 DOOR UNLATCHED.
doorstringDoor state (OPEN / CLOSED / UNLATCHED).
avail#codeavaildintYesAvailability. Availability code (1 available, 0 no data). States: 0 NO DATA · 1 AVAILABLE.
availstringAvailability (AVAILABLE / UNAVAILABLE).

Events

AddressRecordTypeHistoryStreamSourceDescription
cond#codeconddintYesYesWorst condition. Worst active condition (0 normal, 1 warning, 2 alarm). States: 0 NORMAL · 1 WARNING · 2 ALARM.
cond.codecondcodedintYesYesAlarm code. Native code of the worst active condition.
cond.textcondtextstringYesAlarm text. Text of the worst active condition.
cond.countdintActive warnings + alarms.

Program

AddressRecordTypeHistoryStreamSourceDescription
programprogramstringYesYesProgram. Main program name.
program.substringSub program name.
program.commentstringProgram comment.
linelinedintYesYesProgram line. Program line number.
line.labelstringProgram line label (N…).
tooltoolstringYesYesTool number. Tool number in the spindle.
tool.groupstringTool group.
partspartsdintYesYesPart count.
parts.targetdintPart count target.
palletpalletstringYesPallet. Pallet id.

Overrides

AddressRecordTypeHistoryStreamSourceDescription
ovr.feedovrfeeddintYesFeed override %.
ovr.rapidovrrapiddintYesRapid override %.
ovr.spindleovrspindintYesSpindle override %.

Spindle

AddressRecordTypeHistoryStreamSourceDescription
spindle.rpmsrpmrealYesSpindle speed. Spindle speed (rpm).
spindle.loadsloadrealYesSpindle load %.
spindle.temprealSpindle temperature °C.
spindle.modestringSpindle rotary mode (SPINDLE / INDEX / CONTOUR).
feedfeedrealYesPath feedrate. Path feedrate (mm/s, actual).

Counters

AddressRecordTypeHistoryStreamSourceDescription
time.autodintAccumulated automatic operation time (s).
time.cutdintAccumulated cutting time (s).
time.totaldintAccumulated power-on time (s).

System

AddressRecordTypeHistoryStreamSourceDescription
system.namestringDevice name.
system.modelstringModel description.
system.serialstringSerial number.
system.agentstringMTConnect agent version.
system.axesstringAxis names (space separated, probe order).
system.spindlesstringSpindle component names.

Axis n

The camera creates these addresses for each axis it finds on connect. n is its number or name.

AddressRecordTypeHistoryStreamSourceDescription
axis.{n}.posa{n}posrealYesAxis n position.
axis.{n}.feeda{n}feedrealAxis n feedrate.
axis.{n}.loada{n}loadrealYesAxis n load %.
axis.{n}.tempa{n}temprealYesAxis n temperature.
axis.{n}.state#codea{n}statedintYesAxis n state. States: 0 HOME · 1 TRAVEL · 2 PARKED · 3 STOPPED.

Tripp Lite ATS / PDU over PowerAlert

Source in use, source availability, transfer count, main output, general fault, per-source voltage / frequency / current and the outlet states. Read-only.

ItemDetails
Profileraviden/tripplite-pdu
FamilyATS / PDU
SourceSNMP device
BrandTripp Lite
ModelsPDUMH / PDUMNH ATS and switched PDUs with PowerAlert 12.06+ / 15 / 20 (TRIPPLITE-PRODUCTS tlpAts branch, device index 1)
Poll interval5,000 ms
Port161

Alarm conditions

A checked condition counts as an alarm on the connection. Default shows which conditions a new connection checks.

ConditionDefaultRaisesDescription
Transferred to source BOnON SOURCE BThe ATS switched off its primary source; stays active until it switches back.
Source lostOnNO SOURCE · SOURCE B LOST · SOURCE A LOSTOne input (or both) is out of tolerance.
Fault / critical alarmOnGENERAL FAULTThe general-fault flag or a critical PowerAlert alarm.
Output offOffOUTPUT OFFThe main output is switched off (usually deliberate).

Status

AddressRecordTypeHistoryStreamSourceDescription
rollup#coderollupdintYesYesRoll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes.
rollupstringLabel of rollup#codeRoll-up label.
state#codestatedintYesYesDerivedATS state. Worst-of ATS / PDU state (0 normal (source A) · 1 on source B · 2 alarm · 3 output off · 5 no data · 6 offline). States: 0 NORMAL (roll-up RUNNING) · 1 ON SOURCE B (roll-up WARNING) · 2 ALARM · 3 OUTPUT OFF (roll-up STOPPED) · 5 NO DATA · 6 OFFLINE.
statestringLabel of state#codeATS state label.
source#codesourcedintYesYes1.3.6.1.4.1.850.1.1.3.4.3.1.1.1.13.1Source in use. Input source in use (0 A · 1 B). States: 0 SOURCE A · 1 SOURCE B.
sourcestringLabel of source#codeInput source in use (SOURCE A / SOURCE B).
source.avail#codeavaildintYesYes1.3.6.1.4.1.850.1.1.3.4.3.1.1.1.12.1Source availability. Source availability (0 none · 1 A only · 2 B only · 3 A+B). States: 0 NO SOURCE · 1 A ONLY · 2 B ONLY · 3 A + B.
source.transfersxfersdintYes1.3.6.1.4.1.850.1.1.3.4.3.1.1.1.14.1Source transfers. Source transfer count.
load#codeloaddintYesYes1.3.6.1.4.1.850.1.1.3.4.2.1.1.1.1Main output. Main output (0 off · 1 on). States: 0 OUTPUT OFF · 1 OUTPUT ON.
fault#codefaultdintYes1.3.6.1.4.1.850.1.1.3.4.2.1.1.12.1General fault. General fault (0 none · 1 fault). States: 0 NO FAULT · 1 FAULT.
device.status#codedint1.3.6.1.4.1.850.1.1.1.2.1.10.1PowerAlert device status (0 ok · 1 info · 2 warning · 3 critical · 4 offline). States: 0 OK · 1 INFO · 2 WARNING · 3 CRITICAL · 4 OFFLINE.
tempreal1.3.6.1.4.1.850.1.1.3.4.2.1.1.6.1Device temperature (°C).

Alarms

AddressRecordTypeHistoryStreamSourceDescription
alarm#codealarmdintYesYesAlarm level. Alarm level (0 none · 1 warning · 2 alarm) per the connection's alarm policy. States: 0 NORMAL · 1 WARNING · 2 ALARM.
alarms.countalarmsdintYes1.3.6.1.4.1.850.1.3.1.0Active alarms. Active alarms (tlpAlarmsPresent).
alarms.textalarmtextstringYesActive alarm text. Active alarm labels, comma separated.

Input

AddressRecordTypeHistoryStreamSourceDescription
input.nominalreal1.3.6.1.4.1.850.1.1.3.4.3.1.1.1.1.1Nominal input voltage (V).
inputsdint1.3.6.1.4.1.850.1.1.3.4.1.2.1.1.1Number of input sources.

Output

AddressRecordTypeHistoryStreamSourceDescription
output.voltagevoutrealYes1.3.6.1.4.1.850.1.1.3.4.3.2.1.1.4.1.1Output voltage. Output voltage (V).
output.currentioutrealYes1.3.6.1.4.1.850.1.1.3.4.3.2.1.1.5.1.1Output current. Output current (A).
output.powerpoutrealYesYes1.3.6.1.4.1.850.1.1.3.4.3.2.1.1.8.1.1Output power. Output active power (W).
output.powerfactorreal1.3.6.1.4.1.850.1.1.3.4.3.2.1.1.9.1.1Output power factor.
output.ratingreal1.3.6.1.4.1.850.1.1.3.4.2.1.1.5.1Total input power rating (W).

Outlets

AddressRecordTypeHistoryStreamSourceDescription
outletsdint1.3.6.1.4.1.850.1.1.3.4.1.2.1.4.1Number of outlets.
outlets.ondintOutlets on.

System

AddressRecordTypeHistoryStreamSourceDescription
system.modelstring1.3.6.1.4.1.850.1.1.1.2.1.5.1Model.
system.manufacturerstring1.3.6.1.4.1.850.1.1.1.2.1.4.1Manufacturer.
system.devicenamestring1.3.6.1.4.1.850.1.1.1.2.1.6.1Device name as configured in PowerAlert.
system.locationstring1.3.6.1.4.1.850.1.1.1.2.1.8.1Device location.
system.namestring1.3.6.1.2.1.1.5.0SysName.
system.descrstring1.3.6.1.2.1.1.1.0SysDescr.
system.uptimedint1.3.6.1.2.1.1.3.0Agent uptime (s).

Input source letter

The camera creates these addresses for each input it finds on connect. n is its number or name, up to 8.

AddressRecordTypeHistoryStreamSourceDescription
input.{n}.voltagei{n}vrealYesYes1.3.6.1.4.1.850.1.1.3.4.3.1.2.1.5.1.{n}.1Source letter voltage.
input.{n}.frequencyi{n}frealYes1.3.6.1.4.1.850.1.1.3.4.3.1.2.1.4.1.{n}.1Source letter frequency.
input.{n}.currenti{n}arealYes1.3.6.1.4.1.850.1.1.3.4.3.1.2.1.8.1.{n}.1Source letter current.

Outlet n

The camera creates these addresses for each outlet it finds on connect. n is its number or name, up to 48.

AddressRecordTypeHistoryStreamSourceDescription
outlet.{n}.state#codeo{n}dintYesYes1.3.6.1.4.1.850.1.1.3.4.3.3.1.1.4.1.{n}Outlet n state. States: 0 OFF · 1 ON.
outlet.{n}.nameo{n}namestringYes1.3.6.1.4.1.850.1.1.3.4.3.3.1.1.2.1.{n}Outlet n name.
outlet.{n}.currento{n}arealYes1.3.6.1.4.1.850.1.1.3.4.3.3.1.1.8.1.{n}Outlet n current.
outlet.{n}.powero{n}wrealYes1.3.6.1.4.1.850.1.1.3.4.3.3.1.1.9.1.{n}Outlet n power.

ABB robot over Robot Web Services

Panel state, operating mode, RAPID execution and program pointer, joint angles, event log. Read-only.

ItemDetails
Profileraviden/abb-rws
FamilyRobot
SourceABB robot (Robot Web Services)
BrandABB
ModelsIRC5 (RobotWare 6, RWS 1.0) and OmniCore (RobotWare 7, RWS 2.0); the RWS version is detected at connect
Poll interval1,000 ms
UserDefault User

Status

AddressRecordTypeHistoryStreamSourceDescription
panel.rollup#coderollupdintYesYesRoll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes.
panel.state#codestatedintYesYesRobot state. Worst-of robot state (0 running · 1 stopped · 2 alarm (error in the last 10 min) · 3 guard stop · 4 e-stop · 5 system failure · 6 offline). States: 0 RUNNING · 1 STOPPED (roll-up IDLE) · 2 ALARM (roll-up WARNING) · 3 GUARD STOP (roll-up ALARM) · 4 E-STOP (roll-up ALARM) · 5 SYS FAIL (roll-up ALARM) · 6 OFFLINE.
panel.ctrlstate#codectrldintYesYesController state. Controller state code (0 init … 6 sysfail). States: 0 init · 1 motoroff · 2 motoron · 3 guardstop · 4 emergencystop · 5 emergencystopreset · 6 sysfail.
panel.opmode#codeopmodedintYesYesOperating mode. Operating mode code. States: 0 INIT · 1 AUTO · 2 MANR · 3 MANF · 4 AUTO_CH · 5 MANF_CH · 6 UNDEF.
exec.state#codeexecdintYesYesExecution. RAPID execution code (1 running, 0 stopped). States: 0 stopped · 1 running.
panel.speedratiospeeddintYesYesSpeed %. Panel speed ratio %.

Panel

AddressRecordTypeHistoryStreamSourceDescription
panel.rollupstringLabel of panel.rollup#codeRoll-up label.
panel.statestringLabel of panel.state#codeRobot state label.
panel.ctrlstatestringController state (motoron / guardstop / emergencystop …).
panel.opmodestringOperating mode (AUTO / MANR / MANF …).

Execution

AddressRecordTypeHistoryStreamSourceDescription
exec.statestringRAPID execution (running / stopped).
exec.cyclestringRAPID cycle mode.

Events

AddressRecordTypeHistoryStreamSourceDescription
elog.last.codeelogcodedintYesYesLast event code. Latest event — number.
elog.last.severityelogsevdintYesLast event severity. Latest event — severity (1 info, 2 warning, 3 error). States: 1 info · 2 warning · 3 error.
elog.last.titleelogtitlestringYesLast event title. Latest event — title.
elog.last.seqdintLatest event — sequence number.

Program

AddressRecordTypeHistoryStreamSourceDescription
exec.routineroutinestringYesYesRoutine. Program pointer — Module/Routine.
exec.linelinedintYesYesProgram line. Program pointer — line.
exec.stmtstmtstringYesStatement text. Program pointer — statement source text (module cache, change-count validated).

Tooling

AddressRecordTypeHistoryStreamSourceDescription
motion.tooltoolstringYesActive tool.
motion.wobjwobjstringYesWork object. Active work object.

Motion

AddressRecordTypeHistoryStreamSourceDescription
motion.joint.1j1realJoint 1. Joint 1 angle (deg).
motion.joint.2j2realJoint 2. Joint 2 angle (deg).
motion.joint.3j3realJoint 3. Joint 3 angle (deg).
motion.joint.4j4realJoint 4. Joint 4 angle (deg).
motion.joint.5j5realJoint 5. Joint 5 angle (deg).
motion.joint.6j6realJoint 6. Joint 6 angle (deg).
motion.tcp.xtcpxrealTCP X. TCP position X (mm, Base frame).
motion.tcp.ytcpyrealTCP Y. TCP position Y (mm).
motion.tcp.ztcpzrealTCP Z. TCP position Z (mm).

System

AddressRecordTypeHistoryStreamSourceDescription
system.namestringSystem name.
system.rwversionstringRobotWare version.
system.robottypestringRobot type.
system.energy.powerrealAverage power (W).

APC Smart-UPS over Modbus TCP (NMC2 / NMC3)

The UPS status word, runtime, charge, battery voltage and temperature, load, output and input through APC's Smart-UPS holding registers (FC03, unit id 1). Read-only. Status bits are the only per-bit-documented register; the error bitfields (18–25) are not implemented by UPS 09.x firmware, so battery-health conditions here come from charge and runtime.

ItemDetails
Profileraviden/apc-ap9631
FamilyUPS
SourceModbus TCP
BrandAPC
ModelsSmart-UPS SMT / SMX / SRT / SURTD behind an AP9630 / AP9631 / AP9635 / AP9537SUM card with Modbus TCP enabled (register map 990-9840)
Poll interval5,000 ms
Port502

Alarm conditions

A checked condition counts as an alarm on the connection. Default shows which conditions a new connection checks.

ConditionDefaultRaisesDescription
On batteryOnON BATTERYUtility lost, the load runs on the battery.
Low / depleted batteryOnLOW BATTERY · BATTERY DEPLETEDOn battery below 25 % charge, or the UPS is committed to shutting down.
OverloadOnOVERLOADThe UPS reports an overload state, or output load above 100 %.
On bypassOnON BYPASSThe load is unprotected.
UPS faultOnUPS FAULT · INPUT BAD · INFORMATIONAL ALERTThe status word's Fault modifier, or the input is not acceptable.

Status

AddressRecordTypeHistoryStreamSourceDescription
rollup#coderollupdintYesYesRoll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes.
rollupstringLabel of rollup#codeRoll-up label.
state#codestatedintYesYesDerivedUPS state. Worst-of UPS state (0 online · 1 on battery · 2 alarm · 3 bypass · 4 off · 5 no data · 6 offline). States: 0 ONLINE (roll-up RUNNING) · 1 ON BATTERY (roll-up WARNING) · 2 ALARM · 3 BYPASS (roll-up WARNING) · 4 OFF (roll-up STOPPED) · 5 NO DATA · 6 OFFLINE.
statestringLabel of state#codeUPS state label.
status#codestatusdintYesYesDerivedOutput status. Output status from the status word (0 online · 1 on battery · 2 bypass · 5 off · 7 eco · 8 test · 9 other). States: 0 ONLINE · 1 ON BATTERY · 2 BYPASS · 3 BOOST · 4 TRIM · 5 OFF · 6 SLEEP · 7 ECO · 8 TEST · 9 OTHER.
statusstringLabel of status#codeOutput status label.

Status word

AddressRecordTypeHistoryStreamSourceDescription
status.onlinedinthr:0 bit 1UPSStatus_BF bit 1 StateOnline: the output is sourced from the input.
status.onbatterydinthr:0 bit 2UPSStatus_BF bit 2 StateOnBattery.
status.bypassdinthr:0 bit 3UPSStatus_BF bit 3 StateBypass.
status.outputoffdinthr:0 bit 4UPSStatus_BF bit 4 StateOutputOff.
status.faultdinthr:0 bit 5UPSStatus_BF bit 5 Fault: a fault of any severity is present.
status.inputbaddinthr:0 bit 6UPSStatus_BF bit 6 InputBad: the input is not acceptable.
status.testdinthr:0 bit 7UPSStatus_BF bit 7 Test: a test is in progress.
status.pendingoffdinthr:0 bit 9UPSStatus_BF bit 9 PendingOutputOff: shutdown in progress — watch RunTimeRemaining.
status.ecodinthr:0 bit 13UPSStatus_BF bit 13 HighEfficiency (green / ECO mode).
status.alertdinthr:0 bit 14UPSStatus_BF bit 14 InformationalAlert (e.g. battery lifetime near end).
status.overloaddinthr:0 bit 21UPSStatus_BF bit 21 OverloadState.
status.rawdinthr:0:u32UPSStatus_BF as a number (registers 0–1).
status.cause#codedinthr:2:u16UPSStatusChangeCause_EN: why the current status was reached. States: 0 SYSTEM INIT · 1 HIGH INPUT VOLTAGE · 2 LOW INPUT VOLTAGE · 3 DISTORTED INPUT · 4 RAPID INPUT CHANGE · 5 HIGH INPUT FREQUENCY · 6 LOW INPUT FREQUENCY · 7 FREQUENCY / PHASE · 8 ACCEPTABLE INPUT · 9 AUTOMATIC TEST · 10 TEST ENDED · 11 LOCAL UI COMMAND · 12 PROTOCOL COMMAND · 13 LOW BATTERY VOLTAGE · 14 GENERAL ERROR · 15 POWER SYSTEM ERROR · 16 BATTERY SYSTEM ERROR · 17 ERROR CLEARED · 18 AUTOMATIC RESTART · 19 DISTORTED INVERTER OUTPUT · 20 INVERTER OUTPUT OK · 21 EPO · 22 INPUT PHASE DELTA · 23 NEUTRAL NOT CONNECTED · 24 ATS TRANSFER · 25 CONFIGURATION CHANGE · 26 ALERT ASSERTED · 27 ALERT CLEARED · 28 PLUG RATING EXCEEDED · 29 OUTLET GROUP CHANGE · 30 FAILURE BYPASS EXPIRED.

Alarms

AddressRecordTypeHistoryStreamSourceDescription
alarm#codealarmdintYesYesAlarm level. Alarm level (0 none · 1 warning · 2 alarm) per the connection's alarm policy. States: 0 NORMAL · 1 WARNING · 2 ALARM.
alarms.countalarmsdintYesActive alarms. Active conditions (derived).
alarms.textalarmtextstringYesActive alarm text. Active condition labels, comma separated.

Battery

AddressRecordTypeHistoryStreamSourceDescription
battery#codebattdintYesYesDerivedBattery status. Battery status derived from charge and the status word (0 normal · 1 low · 2 depleted) — the battery-error bitfield is not served by UPS 09.x firmware. States: 0 NORMAL · 1 LOW · 2 DEPLETED.
battery.chargechargerealYesYeshr:130:u16 × 0.001953125Battery charge %. StateOfCharge_Pct (register 130, ×2^-9).
battery.runtimeruntimerealYesYeshr:128:u32 × 0.016666666666666666Runtime remaining min. RunTimeRemaining (registers 128–129, seconds → minutes).
battery.voltagevbattrealYeshr:131:i16 × 0.03125Battery voltage. Battery.Positive.VoltageDC (register 131, ×2^-5).
battery.temptbattrealYeshr:135:i16 × 0.0078125Battery temperature. Battery.Temperature (register 135, ×2^-7 °C).

Input

AddressRecordTypeHistoryStreamSourceDescription
input.acceptabledinthr:150 bit 0Input.InputStatus_BF bit 0 Acceptable.
input.voltagevinrealYeshr:151:u16 × 0.015625Input voltage. Input0.VoltageAC (register 151, ×2^-6 V).
input.efficiencyrealhr:154:i16 × 0.0078125Input.Efficiency_EN (register 154, ×2^-7 %; negative = not available / load too low / output off / on battery / in bypass / charging / poor input / battery disconnected).

Output

AddressRecordTypeHistoryStreamSourceDescription
output.loadloadrealYesYeshr:136:u16 × 0.00390625Output load %. Output0.RealPower_Pct (register 136, ×2^-8).
output.apparentrealhr:138:u16 × 0.00390625Output0.ApparentPower_Pct (register 138, ×2^-8).
output.currentioutrealYeshr:140:u16 × 0.03125Output current. Output0.CurrentAC (register 140, ×2^-5 A).
output.voltagevoutrealYeshr:142:u16 × 0.015625Output voltage. Output0.VoltageAC (register 142, ×2^-6 V).
output.frequencyrealhr:144:u16 × 0.0078125Output.Frequency (register 144, ×2^-7 Hz).
output.energyrealhr:145:u32 × 0.001Output.Energy (registers 145–146, Wh → kWh).
output.powerpoutrealYesmul(output.load, system.ratedw)Output power. Output real power (W) = load % × nominal W (registers 136 and 589).

System

AddressRecordTypeHistoryStreamSourceDescription
system.firmwarestringhr:516:str8UPS firmware (registers 516–523).
system.modelstringhr:532:str16Model (registers 532–547).
system.skustringhr:548:str16SKU (registers 548–563).
system.serialstringhr:564:str8Serial number (registers 564–571).
system.batteryskustringhr:572:str8Battery SKU (registers 572–579).
system.ratedvadinthr:588:u16Nominal apparent power rating (VA, register 588).
system.ratedwdinthr:589:u16Nominal real power rating (W, register 589).
system.namestringhr:596:str8UPS name as configured on the card (registers 596–603).

APC UPS over PowerNet (+ UPS-MIB fallback)

PowerNet objects first (higher resolution, replace-battery flag, last transfer reason, state flags), UPS-MIB per object when the card lacks the PowerNet one.

ItemDetails
Profileraviden/apc-ups
FamilyUPS
SourceSNMP device
BrandAPC
ModelsSmart-UPS / Symmetra with a Network Management Card (NMC2 / NMC3, PowerNet-MIB)
Poll interval5,000 ms
Port161

The profile extends raviden/ups-mib. Its own sources are tried first, and the extended profile's sources fill in each object the device does not answer.

Alarm conditions

A checked condition counts as an alarm on the connection. Default shows which conditions a new connection checks.

ConditionDefaultRaisesDescription
On batteryOnON BATTERYUtility lost, the load runs on the battery.
Low / depleted batteryOnLOW BATTERY · BATTERY DEPLETEDThe runtime floor is near.
OverloadOnOVERLOADOutput load above 100 %.
On bypassOnON BYPASSThe load is unprotected.
Replace batteryOnNO BATTERY · REPLACE BATTERYThe UPS flags its battery as bad.
UPS faultOnBATTERY FAULTAny other alarm the UPS raises (fan, charger, temperature, comms lost …).

Status

AddressRecordTypeHistoryStreamSourceDescription
rollup#coderollupdintYesYesRoll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes.
rollupstringLabel of rollup#codeRoll-up label.
state#codestatedintYesYesDerivedUPS state. Worst-of UPS state (0 online · 1 on battery · 2 alarm · 3 bypass · 4 off · 5 no data · 6 offline). States: 0 ONLINE (roll-up RUNNING) · 1 ON BATTERY (roll-up WARNING) · 2 ALARM · 3 BYPASS (roll-up WARNING) · 4 OFF (roll-up STOPPED) · 5 NO DATA · 6 OFFLINE.
statestringLabel of state#codeUPS state label.
status#codestatusdintYesYes1.3.6.1.4.1.318.1.1.1.4.1.1.0, then 1.3.6.1.2.1.33.1.4.1.0Output status. Output status (0 online · 1 on battery · 2 bypass · 3 boost · 4 trim · 5 off · 6 sleep · 7 eco · 8 test). States: 0 ONLINE · 1 ON BATTERY · 2 BYPASS · 3 BOOST · 4 TRIM · 5 OFF · 6 SLEEP · 7 ECO · 8 TEST · 9 OTHER.
statusstringLabel of status#codeOutput status label (ONLINE / ON BATTERY / BYPASS …).
state.flagsstring1.3.6.1.4.1.318.1.1.1.11.1.1.0APC 64-character state flag string (upsBasicStateOutputState).

Alarms

AddressRecordTypeHistoryStreamSourceDescription
alarm#codealarmdintYesYesAlarm level. Alarm level (0 none · 1 warning · 2 alarm) per the connection's alarm policy. States: 0 NORMAL · 1 WARNING · 2 ALARM.
alarms.countalarmsdintYes1.3.6.1.2.1.33.1.6.1.0Active alarms. Active alarms (UPS-MIB alarm table).
alarms.textalarmtextstringYesActive alarm text. Active alarm labels, comma separated.

Battery

AddressRecordTypeHistoryStreamSourceDescription
battery#codebattdintYesYes1.3.6.1.4.1.318.1.1.1.2.1.1.0, then 1.3.6.1.2.1.33.1.2.1.0Battery status. Battery status (0 normal · 1 low · 2 depleted · 3 fault · 4 no battery). States: 0 NORMAL · 1 LOW · 2 DEPLETED · 3 FAULT · 4 NO BATTERY.
battery.chargechargerealYesYes1.3.6.1.4.1.318.1.1.1.2.3.1.0, then 1.3.6.1.2.1.33.1.2.4.0Battery charge %.
battery.runtimeruntimerealYesYes1.3.6.1.4.1.318.1.1.1.2.2.3.0, then 1.3.6.1.2.1.33.1.2.3.0Runtime remaining min. Estimated runtime remaining (min).
battery.voltagevbattrealYes1.3.6.1.4.1.318.1.1.1.2.3.4.0, then 1.3.6.1.2.1.33.1.2.5.0Battery voltage. Battery voltage (V DC).
battery.temptbattrealYes1.3.6.1.4.1.318.1.1.1.2.3.2.0, then 1.3.6.1.2.1.33.1.2.7.0Battery temperature. Battery temperature (°C).
battery.onbatterydint1.3.6.1.4.1.318.1.1.1.2.1.2.0, then 1.3.6.1.2.1.33.1.2.2.0Seconds on battery (0 while on line).
battery.replace#codereplacedintYes1.3.6.1.4.1.318.1.1.1.2.2.4.0Replace battery. Replace-battery flag (0 ok · 1 replace). States: 0 BATTERY OK · 1 REPLACE BATTERY.
battery.replacedstring1.3.6.1.4.1.318.1.1.1.2.1.3.0Last battery replacement date (APC).

Input

AddressRecordTypeHistoryStreamSourceDescription
input.voltagevinrealYes1.3.6.1.4.1.318.1.1.1.3.3.1.0, then 1.3.6.1.2.1.33.1.3.3.1.3.1Input voltage. Input voltage (V).
input.frequencyfinrealYes1.3.6.1.4.1.318.1.1.1.3.3.4.0, then 1.3.6.1.2.1.33.1.3.3.1.2.1Input frequency. Input frequency (Hz).
input.linebadsdint1.3.6.1.2.1.33.1.3.1.0Input line-bad count (transfers to battery since agent start).
input.transfer#codexferdintYes1.3.6.1.4.1.318.1.1.1.3.2.5.0Last transfer reason. Reason for the last transfer to battery (upsAdvInputLineFailCause). States: 0 NO TRANSFER · 1 HIGH LINE · 2 BROWNOUT · 3 BLACKOUT · 4 SMALL SAG · 5 DEEP SAG · 6 SMALL SPIKE · 7 LARGE SPIKE · 8 SELF TEST · 9 RATE OF CHANGE.

Output

AddressRecordTypeHistoryStreamSourceDescription
output.voltagevoutrealYes1.3.6.1.4.1.318.1.1.1.4.3.1.0, then 1.3.6.1.2.1.33.1.4.4.1.2.1Output voltage. Output voltage (V).
output.frequencyreal1.3.6.1.4.1.318.1.1.1.4.3.2.0, then 1.3.6.1.2.1.33.1.4.2.0Output frequency (Hz).
output.currentioutrealYes1.3.6.1.4.1.318.1.1.1.4.3.4.0, then 1.3.6.1.2.1.33.1.4.4.1.3.1Output current. Output current (A).
output.loadloadrealYesYes1.3.6.1.4.1.318.1.1.1.4.3.3.0, then 1.3.6.1.2.1.33.1.4.4.1.5.1Output load %.
output.powerpoutrealYes1.3.6.1.4.1.318.1.1.1.4.2.8.0, then 1.3.6.1.2.1.33.1.4.4.1.4.1Output power. Output power (W).

Test

AddressRecordTypeHistoryStreamSourceDescription
test#codetestdintYes1.3.6.1.4.1.318.1.1.1.7.2.3.0, then 1.3.6.1.2.1.33.1.7.3.0Self-test result. Last self-test result (0 passed · 1 warning · 2 failed · 3 aborted · 4 in progress · 5 none). States: 0 PASSED · 1 WARNING · 2 FAILED · 3 ABORTED · 4 IN PROGRESS · 5 NO TEST.
test.laststring1.3.6.1.4.1.318.1.1.1.7.2.4.0Last self-test date (APC).

System

AddressRecordTypeHistoryStreamSourceDescription
system.modelstring1.3.6.1.4.1.318.1.1.1.1.1.1.0, then 1.3.6.1.2.1.33.1.1.2.0Model.
system.manufacturerstring1.3.6.1.2.1.33.1.1.1.0Manufacturer.
system.firmwarestring1.3.6.1.4.1.318.1.1.1.1.2.1.0, then 1.3.6.1.2.1.33.1.1.3.0UPS firmware.
system.upsnamestring1.3.6.1.4.1.318.1.1.1.1.1.2.0, then 1.3.6.1.2.1.33.1.1.5.0UPS name as configured on the card.
system.namestring1.3.6.1.2.1.1.5.0SysName.
system.descrstring1.3.6.1.2.1.1.1.0SysDescr.
system.uptimedint1.3.6.1.2.1.1.3.0Agent uptime (s).
system.serialstring1.3.6.1.4.1.318.1.1.1.1.2.3.0Serial number (APC).

UPS over UPS-MIB (RFC 1628, any vendor)

Output status, battery, runtime, load, input and output through the standard UPS-MIB. Read-only: the driver only ever GETs.

ItemDetails
Profileraviden/ups-mib
FamilyUPS
SourceSNMP device
BrandAny
ModelsAny UPS whose network card implements RFC 1628 (Eaton, Vertiv, CyberPower, Tripp Lite, APC …)
Poll interval5,000 ms
Port161

Alarm conditions

A checked condition counts as an alarm on the connection. Default shows which conditions a new connection checks.

ConditionDefaultRaisesDescription
On batteryOnON BATTERYUtility lost, the load runs on the battery.
Low / depleted batteryOnLOW BATTERY · BATTERY DEPLETEDThe runtime floor is near.
OverloadOnOVERLOADOutput load above 100 %.
On bypassOnON BYPASSThe load is unprotected.
Replace batteryOnNO BATTERYThe UPS flags its battery as bad.
UPS faultOnBATTERY FAULTAny other alarm the UPS raises (fan, charger, temperature, comms lost …).

Status

AddressRecordTypeHistoryStreamSourceDescription
rollup#coderollupdintYesYesRoll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes.
rollupstringLabel of rollup#codeRoll-up label.
state#codestatedintYesYesDerivedUPS state. Worst-of UPS state (0 online · 1 on battery · 2 alarm · 3 bypass · 4 off · 5 no data · 6 offline). States: 0 ONLINE (roll-up RUNNING) · 1 ON BATTERY (roll-up WARNING) · 2 ALARM · 3 BYPASS (roll-up WARNING) · 4 OFF (roll-up STOPPED) · 5 NO DATA · 6 OFFLINE.
statestringLabel of state#codeUPS state label.
status#codestatusdintYesYes1.3.6.1.2.1.33.1.4.1.0Output status. Output status (0 online · 1 on battery · 2 bypass · 3 boost · 4 trim · 5 off · 6 sleep · 7 eco · 8 test). States: 0 ONLINE · 1 ON BATTERY · 2 BYPASS · 3 BOOST · 4 TRIM · 5 OFF · 6 SLEEP · 7 ECO · 8 TEST · 9 OTHER.
statusstringLabel of status#codeOutput status label (ONLINE / ON BATTERY / BYPASS …).

Alarms

AddressRecordTypeHistoryStreamSourceDescription
alarm#codealarmdintYesYesAlarm level. Alarm level (0 none · 1 warning · 2 alarm) per the connection's alarm policy. States: 0 NORMAL · 1 WARNING · 2 ALARM.
alarms.countalarmsdintYes1.3.6.1.2.1.33.1.6.1.0Active alarms. Active alarms (UPS-MIB alarm table).
alarms.textalarmtextstringYesActive alarm text. Active alarm labels, comma separated.

Battery

AddressRecordTypeHistoryStreamSourceDescription
battery#codebattdintYesYes1.3.6.1.2.1.33.1.2.1.0Battery status. Battery status (0 normal · 1 low · 2 depleted · 3 fault · 4 no battery). States: 0 NORMAL · 1 LOW · 2 DEPLETED · 3 FAULT · 4 NO BATTERY.
battery.chargechargerealYesYes1.3.6.1.2.1.33.1.2.4.0Battery charge %.
battery.runtimeruntimerealYesYes1.3.6.1.2.1.33.1.2.3.0Runtime remaining min. Estimated runtime remaining (min).
battery.voltagevbattrealYes1.3.6.1.2.1.33.1.2.5.0Battery voltage. Battery voltage (V DC).
battery.temptbattrealYes1.3.6.1.2.1.33.1.2.7.0Battery temperature. Battery temperature (°C).
battery.onbatterydint1.3.6.1.2.1.33.1.2.2.0Seconds on battery (0 while on line).

Input

AddressRecordTypeHistoryStreamSourceDescription
input.voltagevinrealYes1.3.6.1.2.1.33.1.3.3.1.3.1Input voltage. Input voltage (V).
input.frequencyfinrealYes1.3.6.1.2.1.33.1.3.3.1.2.1Input frequency. Input frequency (Hz).
input.linebadsdint1.3.6.1.2.1.33.1.3.1.0Input line-bad count (transfers to battery since agent start).

Output

AddressRecordTypeHistoryStreamSourceDescription
output.voltagevoutrealYes1.3.6.1.2.1.33.1.4.4.1.2.1Output voltage. Output voltage (V).
output.frequencyreal1.3.6.1.2.1.33.1.4.2.0Output frequency (Hz).
output.currentioutrealYes1.3.6.1.2.1.33.1.4.4.1.3.1Output current. Output current (A).
output.loadloadrealYesYes1.3.6.1.2.1.33.1.4.4.1.5.1Output load %.
output.powerpoutrealYes1.3.6.1.2.1.33.1.4.4.1.4.1Output power. Output power (W).

Test

AddressRecordTypeHistoryStreamSourceDescription
test#codetestdintYes1.3.6.1.2.1.33.1.7.3.0Self-test result. Last self-test result (0 passed · 1 warning · 2 failed · 3 aborted · 4 in progress · 5 none). States: 0 PASSED · 1 WARNING · 2 FAILED · 3 ABORTED · 4 IN PROGRESS · 5 NO TEST.

System

AddressRecordTypeHistoryStreamSourceDescription
system.modelstring1.3.6.1.2.1.33.1.1.2.0Model.
system.manufacturerstring1.3.6.1.2.1.33.1.1.1.0Manufacturer.
system.firmwarestring1.3.6.1.2.1.33.1.1.3.0UPS firmware.
system.upsnamestring1.3.6.1.2.1.33.1.1.5.0UPS name as configured on the card.
system.namestring1.3.6.1.2.1.1.5.0SysName.
system.descrstring1.3.6.1.2.1.1.1.0SysDescr.
system.uptimedint1.3.6.1.2.1.1.3.0Agent uptime (s).