WIENER_SNMP
1.1
A C/C++ library for MPOD crate access via SNMP
|
#include <net-snmp/net-snmp-config.h>
#include <net-snmp/net-snmp-includes.h>
Go to the source code of this file.
Classes | |
struct | SnmpDoubleBuffer |
struct | SnmpIntegerBuffer |
Macros | |
#define | EXPORT extern "C" |
#define | WIN32_LEAN_AND_MEAN |
#define | NET_SNMP_SNMPV3_H |
Typedefs | |
typedef void * | HSNMP |
typedef enum MaximumCrateValues | MaximumCrateValues |
typedef struct SnmpDoubleBuffer | SnmpDoubleBuffer |
typedef struct SnmpIntegerBuffer | SnmpIntegerBuffer |
Enumerations | |
enum | MaximumCrateValues { MaxModuleAuxSupplies = 2, MaxModuleAuxTemperatures = 4, MaxCommunities = 4, MaxFans = 6, MaxPsAuxSupplies = 8, MaxSlotsPerCrate = 10, MaxSensors = 12, MaxChannelsPerSlot = 100, MaxChannelsPerCrate = 1000 } |
Functions | |
EXPORT void | snmpSetStdErrLog (void) |
Activates logging on stderr console. More... | |
EXPORT void | snmpSetFileLog (const char *const fileName) |
Activates logging to the file filename. More... | |
EXPORT unsigned int | snmpGetVersion (void) |
Returns the library four digit version number as unsigned int value. More... | |
EXPORT char * | snmpGetVersionString (void) |
Returns the library four digit version number as null-terminated string. More... | |
EXPORT int | snmpInit (void) |
SNMP Initialization. More... | |
EXPORT void | snmpCleanup (void) |
Additional cleanup. Should be called after snmpClose. More... | |
EXPORT void | snmpSetReadCommunityName (const char *const readCommunityName) |
Set a new read community name for SNMP access. More... | |
EXPORT void | snmpSetWriteCommunityName (const char *const writeCommunityName) |
Set a new write community name for SNMP access. More... | |
EXPORT HSNMP | snmpOpen (const char *const ipAddress) |
Opens a SNMP session to the specified ipAddress. More... | |
EXPORT void | snmpClose (HSNMP session) |
Closes the previously opened session specified by session. More... | |
EXPORT char * | snmpGetLastError (void) |
Returns a pointer to a descriptive string for the last failed SNMP operation. More... | |
EXPORT char * | getSysDescr (HSNMP session) |
Returns a pointer to the MPOD controller description string. More... | |
EXPORT int | getMainSwitch (HSNMP session) |
Returns the crate power on/off status. More... | |
EXPORT int | setMainSwitch (HSNMP session, int value) |
Sets the crate main switch to 1 = on or 0 = off. More... | |
EXPORT int | getMainStatus (HSNMP session) |
Returns a bit field with the status of the complete crate. More... | |
EXPORT int | getVmeReset (HSNMP session) |
Returns the VME system reset status. More... | |
EXPORT int | setVmeReset (HSNMP session) |
Initiate a VME system reset. More... | |
EXPORT int | getIpStaticAddress (HSNMP session) |
Returns the static IP address as 32 bit integer. More... | |
EXPORT int | setIpStaticAddress (HSNMP session, int value) |
Sets a new static IP address. More... | |
EXPORT char * | getPsSerialNumber (HSNMP session) |
Returns a pointer to a string containing the MPOD controllers serial number. More... | |
EXPORT int | getOutputNumber (HSNMP session) |
Returns the total number of output channels in the crate. More... | |
EXPORT int | getOutputGroups (HSNMP session) |
getOutputGroups More... | |
EXPORT int | getOutputGroup (HSNMP session, int channel) |
getOutputGroup More... | |
EXPORT int | getOutputStatus (HSNMP session, int channel) |
Returns the channel outputStatus register. More... | |
EXPORT int | getChannelStatus (HSNMP m_sessmp, int channel) |
Returns the channel outputStatus register. More... | |
EXPORT double | getOutputSenseMeasurement (HSNMP session, int channel) |
Returns the measured output sense voltage for channel in Volt. More... | |
EXPORT double | getOutputTerminalMeasurement (HSNMP session, int channel) |
Returns the measured output terminal voltage for channel in Volt. More... | |
EXPORT double | getCurrentMeasurement (HSNMP session, int channel) |
Returns the measured output current for channel in Ampere. More... | |
EXPORT int | getTemperatureMeasurement (HSNMP session, int channel) |
Returns the measured temperature for channel in Degree Celsius. More... | |
EXPORT int | setChannelSwitch (HSNMP session, int channel, int value) |
Change the state of the channel. More... | |
EXPORT int | setOutputSwitch (HSNMP session, int channel, int value) |
Change the state of the channel. More... | |
EXPORT int | getChannelSwitch (HSNMP session, int channel) |
Returns the state of the channel. More... | |
EXPORT int | getOutputSwitch (HSNMP session, int channel) |
Returns the state of the channel. More... | |
EXPORT int | setHighVoltageGroupsSwitch (HSNMP session, int value) |
setHighVoltageGroupsSwitch More... | |
EXPORT int | getHighVoltageGroupsSwitch (HSNMP session) |
getHighVoltageGroupsSwitch More... | |
EXPORT int | setLowVoltageGroupsSwitch (HSNMP session, int value) |
setLowVoltageGroupsSwitch More... | |
EXPORT int | getLowVoltageGroupsSwitch (HSNMP session) |
getLowVoltageGroupsSwitch More... | |
EXPORT double | getOutputVoltage (HSNMP session, int channel) |
Returns the demanded output voltage for channel. More... | |
EXPORT double | setOutputVoltage (HSNMP session, int channel, double value) |
Sets the demanded output voltage for channel. More... | |
EXPORT double | getOutputCurrent (HSNMP session, int channel) |
Returns the demanded maximum output current for channel. More... | |
EXPORT double | setOutputCurrent (HSNMP session, int channel, double value) |
Sets the demanded maximum output current for channel. More... | |
EXPORT double | getOutputRiseRate (HSNMP session, int channel) |
Returns the channel voltage rise rate in Volt/second. More... | |
EXPORT double | setOutputRiseRate (HSNMP session, int channel, double value) |
Sets the channel voltage rise rate in Volt/second. More... | |
EXPORT double | getOutputFallRate (HSNMP session, int channel) |
Returns the channel voltage fall rate in Volt/second. More... | |
EXPORT double | setOutputFallRate (HSNMP session, int channel, double value) |
Sets the channel voltage fall rate in Volt/second. More... | |
EXPORT double | getOutputCurrentRiseRate (HSNMP session, int channel) |
Returns the channel current rise rate in Ampere/second. More... | |
EXPORT double | setOutputCurrentRiseRate (HSNMP session, int channel, double value) |
Sets the channel current rise rate in Ampere/second. More... | |
EXPORT double | getOutputCurrentFallRate (HSNMP session, int channel) |
Returns the channel current fall rate in Ampere/second. More... | |
EXPORT double | setOutputCurrentFallRate (HSNMP session, int channel, double value) |
Sets the channel current fall rate in Ampere/second. More... | |
EXPORT int | getOutputSupervisionBehavior (HSNMP session, int channel) |
Returns a bit field packed into an integer which define the behavior of the output channel or power supply after failures. More... | |
EXPORT int | setOutputSupervisionBehavior (HSNMP session, int channel, int value) |
Set the behavior of the output channel or power supply after failures. More... | |
EXPORT double | getOutputSupervisionMinSenseVoltage (HSNMP session, int channel) |
getOutputSupervisionMinSenseVoltage More... | |
EXPORT double | setOutputSupervisionMinSenseVoltage (HSNMP session, int channel, double value) |
setOutputSupervisionMinSenseVoltage More... | |
EXPORT double | getOutputSupervisionMaxSenseVoltage (HSNMP session, int channel) |
getOutputSupervisionMaxSenseVoltage More... | |
EXPORT double | setOutputSupervisionMaxSenseVoltage (HSNMP session, int channel, double value) |
setOutputSupervisionMaxSenseVoltage More... | |
EXPORT double | getOutputSupervisionMaxTerminalVoltage (HSNMP session, int channel) |
If the measured voltage at the power supply output terminals is above this value, the power supply performs the function defined by setOutputSupervisionBehavior(). More... | |
EXPORT double | setOutputSupervisionMaxTerminalVoltage (HSNMP session, int channel, double value) |
If the measured voltage at the power supply output terminals is above this value, the power supply performs the function defined by setOutputSupervisionBehavior(). More... | |
EXPORT double | getOutputSupervisionMaxCurrent (HSNMP session, int channel) |
If the measured current is above this value, the power supply performs the function defined by setOutputSupervisionBehavior(). More... | |
EXPORT double | setOutputSupervisionMaxCurrent (HSNMP session, int channel, double value) |
If the measured current is above this value, the power supply performs the function defined by setOutputSupervisionBehavior(). More... | |
EXPORT int | setOutputSupervisionMaxTemperature (HSNMP session, int channel, int value) |
EXPORT double | getOutputConfigMaxSenseVoltage (HSNMP session, int channel) |
getOutputConfigMaxSenseVoltage More... | |
EXPORT double | getOutputConfigMaxTerminalVoltage (HSNMP session, int channel) |
getOutputConfigMaxTerminalVoltage More... | |
EXPORT double | getOutputConfigMaxCurrent (HSNMP session, int channel) |
getOutputConfigMaxCurrent More... | |
EXPORT double | getOutputSupervisionMaxPower (HSNMP session, int channel) |
getOutputSupervisionMaxPower More... | |
EXPORT int | getOutputTripTimeMaxCurrent (HSNMP session, int channel) |
Returns the time span for the delayed trip function. More... | |
EXPORT int | setOutputTripTimeMaxCurrent (HSNMP session, int channel, int delay) |
Defines a span for the delayed trip function. More... | |
EXPORT int | getSensorNumber (HSNMP session) |
EXPORT int | getSensorTemp (HSNMP session, int sensor) |
EXPORT int | getSensorWarningTemperature (HSNMP session, int sensor) |
EXPORT int | setSensorWarningTemperature (HSNMP session, int sensor, int value) |
EXPORT int | getSensorFailureTemperature (HSNMP session, int sensor) |
EXPORT int | setSensorFailureTemperature (HSNMP session, int sensor, int value) |
EXPORT int | getPsOperatingTime (HSNMP session) |
Returns the crates operating time in seconds. More... | |
EXPORT double | getPsAuxVoltage (HSNMP session, int auxIndex) |
EXPORT double | getPsAuxCurrent (HSNMP session, int auxIndex) |
EXPORT int | getFanOperatingTime (HSNMP session) |
EXPORT int | getFanAirTemperature (HSNMP session) |
EXPORT int | getFanSwitchOffDelay (HSNMP session) |
EXPORT int | setFanSwitchOffDelay (HSNMP session, int value) |
EXPORT int | getFanNominalSpeed (HSNMP session) |
Returns the MPODs fan rotation speed in revolutions per minute. More... | |
EXPORT int | setFanNominalSpeed (HSNMP session, int value) |
Sets the MPODs fan rotation speed in revolutions per minute. More... | |
EXPORT int | getFanNumberOfFans (HSNMP session) |
EXPORT int | getFanSpeed (HSNMP session, int fan) |
EXPORT char * | getModuleDescription (HSNMP session, int slot) |
Returns a pointer to the module description string. More... | |
EXPORT double | getModuleSupply24 (HSNMP session, int slot) |
Returns the measured value of the modules +24 Volt line. More... | |
EXPORT double | getModuleSupply5 (HSNMP session, int slot) |
Returns the measured value of the modules +5 Volt line. More... | |
EXPORT double | getModuleAuxTemperature (HSNMP session, int slot, int index) |
Returns the measured value of one of the modules temperature sensors. More... | |
EXPORT double | getModuleHardwareLimitVoltage (HSNMP session, int slot) |
Returns the modules hardware voltage limit in percent. More... | |
EXPORT double | getModuleHardwareLimitCurrent (HSNMP session, int slot) |
Returns the modules hardware current limit in percent. More... | |
EXPORT double | getModuleRampSpeedVoltage (HSNMP session, int slot) |
Returns the modules voltage ramp speed in percent. More... | |
EXPORT double | setModuleRampSpeedVoltage (HSNMP session, int slot, double value) |
Sets the modules voltage ramp speed in percent. More... | |
EXPORT double | getModuleRampSpeedCurrent (HSNMP session, int slot) |
Returns the modules current ramp speed in percent. More... | |
EXPORT double | setModuleRampSpeedCurrent (HSNMP session, int slot, double value) |
Sets the modules current ramp speed in percent. More... | |
EXPORT int | getModuleStatus (HSNMP session, int slot) |
Returns the value of the module status register. More... | |
EXPORT int | getModuleEventStatus (HSNMP session, int slot) |
Returns the value of the module event status register. More... | |
EXPORT int | setModuleDoClear (HSNMP session, int slot) |
Clears all modules events in a specific slot. More... | |
EXPORT SnmpIntegerBuffer * | getMultipleChannelStatuses (HSNMP session, int start, int size) |
Returns an array with the outputStatus for a consecutive range of channels. More... | |
EXPORT SnmpIntegerBuffer * | getMultipleOutputStatuses (HSNMP session, int start, int size) |
Returns an array with the outputStatus for a consecutive range of channels. More... | |
EXPORT SnmpIntegerBuffer * | getMultipleOutputSwitches (HSNMP session, int start, int size) |
Returns an array with the outputSwitches for a consecutive range of channels. More... | |
EXPORT SnmpIntegerBuffer * | setMultipleOutputSwitches (HSNMP session, int start, SnmpIntegerBuffer *values) |
Sets the outputSwitch for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | getMultipleOutputVoltages (HSNMP session, int start, int size) |
Returns the actual outputVoltage for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | setMultipleOutputVoltages (HSNMP session, int start, SnmpDoubleBuffer *values) |
Sets the demanded outputVoltage for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | getMultipleMeasurementTerminalVoltages (HSNMP session, int start, int size) |
Returns the measured terminal voltages for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | getMultipleOutputMeasurementTerminalVoltages (HSNMP session, int start, int size) |
Returns an array with the measured terminal voltages for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | getMultipleOutputConfigMaxTerminalVoltages (HSNMP session, int start, int size) |
getMultipleOutputConfigMaxTerminalVoltages More... | |
EXPORT SnmpDoubleBuffer * | getMultipleOutputCurrents (HSNMP session, int start, int size) |
Returns an array the demanded output currents for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | setMultipleOutputCurrents (HSNMP session, int start, SnmpDoubleBuffer *values) |
Sets the demanded output current for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | getMultipleMeasurementCurrents (HSNMP session, int start, int size) |
Returns an array with the measured currents for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | getMultipleOutputMeasurementCurrents (HSNMP session, int start, int size) |
Returns an array with the measured currents for a consecutive range of channels. More... | |
EXPORT SnmpDoubleBuffer * | getMultipleOutputConfigMaxCurrents (HSNMP session, int start, int size) |
Returns an array with the outputConfigMaxCurrent for a consecutive range of channels. More... | |
EXPORT SnmpIntegerBuffer * | getMultipleOutputTripTimeMaxCurrents (HSNMP session, int start, int size) |
Returns an array with the outputTripTimeMaxCurrent for a consecutive range of channels. More... | |
EXPORT SnmpIntegerBuffer * | setMultipleOutputTripTimeMaxCurrents (HSNMP session, int start, SnmpIntegerBuffer *values) |
Sets the outputTripTimeMaxCurrent for a consecutive ranges of channels. More... | |
EXPORT SnmpIntegerBuffer * | getMultipleOutputSupervisionBehaviors (HSNMP session, int start, int size) |
Returns an array with the outputSupervisionBehavior for a consecutive range of channels. More... | |
EXPORT SnmpIntegerBuffer * | setMultipleOutputSupervisionBehaviors (HSNMP session, int start, SnmpIntegerBuffer *values) |
Sets the outputSupervisionBehavior for a consecutive range of channels. More... | |
#define EXPORT extern "C" |
Definition at line 9 of file WIENER_SNMP.h.
#define NET_SNMP_SNMPV3_H |
Definition at line 15 of file WIENER_SNMP.h.
#define WIN32_LEAN_AND_MEAN |
Definition at line 12 of file WIENER_SNMP.h.
typedef void* HSNMP |
Definition at line 18 of file WIENER_SNMP.h.
typedef enum MaximumCrateValues MaximumCrateValues |
typedef struct SnmpDoubleBuffer SnmpDoubleBuffer |
typedef struct SnmpIntegerBuffer SnmpIntegerBuffer |
enum MaximumCrateValues |
Definition at line 148 of file WIENER_SNMP.h.
Returns the channel outputStatus register.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 659 of file WIENER_SNMP.cpp.
Returns the state of the channel.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 777 of file WIENER_SNMP.cpp.
Returns the measured output current for channel in Ampere.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 714 of file WIENER_SNMP.cpp.
Definition at line 1391 of file WIENER_SNMP.cpp.
Returns the MPODs fan rotation speed in revolutions per minute.
session | The handle returned by snmpOpen() |
Definition at line 1411 of file WIENER_SNMP.cpp.
Definition at line 1427 of file WIENER_SNMP.cpp.
Definition at line 1386 of file WIENER_SNMP.cpp.
Definition at line 1432 of file WIENER_SNMP.cpp.
Definition at line 1396 of file WIENER_SNMP.cpp.
getHighVoltageGroupsSwitch
session | The handle returned by snmpOpen() |
Definition at line 814 of file WIENER_SNMP.cpp.
Returns the static IP address as 32 bit integer.
session | The handle returned by snmpOpen() |
Definition at line 586 of file WIENER_SNMP.cpp.
getLowVoltageGroupsSwitch
session | The handle returned by snmpOpen() |
Definition at line 835 of file WIENER_SNMP.cpp.
Returns a bit field with the status of the complete crate.
session | The handle returned by snmpOpen() |
Definition at line 556 of file WIENER_SNMP.cpp.
Returns the crate power on/off status.
The result is the logical "and" between the hardware main switch and the setMainSwitch function.
session | The handle returned by snmpOpen() |
Definition at line 533 of file WIENER_SNMP.cpp.
Returns the measured value of one of the modules temperature sensors.
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
index | The temperature sensor index (0...3) |
Definition at line 1503 of file WIENER_SNMP.cpp.
Returns a pointer to the module description string.
The pointer is valid until the next call of any string function.
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
Example: "iseg, E24D1, 24, 715070, 5.14"
Definition at line 1455 of file WIENER_SNMP.cpp.
Returns the value of the module event status register.
session | The handle returned by snmpOpen() |
slot | the modules slot position in the crate (0...9) |
Definition at line 1646 of file WIENER_SNMP.cpp.
Returns the modules hardware current limit in percent.
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
Definition at line 1538 of file WIENER_SNMP.cpp.
Returns the modules hardware voltage limit in percent.
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
Definition at line 1522 of file WIENER_SNMP.cpp.
Returns the modules current ramp speed in percent.
iseg modules have one common ramp speed for all channels. This item is only valid for modules with constant current regulation.
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
Definition at line 1594 of file WIENER_SNMP.cpp.
Returns the modules voltage ramp speed in percent.
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
Definition at line 1555 of file WIENER_SNMP.cpp.
Returns the value of the module status register.
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
Definition at line 1630 of file WIENER_SNMP.cpp.
Returns the measured value of the modules +24 Volt line.
session | The handle returned by snmpOpen() |
slot | the modules slot position in the crate (0...9) |
Definition at line 1470 of file WIENER_SNMP.cpp.
Returns the measured value of the modules +5 Volt line.
session | The handle returned by snmpOpen() |
slot | the modules slot position in the crate (0...9) |
Definition at line 1485 of file WIENER_SNMP.cpp.
EXPORT SnmpIntegerBuffer* getMultipleChannelStatuses | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the outputStatus for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 1985 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* getMultipleMeasurementCurrents | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the measured currents for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2189 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* getMultipleMeasurementTerminalVoltages | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns the measured terminal voltages for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2097 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* getMultipleOutputConfigMaxCurrents | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the outputConfigMaxCurrent for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2223 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* getMultipleOutputConfigMaxTerminalVoltages | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
getMultipleOutputConfigMaxTerminalVoltages
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2131 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* getMultipleOutputCurrents | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array the demanded output currents for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2149 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* getMultipleOutputMeasurementCurrents | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the measured currents for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2205 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* getMultipleOutputMeasurementTerminalVoltages | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the measured terminal voltages for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2113 of file WIENER_SNMP.cpp.
EXPORT SnmpIntegerBuffer* getMultipleOutputStatuses | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the outputStatus for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2001 of file WIENER_SNMP.cpp.
EXPORT SnmpIntegerBuffer* getMultipleOutputSupervisionBehaviors | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the outputSupervisionBehavior for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2277 of file WIENER_SNMP.cpp.
EXPORT SnmpIntegerBuffer* getMultipleOutputSwitches | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the outputSwitches for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2021 of file WIENER_SNMP.cpp.
EXPORT SnmpIntegerBuffer* getMultipleOutputTripTimeMaxCurrents | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns an array with the outputTripTimeMaxCurrent for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2241 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* getMultipleOutputVoltages | ( | HSNMP | session, |
int | start, | ||
int | size | ||
) |
Returns the actual outputVoltage for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
size | The number of requested channels. |
Definition at line 2059 of file WIENER_SNMP.cpp.
getOutputConfigMaxCurrent
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1258 of file WIENER_SNMP.cpp.
getOutputConfigMaxSenseVoltage
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1230 of file WIENER_SNMP.cpp.
getOutputConfigMaxTerminalVoltage
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1244 of file WIENER_SNMP.cpp.
Returns the demanded maximum output current for channel.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 875 of file WIENER_SNMP.cpp.
Returns the channel current fall rate in Ampere/second.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1012 of file WIENER_SNMP.cpp.
Returns the channel current rise rate in Ampere/second.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 977 of file WIENER_SNMP.cpp.
Returns the channel voltage fall rate in Volt/second.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 942 of file WIENER_SNMP.cpp.
getOutputGroup
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 644 of file WIENER_SNMP.cpp.
getOutputGroups
session | The handle returned by snmpOpen() |
Definition at line 631 of file WIENER_SNMP.cpp.
Returns the total number of output channels in the crate.
session | The handle returned by snmpOpen() |
Definition at line 621 of file WIENER_SNMP.cpp.
Returns the channel voltage rise rate in Volt/second.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 907 of file WIENER_SNMP.cpp.
Returns the measured output sense voltage for channel in Volt.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 686 of file WIENER_SNMP.cpp.
Returns the channel outputStatus register.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 671 of file WIENER_SNMP.cpp.
Returns a bit field packed into an integer which define the behavior of the output channel or power supply after failures.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1045 of file WIENER_SNMP.cpp.
If the measured current is above this value, the power supply performs the function defined by setOutputSupervisionBehavior().
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1186 of file WIENER_SNMP.cpp.
getOutputSupervisionMaxPower
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1272 of file WIENER_SNMP.cpp.
getOutputSupervisionMaxSenseVoltage
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1125 of file WIENER_SNMP.cpp.
If the measured voltage at the power supply output terminals is above this value, the power supply performs the function defined by setOutputSupervisionBehavior().
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1155 of file WIENER_SNMP.cpp.
getOutputSupervisionMinSenseVoltage
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1096 of file WIENER_SNMP.cpp.
Returns the state of the channel.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 790 of file WIENER_SNMP.cpp.
Returns the measured output terminal voltage for channel in Volt.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 700 of file WIENER_SNMP.cpp.
Returns the time span for the delayed trip function.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 1286 of file WIENER_SNMP.cpp.
Returns the demanded output voltage for channel.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 846 of file WIENER_SNMP.cpp.
Definition at line 1376 of file WIENER_SNMP.cpp.
Definition at line 1368 of file WIENER_SNMP.cpp.
Returns the crates operating time in seconds.
session | The handle returned by snmpOpen() |
Definition at line 1363 of file WIENER_SNMP.cpp.
Returns a pointer to a string containing the MPOD controllers serial number.
The pointer is valid until the next call of any string function.
session | The handle returned by snmpOpen() |
Definition at line 609 of file WIENER_SNMP.cpp.
Definition at line 1340 of file WIENER_SNMP.cpp.
Definition at line 1311 of file WIENER_SNMP.cpp.
Definition at line 1316 of file WIENER_SNMP.cpp.
Definition at line 1324 of file WIENER_SNMP.cpp.
Returns a pointer to the MPOD controller description string.
The pointer is valid until the next call of any string function.
session | The handle returned by snmpOpen() |
Definition at line 518 of file WIENER_SNMP.cpp.
Returns the measured temperature for channel in Degree Celsius.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
Definition at line 730 of file WIENER_SNMP.cpp.
Returns the VME system reset status.
session | The handle returned by snmpOpen() |
Definition at line 566 of file WIENER_SNMP.cpp.
Change the state of the channel.
session | The handle returned by snmpOpen() |
channel | The channel in the range of 0...999 |
value | One of the following: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10). |
Definition at line 747 of file WIENER_SNMP.cpp.
Sets the MPODs fan rotation speed in revolutions per minute.
session | The handle returned by snmpOpen() |
value | 1200..3600. 0 turns off the crates fans. |
Definition at line 1422 of file WIENER_SNMP.cpp.
Definition at line 1401 of file WIENER_SNMP.cpp.
setHighVoltageGroupsSwitch
session | The handle returned by snmpOpen() |
value |
Definition at line 804 of file WIENER_SNMP.cpp.
Sets a new static IP address.
session | The handle returned by snmpOpen() |
value | The IP address as 32 bit integer |
Definition at line 597 of file WIENER_SNMP.cpp.
setLowVoltageGroupsSwitch
session | The handle returned by snmpOpen() |
value |
Definition at line 825 of file WIENER_SNMP.cpp.
Sets the crate main switch to 1 = on or 0 = off.
If the hardware main switch is set to "0" position, this function always returns 0.
session | The handle returned by snmpOpen() |
value | 0 = set off, 1 = set on |
Definition at line 546 of file WIENER_SNMP.cpp.
Clears all modules events in a specific slot.
To clear all events in all iseg HV modules, use setHighVoltageGroupsSwitch() with the parameter clearEvents(10).
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
Definition at line 1663 of file WIENER_SNMP.cpp.
Sets the modules current ramp speed in percent.
iseg modules have one common ramp speed for all channels. This item is only valid for modules with constant current regulation.
session | The handle returned by snmpOpen() |
slot | The modules slot position in the crate (0...9) |
value | The new current ramp speed in percent |
Definition at line 1614 of file WIENER_SNMP.cpp.
Sets the modules voltage ramp speed in percent.
iseg modules have one common ramp speed for all channels.
session | The handle returned by snmpOpen() |
slot | the modules slot position in the crate (0...9) |
value | The new voltage ramp speed in percent |
Definition at line 1575 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* setMultipleOutputCurrents | ( | HSNMP | session, |
int | start, | ||
SnmpDoubleBuffer * | values | ||
) |
Sets the demanded output current for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
values | A pointer to SnmpDoubleBuffer with a list of new output currents |
Definition at line 2167 of file WIENER_SNMP.cpp.
EXPORT SnmpIntegerBuffer* setMultipleOutputSupervisionBehaviors | ( | HSNMP | session, |
int | start, | ||
SnmpIntegerBuffer * | values | ||
) |
Sets the outputSupervisionBehavior for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
values | The new outputSupervisionBehavior for the all channels starting with start. |
Definition at line 2295 of file WIENER_SNMP.cpp.
EXPORT SnmpIntegerBuffer* setMultipleOutputSwitches | ( | HSNMP | session, |
int | start, | ||
SnmpIntegerBuffer * | values | ||
) |
Sets the outputSwitch for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
values | A pointer to SnmpIntegerBuffer with the list of outputSwitches. |
Definition at line 2039 of file WIENER_SNMP.cpp.
EXPORT SnmpIntegerBuffer* setMultipleOutputTripTimeMaxCurrents | ( | HSNMP | session, |
int | start, | ||
SnmpIntegerBuffer * | values | ||
) |
Sets the outputTripTimeMaxCurrent for a consecutive ranges of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
values |
Definition at line 2259 of file WIENER_SNMP.cpp.
EXPORT SnmpDoubleBuffer* setMultipleOutputVoltages | ( | HSNMP | session, |
int | start, | ||
SnmpDoubleBuffer * | values | ||
) |
Sets the demanded outputVoltage for a consecutive range of channels.
session | The handle returned by snmpOpen() |
start | The first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0. |
values | A pointer to SnmpDoubleBuffer with the list of new outputVoltages |
Definition at line 2077 of file WIENER_SNMP.cpp.
Sets the demanded maximum output current for channel.
session | The handle returned by snmpOpen() |
channel | The channel in the range of 0...999 |
value | The demanded ouput current in Ampere |
Definition at line 890 of file WIENER_SNMP.cpp.
Sets the channel current fall rate in Ampere/second.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
value |
Definition at line 1030 of file WIENER_SNMP.cpp.
Sets the channel current rise rate in Ampere/second.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
value |
Definition at line 995 of file WIENER_SNMP.cpp.
Sets the channel voltage fall rate in Volt/second.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
value |
Definition at line 960 of file WIENER_SNMP.cpp.
Sets the channel voltage rise rate in Volt/second.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
value |
Definition at line 925 of file WIENER_SNMP.cpp.
Set the behavior of the output channel or power supply after failures.
For each supervision value, a two-bit field exists. The enumeration of this value (..L+..H*2) is: WIENER LV devices 0 ignore the failure 1 switch off this channel 2 switch off all channels with the same group number 3 switch off the complete crate. iseg HV devices 0 ignore the failure 1 switch off this channel by ramp down the voltage 2 switch off this channel by a emergencyOff 3 switch off the whole board of the HV module by emergencyOff. The position of the bit fields in the integer value are: Bit 0, 1: outputFailureMinSenseVoltage Bit 2, 3: outputFailureMaxSenseVoltage Bit 4, 5: outputFailureMaxTerminalVoltage Bit 6, 7: outputFailureMaxCurrent Bit 8, 9: outputFailureMaxTemperature Bit 10, 11: outputFailureMaxPower Bit 12, 13: outputFailureInhibit Bit 14, 15: outputFailureTimeout
session | The handle returned by snmpOpen() |
channel | The channel (0...999) for which the behaviour should be set |
value | The 16 bit integer with bits set according the preceding table. |
Definition at line 1082 of file WIENER_SNMP.cpp.
If the measured current is above this value, the power supply performs the function defined by setOutputSupervisionBehavior().
session | The handle returned by snmpOpen() |
channel | The channel (0...999) to set the max. current |
value | The maximum current in Ampere |
Definition at line 1202 of file WIENER_SNMP.cpp.
setOutputSupervisionMaxSenseVoltage
session | The handle returned by snmpOpen() |
channel | |
value |
Definition at line 1140 of file WIENER_SNMP.cpp.
If the measured voltage at the power supply output terminals is above this value, the power supply performs the function defined by setOutputSupervisionBehavior().
session | The handle returned by snmpOpen() |
channel | the channel (0...999) to set the max. terminal voltage |
value | The maximum terminal voltage in Volt |
Definition at line 1171 of file WIENER_SNMP.cpp.
setOutputSupervisionMinSenseVoltage
session | The handle returned by snmpOpen() |
channel | |
value |
Definition at line 1111 of file WIENER_SNMP.cpp.
Change the state of the channel.
session | The handle returned by snmpOpen() |
channel | The channel in the range of 0...999 |
value | One of the following: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10). |
Definition at line 761 of file WIENER_SNMP.cpp.
Defines a span for the delayed trip function.
session | The handle returned by snmpOpen() |
channel | The channel (0...999) for which to set the delayed trip |
delay | The trip delay time (0...4000 ms) |
Definition at line 1301 of file WIENER_SNMP.cpp.
Sets the demanded output voltage for channel.
session | The handle returned by snmpOpen() |
channel | The requested channel in the range of 0...999 |
value | the demanded output voltage in Volt. |
Definition at line 861 of file WIENER_SNMP.cpp.
Definition at line 1348 of file WIENER_SNMP.cpp.
Definition at line 1332 of file WIENER_SNMP.cpp.
Initiate a VME system reset.
session | The handle returned by snmpOpen() |
Definition at line 576 of file WIENER_SNMP.cpp.
EXPORT void snmpCleanup | ( | void | ) |
Additional cleanup. Should be called after snmpClose.
Definition at line 414 of file WIENER_SNMP.cpp.
Closes the previously opened session specified by session.
session | The handle returned by snmpOpen() |
Definition at line 486 of file WIENER_SNMP.cpp.
EXPORT char* snmpGetLastError | ( | void | ) |
Returns a pointer to a descriptive string for the last failed SNMP operation.
Definition at line 502 of file WIENER_SNMP.cpp.
EXPORT unsigned int snmpGetVersion | ( | void | ) |
Returns the library four digit version number as unsigned int value.
This allows to check for a specific version number.
Definition at line 238 of file WIENER_SNMP.cpp.
EXPORT char* snmpGetVersionString | ( | void | ) |
Returns the library four digit version number as null-terminated string.
The digits are separated by dots.
Definition at line 252 of file WIENER_SNMP.cpp.
EXPORT int snmpInit | ( | void | ) |
SNMP Initialization.
Resolves all needed OIDs from the MIB file and prepares the SNMP communication. The actual connection to a MPOD crate is done with snmpOpen().
Definition at line 278 of file WIENER_SNMP.cpp.
Opens a SNMP session to the specified ipAddress.
This function also sets the number of retries and the timeout value.
ipAddress | a zero-terminated ASCII string representation of an IPv4 address, e.g. "192.168.17.101" |
Definition at line 456 of file WIENER_SNMP.cpp.
EXPORT void snmpSetFileLog | ( | const char *const | fileName | ) |
Activates logging to the file filename.
fileName | The full path to the file where all log information should go to. |
Definition at line 226 of file WIENER_SNMP.cpp.
EXPORT void snmpSetReadCommunityName | ( | const char *const | readCommunityName | ) |
Set a new read community name for SNMP access.
The read community name has to match the configured read community name in the MPOD. The default read community name is "public".
readCommunityName | the new read community name |
Definition at line 428 of file WIENER_SNMP.cpp.
EXPORT void snmpSetStdErrLog | ( | void | ) |
Activates logging on stderr console.
Definition at line 213 of file WIENER_SNMP.cpp.
EXPORT void snmpSetWriteCommunityName | ( | const char *const | writeCommunityName | ) |
Set a new write community name for SNMP access.
The write community name has to match the configured write community name in the MPOD. The default write community name is "guru".
writeCommunityName | the new write community name |
Definition at line 442 of file WIENER_SNMP.cpp.