labbCAN_Controller_API.h File Reference

labbCAN Controller Application Programming Interface More...

#include "labbCAN_Bus_API.h"
+ Include dependency graph for labbCAN_Controller_API.h:

Enumerations

enum  LoopOutType { ANALOG, DIGITAL, DIGITAL_PWM, PUMP_FLOW }
 Control loop output type This enumeration defines the output types for dynamic control channels. More...
 
enum  PIDParameterId {
  PID_PARAM_K = 0, PID_PARAM_T_I, PID_PARAM_T_D, PID_PARAM_DERIVATIVE_GAIN_LIMIT,
  PID_PARAM_T_T, PID_PARAM_MAX_U, PID_PARAM_MIN_U, PID_PARAM_DISABLED_U,
  PID_PARAM_INITIAL_SETPOINT, PID_PARAM_SAMPLE_TIME, PID_PARAM_COUNT
}
 ID parameter identifier Identifier for all PID control loop parameter that can be changed via LCC_SetPIDParameter. More...
 

Functions

long LCC_CreatePIDControlChannel (dev_hdl AnalogInput, dev_hdl Output, unsigned int LoopOutType, dev_hdl *pCreatedChannel)
 Function for creation of dynamic PID control channels. More...
 
long LCC_EnableControlLoop (dev_hdl ChanHdl, int Enable)
 Enables / disables a control loop. More...
 
long LCC_GetChanName (dev_hdl hChan, char *pNameStringBuf, int StringBufSize)
 Query name of specific channel. More...
 
long LCC_GetChannelHandle (unsigned char Index, dev_hdl *pChanHdl)
 Get controller channel handle by its index. More...
 
long LCC_GetNoOfControlChannels ()
 Query number of available controller channels. More...
 
long LCC_GetSetPoint (dev_hdl ChanHdl, double *pfSetPointValue)
 Query setpoint value from device object. More...
 
long LCC_GetSwScalingParam (dev_hdl ChanHdl, double *pfScalingFactor, double *pfScalingOffset)
 Read software scaling parameters. More...
 
long LCC_IsControlLoopEnabled (dev_hdl ChanHdl)
 Query if a control loop is enabled. More...
 
long LCC_LookupChanByName (const char *pChannelName, dev_hdl *pChanHdl)
 Lookup for a controller channel by its name. More...
 
long LCC_LookupCtrlDeviceByName (char *pName, dev_hdl *pCtrlDeviceHdl)
 Lookup a controller device by its name. More...
 
long LCC_ReadActualValue (dev_hdl ChanHdl, double *pfActualValue)
 Read actual value from device. More...
 
long LCC_ReadActualValueUnscaled (dev_hdl ChanHdl, double *pfActualValueRaw)
 Read actual value from device - bypass scaling. More...
 
long LCC_ReadStatus (dev_hdl ChanHdl, unsigned long *pdwStatus)
 Read additional status information from device. More...
 
long LCC_SetPIDParameter (dev_hdl ChanHdl, int PIDParamId, double Value)
 Set the PID parameters of a certain control channel. More...
 
long LCC_SetSwScalingOn (dev_hdl ChanHdl, int ScalingOn)
 Enable / disable software scaling. More...
 
long LCC_SetSwScalingParam (dev_hdl ChanHdl, double fScalingFactor, double fScalingOffset)
 Set software scaling parameters. More...
 
long LCC_WriteSetPoint (dev_hdl ChanHdl, double fSetPointValue)
 Write setpoint value to controller device. More...
 
long LCC_WriteSetPointUnscaled (dev_hdl ChanHdl, double SetPointValueRaw)
 Write setpoint value to controller device - bypass scaling stage. More...
 

Detailed Description

labbCAN Controller Application Programming Interface

Author
Uwe Kindler (UK)
Date
2011/05/25