entity_sensor_mib

Documentation

Overview

This module defines Entity MIB extensions for physical sensors.

Copyright (C) The Internet Society (2002). This version of this MIB module is part of RFC 3433; see the RFC itself for full legal notices.

Index

• type ENTITYSENSORMIB
  • func (eNTITYSENSORMIB *ENTITYSENSORMIB) GetEntityData() *types.CommonEntityData
• type ENTITYSENSORMIB_EntPhySensorTable
  • func (entPhySensorTable *ENTITYSENSORMIB_EntPhySensorTable) GetEntityData() *types.CommonEntityData
• type ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry
  • func (entPhySensorEntry *ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry) GetEntityData() *types.CommonEntityData
• type EntitySensorDataScale
• type EntitySensorDataType
• type EntitySensorStatus

Types

type ENTITYSENSORMIB

type ENTITYSENSORMIB struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// This table contains one row per physical sensor represented by an
	// associated row in the entPhysicalTable.
	EntPhySensorTable ENTITYSENSORMIB_EntPhySensorTable
}

ENTITYSENSORMIB

func (*ENTITYSENSORMIB) GetEntityData

func (eNTITYSENSORMIB *ENTITYSENSORMIB) GetEntityData() *types.CommonEntityData

type ENTITYSENSORMIB_EntPhySensorTable

type ENTITYSENSORMIB_EntPhySensorTable struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Information about a particular physical sensor.  An entry in this table
	// describes the present reading of a sensor, the measurement units and scale,
	// and sensor operational status.  Entries are created in this table by the
	// agent.  An entry for each physical sensor SHOULD be created at the same
	// time as the associated entPhysicalEntry.  An entry SHOULD be destroyed if
	// the associated entPhysicalEntry is destroyed. The type is slice of
	// ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry.
	EntPhySensorEntry []*ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry
}

ENTITYSENSORMIB_EntPhySensorTable This table contains one row per physical sensor represented by an associated row in the entPhysicalTable.

func (*ENTITYSENSORMIB_EntPhySensorTable) GetEntityData

func (entPhySensorTable *ENTITYSENSORMIB_EntPhySensorTable) GetEntityData() *types.CommonEntityData

type ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry

type ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to
	// entity_mib.ENTITYMIB_EntPhysicalTable_EntPhysicalEntry_EntPhysicalIndex
	EntPhysicalIndex interface{}

	// The type of data returned by the associated entPhySensorValue object.  This
	// object SHOULD be set by the agent during entry creation, and the value
	// SHOULD NOT change during operation. The type is EntitySensorDataType.
	EntPhySensorType interface{}

	// The exponent to apply to values returned by the associated
	// entPhySensorValue object.  This object SHOULD be set by the agent during
	// entry creation, and the value SHOULD NOT change during operation. The type
	// is EntitySensorDataScale.
	EntPhySensorScale interface{}

	// The number of decimal places of precision in fixed-point sensor values
	// returned by the associated entPhySensorValue object.  This object SHOULD be
	// set to '0' when the associated entPhySensorType value is not a fixed-point
	// type: e.g., 'percentRH(9)', 'rpm(10)', 'cmm(11)', or 'truthvalue(12)'.
	// This object SHOULD be set by the agent during entry creation, and the value
	// SHOULD NOT change during operation. The type is interface{} with range:
	// -8..9.
	EntPhySensorPrecision interface{}

	// The most recent measurement obtained by the agent for this sensor.  To
	// correctly interpret the value of this object, the associated
	// entPhySensorType, entPhySensorScale, and entPhySensorPrecision objects must
	// also be examined. The type is interface{} with range:
	// -1000000000..1073741823.
	EntPhySensorValue interface{}

	// The operational status of the sensor. The type is EntitySensorStatus.
	EntPhySensorOperStatus interface{}

	// A textual description of the data units that should be used in the display
	// of entPhySensorValue. The type is string.
	EntPhySensorUnitsDisplay interface{}

	// The value of sysUpTime at the time the status and/or value of this sensor
	// was last obtained by the agent. The type is interface{} with range:
	// 0..4294967295.
	EntPhySensorValueTimeStamp interface{}

	// An indication of the frequency that the agent updates the associated
	// entPhySensorValue object, representing in milliseconds.  The value zero
	// indicates:      - the sensor value is updated on demand (e.g.,       when
	// polled by the agent for a get-request),     - the sensor value is updated
	// when the sensor       value changes (event-driven),     - the agent does
	// not know the update rate. The type is interface{} with range:
	// 0..4294967295. Units are milliseconds.
	EntPhySensorValueUpdateRate interface{}
}

ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry Information about a particular physical sensor.

An entry in this table describes the present reading of a sensor, the measurement units and scale, and sensor operational status.

Entries are created in this table by the agent. An entry for each physical sensor SHOULD be created at the same time as the associated entPhysicalEntry. An entry SHOULD be destroyed if the associated entPhysicalEntry is destroyed.

func (*ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry) GetEntityData

func (entPhySensorEntry *ENTITYSENSORMIB_EntPhySensorTable_EntPhySensorEntry) GetEntityData() *types.CommonEntityData

type EntitySensorDataScale

type EntitySensorDataScale string

EntitySensorDataScale represents object of type EntitySensorValue.

const (
	EntitySensorDataScale_yocto EntitySensorDataScale = "yocto"

	EntitySensorDataScale_zepto EntitySensorDataScale = "zepto"

	EntitySensorDataScale_atto EntitySensorDataScale = "atto"

	EntitySensorDataScale_femto EntitySensorDataScale = "femto"

	EntitySensorDataScale_pico EntitySensorDataScale = "pico"

	EntitySensorDataScale_nano EntitySensorDataScale = "nano"

	EntitySensorDataScale_micro EntitySensorDataScale = "micro"

	EntitySensorDataScale_milli EntitySensorDataScale = "milli"

	EntitySensorDataScale_units EntitySensorDataScale = "units"

	EntitySensorDataScale_kilo EntitySensorDataScale = "kilo"

	EntitySensorDataScale_mega EntitySensorDataScale = "mega"

	EntitySensorDataScale_giga EntitySensorDataScale = "giga"

	EntitySensorDataScale_tera EntitySensorDataScale = "tera"

	EntitySensorDataScale_exa EntitySensorDataScale = "exa"

	EntitySensorDataScale_peta EntitySensorDataScale = "peta"

	EntitySensorDataScale_zetta EntitySensorDataScale = "zetta"

	EntitySensorDataScale_yotta EntitySensorDataScale = "yotta"
)

type EntitySensorDataType

type EntitySensorDataType string

EntitySensorDataType represents truthvalue(12): value takes { true(1), false(2) }

const (
	EntitySensorDataType_other EntitySensorDataType = "other"

	EntitySensorDataType_unknown EntitySensorDataType = "unknown"

	EntitySensorDataType_voltsAC EntitySensorDataType = "voltsAC"

	EntitySensorDataType_voltsDC EntitySensorDataType = "voltsDC"

	EntitySensorDataType_amperes EntitySensorDataType = "amperes"

	EntitySensorDataType_watts EntitySensorDataType = "watts"

	EntitySensorDataType_hertz EntitySensorDataType = "hertz"

	EntitySensorDataType_celsius EntitySensorDataType = "celsius"

	EntitySensorDataType_percentRH EntitySensorDataType = "percentRH"

	EntitySensorDataType_rpm EntitySensorDataType = "rpm"

	EntitySensorDataType_cmm EntitySensorDataType = "cmm"

	EntitySensorDataType_truthvalue EntitySensorDataType = "truthvalue"
)

type EntitySensorStatus

type EntitySensorStatus string

EntitySensorStatus represents of-range, jittery, or wildly fluctuating readings.

const (
	EntitySensorStatus_ok EntitySensorStatus = "ok"

	EntitySensorStatus_unavailable EntitySensorStatus = "unavailable"

	EntitySensorStatus_nonoperational EntitySensorStatus = "nonoperational"
)