sbgEComLogVibMon.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_VIB_MON_H
#define SBG_ECOM_LOG_VIB_MON_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Public definitions                                                 -//
//----------------------------------------------------------------------//

typedef enum _SbgEComVibMonAxis
{
    SBG_ECOM_VIB_MON_AXIS_X                          = 0,                            
    SBG_ECOM_VIB_MON_AXIS_Y                          = 1,                            
    SBG_ECOM_VIB_MON_AXIS_Z                          = 2,                            
} SbgEComVibMonAxis;

typedef enum _SbgEComVibMonWindow
{
    SBG_ECOM_VIB_MON_WINDOW_RECTANGULAR              = 0,                            
    SBG_ECOM_VIB_MON_WINDOW_HANNING                  = 1,                            
    SBG_ECOM_VIB_MON_WINDOW_FLAT_TOP                = 2,                            
} SbgEComVibMonWindow;
 
//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogVibMonFft
{
    uint16_t                             pageIndex;                                
    uint16_t                             nrPages;                                
    size_t                               size;                                  
 
    uint8_t                              buffer[64];                          
} SbgEComLogVibMonFft;

typedef struct _SbgEComLogVibMonBand
{
    float                                freq1;                                    
    float                                freq2;                                    
 
    float                                rms;                                    
    float                                peakHarmonic;                          
    float                                peakMagnitude;                            
} SbgEComLogVibMonBand;

typedef struct _SbgEComLogVibMonReport
{
    uint32_t                             timeStamp;                                
    uint16_t                             status;                              
    float                                mean;                                  
    float                                rms;                                    
 
    SbgEComLogVibMonBand                 bands[4];                             
 
} SbgEComLogVibMonReport;
 
//----------------------------------------------------------------------//
//- Public functions (SbgEComLogVibMonFft)                             -//
//----------------------------------------------------------------------//

void sbgEComLogVibMonFftZeroInit(SbgEComLogVibMonFft *pLogData);

SbgErrorCode sbgEComLogVibMonFftReadFromStream(SbgEComLogVibMonFft *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogVibMonFftWriteToStream(const SbgEComLogVibMonFft *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public functions (SbgEComLogVibMonReport)                          -//
//----------------------------------------------------------------------//

void sbgEComLogVibMonReportZeroInit(SbgEComLogVibMonReport *pLogData);

SbgErrorCode sbgEComLogVibMonReportReadFromStream(SbgEComLogVibMonReport *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogVibMonReportWriteToStream(const SbgEComLogVibMonReport *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters (SbgEComLogVibMonReport)                    -//
//----------------------------------------------------------------------//

SbgEComVibMonAxis sbgEComLogVibMonReportGetAxis(const SbgEComLogVibMonReport *pLogData);

SbgEComVibMonWindow sbgEComLogVibMonReportGetWindow(const SbgEComLogVibMonReport *pLogData);

const SbgEComLogVibMonBand *sbgEComLogVibMonReportGetMaxPeakBand(const SbgEComLogVibMonReport *pLogData);
 
//----------------------------------------------------------------------//
//- Private setters/getters                                            -//
//----------------------------------------------------------------------//

SbgEComVibMonAxis sbgEComLogVibMonStatusGetAxis(uint16_t status);

SbgEComVibMonWindow sbgEComLogVibMonStatusGetWindow(uint16_t status);

uint16_t sbgEComLogVibMonMakeStatus(SbgEComVibMonAxis axis, SbgEComVibMonWindow window);
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_VIB_MON_H