sbgEComLogVibMon.h File Reference

Vibration monitoring related logs. More...

#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>

Go to the source code of this file.

Data Structures
struct	_SbgEComLogVibMonFft
struct	_SbgEComLogVibMonBand
struct	_SbgEComLogVibMonReport

Typedefs
typedef enum _SbgEComVibMonAxis	SbgEComVibMonAxis
typedef enum _SbgEComVibMonWindow	SbgEComVibMonWindow
typedef struct _SbgEComLogVibMonFft	SbgEComLogVibMonFft
typedef struct _SbgEComLogVibMonBand	SbgEComLogVibMonBand
typedef struct _SbgEComLogVibMonReport	SbgEComLogVibMonReport

Enumerations
enum	_SbgEComVibMonAxis {   SBG_ECOM_VIB_MON_AXIS_X = 0 ,   SBG_ECOM_VIB_MON_AXIS_Y = 1 ,   SBG_ECOM_VIB_MON_AXIS_Z = 2 }
enum	_SbgEComVibMonWindow {   SBG_ECOM_VIB_MON_WINDOW_RECTANGULAR = 0 ,   SBG_ECOM_VIB_MON_WINDOW_HANNING = 1 ,   SBG_ECOM_VIB_MON_WINDOW_FLAT_TOP = 2 }

Functions
void	sbgEComLogVibMonFftZeroInit (SbgEComLogVibMonFft *pLogData)
SbgErrorCode	sbgEComLogVibMonFftReadFromStream (SbgEComLogVibMonFft *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgErrorCode	sbgEComLogVibMonFftWriteToStream (const SbgEComLogVibMonFft *pLogData, SbgStreamBuffer *pStreamBuffer)
void	sbgEComLogVibMonReportZeroInit (SbgEComLogVibMonReport *pLogData)
SbgErrorCode	sbgEComLogVibMonReportReadFromStream (SbgEComLogVibMonReport *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgErrorCode	sbgEComLogVibMonReportWriteToStream (const SbgEComLogVibMonReport *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgEComVibMonAxis	sbgEComLogVibMonReportGetAxis (const SbgEComLogVibMonReport *pLogData)
SbgEComVibMonWindow	sbgEComLogVibMonReportGetWindow (const SbgEComLogVibMonReport *pLogData)
const SbgEComLogVibMonBand *	sbgEComLogVibMonReportGetMaxPeakBand (const SbgEComLogVibMonReport *pLogData)
SbgEComVibMonAxis	sbgEComLogVibMonStatusGetAxis (uint16_t status)
SbgEComVibMonWindow	sbgEComLogVibMonStatusGetWindow (uint16_t status)
uint16_t	sbgEComLogVibMonMakeStatus (SbgEComVibMonAxis axis, SbgEComVibMonWindow window)

Detailed Description

Vibration monitoring related logs.

Author

SBG Systems

Date

February 27, 2025

Copyright

Copyright (C) 2007-2025, SBG Systems SAS. All rights reserved.

License

The MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

SbgEComVibMonAxis

typedef enum _SbgEComVibMonAxis SbgEComVibMonAxis

Axes.

SbgEComVibMonWindow

typedef enum _SbgEComVibMonWindow SbgEComVibMonWindow

Windows.

SbgEComLogVibMonFft

typedef struct _SbgEComLogVibMonFft SbgEComLogVibMonFft

Log structure for vibration monitoring FFT data.

SbgEComLogVibMonBand

typedef struct _SbgEComLogVibMonBand SbgEComLogVibMonBand

Structure for a frequency band.

SbgEComLogVibMonReport

typedef struct _SbgEComLogVibMonReport SbgEComLogVibMonReport

Log structure for vibration monitoring report information.

Enumeration Type Documentation

_SbgEComVibMonAxis

enum _SbgEComVibMonAxis

Axes.

Enumerator
SBG_ECOM_VIB_MON_AXIS_X	X axis.
SBG_ECOM_VIB_MON_AXIS_Y	Y axis.
SBG_ECOM_VIB_MON_AXIS_Z	Z axis.

_SbgEComVibMonWindow

enum _SbgEComVibMonWindow

Windows.

Enumerator
SBG_ECOM_VIB_MON_WINDOW_RECTANGULAR	Rectangular (Uniform) window.
SBG_ECOM_VIB_MON_WINDOW_HANNING	Hanning (Hann) window.
SBG_ECOM_VIB_MON_WINDOW_FLAT_TOP	Flat Top window.

Function Documentation

sbgEComLogVibMonFftZeroInit()

void sbgEComLogVibMonFftZeroInit

(

SbgEComLogVibMonFft *

pLogData

)

Zero initialize the message struct.

Parameters

[out]

pLogData

Structure instance to zero init.

sbgEComLogVibMonFftReadFromStream()

SbgErrorCode sbgEComLogVibMonFftReadFromStream	(	SbgEComLogVibMonFft *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

Parse data for the SBG_ECOM_LOG_VIB_MON_FFT message and fill the corresponding structure.

Parameters

[out]	pLogData	Log structure instance to fill.
[in]	pStreamBuffer	Input stream buffer to read the log from.

Returns

SBG_NO_ERROR if a valid log has been read from the stream buffer.

sbgEComLogVibMonFftWriteToStream()

SbgErrorCode sbgEComLogVibMonFftWriteToStream	(	const SbgEComLogVibMonFft *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

Write data for the SBG_ECOM_LOG_VIB_MON_FFT message to the output stream buffer from the provided structure.

Parameters

[in]	pLogData	Log structure instance to write.
[out]	pStreamBuffer	Output stream buffer to write the log to.

Returns

SBG_NO_ERROR if the log has been written to the stream buffer.

sbgEComLogVibMonReportZeroInit()

void sbgEComLogVibMonReportZeroInit

(

SbgEComLogVibMonReport *

pLogData

)

Zero initialize the message struct.

Parameters

[out]

pLogData

Structure instance to zero init.

sbgEComLogVibMonReportReadFromStream()

SbgErrorCode sbgEComLogVibMonReportReadFromStream	(	SbgEComLogVibMonReport *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

Parse data for the SBG_ECOM_LOG_VIB_MON_REPORT message and fill the corresponding structure.

Parameters

[out]	pLogData	Log structure instance to fill.
[in]	pStreamBuffer	Input stream buffer to read the log from.

Returns

SBG_NO_ERROR if a valid log has been read from the stream buffer.

sbgEComLogVibMonReportWriteToStream()

SbgErrorCode sbgEComLogVibMonReportWriteToStream	(	const SbgEComLogVibMonReport *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

Write data for the SBG_ECOM_LOG_VIB_MON_REPORT message to the output stream buffer from the provided structure.

Parameters

[in]	pLogData	Log structure instance to write.
[out]	pStreamBuffer	Output stream buffer to write the log to.

Returns

SBG_NO_ERROR if the log has been written to the stream buffer.

sbgEComLogVibMonReportGetAxis()

SbgEComVibMonAxis sbgEComLogVibMonReportGetAxis

(

const SbgEComLogVibMonReport *

pLogData

)

Returns the vibration monitoring axis status.

Parameters

[in]

pLogData

Log instance.

Returns

Axis.

sbgEComLogVibMonReportGetWindow()

SbgEComVibMonWindow sbgEComLogVibMonReportGetWindow

(

const SbgEComLogVibMonReport *

pLogData

)

Returns the vibration monitoring window status.

Parameters

[in]

pLogData

Log instance.

Returns

Window.

sbgEComLogVibMonReportGetMaxPeakBand()

const SbgEComLogVibMonBand * sbgEComLogVibMonReportGetMaxPeakBand

(

const SbgEComLogVibMonReport *

pLogData

)

Returns a pointer to the frequency band with the highest peak amplitude.

This function scans all frequency bands in the given vibration monitoring report and returns a pointer to the band where the signal peak is the highest.

Parameters

[in]

pLogData

Pointer to the vibration monitoring report log.

Returns

Pointer to the frequency band with the highest peak amplitude.

sbgEComLogVibMonStatusGetAxis()

SbgEComVibMonAxis sbgEComLogVibMonStatusGetAxis

(

uint16_t

status

)

Returns the vibration monitoring axis status.

Parameters

[in]

status

Vibration monitoring status.

Returns

Axis.

sbgEComLogVibMonStatusGetWindow()

SbgEComVibMonWindow sbgEComLogVibMonStatusGetWindow

(

uint16_t

status

)

Returns the vibration monitoring window status.

Parameters

[in]

status

Vibration monitoring status.

Returns

Window.

sbgEComLogVibMonMakeStatus()

uint16_t sbgEComLogVibMonMakeStatus	(	SbgEComVibMonAxis	axis,
		SbgEComVibMonWindow	window )

Make a vibration monitoring status.

Parameters

[in]	axis	Axis.
[in]	window	Window.

Returns

Status.