--************************************************************************** -- -- Copyright 2005 Broadcom Corporation -- All Rights Reserved -- No portions of this material may be reproduced in any form without the -- written permission of: -- Broadcom Corporation -- 16251 Laguna Canyon Road -- Irvine, California 92618 -- All information contained in this document is Broadcom Corporation -- company private, proprietary, and trade secret. -- -- -- --************************************************************************** -- Filename: brcm-battery-mgmt.mib -- Author: Kevin O'Neal -- Creation Date: February 11, 2005 -- --************************************************************************** -- Description: -- -- private MIB for runtime (not factory) management of battery -- --************************************************************************** -- Revision History: -- --************************************************************************** BRCM-BATTERY-MGMT-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Integer32, Unsigned32 FROM SNMPv2-SMI TruthValue, DateAndTime, DisplayString FROM SNMPv2-TC cableDataMgmtMIBObjects FROM BRCM-CABLEDATA-MGMT-MIB PositiveInteger FROM UPS-MIB; batteryMgmt MODULE-IDENTITY LAST-UPDATED "200612080000Z" ORGANIZATION "Broadcom Corporation" CONTACT-INFO " BANANA-CABLEDATA (cableData branch of the Broadcom Assigned Numbers and Naming Authority) Broadcom Corporation Postal: 4385 River Green Parkway Duluth, GA 30096 USA Tel: +1 770 232-0018 E-mail: banana-cabledata@broadcom.com" DESCRIPTION "Broadcom proprietary MIB for management of battery objects." REVISION "200502110000Z" DESCRIPTION "Initial version of this MIB module." REVISION "200504190000Z" DESCRIPTION "Added object battChargerReplaceBatteryThreshold." REVISION "200508230000Z" DESCRIPTION "Added group batteryPowerMgmt." REVISION "200512010000Z" DESCRIPTION "Added group batteryBcmAlarms and object battChargerLowChargeThreshold." REVISION "200602070000Z" DESCRIPTION "Added alarms bcmAlarmBadTempChargeSuspended and bcmAlarmBadTempPowerReduced." REVISION "200602070100Z" DESCRIPTION "Added objects battEstimatedMinutesRemaining and battEstimatedChargeRemaining to the batteryTable." REVISION "200602080000Z" DESCRIPTION "Added object battErrors to the batteryTable." REVISION "200612080000Z" DESCRIPTION "Added alarm bcmAlarmTempBadDischargeInhibited. Changed names of bcmAlarmBadTempChargeSuspended and bcmAlarmBadTempPowerReduced to bcmAlarmTempBadChargeSuspended and bcmAlarmTempBadPowerReduced for naming consistency with upsAlarmTempBad from the UPS-MIB." ::= { cableDataMgmtMIBObjects 10 } batteryMgmtBase OBJECT IDENTIFIER ::= { batteryMgmt 1 } batteryTable OBJECT-TYPE SYNTAX SEQUENCE OF BatteryEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of batteries present on the system." ::= { batteryMgmtBase 1 } batteryEntry OBJECT-TYPE SYNTAX BatteryEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry describing the characteristics of an individual battery." INDEX { battIndex } ::= { batteryTable 1 } BatteryEntry ::= SEQUENCE { battIndex Integer32, battCapacity Unsigned32, battMaximumVoltage Unsigned32, battMinimumVoltage Unsigned32, battMeasuredVoltage Unsigned32, battIsValid TruthValue, battIsSelected TruthValue, battEstimatedMinutesRemaining PositiveInteger, battEstimatedChargeRemaining INTEGER, battErrors Unsigned32, battEpromRevision DisplayString, battPackSupplier DisplayString, battModelNumber DisplayString, battSerialNumber DisplayString, battCellSupplier DisplayString, battCellCapacity DisplayString, battCellDateCode DisplayString, battPackDateCode DisplayString } battIndex OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS not-accessible STATUS current DESCRIPTION "Identifies the instance number of this individual battery." ::= { batteryEntry 1 } battCapacity OBJECT-TYPE SYNTAX Unsigned32 UNITS "milliamp hours" MAX-ACCESS read-only STATUS current DESCRIPTION "The charge capacity of this battery." ::= { batteryEntry 2 } battMaximumVoltage OBJECT-TYPE SYNTAX Unsigned32 UNITS "millivolts" MAX-ACCESS read-only STATUS current DESCRIPTION "The voltage at which this battery is considered to be fully charged. Note that if battChargerMaximumCharge is set to less than 100%, the battery will never be charged to this voltage." ::= { batteryEntry 3 } battMinimumVoltage OBJECT-TYPE SYNTAX Unsigned32 UNITS "millivolts" MAX-ACCESS read-only STATUS current DESCRIPTION "The voltage at which this battery is considered to be fully discharged." ::= { batteryEntry 4 } battMeasuredVoltage OBJECT-TYPE SYNTAX Unsigned32 UNITS "millivolts" MAX-ACCESS read-only STATUS current DESCRIPTION "The most recently measured voltage of this battery." ::= { batteryEntry 5 } battIsValid OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "Indicates whether this battery is considered valid by the battery charger. A value of false(2) here indicates some kind of failure with this battery." ::= { batteryEntry 6 } battIsSelected OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "Indicates whether this battery is currently selected for charging or discharging." ::= { batteryEntry 7 } battEstimatedMinutesRemaining OBJECT-TYPE SYNTAX PositiveInteger UNITS "minutes" MAX-ACCESS read-only STATUS current DESCRIPTION "An estimate of the time to depletion of this battery's charge under the present load conditions if the utility power is off and remains off, or if it were to be lost and remain off." ::= { batteryEntry 8 } battEstimatedChargeRemaining OBJECT-TYPE SYNTAX INTEGER (0..100) UNITS "percent" MAX-ACCESS read-only STATUS current DESCRIPTION "An estimate of this battery's charge remaining expressed as a percent of full charge." ::= { batteryEntry 9 } battErrors OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "Indicates the number of errors reported by the charger when trying to charge this battery. This object should always have a value of zero if all is well with the charger and the battery." ::= { batteryEntry 10 } battEpromRevision OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The version of the battery EPROM." ::= { batteryEntry 11 } battPackSupplier OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Battery Pack Supplier" ::= { batteryEntry 12 } battModelNumber OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Battery Model Number." ::= { batteryEntry 13 } battSerialNumber OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Battery Serial Number." ::= { batteryEntry 14 } battCellSupplier OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Battery Cell Supplier." ::= { batteryEntry 15 } battCellCapacity OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Battery Cell Capacity." ::= { batteryEntry 16 } battCellDateCode OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Battery Cell Date Code(mmddyy)." ::= { batteryEntry 17 } battPackDateCode OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Battery Pack Date Code(mmddyy)." ::= { batteryEntry 18 } batteryCharger OBJECT IDENTIFIER ::= { batteryMgmt 2 } battChargerMicrocodeVersion OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The version of the battery charger microcode." ::= { batteryCharger 1 } battChargerMicrocodeBuildTime OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-only STATUS current DESCRIPTION "The build date and time of the battery charger microcode." ::= { batteryCharger 2 } battChargerInputVoltage OBJECT-TYPE SYNTAX Unsigned32 UNITS "millivolts" MAX-ACCESS read-only STATUS current DESCRIPTION "The most recently measured input voltage to the battery charger. Typically, if operating on battery power, this value will approach zero. If operating on utility power, this value will approach the value of the power supplied to the device." ::= { batteryCharger 3 } battChargerState OBJECT-TYPE SYNTAX INTEGER { initializing(1), sleep(2), chargeInit(3), preQualification(4), fastCharge(5), trickleCharge(6), topOff(7), discharge(8), forcedDischarge(9), powerOnDischarge(10), eternalSleep(11) } MAX-ACCESS read-only STATUS current DESCRIPTION "The current state of the battery charger. Note that all states may not be supported on all types of chargers." ::= { batteryCharger 4 } battChargerMaximumCharge OBJECT-TYPE SYNTAX Unsigned32 (0..100) UNITS "percent" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the level to which the charger should charge the batteries." ::= { batteryCharger 5 } battChargerReplaceBatteryThreshold OBJECT-TYPE SYNTAX Unsigned32 (0..100) UNITS "percent" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the minimum charge percentage that the battery must be able to reach when charging. If a battery cannot be charged above this percentage, it will be considered bad and battIsValid will transition to false(2)." ::= { batteryCharger 6 } battChargerLowChargeThreshold OBJECT-TYPE SYNTAX Unsigned32 (0..100) UNITS "percent" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the charge percentage at which the bcmAlarmLowBatteryCharge will be raised." DEFVAL { 25 } ::= { batteryCharger 7 } batteryPowerMgmt OBJECT IDENTIFIER ::= { batteryMgmt 3 } batteryPowerMgmtInterfaces OBJECT IDENTIFIER ::= { batteryPowerMgmt 1 } battPowerMgmtCmDelay OBJECT-TYPE SYNTAX Integer32 (-1..2147483647) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the number of seconds following transition to battery power before the DOCSIS CM interface will enter power management mode. If set to -1, the interface will never enter power management mode and will remain at full power until utility power is restored or battery charge is depleted." DEFVAL { 0 } ::= { batteryPowerMgmtInterfaces 1 } battPowerMgmtEthernetDelay OBJECT-TYPE SYNTAX Integer32 (-1..2147483647) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the number of seconds following transition to battery power before the ethernet interface will enter power management mode. If set to -1, the interface will never enter power management mode and will remain at full power until utility power is restored or battery charge is depleted." DEFVAL { 0 } ::= { batteryPowerMgmtInterfaces 2 } battPowerMgmtUsbDelay OBJECT-TYPE SYNTAX Integer32 (-1..2147483647) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the number of seconds following transition to battery power before the USB interface will enter power management mode. If set to -1, the interface will never enter power management mode and will remain at full power until utility power is restored or battery charge is depleted." DEFVAL { 0 } ::= { batteryPowerMgmtInterfaces 3 } battPowerMgmtWiFiDelay OBJECT-TYPE SYNTAX Integer32 (-1..2147483647) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the number of seconds following transition to battery power before the WiFi interface will enter power management mode. If set to -1, the interface will never enter power management mode and will remain at full power until utility power is restored or battery charge is depleted." DEFVAL { 0 } ::= { batteryPowerMgmtInterfaces 4 } battPowerMgmtBluetoothDelay OBJECT-TYPE SYNTAX Integer32 (-1..2147483647) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the number of seconds following transition to battery power before the bluetooth interface will enter power management mode. If set to -1, the interface will never enter power management mode and will remain at full power until utility power is restored or battery charge is depleted." DEFVAL { 0 } ::= { batteryPowerMgmtInterfaces 5 } battPowerMgmtHpnaDelay OBJECT-TYPE SYNTAX Integer32 (-1..2147483647) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "Specifies the number of seconds following transition to battery power before the HPNA interface will enter power management mode. If set to -1, the interface will never enter power management mode and will remain at full power until utility power is restored or battery charge is depleted." DEFVAL { 0 } ::= { batteryPowerMgmtInterfaces 6 } -- batteryBcmAlarms provides a node under which enterprise-specific alarm -- OIDs may be defined for use in the upsAlarmTable. batteryBcmAlarms OBJECT IDENTIFIER ::= { batteryMgmt 4 } bcmAlarmLowBatteryCharge OBJECT-IDENTITY STATUS current DESCRIPTION "The value of upsEstimatedChargeRemaining is less than or equal to the value of battChargerLowChargeThreshold." ::= { batteryBcmAlarms 1 } bcmAlarmTempBadChargeSuspended OBJECT-IDENTITY STATUS current DESCRIPTION "The temperature of the device has exceeded operational limits for safe battery charging, and battery charging has been suspended." ::= { batteryBcmAlarms 2 } bcmAlarmTempBadPowerReduced OBJECT-IDENTITY STATUS current DESCRIPTION "The temperature of the device has exceeded operational limits, and the device has been placed in low power mode in an to attempt to reduce heat production." ::= { batteryBcmAlarms 3 } bcmAlarmBatteryMissing OBJECT-IDENTITY STATUS current DESCRIPTION "There are no batteries installed in the device and the device will not be capable of sustaining power in the event of utility power loss." ::= { batteryBcmAlarms 4 } bcmAlarmTempBadDischargeInhibited OBJECT-IDENTITY STATUS current DESCRIPTION "The temperature of the device has exceeded operational limits for safe battery discharging, and battery discharging has been inhibited." ::= { batteryBcmAlarms 5 } END