WIENER_SNMP  1.1
A C/C++ library for MPOD crate access via SNMP
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
WIENER_SNMP.h File Reference
#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 SnmpIntegerBuffergetMultipleChannelStatuses (HSNMP session, int start, int size)
 Returns an array with the outputStatus for a consecutive range of channels. More...
 
EXPORT SnmpIntegerBuffergetMultipleOutputStatuses (HSNMP session, int start, int size)
 Returns an array with the outputStatus for a consecutive range of channels. More...
 
EXPORT SnmpIntegerBuffergetMultipleOutputSwitches (HSNMP session, int start, int size)
 Returns an array with the outputSwitches for a consecutive range of channels. More...
 
EXPORT SnmpIntegerBuffersetMultipleOutputSwitches (HSNMP session, int start, SnmpIntegerBuffer *values)
 Sets the outputSwitch for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffergetMultipleOutputVoltages (HSNMP session, int start, int size)
 Returns the actual outputVoltage for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffersetMultipleOutputVoltages (HSNMP session, int start, SnmpDoubleBuffer *values)
 Sets the demanded outputVoltage for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffergetMultipleMeasurementTerminalVoltages (HSNMP session, int start, int size)
 Returns the measured terminal voltages for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffergetMultipleOutputMeasurementTerminalVoltages (HSNMP session, int start, int size)
 Returns an array with the measured terminal voltages for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffergetMultipleOutputConfigMaxTerminalVoltages (HSNMP session, int start, int size)
 getMultipleOutputConfigMaxTerminalVoltages More...
 
EXPORT SnmpDoubleBuffergetMultipleOutputCurrents (HSNMP session, int start, int size)
 Returns an array the demanded output currents for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffersetMultipleOutputCurrents (HSNMP session, int start, SnmpDoubleBuffer *values)
 Sets the demanded output current for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffergetMultipleMeasurementCurrents (HSNMP session, int start, int size)
 Returns an array with the measured currents for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffergetMultipleOutputMeasurementCurrents (HSNMP session, int start, int size)
 Returns an array with the measured currents for a consecutive range of channels. More...
 
EXPORT SnmpDoubleBuffergetMultipleOutputConfigMaxCurrents (HSNMP session, int start, int size)
 Returns an array with the outputConfigMaxCurrent for a consecutive range of channels. More...
 
EXPORT SnmpIntegerBuffergetMultipleOutputTripTimeMaxCurrents (HSNMP session, int start, int size)
 Returns an array with the outputTripTimeMaxCurrent for a consecutive range of channels. More...
 
EXPORT SnmpIntegerBuffersetMultipleOutputTripTimeMaxCurrents (HSNMP session, int start, SnmpIntegerBuffer *values)
 Sets the outputTripTimeMaxCurrent for a consecutive ranges of channels. More...
 
EXPORT SnmpIntegerBuffergetMultipleOutputSupervisionBehaviors (HSNMP session, int start, int size)
 Returns an array with the outputSupervisionBehavior for a consecutive range of channels. More...
 
EXPORT SnmpIntegerBuffersetMultipleOutputSupervisionBehaviors (HSNMP session, int start, SnmpIntegerBuffer *values)
 Sets the outputSupervisionBehavior for a consecutive range of channels. More...
 

Macro Definition Documentation

#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 Documentation

typedef void* HSNMP

Definition at line 18 of file WIENER_SNMP.h.

Enumeration Type Documentation

Enumerator
MaxModuleAuxSupplies 

The maximum number of module auxiliary supply measurements.

MaxModuleAuxTemperatures 

The maximum number of module temperature sensors (iseg HV only)

MaxCommunities 

The maximum number of SNMP community names.

MaxFans 
MaxPsAuxSupplies 
MaxSlotsPerCrate 

The number of slots per crate.

MaxSensors 

The maximum.

MaxChannelsPerSlot 

The maximum number of channels per slot.

MaxChannelsPerCrate 

The maximum number of channels per crate.

Definition at line 148 of file WIENER_SNMP.h.

Function Documentation

EXPORT int getChannelStatus ( HSNMP  session,
int  channel 
)

Returns the channel outputStatus register.

Note
This function is deprecated. Use getOutputStatus() instead.
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The channels outputStatus register

Definition at line 659 of file WIENER_SNMP.cpp.

EXPORT int getChannelSwitch ( HSNMP  session,
int  channel 
)

Returns the state of the channel.

Note
This function is deprecated. Use getOutputSwitch() instead.
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
One of the following: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10).

Definition at line 777 of file WIENER_SNMP.cpp.

EXPORT double getCurrentMeasurement ( HSNMP  session,
int  channel 
)

Returns the measured output current for channel in Ampere.

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The measured output measurement current in Ampere.

Definition at line 714 of file WIENER_SNMP.cpp.

EXPORT int getFanAirTemperature ( HSNMP  session)

Definition at line 1391 of file WIENER_SNMP.cpp.

EXPORT int getFanNominalSpeed ( HSNMP  session)

Returns the MPODs fan rotation speed in revolutions per minute.

Parameters
sessionThe handle returned by snmpOpen()
Returns

Definition at line 1411 of file WIENER_SNMP.cpp.

EXPORT int getFanNumberOfFans ( HSNMP  session)

Definition at line 1427 of file WIENER_SNMP.cpp.

EXPORT int getFanOperatingTime ( HSNMP  session)

Definition at line 1386 of file WIENER_SNMP.cpp.

EXPORT int getFanSpeed ( HSNMP  session,
int  fan 
)

Definition at line 1432 of file WIENER_SNMP.cpp.

EXPORT int getFanSwitchOffDelay ( HSNMP  session)

Definition at line 1396 of file WIENER_SNMP.cpp.

EXPORT int getHighVoltageGroupsSwitch ( HSNMP  session)

getHighVoltageGroupsSwitch

Parameters
sessionThe handle returned by snmpOpen()
Returns

Definition at line 814 of file WIENER_SNMP.cpp.

EXPORT int getIpStaticAddress ( HSNMP  session)

Returns the static IP address as 32 bit integer.

Parameters
sessionThe handle returned by snmpOpen()
Returns
The static IP address.

Definition at line 586 of file WIENER_SNMP.cpp.

EXPORT int getLowVoltageGroupsSwitch ( HSNMP  session)

getLowVoltageGroupsSwitch

Parameters
sessionThe handle returned by snmpOpen()
Returns

Definition at line 835 of file WIENER_SNMP.cpp.

EXPORT int getMainStatus ( HSNMP  session)

Returns a bit field with the status of the complete crate.

Parameters
sessionThe handle returned by snmpOpen()
Returns
The complete crate status.

Definition at line 556 of file WIENER_SNMP.cpp.

EXPORT int getMainSwitch ( HSNMP  session)

Returns the crate power on/off status.

The result is the logical "and" between the hardware main switch and the setMainSwitch function.

Parameters
sessionThe handle returned by snmpOpen()
Returns
The current on/off status of the crate: 0: crate is powered off 1: crate is powered on

Definition at line 533 of file WIENER_SNMP.cpp.

EXPORT double getModuleAuxTemperature ( HSNMP  session,
int  slot,
int  index 
)

Returns the measured value of one of the modules temperature sensors.

Note
This function is for iseg HV modules only.
Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
indexThe temperature sensor index (0...3)
Note
Most modules only have one temperature sensor at index 0.
Returns

Definition at line 1503 of file WIENER_SNMP.cpp.

EXPORT char* getModuleDescription ( HSNMP  session,
int  slot 
)

Returns a pointer to the module description string.

The pointer is valid until the next call of any string function.

Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
Returns
A string with the following contents, separated by comma and space:
  • The module vendor ("iseg" or "WIENER")
  • The module type name
  • The channel number
  • The module serial number (optional)
  • The module firmware release (optional)

Example: "iseg, E24D1, 24, 715070, 5.14"

Definition at line 1455 of file WIENER_SNMP.cpp.

EXPORT int getModuleEventStatus ( HSNMP  session,
int  slot 
)

Returns the value of the module event status register.

Note
This function is for iseg HV modules only.
Parameters
sessionThe handle returned by snmpOpen()
slotthe modules slot position in the crate (0...9)
Returns
The module event status register

Definition at line 1646 of file WIENER_SNMP.cpp.

EXPORT double getModuleHardwareLimitCurrent ( HSNMP  session,
int  slot 
)

Returns the modules hardware current limit in percent.

Note
This function is for iseg HV modules only.
Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
Returns
The modules hardware current limit in percent (2...102)

Definition at line 1538 of file WIENER_SNMP.cpp.

EXPORT double getModuleHardwareLimitVoltage ( HSNMP  session,
int  slot 
)

Returns the modules hardware voltage limit in percent.

Note
This function is for iseg HV modules only.
Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
Returns
The modules hardware voltage limit in percent (2...102)

Definition at line 1522 of file WIENER_SNMP.cpp.

EXPORT double getModuleRampSpeedCurrent ( HSNMP  session,
int  slot 
)

Returns the modules current ramp speed in percent.

Note
This function is for iseg HV modules only.

iseg modules have one common ramp speed for all channels. This item is only valid for modules with constant current regulation.

Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
Returns
The modules current ramp speed in percent

Definition at line 1594 of file WIENER_SNMP.cpp.

EXPORT double getModuleRampSpeedVoltage ( HSNMP  session,
int  slot 
)

Returns the modules voltage ramp speed in percent.

Note
This function is for iseg HV modules only. iseg modules have one common ramp speed for all channels.
Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
Returns
The modules voltage ramp speed in percent

Definition at line 1555 of file WIENER_SNMP.cpp.

EXPORT int getModuleStatus ( HSNMP  session,
int  slot 
)

Returns the value of the module status register.

Note
This function is for iseg HV modules only.
Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
Returns
The module status register

Definition at line 1630 of file WIENER_SNMP.cpp.

EXPORT double getModuleSupply24 ( HSNMP  session,
int  slot 
)

Returns the measured value of the modules +24 Volt line.

Note
This function is for iseg HV modules only.
Parameters
sessionThe handle returned by snmpOpen()
slotthe modules slot position in the crate (0...9)
Returns
the measured +24 Volt line voltage in Volt.

Definition at line 1470 of file WIENER_SNMP.cpp.

EXPORT double getModuleSupply5 ( HSNMP  session,
int  slot 
)

Returns the measured value of the modules +5 Volt line.

Note
This function is for iseg HV modules only.
Parameters
sessionThe handle returned by snmpOpen()
slotthe modules slot position in the crate (0...9)
Returns
the measured +5 Volt line voltage in Volt.

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.

Note
This function is deprecated. Use getMultipleOutputStatuses() instead.
Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns
A pointer to SnmpIntegerBuffer with the requested information.
Note
This pointer is only valid until the next call of getMultiple... or setMultiple... function.

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.

Note
This function is deprecated. Use getMultipleOutputMeasurementCurrents() instead.
Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns
A pointer to SnmpDoubleBuffer with the requested information.
Note
This pointer is only valid until the next call of getMultiple... or setMultiple... function.

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns
A pointer to SnmpDoubleBuffer with the requested information.
Note
This pointer is only valid until the next call of getMultiple... or setMultiple... function.

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns

Definition at line 2223 of file WIENER_SNMP.cpp.

EXPORT SnmpDoubleBuffer* getMultipleOutputConfigMaxTerminalVoltages ( HSNMP  session,
int  start,
int  size 
)

getMultipleOutputConfigMaxTerminalVoltages

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns

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.

Since
1.1
Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns
A pointer to SnmpDoubleBuffer with the requested information.
Note
This pointer is only valid until the next call of getMultiple... or setMultiple... function.

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.

Since
1.1
Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns
A pointer to SnmpDoubleBuffer with the requested information.
Note
This pointer is only valid until the next call of getMultiple... or setMultiple... function.

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.

Since
1.1
Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns
A pointer to SnmpIntegerBuffer with the requested information.
Note
This pointer is only valid until the next call of getMultiple... or setMultiple... function.

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns
A pointer to SnmpIntegerBuffer with the requested information.
Note
This pointer is only valid until the next call of getMultiple... or setMultiple... function.

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
sizeThe number of requested channels.
Returns
A pointer to SnmpDoubleBuffer with the requested information.
Note
This pointer is only valid until the next call of getMultiple... or setMultiple... function.

Definition at line 2059 of file WIENER_SNMP.cpp.

EXPORT double getOutputConfigMaxCurrent ( HSNMP  session,
int  channel 
)

getOutputConfigMaxCurrent

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 1258 of file WIENER_SNMP.cpp.

EXPORT double getOutputConfigMaxSenseVoltage ( HSNMP  session,
int  channel 
)

getOutputConfigMaxSenseVoltage

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 1230 of file WIENER_SNMP.cpp.

EXPORT double getOutputConfigMaxTerminalVoltage ( HSNMP  session,
int  channel 
)

getOutputConfigMaxTerminalVoltage

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 1244 of file WIENER_SNMP.cpp.

EXPORT double getOutputCurrent ( HSNMP  session,
int  channel 
)

Returns the demanded maximum output current for channel.

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The demanded output current in Ampere.

Definition at line 875 of file WIENER_SNMP.cpp.

EXPORT double getOutputCurrentFallRate ( HSNMP  session,
int  channel 
)

Returns the channel current fall rate in Ampere/second.

Note
This function is for WIENER LV only. For iseg HV modules, use getModuleRampSpeedCurrent().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 1012 of file WIENER_SNMP.cpp.

EXPORT double getOutputCurrentRiseRate ( HSNMP  session,
int  channel 
)

Returns the channel current rise rate in Ampere/second.

Note
This function is for WIENER LV only. For iseg HV modules, use getModuleRampSpeedCurrent().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 977 of file WIENER_SNMP.cpp.

EXPORT double getOutputFallRate ( HSNMP  session,
int  channel 
)

Returns the channel voltage fall rate in Volt/second.

Note
This function is for WIENER LV only. For iseg HV modules, use getModuleRampSpeedVoltage().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 942 of file WIENER_SNMP.cpp.

EXPORT int getOutputGroup ( HSNMP  session,
int  channel 
)

getOutputGroup

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 644 of file WIENER_SNMP.cpp.

EXPORT int getOutputGroups ( HSNMP  session)

getOutputGroups

Parameters
sessionThe handle returned by snmpOpen()
Returns

Definition at line 631 of file WIENER_SNMP.cpp.

EXPORT int getOutputNumber ( HSNMP  session)

Returns the total number of output channels in the crate.

Parameters
sessionThe handle returned by snmpOpen()
Returns
The total number of output channels

Definition at line 621 of file WIENER_SNMP.cpp.

EXPORT double getOutputRiseRate ( HSNMP  session,
int  channel 
)

Returns the channel voltage rise rate in Volt/second.

Note
This function is for WIENER LV only. For iseg HV modules, use getModuleRampSpeedVoltage().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 907 of file WIENER_SNMP.cpp.

EXPORT double getOutputSenseMeasurement ( HSNMP  session,
int  channel 
)

Returns the measured output sense voltage for channel in Volt.

Note
This is only valid for WIENER LV modules.
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 686 of file WIENER_SNMP.cpp.

EXPORT int getOutputStatus ( HSNMP  session,
int  channel 
)

Returns the channel outputStatus register.

Since
1.1
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The channels outputStatus register

Definition at line 671 of file WIENER_SNMP.cpp.

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.

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 1045 of file WIENER_SNMP.cpp.

EXPORT double getOutputSupervisionMaxCurrent ( HSNMP  session,
int  channel 
)

If the measured current is above this value, the power supply performs the function defined by setOutputSupervisionBehavior().

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The maximum output current in Ampere

Definition at line 1186 of file WIENER_SNMP.cpp.

EXPORT double getOutputSupervisionMaxPower ( HSNMP  session,
int  channel 
)

getOutputSupervisionMaxPower

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 1272 of file WIENER_SNMP.cpp.

EXPORT double getOutputSupervisionMaxSenseVoltage ( HSNMP  session,
int  channel 
)

getOutputSupervisionMaxSenseVoltage

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 1125 of file WIENER_SNMP.cpp.

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().

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The maximum terminal voltage in Volt

Definition at line 1155 of file WIENER_SNMP.cpp.

EXPORT double getOutputSupervisionMinSenseVoltage ( HSNMP  session,
int  channel 
)

getOutputSupervisionMinSenseVoltage

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns

Definition at line 1096 of file WIENER_SNMP.cpp.

EXPORT int getOutputSwitch ( HSNMP  session,
int  channel 
)

Returns the state of the channel.

Since
1.1
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
One of the following: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10).

Definition at line 790 of file WIENER_SNMP.cpp.

EXPORT double getOutputTerminalMeasurement ( HSNMP  session,
int  channel 
)

Returns the measured output terminal voltage for channel in Volt.

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The measured output terminal voltage in Volt.

Definition at line 700 of file WIENER_SNMP.cpp.

EXPORT int getOutputTripTimeMaxCurrent ( HSNMP  session,
int  channel 
)

Returns the time span for the delayed trip function.

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
the trip delay time (0...4000 ms)

Definition at line 1286 of file WIENER_SNMP.cpp.

EXPORT double getOutputVoltage ( HSNMP  session,
int  channel 
)

Returns the demanded output voltage for channel.

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The demanded output voltage in Volt.

Definition at line 846 of file WIENER_SNMP.cpp.

EXPORT double getPsAuxCurrent ( HSNMP  session,
int  auxIndex 
)

Definition at line 1376 of file WIENER_SNMP.cpp.

EXPORT double getPsAuxVoltage ( HSNMP  session,
int  auxIndex 
)

Definition at line 1368 of file WIENER_SNMP.cpp.

EXPORT int getPsOperatingTime ( HSNMP  session)

Returns the crates operating time in seconds.

Parameters
sessionThe handle returned by snmpOpen()
Returns

Definition at line 1363 of file WIENER_SNMP.cpp.

EXPORT char* getPsSerialNumber ( HSNMP  session)

Returns a pointer to a string containing the MPOD controllers serial number.

The pointer is valid until the next call of any string function.

Parameters
sessionThe handle returned by snmpOpen()
Returns
The crates serial number, e.g. "4388090".

Definition at line 609 of file WIENER_SNMP.cpp.

EXPORT int getSensorFailureTemperature ( HSNMP  session,
int  sensor 
)

Definition at line 1340 of file WIENER_SNMP.cpp.

EXPORT int getSensorNumber ( HSNMP  session)

Definition at line 1311 of file WIENER_SNMP.cpp.

EXPORT int getSensorTemp ( HSNMP  session,
int  sensor 
)

Definition at line 1316 of file WIENER_SNMP.cpp.

EXPORT int getSensorWarningTemperature ( HSNMP  session,
int  sensor 
)

Definition at line 1324 of file WIENER_SNMP.cpp.

EXPORT char* getSysDescr ( HSNMP  session)

Returns a pointer to the MPOD controller description string.

The pointer is valid until the next call of any string function.

Parameters
sessionThe handle returned by snmpOpen()
Returns
the MPOD controller description string, containing the controller serial number and firmware releases, e.g.: "WIENER MPOD (4388090, MPOD 2.1.2098.1, MPODslave 1.09, MPOD-BL 1.50 )"

Definition at line 518 of file WIENER_SNMP.cpp.

EXPORT int getTemperatureMeasurement ( HSNMP  session,
int  channel 
)

Returns the measured temperature for channel in Degree Celsius.

Note
Only WIENER Low Voltage modules have a channel-wise temperature measurement. For iseg HV modules, use getModuleAuxTemperature().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
Returns
The measured output temperature in Degree Celsius.

Definition at line 730 of file WIENER_SNMP.cpp.

EXPORT int getVmeReset ( HSNMP  session)

Returns the VME system reset status.

Parameters
sessionThe handle returned by snmpOpen()
Returns

Definition at line 566 of file WIENER_SNMP.cpp.

EXPORT int setChannelSwitch ( HSNMP  session,
int  channel,
int  value 
)

Change the state of the channel.

Note
This function is deprecated. Use setOutputSwitch() instead.
Parameters
sessionThe handle returned by snmpOpen()
channelThe channel in the range of 0...999
valueOne of the following: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10).
Returns

Definition at line 747 of file WIENER_SNMP.cpp.

EXPORT int setFanNominalSpeed ( HSNMP  session,
int  value 
)

Sets the MPODs fan rotation speed in revolutions per minute.

Parameters
sessionThe handle returned by snmpOpen()
value1200..3600. 0 turns off the crates fans.
Returns

Definition at line 1422 of file WIENER_SNMP.cpp.

EXPORT int setFanSwitchOffDelay ( HSNMP  session,
int  value 
)

Definition at line 1401 of file WIENER_SNMP.cpp.

EXPORT int setHighVoltageGroupsSwitch ( HSNMP  session,
int  value 
)

setHighVoltageGroupsSwitch

Parameters
sessionThe handle returned by snmpOpen()
value
Returns

Definition at line 804 of file WIENER_SNMP.cpp.

EXPORT int setIpStaticAddress ( HSNMP  session,
int  value 
)

Sets a new static IP address.

Parameters
sessionThe handle returned by snmpOpen()
valueThe IP address as 32 bit integer
Returns

Definition at line 597 of file WIENER_SNMP.cpp.

EXPORT int setLowVoltageGroupsSwitch ( HSNMP  session,
int  value 
)

setLowVoltageGroupsSwitch

Parameters
sessionThe handle returned by snmpOpen()
value
Returns

Definition at line 825 of file WIENER_SNMP.cpp.

EXPORT int setMainSwitch ( HSNMP  session,
int  value 
)

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.

Parameters
sessionThe handle returned by snmpOpen()
value0 = set off, 1 = set on
Returns
The new on/off status of the crate.

Definition at line 546 of file WIENER_SNMP.cpp.

EXPORT int setModuleDoClear ( HSNMP  session,
int  slot 
)

Clears all modules events in a specific slot.

To clear all events in all iseg HV modules, use setHighVoltageGroupsSwitch() with the parameter clearEvents(10).

Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
Returns

Definition at line 1663 of file WIENER_SNMP.cpp.

EXPORT double setModuleRampSpeedCurrent ( HSNMP  session,
int  slot,
double  value 
)

Sets the modules current ramp speed in percent.

Note
This function is for iseg HV modules only.

iseg modules have one common ramp speed for all channels. This item is only valid for modules with constant current regulation.

Parameters
sessionThe handle returned by snmpOpen()
slotThe modules slot position in the crate (0...9)
valueThe new current ramp speed in percent
Returns
The new current ramp speed in percent

Definition at line 1614 of file WIENER_SNMP.cpp.

EXPORT double setModuleRampSpeedVoltage ( HSNMP  session,
int  slot,
double  value 
)

Sets the modules voltage ramp speed in percent.

Note
This function is for iseg HV modules only.

iseg modules have one common ramp speed for all channels.

Parameters
sessionThe handle returned by snmpOpen()
slotthe modules slot position in the crate (0...9)
valueThe new voltage ramp speed in percent
Note
For most modules, the range is 0.001...20 percent.
Returns
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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
valuesA pointer to SnmpDoubleBuffer with a list of new output currents
Returns

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
valuesThe new outputSupervisionBehavior for the all channels starting with start.
Returns

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
valuesA pointer to SnmpIntegerBuffer with the list of outputSwitches.
Returns

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
values
Returns

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.

Parameters
sessionThe handle returned by snmpOpen()
startThe first channel (in the range of 0 to MaxArraySize). 0 = slot 0, channel 0; 100 = slot 1, channel 0.
valuesA pointer to SnmpDoubleBuffer with the list of new outputVoltages
Returns

Definition at line 2077 of file WIENER_SNMP.cpp.

EXPORT double setOutputCurrent ( HSNMP  session,
int  channel,
double  value 
)

Sets the demanded maximum output current for channel.

Parameters
sessionThe handle returned by snmpOpen()
channelThe channel in the range of 0...999
valueThe demanded ouput current in Ampere
Returns
The demanded maximum output current in Ampere.

Definition at line 890 of file WIENER_SNMP.cpp.

EXPORT double setOutputCurrentFallRate ( HSNMP  session,
int  channel,
double  value 
)

Sets the channel current fall rate in Ampere/second.

Note
This function is for WIENER LV only. For iseg HV modules, use setModuleRampSpeedCurrent().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
value
Returns

Definition at line 1030 of file WIENER_SNMP.cpp.

EXPORT double setOutputCurrentRiseRate ( HSNMP  session,
int  channel,
double  value 
)

Sets the channel current rise rate in Ampere/second.

Note
This function is for WIENER LV only. For iseg HV modules, use setModuleRampSpeedCurrent().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
value
Returns

Definition at line 995 of file WIENER_SNMP.cpp.

EXPORT double setOutputFallRate ( HSNMP  session,
int  channel,
double  value 
)

Sets the channel voltage fall rate in Volt/second.

Note
This function is for WIENER LV only. For iseg HV modules, use setModuleRampSpeedVoltage().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
value
Returns

Definition at line 960 of file WIENER_SNMP.cpp.

EXPORT double setOutputRiseRate ( HSNMP  session,
int  channel,
double  value 
)

Sets the channel voltage rise rate in Volt/second.

Note
This function is for WIENER LV only. For iseg HV modules, use setModuleRampSpeedVoltage().
Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
value
Returns

Definition at line 925 of file WIENER_SNMP.cpp.

EXPORT int setOutputSupervisionBehavior ( HSNMP  session,
int  channel,
int  value 
)

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

Parameters
sessionThe handle returned by snmpOpen()
channelThe channel (0...999) for which the behaviour should be set
valueThe 16 bit integer with bits set according the preceding table.
Returns

Definition at line 1082 of file WIENER_SNMP.cpp.

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().

Parameters
sessionThe handle returned by snmpOpen()
channelThe channel (0...999) to set the max. current
valueThe maximum current in Ampere
Returns

Definition at line 1202 of file WIENER_SNMP.cpp.

EXPORT double setOutputSupervisionMaxSenseVoltage ( HSNMP  session,
int  channel,
double  value 
)

setOutputSupervisionMaxSenseVoltage

Parameters
sessionThe handle returned by snmpOpen()
channel
value
Returns

Definition at line 1140 of file WIENER_SNMP.cpp.

EXPORT int setOutputSupervisionMaxTemperature ( HSNMP  session,
int  channel,
int  value 
)
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().

Parameters
sessionThe handle returned by snmpOpen()
channelthe channel (0...999) to set the max. terminal voltage
valueThe maximum terminal voltage in Volt
Returns

Definition at line 1171 of file WIENER_SNMP.cpp.

EXPORT double setOutputSupervisionMinSenseVoltage ( HSNMP  session,
int  channel,
double  value 
)

setOutputSupervisionMinSenseVoltage

Parameters
sessionThe handle returned by snmpOpen()
channel
value
Returns

Definition at line 1111 of file WIENER_SNMP.cpp.

EXPORT int setOutputSwitch ( HSNMP  session,
int  channel,
int  value 
)

Change the state of the channel.

Since
1.1
Parameters
sessionThe handle returned by snmpOpen()
channelThe channel in the range of 0...999
valueOne of the following: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10).
Returns

Definition at line 761 of file WIENER_SNMP.cpp.

EXPORT int setOutputTripTimeMaxCurrent ( HSNMP  session,
int  channel,
int  delay 
)

Defines a span for the delayed trip function.

Parameters
sessionThe handle returned by snmpOpen()
channelThe channel (0...999) for which to set the delayed trip
delayThe trip delay time (0...4000 ms)
Returns

Definition at line 1301 of file WIENER_SNMP.cpp.

EXPORT double setOutputVoltage ( HSNMP  session,
int  channel,
double  value 
)

Sets the demanded output voltage for channel.

Parameters
sessionThe handle returned by snmpOpen()
channelThe requested channel in the range of 0...999
valuethe demanded output voltage in Volt.
Returns
The demanded output voltage in Volt.

Definition at line 861 of file WIENER_SNMP.cpp.

EXPORT int setSensorFailureTemperature ( HSNMP  session,
int  sensor,
int  value 
)

Definition at line 1348 of file WIENER_SNMP.cpp.

EXPORT int setSensorWarningTemperature ( HSNMP  session,
int  sensor,
int  value 
)

Definition at line 1332 of file WIENER_SNMP.cpp.

EXPORT int setVmeReset ( HSNMP  session)

Initiate a VME system reset.

Parameters
sessionThe handle returned by snmpOpen()
Returns

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.

EXPORT void snmpClose ( HSNMP  session)

Closes the previously opened session specified by session.

Parameters
sessionThe 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.

Returns
a pointer to a zero-terminated error string for the last failed SNMP operation. Note: this pointer is valid until the next string 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.

Since
1.1
Returns
The version number as unsigned long value, e.g. 0x01010000

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.

Since
1.1
Returns
The version number, e.g. "1.1.0.3"

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().

Returns
true on success, false otherwise (e.g. an OID could not be resolved)

Definition at line 278 of file WIENER_SNMP.cpp.

EXPORT HSNMP snmpOpen ( const char *const  ipAddress)

Opens a SNMP session to the specified ipAddress.

This function also sets the number of retries and the timeout value.

Parameters
ipAddressa zero-terminated ASCII string representation of an IPv4 address, e.g. "192.168.17.101"
Returns
a handle to the opened SNMP session, which is a required parameter for any further call.

Definition at line 456 of file WIENER_SNMP.cpp.

EXPORT void snmpSetFileLog ( const char *const  fileName)

Activates logging to the file filename.

Since
1.1
Parameters
fileNameThe full path to the file where all log information should go to.
Note
If the specified file already exists, new log information is appended.

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".

Since
1.1
Note
This function must be called before snmpOpen().
Parameters
readCommunityNamethe new read community name

Definition at line 428 of file WIENER_SNMP.cpp.

EXPORT void snmpSetStdErrLog ( void  )

Activates logging on stderr console.

Since
1.1
Note
This is the default setting.

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".

Since
1.1
Note
This function must be called before any write access function.
Parameters
writeCommunityNamethe new write community name

Definition at line 442 of file WIENER_SNMP.cpp.