XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Enumerations | Functions
External sensor

Interface header file for the External Sensor features. More...

+ Collaboration diagram for External sensor:

Files

file  XDK_ExternalSensor.h
 

Data Structures

struct  ExternalSensor_Enable_S
 Structure to represent the Sensors to be enabled. More...
 
struct  ExternalSensor_LemConfig_S
 
struct  ExternalSensor_Max31865Config_S
 
struct  ExternalSensor_Setup_S
 Structure to represent the Sensor setup features. More...
 
struct  ExternalSensor_Value_S
 Structure to represent the Data Collector sampled node informations. More...
 

Typedefs

typedef struct
ExternalSensor_Enable_S 
ExternalSensor_Enable_T
 Typedef to represent the Sensor to be enabled. More...
 
typedef struct
ExternalSensor_LemConfig_S 
ExternalSensor_LemConfig_T
 
typedef struct
ExternalSensor_Max31865Config_S 
ExternalSensor_Max31865Config_T
 
typedef enum
ExternalSensor_Max31865TempType_E 
ExternalSensor_Max31865TempType_T
 Typedef representing the the external temperature sensor.. More...
 
typedef struct
ExternalSensor_Setup_S 
ExternalSensor_Setup_T
 Typedef to represent the Sensor setup features. More...
 
typedef enum
ExternalSensor_Target_E 
ExternalSensor_Target_T
 Typedef representing the supported External sensor. More...
 
typedef struct
ExternalSensor_Value_S 
ExternalSensor_Value_T
 Typedef to represent the Data Collector sampled node information. More...
 

Enumerations

enum  ExternalSensor_Max31865TempType_E
 Enum representing the external temperature supported. More...
 
enum  ExternalSensor_Target_E
 Enum representing the supported External sensors. More...
 

Functions

Retcode_T ExternalSensor_Enable (void)
 This will enable the External Sensor module. More...
 
Retcode_T ExternalSensor_GetData (ExternalSensor_Value_T *value)
 This will sample the necessary sensor nodes and update the data. More...
 
Retcode_T ExternalSensor_GetLemData (float *xLemI, float *xLemV)
 
Retcode_T ExternalSensor_GetMax31865Data (float *xMaxT, float *xMaxR)
 
Retcode_T ExternalSensor_HwStatusPinDeInit (void)
 
Retcode_T ExternalSensor_HwStatusPinInit (void)
 
Retcode_T ExternalSensor_IsAvailable (ExternalSensor_Target_T sensor, bool *status)
 This will validate if the Sensor is available or not. More...
 
Retcode_T ExternalSensor_Setup (ExternalSensor_Setup_T *setup)
 This will setup the External Sensor module. More...
 

Detailed Description

This provides the basic sensor sampling feature with the default configuration. This supports only single thread for data sampling and reporting, yet.


Data Structure Documentation

struct ExternalSensor_Enable_S

Data Fields

bool LemCurrent
 
bool LemVoltage
 
bool MaxResistance
 
bool MaxTemp
 

Field Documentation

bool LemCurrent

Boolean representing if Current sensor is to be enabled or not

bool LemVoltage

Boolean representing if Voltage sensor is to be enabled or not

bool MaxResistance

Boolean representing if external resistance is to be enabled or not

bool MaxTemp

Boolean representing if external temperature sensor is to be enabled or not

struct ExternalSensor_LemConfig_S

Data Fields

float CurrentRatedTransformationRatio
 

Field Documentation

float CurrentRatedTransformationRatio

Current sensor (LEM) rated transformation ratio. Unused if Enable.Current is false.

struct ExternalSensor_Max31865Config_S
struct ExternalSensor_Setup_S
+ Collaboration diagram for ExternalSensor_Setup_S:

Data Fields

CmdProcessor_TCmdProcessorHandle
 
ExternalSensor_Enable_T Enable
 
ExternalSensor_LemConfig_T LemConfig
 
ExternalSensor_Max31865Config_T Max31865Config
 

Field Documentation

CmdProcessor_T* CmdProcessorHandle

The Sensors to be enabled

LEM configuration for setting up current rated transformation ratio

MAX31865 configuration for setting up the external temperature sensor type

struct ExternalSensor_Value_S

Data Fields

float XLemI
 
float XLemV
 
float XMaxR
 
float XMaxT
 

Field Documentation

float XLemI

Current sensor value

float XLemV

Voltage sensor value

float XMaxR

External resistance value

float XMaxT

External temperature sensor value

Typedef Documentation

Enumeration Type Documentation

Enumerator
SENSOR_TEMPERATURE_PT100 

PT100 based temperature sensor

SENSOR_TEMPERATURE_PT1000 

PT1000 based temperature sensor

SENSOR_TEMPERATURE_INVALID 

Invalid Sensor Type

Enumerator
XDK_EXTERNAL_LEM 
XDK_EXTERNAL_MAX31865 
XDK_EXTERNAL_INVALID 

Function Documentation

Retcode_T ExternalSensor_Enable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • Based on setup->Enable value, it will enable the necessary sensors.
  • ExternalSensor_Setup must have been successful prior.
  • Do not call this API more than once.

+ Here is the caller graph for this function:

Retcode_T ExternalSensor_GetData ( ExternalSensor_Value_T value)
Parameters
in/out]value The sampled sensor node values. User must provide a valid buffer.
Returns
RETCODE_OK on success, or an error code otherwise.
Note

+ Here is the caller graph for this function:

Retcode_T ExternalSensor_GetLemData ( float *  xLemI,
float *  xLemV 
)

+ Here is the caller graph for this function:

Retcode_T ExternalSensor_GetMax31865Data ( float *  xMaxT,
float *  xMaxR 
)

+ Here is the caller graph for this function:

Retcode_T ExternalSensor_HwStatusPinDeInit ( void  )

+ Here is the caller graph for this function:

Retcode_T ExternalSensor_HwStatusPinInit ( void  )

+ Here is the caller graph for this function:

Retcode_T ExternalSensor_IsAvailable ( ExternalSensor_Target_T  sensor,
bool *  status 
)
Parameters
[in]sensorExternal sensor to be validated for availability
[out]statusPointer to the availability of the requested sensor availability status
Note
More than one sensor availability can be validated in single request
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T ExternalSensor_Setup ( ExternalSensor_Setup_T setup)
Parameters
[in]setupPointer to the Sensor setup feature
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • This must be the first API to be called if this Sensor feature is to be used.
  • Enable required sensor which is connected on external board.
  • Do not call this API more than once.

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:50 by doxygen 1.8.8