Cos404_AI_Config_s Struct Reference

Detailed Description

This struct holds parameters that are used at initial startup of the CiA 404 AI software module. The values within this structure are provided to CiA 404 AI software module using the Cos404_AI_DefaultConfiguration() function.

Collaboration diagram for Cos404_AI_Config_s:

Data Fields
uint8_t	ubIdx6102_DecimalDigitsInt16FV
uint8_t	ubIdx6102_DecimalDigitsInt32FV
uint8_t	ubIdx6132_DecimalDigitsInt16PV
uint8_t	ubIdx6132_DecimalDigitsInt32PV
uint16_t	uwIdx6110_DefaultSensorType
uint8_t	ubIdx6112_DefaultOpMode
uint32_t	ulIdx6101_PhysicalUnitFV
uint32_t	ulIdx6131_PhysicalUnitPV
int32_t	slIdx9148_SpanStart
int32_t	slIdx9149_SpanEnd
int32_t	slIdx914A_LowerErrorLimit
int32_t	slIdx914B_UpperErrorLimit
Cos404AiSensorType_fn	pfnSensorTypeEvent
Cos404AiOpMode_fn	pfnOperatingModeEvent
Cos404AiLinearisation_fn	pfnLinearisationEvent

Field Documentation

pfnLinearisationEvent

Cos404AiLinearisation_fn Cos404_AI_Config_s::pfnLinearisationEvent

This processing callback function is called by the 404 AI software module upon set of new field value using Cos404_AI_SetFieldValue() function.

By defining this function it is possible to use manufacturer specific scaling of the field value to the temperature of, for example, a thermocouple sensor.

pfnOperatingModeEvent

Cos404AiOpMode_fn Cos404_AI_Config_s::pfnOperatingModeEvent

Parameters

[in]

ubChannelV

Analog input channel

The parameter ubChannelV defines the channel number, the first channel starts at eCOS404_CHANNEL_1.

This event handler is called by the 404 AI software module upon change of operating mode. The application can check the current operating mode by calling Cos404_AI_GetOperatingMode().

Note

In case this function is registered, it is called during initialisation and upon write access to the object at index 6112_h.

pfnSensorTypeEvent

Cos404AiSensorType_fn Cos404_AI_Config_s::pfnSensorTypeEvent

This value holds actual ADC sample rate given in [us].

Parameters

[in]	ubChannelV	Analog input channel
[in]	pvdDataV	Pointer to sensor type value defined by Cos404_AI_SensorType_e

Returns

eCosSdo_WRITE_OK on success or any other value from CosSdo_e in case of an error

The parameter ubChannelV defines the channel number, the first channel starts at eCOS404_CHANNEL_1. The data contents of pointer pvdDataV should be defined by the Cos404_AI_SensorType_e enumeration. It is the task of the application to check the value and evaluate whether the corresponding sensor type is supported or not. In case the sensor type is accepted by the application the function shall return eCosSdo_WRITE_OK.

Note

In case this function is registered, it is called during initialisation and upon write access to the object at index 6110_h.

slIdx9148_SpanStart

int32_t Cos404_AI_Config_s::slIdx9148_SpanStart

This variable defines the span start value of the analog input channel (object at index 9148_h).

The value is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

slIdx9149_SpanEnd

int32_t Cos404_AI_Config_s::slIdx9149_SpanEnd

This variable defines the span end value of the analog input channel (object at index 9149_h).

The value is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

slIdx914A_LowerErrorLimit

int32_t Cos404_AI_Config_s::slIdx914A_LowerErrorLimit

This variable defines the lower error limit of the analog input channel (object at index 914A_h).

The value is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

slIdx914B_UpperErrorLimit

int32_t Cos404_AI_Config_s::slIdx914B_UpperErrorLimit

This variable defines the upper error limit of the analog input channel (object at index 914B_h).

The value is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

ubIdx6102_DecimalDigitsInt16FV

uint8_t Cos404_AI_Config_s::ubIdx6102_DecimalDigitsInt16FV

This variable defines the number of decimal digits of the field value FV (object at index 6102_h) in case data type int16_t is selected.

The value is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

ubIdx6102_DecimalDigitsInt32FV

uint8_t Cos404_AI_Config_s::ubIdx6102_DecimalDigitsInt32FV

This variable defines the number of decimal digits of the field value FV (object at index 6102_h) in case data type int32_t is selected.

The value is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

ubIdx6112_DefaultOpMode

uint8_t Cos404_AI_Config_s::ubIdx6112_DefaultOpMode

This variable defines the operating mode of the analog input channel.

The default operating mode is provided once initially by the application during configuration (refer to Cos404_AI_DefaultConfiguration()) and can be later set via SDO / USDO write access to the object at index 6112_h.

ubIdx6132_DecimalDigitsInt16PV

uint8_t Cos404_AI_Config_s::ubIdx6132_DecimalDigitsInt16PV

This variable defines the number of decimal digits of the process value PV (object at index 6132_h) in case data type int16_t is selected.

The value is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

ubIdx6132_DecimalDigitsInt32PV

uint8_t Cos404_AI_Config_s::ubIdx6132_DecimalDigitsInt32PV

This variable defines the number of decimal digits of the process value PV (object at index 6132_h) in case data type int32_t is selected.

The value is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

ulIdx6101_PhysicalUnitFV

uint32_t Cos404_AI_Config_s::ulIdx6101_PhysicalUnitFV

This variable defines the physical unit of the field value FV (object at index 6101_h).

The value is encoded according to CiA 890 and is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

ulIdx6131_PhysicalUnitPV

uint32_t Cos404_AI_Config_s::ulIdx6131_PhysicalUnitPV

This variable defines the physical unit of the process value PV (object at index 6131_h).

The value is encoded according to CiA 890 and is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration().

uwIdx6110_DefaultSensorType

uint16_t Cos404_AI_Config_s::uwIdx6110_DefaultSensorType

This variable defines the sensor type of the analog input channel (object at index 6110_h).

The default sensor type is provided once initially by the application within the configuration at the call of Cos404_AI_DefaultConfiguration() and can be later set via the object at index 6110_h.

The object at index 6110_h is only writable if a function handler has been provided for the element Cos404AiSensorType_fn.