Provide pipeline for telemetry. More...

#include "modbus_analyzer.h"
#include "slab_pool.h"

Include dependency graph for telemetry_pipeline.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	telemetry_pipeline_record_t
	Telemetry pipeline record structure. More...

Macros
#define	TELEMETRY_PIPELINE_TASK_NAME ("TELE_PLN")

#define	TELEMETRY_PIPELINE_TASK_STACK_DEPTH (4096U)

#define	TELEMETRY_PIPELINE_TASK_PRIORITY (10U)

#define	TELEMETRY_PIPELINE_TASK_CPU_AFFINITY (0U)

#define	TELEMETRY_PIPELINE_TASK_NOTIFY_STOP_BIT (1U << 0)

#define	TELEMETRY_PIPELINE_TASK_NOTIFY_FRAME_BIT (1U << 1)

Functions
bool	telemetry_pipeline_init (modbus_analyzer_config_t analyzer_config_ptr, void(record_ready_cb)(const telemetry_pipeline_record_t *))
	Initiate telemetry pipeline.

void	telemetry_pipeline_enqueue_raw_frame (const modbus_analyzer_frame_t *raw_frame_ptr)
	Enqueue raw frame.

void	telemetry_pipeline_deinit (void)
	Deinitialize telemetry pipeline.

Detailed Description

Provide pipeline for telemetry.

Author: Abanoub Salah

Serialize raw frames

Macro Definition Documentation

◆ TELEMETRY_PIPELINE_TASK_CPU_AFFINITY

#define TELEMETRY_PIPELINE_TASK_CPU_AFFINITY (0U)

CPU affinity

◆ TELEMETRY_PIPELINE_TASK_NAME

#define TELEMETRY_PIPELINE_TASK_NAME ("TELE_PLN")

Task name

◆ TELEMETRY_PIPELINE_TASK_NOTIFY_FRAME_BIT

#define TELEMETRY_PIPELINE_TASK_NOTIFY_FRAME_BIT (1U << 1)

Task notify for frame bit

◆ TELEMETRY_PIPELINE_TASK_NOTIFY_STOP_BIT

#define TELEMETRY_PIPELINE_TASK_NOTIFY_STOP_BIT (1U << 0)

Task stop bit

◆ TELEMETRY_PIPELINE_TASK_PRIORITY

#define TELEMETRY_PIPELINE_TASK_PRIORITY (10U)

Priority

◆ TELEMETRY_PIPELINE_TASK_STACK_DEPTH

#define TELEMETRY_PIPELINE_TASK_STACK_DEPTH (4096U)

Stack depth

Function Documentation

◆ telemetry_pipeline_enqueue_raw_frame()

void telemetry_pipeline_enqueue_raw_frame ( const modbus_analyzer_frame_t * raw_frame_ptr )

Enqueue raw frame.

Parameters

raw_frame_ptr Pointer to raw frame

Here is the caller graph for this function:

◆ telemetry_pipeline_init()

bool telemetry_pipeline_init	(	modbus_analyzer_config_t *	analyzer_config_ptr,
		void()(const telemetry_pipeline_record_t )	record_ready_cb
	)

Initiate telemetry pipeline.

Initiate a modbus analyzer instance and create serialized queue