NtInfoSensor_s

Reference Documentation

product_line_custom
Napatech SmartNIC
category
Reference Information
struct NtInfoSensor_s

This structure will return the sensor specific information

The units used for the fields: value, valueLowest, valueHighest, limitLow and limitHigh depend on the type field. See NtSensorType_e.

For the limitLow and limitHigh fields the following applies: If the sensor is located in a NIM (Network Interface Module), the limits are read from the NIM module via the DMI (Diagnostic Monitoring Interface) from the alarm and warning threshholds section, and the units are changed to internal representation. Only the alarm threshholds are used and are read only once during initialization. The limits cannot be changed.

The value field is updated internally on a regular basis and is also based on a value read from the NIM which is also changed to internal representation.

Not all NIM types support DMI data, and its presence must be determined by reading an option flag. In general, a NIM can read out: temperature, supply voltage, TX bias, TX optical power and RX optical power but not all NIM types support all 5 values.

If external calibration is used (most NIM use internal calibration), both the current value and the threshold values are subjected to the specified calibration along with the change to internal calibration.

Definition at line 452 of file stream_info.h.

Data Fields

enum NtSensorSource_e

source

The source of the sensor (port or adapter on which the sensor resides) More...

uint32_t

sourceIndex

The source index - the adapter number for adapter sensors and port number for port sensors. More...

uint32_t

sensorIndex

The sensor index within the source index (sensor number on the adapter or sensor number on the port) More...

enum NtSensorType_e

type

The sensor type. More...

enum NtSensorSubType_e

subType

The sensor subtype (if applicable) More...

enum NtSensorState_e

state

The current state (normal or alarm) More...

int32_t

value

The current value. More...

int32_t

valueLowest

The lowest value registered. More...

int32_t

valueHighest

The highest value registered. More...

int32_t

limitLow

The minimum sensor value before an alarm is triggered. More...

int32_t

limitHigh

The maximum sensor value before an alarm is triggered. More...

char

name[50]

The sensor name. More...

enum NtAdapterType_e

adapterType

The adapter type where the sensor resides. More...

Field Documenation

enum NtSensorSource_e source

The source of the sensor (port or adapter on which the sensor resides)

Definition at line 419 of file stream_info.h.

uint32_t sourceIndex

The source index - the adapter number for adapter sensors and port number for port sensors.

Definition at line 454 of file stream_info.h.

Referenced by DumpSensor().

uint32_t sensorIndex

The sensor index within the source index (sensor number on the adapter or sensor number on the port)

Definition at line 455 of file stream_info.h.

Referenced by DumpSensor().

enum NtSensorType_e type

The sensor type.

Definition at line 455 of file stream_info.h.

Referenced by DisplaySensorData(), and DumpSensor().

enum NtSensorSubType_e subType

The sensor subtype (if applicable)

Definition at line 455 of file stream_info.h.

Referenced by DisplaySensorData().

enum NtSensorState_e state

The current state (normal or alarm)

Definition at line 455 of file stream_info.h.

Referenced by DisplaySensorData(), DumpSensor(), and main().

int32_t value

The current value.

Definition at line 459 of file stream_info.h.

Referenced by DisplaySensorData().

int32_t valueLowest

The lowest value registered.

Definition at line 460 of file stream_info.h.

Referenced by DisplaySensorData().

int32_t valueHighest

The highest value registered.

Definition at line 461 of file stream_info.h.

Referenced by DisplaySensorData().

int32_t limitLow

The minimum sensor value before an alarm is triggered.

Definition at line 462 of file stream_info.h.

Referenced by DisplaySensorData(), and DumpSensor().

int32_t limitHigh

The maximum sensor value before an alarm is triggered.

Definition at line 463 of file stream_info.h.

Referenced by DisplaySensorData(), and DumpSensor().

char name[50]

The sensor name.

Definition at line 464 of file stream_info.h.

Referenced by DisplaySensorData(), and DumpSensor().

enum NtAdapterType_e adapterType

The adapter type where the sensor resides.

Definition at line 464 of file stream_info.h.