Device profiles
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.
| Item | Details |
|---|---|
| Profile | raviden/mazak-mtc |
| Family | CNC |
| Source | Mazak CNC (MTConnect) |
| Brand | Mazak |
| Models | SmoothX / Smooth-G controls with the built-in MTConnect 1.x agent (port 5000) |
| Poll interval | 1,000 ms |
| Port | 5000 |
Status
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
rollup#code | rollup | dint | Yes | Yes | Roll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes. | |
rollup | string | Label of rollup#code | Roll-up label. | |||
state#code | state | dint | Yes | Yes | Machine 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. | |
state | string | Label of state#code | Machine state label. | |||
exec#code | exec | dint | Yes | Yes | Execution. 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. | |
exec | string | Execution (ACTIVE / READY / FEED_HOLD / STOPPED …). | ||||
mode#code | mode | dint | Yes | Yes | Controller 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. | |
mode | string | Controller mode (AUTOMATIC / MANUAL / MANUAL_DATA_INPUT / EDIT). | ||||
estop#code | estop | dint | Yes | Yes | Emergency stop. Emergency stop code (0 armed, 1 triggered). States: 0 ARMED · 1 E-STOP. | |
estop | string | Emergency stop (ARMED / TRIGGERED). | ||||
door#code | door | dint | Yes | Yes | Door. Door code (0 closed, 1 open, 2 unlatched). States: 0 DOOR CLOSED · 1 DOOR OPEN · 2 DOOR UNLATCHED. | |
door | string | Door state (OPEN / CLOSED / UNLATCHED). | ||||
avail#code | avail | dint | Yes | Availability. Availability code (1 available, 0 no data). States: 0 NO DATA · 1 AVAILABLE. | ||
avail | string | Availability (AVAILABLE / UNAVAILABLE). |
Events
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
cond#code | cond | dint | Yes | Yes | Worst condition. Worst active condition (0 normal, 1 warning, 2 alarm). States: 0 NORMAL · 1 WARNING · 2 ALARM. | |
cond.code | condcode | dint | Yes | Yes | Alarm code. Native code of the worst active condition. | |
cond.text | condtext | string | Yes | Alarm text. Text of the worst active condition. | ||
cond.count | dint | Active warnings + alarms. |
Program
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
program | program | string | Yes | Yes | Program. Main program name. | |
program.sub | string | Sub program name. | ||||
program.comment | string | Program comment. | ||||
line | line | dint | Yes | Yes | Program line. Program line number. | |
line.label | string | Program line label (N…). | ||||
tool | tool | string | Yes | Yes | Tool number. Tool number in the spindle. | |
tool.group | string | Tool group. | ||||
parts | parts | dint | Yes | Yes | Part count. | |
parts.target | dint | Part count target. | ||||
pallet | pallet | string | Yes | Pallet. Pallet id. |
Overrides
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
ovr.feed | ovrfeed | dint | Yes | Feed override %. | ||
ovr.rapid | ovrrapid | dint | Yes | Rapid override %. | ||
ovr.spindle | ovrspin | dint | Yes | Spindle override %. |
Spindle
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
spindle.rpm | srpm | real | Yes | Spindle speed. Spindle speed (rpm). | ||
spindle.load | sload | real | Yes | Spindle load %. | ||
spindle.temp | real | Spindle temperature °C. | ||||
spindle.mode | string | Spindle rotary mode (SPINDLE / INDEX / CONTOUR). | ||||
feed | feed | real | Yes | Path feedrate. Path feedrate (mm/s, actual). |
Counters
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
time.auto | dint | Accumulated automatic operation time (s). | ||||
time.cut | dint | Accumulated cutting time (s). | ||||
time.total | dint | Accumulated power-on time (s). |
System
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
system.name | string | Device name. | ||||
system.model | string | Model description. | ||||
system.serial | string | Serial number. | ||||
system.agent | string | MTConnect agent version. | ||||
system.axes | string | Axis names (space separated, probe order). | ||||
system.spindles | string | Spindle component names. |
Axis n
The camera creates these addresses for each axis it finds on connect. n is its number or name.
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
axis.{n}.pos | a{n}pos | real | Yes | Axis n position. | ||
axis.{n}.feed | a{n}feed | real | Axis n feedrate. | |||
axis.{n}.load | a{n}load | real | Yes | Axis n load %. | ||
axis.{n}.temp | a{n}temp | real | Yes | Axis n temperature. | ||
axis.{n}.state#code | a{n}state | dint | Yes | Axis 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.
| Item | Details |
|---|---|
| Profile | raviden/tripplite-pdu |
| Family | ATS / PDU |
| Source | SNMP device |
| Brand | Tripp Lite |
| Models | PDUMH / PDUMNH ATS and switched PDUs with PowerAlert 12.06+ / 15 / 20 (TRIPPLITE-PRODUCTS tlpAts branch, device index 1) |
| Poll interval | 5,000 ms |
| Port | 161 |
Alarm conditions
A checked condition counts as an alarm on the connection. Default shows which conditions a new connection checks.
| Condition | Default | Raises | Description |
|---|---|---|---|
| Transferred to source B | On | ON SOURCE B | The ATS switched off its primary source; stays active until it switches back. |
| Source lost | On | NO SOURCE · SOURCE B LOST · SOURCE A LOST | One input (or both) is out of tolerance. |
| Fault / critical alarm | On | GENERAL FAULT | The general-fault flag or a critical PowerAlert alarm. |
| Output off | Off | OUTPUT OFF | The main output is switched off (usually deliberate). |
Status
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
rollup#code | rollup | dint | Yes | Yes | Roll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes. | |
rollup | string | Label of rollup#code | Roll-up label. | |||
state#code | state | dint | Yes | Yes | Derived | ATS 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. |
state | string | Label of state#code | ATS state label. | |||
source#code | source | dint | Yes | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.1.1.1.13.1 | Source in use. Input source in use (0 A · 1 B). States: 0 SOURCE A · 1 SOURCE B. |
source | string | Label of source#code | Input source in use (SOURCE A / SOURCE B). | |||
source.avail#code | avail | dint | Yes | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.1.1.1.12.1 | Source 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.transfers | xfers | dint | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.1.1.1.14.1 | Source transfers. Source transfer count. | |
load#code | load | dint | Yes | Yes | 1.3.6.1.4.1.850.1.1.3.4.2.1.1.1.1 | Main output. Main output (0 off · 1 on). States: 0 OUTPUT OFF · 1 OUTPUT ON. |
fault#code | fault | dint | Yes | 1.3.6.1.4.1.850.1.1.3.4.2.1.1.12.1 | General fault. General fault (0 none · 1 fault). States: 0 NO FAULT · 1 FAULT. | |
device.status#code | dint | 1.3.6.1.4.1.850.1.1.1.2.1.10.1 | PowerAlert device status (0 ok · 1 info · 2 warning · 3 critical · 4 offline). States: 0 OK · 1 INFO · 2 WARNING · 3 CRITICAL · 4 OFFLINE. | |||
temp | real | 1.3.6.1.4.1.850.1.1.3.4.2.1.1.6.1 | Device temperature (°C). |
Alarms
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
alarm#code | alarm | dint | Yes | Yes | Alarm level. Alarm level (0 none · 1 warning · 2 alarm) per the connection's alarm policy. States: 0 NORMAL · 1 WARNING · 2 ALARM. | |
alarms.count | alarms | dint | Yes | 1.3.6.1.4.1.850.1.3.1.0 | Active alarms. Active alarms (tlpAlarmsPresent). | |
alarms.text | alarmtext | string | Yes | Active alarm text. Active alarm labels, comma separated. |
Input
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
input.nominal | real | 1.3.6.1.4.1.850.1.1.3.4.3.1.1.1.1.1 | Nominal input voltage (V). | |||
inputs | dint | 1.3.6.1.4.1.850.1.1.3.4.1.2.1.1.1 | Number of input sources. |
Output
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
output.voltage | vout | real | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.2.1.1.4.1.1 | Output voltage. Output voltage (V). | |
output.current | iout | real | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.2.1.1.5.1.1 | Output current. Output current (A). | |
output.power | pout | real | Yes | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.2.1.1.8.1.1 | Output power. Output active power (W). |
output.powerfactor | real | 1.3.6.1.4.1.850.1.1.3.4.3.2.1.1.9.1.1 | Output power factor. | |||
output.rating | real | 1.3.6.1.4.1.850.1.1.3.4.2.1.1.5.1 | Total input power rating (W). |
Outlets
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
outlets | dint | 1.3.6.1.4.1.850.1.1.3.4.1.2.1.4.1 | Number of outlets. | |||
outlets.on | dint | Outlets on. |
System
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
system.model | string | 1.3.6.1.4.1.850.1.1.1.2.1.5.1 | Model. | |||
system.manufacturer | string | 1.3.6.1.4.1.850.1.1.1.2.1.4.1 | Manufacturer. | |||
system.devicename | string | 1.3.6.1.4.1.850.1.1.1.2.1.6.1 | Device name as configured in PowerAlert. | |||
system.location | string | 1.3.6.1.4.1.850.1.1.1.2.1.8.1 | Device location. | |||
system.name | string | 1.3.6.1.2.1.1.5.0 | SysName. | |||
system.descr | string | 1.3.6.1.2.1.1.1.0 | SysDescr. | |||
system.uptime | dint | 1.3.6.1.2.1.1.3.0 | Agent 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.
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
input.{n}.voltage | i{n}v | real | Yes | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.1.2.1.5.1.{n}.1 | Source letter voltage. |
input.{n}.frequency | i{n}f | real | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.1.2.1.4.1.{n}.1 | Source letter frequency. | |
input.{n}.current | i{n}a | real | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.1.2.1.8.1.{n}.1 | Source 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.
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
outlet.{n}.state#code | o{n} | dint | Yes | Yes | 1.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}.name | o{n}name | string | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.3.1.1.2.1.{n} | Outlet n name. | |
outlet.{n}.current | o{n}a | real | Yes | 1.3.6.1.4.1.850.1.1.3.4.3.3.1.1.8.1.{n} | Outlet n current. | |
outlet.{n}.power | o{n}w | real | Yes | 1.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.
| Item | Details |
|---|---|
| Profile | raviden/abb-rws |
| Family | Robot |
| Source | ABB robot (Robot Web Services) |
| Brand | ABB |
| Models | IRC5 (RobotWare 6, RWS 1.0) and OmniCore (RobotWare 7, RWS 2.0); the RWS version is detected at connect |
| Poll interval | 1,000 ms |
| User | Default User |
Status
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
panel.rollup#code | rollup | dint | Yes | Yes | Roll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes. | |
panel.state#code | state | dint | Yes | Yes | Robot 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#code | ctrl | dint | Yes | Yes | Controller 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#code | opmode | dint | Yes | Yes | Operating mode. Operating mode code. States: 0 INIT · 1 AUTO · 2 MANR · 3 MANF · 4 AUTO_CH · 5 MANF_CH · 6 UNDEF. | |
exec.state#code | exec | dint | Yes | Yes | Execution. RAPID execution code (1 running, 0 stopped). States: 0 stopped · 1 running. | |
panel.speedratio | speed | dint | Yes | Yes | Speed %. Panel speed ratio %. |
Panel
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
panel.rollup | string | Label of panel.rollup#code | Roll-up label. | |||
panel.state | string | Label of panel.state#code | Robot state label. | |||
panel.ctrlstate | string | Controller state (motoron / guardstop / emergencystop …). | ||||
panel.opmode | string | Operating mode (AUTO / MANR / MANF …). |
Execution
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
exec.state | string | RAPID execution (running / stopped). | ||||
exec.cycle | string | RAPID cycle mode. |
Events
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
elog.last.code | elogcode | dint | Yes | Yes | Last event code. Latest event — number. | |
elog.last.severity | elogsev | dint | Yes | Last event severity. Latest event — severity (1 info, 2 warning, 3 error). States: 1 info · 2 warning · 3 error. | ||
elog.last.title | elogtitle | string | Yes | Last event title. Latest event — title. | ||
elog.last.seq | dint | Latest event — sequence number. |
Program
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
exec.routine | routine | string | Yes | Yes | Routine. Program pointer — Module/Routine. | |
exec.line | line | dint | Yes | Yes | Program line. Program pointer — line. | |
exec.stmt | stmt | string | Yes | Statement text. Program pointer — statement source text (module cache, change-count validated). |
Tooling
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
motion.tool | tool | string | Yes | Active tool. | ||
motion.wobj | wobj | string | Yes | Work object. Active work object. |
Motion
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
motion.joint.1 | j1 | real | Joint 1. Joint 1 angle (deg). | |||
motion.joint.2 | j2 | real | Joint 2. Joint 2 angle (deg). | |||
motion.joint.3 | j3 | real | Joint 3. Joint 3 angle (deg). | |||
motion.joint.4 | j4 | real | Joint 4. Joint 4 angle (deg). | |||
motion.joint.5 | j5 | real | Joint 5. Joint 5 angle (deg). | |||
motion.joint.6 | j6 | real | Joint 6. Joint 6 angle (deg). | |||
motion.tcp.x | tcpx | real | TCP X. TCP position X (mm, Base frame). | |||
motion.tcp.y | tcpy | real | TCP Y. TCP position Y (mm). | |||
motion.tcp.z | tcpz | real | TCP Z. TCP position Z (mm). |
System
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
system.name | string | System name. | ||||
system.rwversion | string | RobotWare version. | ||||
system.robottype | string | Robot type. | ||||
system.energy.power | real | Average 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.
| Item | Details |
|---|---|
| Profile | raviden/apc-ap9631 |
| Family | UPS |
| Source | Modbus TCP |
| Brand | APC |
| Models | Smart-UPS SMT / SMX / SRT / SURTD behind an AP9630 / AP9631 / AP9635 / AP9537SUM card with Modbus TCP enabled (register map 990-9840) |
| Poll interval | 5,000 ms |
| Port | 502 |
Alarm conditions
A checked condition counts as an alarm on the connection. Default shows which conditions a new connection checks.
| Condition | Default | Raises | Description |
|---|---|---|---|
| On battery | On | ON BATTERY | Utility lost, the load runs on the battery. |
| Low / depleted battery | On | LOW BATTERY · BATTERY DEPLETED | On battery below 25 % charge, or the UPS is committed to shutting down. |
| Overload | On | OVERLOAD | The UPS reports an overload state, or output load above 100 %. |
| On bypass | On | ON BYPASS | The load is unprotected. |
| UPS fault | On | UPS FAULT · INPUT BAD · INFORMATIONAL ALERT | The status word's Fault modifier, or the input is not acceptable. |
Status
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
rollup#code | rollup | dint | Yes | Yes | Roll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes. | |
rollup | string | Label of rollup#code | Roll-up label. | |||
state#code | state | dint | Yes | Yes | Derived | UPS 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. |
state | string | Label of state#code | UPS state label. | |||
status#code | status | dint | Yes | Yes | Derived | Output 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. |
status | string | Label of status#code | Output status label. |
Status word
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
status.online | dint | hr:0 bit 1 | UPSStatus_BF bit 1 StateOnline: the output is sourced from the input. | |||
status.onbattery | dint | hr:0 bit 2 | UPSStatus_BF bit 2 StateOnBattery. | |||
status.bypass | dint | hr:0 bit 3 | UPSStatus_BF bit 3 StateBypass. | |||
status.outputoff | dint | hr:0 bit 4 | UPSStatus_BF bit 4 StateOutputOff. | |||
status.fault | dint | hr:0 bit 5 | UPSStatus_BF bit 5 Fault: a fault of any severity is present. | |||
status.inputbad | dint | hr:0 bit 6 | UPSStatus_BF bit 6 InputBad: the input is not acceptable. | |||
status.test | dint | hr:0 bit 7 | UPSStatus_BF bit 7 Test: a test is in progress. | |||
status.pendingoff | dint | hr:0 bit 9 | UPSStatus_BF bit 9 PendingOutputOff: shutdown in progress — watch RunTimeRemaining. | |||
status.eco | dint | hr:0 bit 13 | UPSStatus_BF bit 13 HighEfficiency (green / ECO mode). | |||
status.alert | dint | hr:0 bit 14 | UPSStatus_BF bit 14 InformationalAlert (e.g. battery lifetime near end). | |||
status.overload | dint | hr:0 bit 21 | UPSStatus_BF bit 21 OverloadState. | |||
status.raw | dint | hr:0:u32 | UPSStatus_BF as a number (registers 0–1). | |||
status.cause#code | dint | hr:2:u16 | UPSStatusChangeCause_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
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
alarm#code | alarm | dint | Yes | Yes | Alarm level. Alarm level (0 none · 1 warning · 2 alarm) per the connection's alarm policy. States: 0 NORMAL · 1 WARNING · 2 ALARM. | |
alarms.count | alarms | dint | Yes | Active alarms. Active conditions (derived). | ||
alarms.text | alarmtext | string | Yes | Active alarm text. Active condition labels, comma separated. |
Battery
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
battery#code | batt | dint | Yes | Yes | Derived | Battery 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.charge | charge | real | Yes | Yes | hr:130:u16 × 0.001953125 | Battery charge %. StateOfCharge_Pct (register 130, ×2^-9). |
battery.runtime | runtime | real | Yes | Yes | hr:128:u32 × 0.016666666666666666 | Runtime remaining min. RunTimeRemaining (registers 128–129, seconds → minutes). |
battery.voltage | vbatt | real | Yes | hr:131:i16 × 0.03125 | Battery voltage. Battery.Positive.VoltageDC (register 131, ×2^-5). | |
battery.temp | tbatt | real | Yes | hr:135:i16 × 0.0078125 | Battery temperature. Battery.Temperature (register 135, ×2^-7 °C). |
Input
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
input.acceptable | dint | hr:150 bit 0 | Input.InputStatus_BF bit 0 Acceptable. | |||
input.voltage | vin | real | Yes | hr:151:u16 × 0.015625 | Input voltage. Input0.VoltageAC (register 151, ×2^-6 V). | |
input.efficiency | real | hr:154:i16 × 0.0078125 | Input.Efficiency_EN (register 154, ×2^-7 %; negative = not available / load too low / output off / on battery / in bypass / charging / poor input / battery disconnected). |
Output
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
output.load | load | real | Yes | Yes | hr:136:u16 × 0.00390625 | Output load %. Output0.RealPower_Pct (register 136, ×2^-8). |
output.apparent | real | hr:138:u16 × 0.00390625 | Output0.ApparentPower_Pct (register 138, ×2^-8). | |||
output.current | iout | real | Yes | hr:140:u16 × 0.03125 | Output current. Output0.CurrentAC (register 140, ×2^-5 A). | |
output.voltage | vout | real | Yes | hr:142:u16 × 0.015625 | Output voltage. Output0.VoltageAC (register 142, ×2^-6 V). | |
output.frequency | real | hr:144:u16 × 0.0078125 | Output.Frequency (register 144, ×2^-7 Hz). | |||
output.energy | real | hr:145:u32 × 0.001 | Output.Energy (registers 145–146, Wh → kWh). | |||
output.power | pout | real | Yes | mul(output.load, system.ratedw) | Output power. Output real power (W) = load % × nominal W (registers 136 and 589). |
System
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
system.firmware | string | hr:516:str8 | UPS firmware (registers 516–523). | |||
system.model | string | hr:532:str16 | Model (registers 532–547). | |||
system.sku | string | hr:548:str16 | SKU (registers 548–563). | |||
system.serial | string | hr:564:str8 | Serial number (registers 564–571). | |||
system.batterysku | string | hr:572:str8 | Battery SKU (registers 572–579). | |||
system.ratedva | dint | hr:588:u16 | Nominal apparent power rating (VA, register 588). | |||
system.ratedw | dint | hr:589:u16 | Nominal real power rating (W, register 589). | |||
system.name | string | hr:596:str8 | UPS 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.
| Item | Details |
|---|---|
| Profile | raviden/apc-ups |
| Family | UPS |
| Source | SNMP device |
| Brand | APC |
| Models | Smart-UPS / Symmetra with a Network Management Card (NMC2 / NMC3, PowerNet-MIB) |
| Poll interval | 5,000 ms |
| Port | 161 |
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.
| Condition | Default | Raises | Description |
|---|---|---|---|
| On battery | On | ON BATTERY | Utility lost, the load runs on the battery. |
| Low / depleted battery | On | LOW BATTERY · BATTERY DEPLETED | The runtime floor is near. |
| Overload | On | OVERLOAD | Output load above 100 %. |
| On bypass | On | ON BYPASS | The load is unprotected. |
| Replace battery | On | NO BATTERY · REPLACE BATTERY | The UPS flags its battery as bad. |
| UPS fault | On | BATTERY FAULT | Any other alarm the UPS raises (fan, charger, temperature, comms lost …). |
Status
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
rollup#code | rollup | dint | Yes | Yes | Roll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes. | |
rollup | string | Label of rollup#code | Roll-up label. | |||
state#code | state | dint | Yes | Yes | Derived | UPS 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. |
state | string | Label of state#code | UPS state label. | |||
status#code | status | dint | Yes | Yes | 1.3.6.1.4.1.318.1.1.1.4.1.1.0, then 1.3.6.1.2.1.33.1.4.1.0 | Output 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. |
status | string | Label of status#code | Output status label (ONLINE / ON BATTERY / BYPASS …). | |||
state.flags | string | 1.3.6.1.4.1.318.1.1.1.11.1.1.0 | APC 64-character state flag string (upsBasicStateOutputState). |
Alarms
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
alarm#code | alarm | dint | Yes | Yes | Alarm level. Alarm level (0 none · 1 warning · 2 alarm) per the connection's alarm policy. States: 0 NORMAL · 1 WARNING · 2 ALARM. | |
alarms.count | alarms | dint | Yes | 1.3.6.1.2.1.33.1.6.1.0 | Active alarms. Active alarms (UPS-MIB alarm table). | |
alarms.text | alarmtext | string | Yes | Active alarm text. Active alarm labels, comma separated. |
Battery
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
battery#code | batt | dint | Yes | Yes | 1.3.6.1.4.1.318.1.1.1.2.1.1.0, then 1.3.6.1.2.1.33.1.2.1.0 | Battery 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.charge | charge | real | Yes | Yes | 1.3.6.1.4.1.318.1.1.1.2.3.1.0, then 1.3.6.1.2.1.33.1.2.4.0 | Battery charge %. |
battery.runtime | runtime | real | Yes | Yes | 1.3.6.1.4.1.318.1.1.1.2.2.3.0, then 1.3.6.1.2.1.33.1.2.3.0 | Runtime remaining min. Estimated runtime remaining (min). |
battery.voltage | vbatt | real | Yes | 1.3.6.1.4.1.318.1.1.1.2.3.4.0, then 1.3.6.1.2.1.33.1.2.5.0 | Battery voltage. Battery voltage (V DC). | |
battery.temp | tbatt | real | Yes | 1.3.6.1.4.1.318.1.1.1.2.3.2.0, then 1.3.6.1.2.1.33.1.2.7.0 | Battery temperature. Battery temperature (°C). | |
battery.onbattery | dint | 1.3.6.1.4.1.318.1.1.1.2.1.2.0, then 1.3.6.1.2.1.33.1.2.2.0 | Seconds on battery (0 while on line). | |||
battery.replace#code | replace | dint | Yes | 1.3.6.1.4.1.318.1.1.1.2.2.4.0 | Replace battery. Replace-battery flag (0 ok · 1 replace). States: 0 BATTERY OK · 1 REPLACE BATTERY. | |
battery.replaced | string | 1.3.6.1.4.1.318.1.1.1.2.1.3.0 | Last battery replacement date (APC). |
Input
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
input.voltage | vin | real | Yes | 1.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.1 | Input voltage. Input voltage (V). | |
input.frequency | fin | real | Yes | 1.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.1 | Input frequency. Input frequency (Hz). | |
input.linebads | dint | 1.3.6.1.2.1.33.1.3.1.0 | Input line-bad count (transfers to battery since agent start). | |||
input.transfer#code | xfer | dint | Yes | 1.3.6.1.4.1.318.1.1.1.3.2.5.0 | Last 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
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
output.voltage | vout | real | Yes | 1.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.1 | Output voltage. Output voltage (V). | |
output.frequency | real | 1.3.6.1.4.1.318.1.1.1.4.3.2.0, then 1.3.6.1.2.1.33.1.4.2.0 | Output frequency (Hz). | |||
output.current | iout | real | Yes | 1.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.1 | Output current. Output current (A). | |
output.load | load | real | Yes | Yes | 1.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.1 | Output load %. |
output.power | pout | real | Yes | 1.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.1 | Output power. Output power (W). |
Test
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
test#code | test | dint | Yes | 1.3.6.1.4.1.318.1.1.1.7.2.3.0, then 1.3.6.1.2.1.33.1.7.3.0 | Self-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.last | string | 1.3.6.1.4.1.318.1.1.1.7.2.4.0 | Last self-test date (APC). |
System
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
system.model | string | 1.3.6.1.4.1.318.1.1.1.1.1.1.0, then 1.3.6.1.2.1.33.1.1.2.0 | Model. | |||
system.manufacturer | string | 1.3.6.1.2.1.33.1.1.1.0 | Manufacturer. | |||
system.firmware | string | 1.3.6.1.4.1.318.1.1.1.1.2.1.0, then 1.3.6.1.2.1.33.1.1.3.0 | UPS firmware. | |||
system.upsname | string | 1.3.6.1.4.1.318.1.1.1.1.1.2.0, then 1.3.6.1.2.1.33.1.1.5.0 | UPS name as configured on the card. | |||
system.name | string | 1.3.6.1.2.1.1.5.0 | SysName. | |||
system.descr | string | 1.3.6.1.2.1.1.1.0 | SysDescr. | |||
system.uptime | dint | 1.3.6.1.2.1.1.3.0 | Agent uptime (s). | |||
system.serial | string | 1.3.6.1.4.1.318.1.1.1.1.2.3.0 | Serial 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.
| Item | Details |
|---|---|
| Profile | raviden/ups-mib |
| Family | UPS |
| Source | SNMP device |
| Brand | Any |
| Models | Any UPS whose network card implements RFC 1628 (Eaton, Vertiv, CyberPower, Tripp Lite, APC …) |
| Poll interval | 5,000 ms |
| Port | 161 |
Alarm conditions
A checked condition counts as an alarm on the connection. Default shows which conditions a new connection checks.
| Condition | Default | Raises | Description |
|---|---|---|---|
| On battery | On | ON BATTERY | Utility lost, the load runs on the battery. |
| Low / depleted battery | On | LOW BATTERY · BATTERY DEPLETED | The runtime floor is near. |
| Overload | On | OVERLOAD | Output load above 100 %. |
| On bypass | On | ON BYPASS | The load is unprotected. |
| Replace battery | On | NO BATTERY | The UPS flags its battery as bad. |
| UPS fault | On | BATTERY FAULT | Any other alarm the UPS raises (fan, charger, temperature, comms lost …). |
Status
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
rollup#code | rollup | dint | Yes | Yes | Roll-up status. Unified health (RUNNING · IDLE · WARNING · ALARM · STOPPED · NO DATA · OFFLINE). Pinned. The values are the unified roll-up codes. | |
rollup | string | Label of rollup#code | Roll-up label. | |||
state#code | state | dint | Yes | Yes | Derived | UPS 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. |
state | string | Label of state#code | UPS state label. | |||
status#code | status | dint | Yes | Yes | 1.3.6.1.2.1.33.1.4.1.0 | Output 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. |
status | string | Label of status#code | Output status label (ONLINE / ON BATTERY / BYPASS …). |
Alarms
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
alarm#code | alarm | dint | Yes | Yes | Alarm level. Alarm level (0 none · 1 warning · 2 alarm) per the connection's alarm policy. States: 0 NORMAL · 1 WARNING · 2 ALARM. | |
alarms.count | alarms | dint | Yes | 1.3.6.1.2.1.33.1.6.1.0 | Active alarms. Active alarms (UPS-MIB alarm table). | |
alarms.text | alarmtext | string | Yes | Active alarm text. Active alarm labels, comma separated. |
Battery
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
battery#code | batt | dint | Yes | Yes | 1.3.6.1.2.1.33.1.2.1.0 | Battery 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.charge | charge | real | Yes | Yes | 1.3.6.1.2.1.33.1.2.4.0 | Battery charge %. |
battery.runtime | runtime | real | Yes | Yes | 1.3.6.1.2.1.33.1.2.3.0 | Runtime remaining min. Estimated runtime remaining (min). |
battery.voltage | vbatt | real | Yes | 1.3.6.1.2.1.33.1.2.5.0 | Battery voltage. Battery voltage (V DC). | |
battery.temp | tbatt | real | Yes | 1.3.6.1.2.1.33.1.2.7.0 | Battery temperature. Battery temperature (°C). | |
battery.onbattery | dint | 1.3.6.1.2.1.33.1.2.2.0 | Seconds on battery (0 while on line). |
Input
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
input.voltage | vin | real | Yes | 1.3.6.1.2.1.33.1.3.3.1.3.1 | Input voltage. Input voltage (V). | |
input.frequency | fin | real | Yes | 1.3.6.1.2.1.33.1.3.3.1.2.1 | Input frequency. Input frequency (Hz). | |
input.linebads | dint | 1.3.6.1.2.1.33.1.3.1.0 | Input line-bad count (transfers to battery since agent start). |
Output
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
output.voltage | vout | real | Yes | 1.3.6.1.2.1.33.1.4.4.1.2.1 | Output voltage. Output voltage (V). | |
output.frequency | real | 1.3.6.1.2.1.33.1.4.2.0 | Output frequency (Hz). | |||
output.current | iout | real | Yes | 1.3.6.1.2.1.33.1.4.4.1.3.1 | Output current. Output current (A). | |
output.load | load | real | Yes | Yes | 1.3.6.1.2.1.33.1.4.4.1.5.1 | Output load %. |
output.power | pout | real | Yes | 1.3.6.1.2.1.33.1.4.4.1.4.1 | Output power. Output power (W). |
Test
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
test#code | test | dint | Yes | 1.3.6.1.2.1.33.1.7.3.0 | Self-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
| Address | Record | Type | History | Stream | Source | Description |
|---|---|---|---|---|---|---|
system.model | string | 1.3.6.1.2.1.33.1.1.2.0 | Model. | |||
system.manufacturer | string | 1.3.6.1.2.1.33.1.1.1.0 | Manufacturer. | |||
system.firmware | string | 1.3.6.1.2.1.33.1.1.3.0 | UPS firmware. | |||
system.upsname | string | 1.3.6.1.2.1.33.1.1.5.0 | UPS name as configured on the card. | |||
system.name | string | 1.3.6.1.2.1.1.5.0 | SysName. | |||
system.descr | string | 1.3.6.1.2.1.1.1.0 | SysDescr. | |||
system.uptime | dint | 1.3.6.1.2.1.1.3.0 | Agent uptime (s). |