RA Flexible Software Package Documentation  Release v5.2.0

 
FSXXXX Middleware Interface

Detailed Description

Interface for FSXXXX Middleware functions.

Summary

The FSXXXX interface provides FSXXXX functionality.

Data Structures

struct  rm_fsxxxx_callback_args_t
 
struct  rm_fsxxxx_raw_data_t
 
struct  rm_fsxxxx_sensor_data_t
 
struct  rm_fsxxxx_data_t
 
struct  rm_fsxxxx_cfg_t
 
struct  rm_fsxxxx_api_t
 
struct  rm_fsxxxx_instance_t
 

Typedefs

typedef void rm_fsxxxx_ctrl_t
 

Enumerations

enum  rm_fsxxxx_event_t
 

Data Structure Documentation

◆ rm_fsxxxx_callback_args_t

struct rm_fsxxxx_callback_args_t

FSXXXX callback parameter definition

◆ rm_fsxxxx_raw_data_t

struct rm_fsxxxx_raw_data_t

FSXXXX raw data

◆ rm_fsxxxx_sensor_data_t

struct rm_fsxxxx_sensor_data_t

FSXXXX sensor data block

Data Fields
int16_t integer_part
int16_t decimal_part To two decimal places.

◆ rm_fsxxxx_data_t

struct rm_fsxxxx_data_t

FSXXXX data block

◆ rm_fsxxxx_cfg_t

struct rm_fsxxxx_cfg_t

FSXXXX Configuration

Data Fields

rm_comms_instance_t const * p_instance
 Pointer to Communications Middleware instance.
 
void const * p_context
 Pointer to the user-provided context.
 
void const * p_extend
 Pointer to extended configuration by instance of interface.
 
void(* p_callback )(rm_fsxxxx_callback_args_t *p_args)
 Pointer to callback function.
 

◆ rm_fsxxxx_api_t

struct rm_fsxxxx_api_t

FSXXXX APIs

Data Fields

fsp_err_t(* open )(rm_fsxxxx_ctrl_t *const p_ctrl, rm_fsxxxx_cfg_t const *const p_cfg)
 
fsp_err_t(* read )(rm_fsxxxx_ctrl_t *const p_ctrl, rm_fsxxxx_raw_data_t *const p_raw_data)
 
fsp_err_t(* dataCalculate )(rm_fsxxxx_ctrl_t *const p_ctrl, rm_fsxxxx_raw_data_t *const p_raw_data, rm_fsxxxx_data_t *const p_fsxxxx_data)
 
fsp_err_t(* close )(rm_fsxxxx_ctrl_t *const p_ctrl)
 

Field Documentation

◆ open

fsp_err_t(* rm_fsxxxx_api_t::open) (rm_fsxxxx_ctrl_t *const p_ctrl, rm_fsxxxx_cfg_t const *const p_cfg)

Open sensor.

Parameters
[in]p_ctrlPointer to control structure.
[in]p_cfgPointer to configuration structure.

◆ read

fsp_err_t(* rm_fsxxxx_api_t::read) (rm_fsxxxx_ctrl_t *const p_ctrl, rm_fsxxxx_raw_data_t *const p_raw_data)

Read ADC data from FSXXXX.

Parameters
[in]p_ctrlPointer to control structure.
[in]p_raw_dataPointer to raw data structure.

◆ dataCalculate

fsp_err_t(* rm_fsxxxx_api_t::dataCalculate) (rm_fsxxxx_ctrl_t *const p_ctrl, rm_fsxxxx_raw_data_t *const p_raw_data, rm_fsxxxx_data_t *const p_fsxxxx_data)

Calculate flow values from ADC data.

Parameters
[in]p_ctrlPointer to control structure.
[in]p_raw_dataPointer to raw data.
[in]p_fsxxxx_dataPointer to FSXXXX data structure.

◆ close

fsp_err_t(* rm_fsxxxx_api_t::close) (rm_fsxxxx_ctrl_t *const p_ctrl)

Close FSXXXX.

Parameters
[in]p_ctrlPointer to control structure.

◆ rm_fsxxxx_instance_t

struct rm_fsxxxx_instance_t

FSXXXX instance

Data Fields
rm_fsxxxx_ctrl_t * p_ctrl

Pointer to the control structure for this instance

rm_fsxxxx_cfg_t const * p_cfg

Pointer to the configuration structure for this instance

rm_fsxxxx_api_t const * p_api

Pointer to the API structure for this instance

Typedef Documentation

◆ rm_fsxxxx_ctrl_t

typedef void rm_fsxxxx_ctrl_t

FSXXXX control block. Allocate an instance specific control block to pass into the FSXXXX API calls.

Enumeration Type Documentation

◆ rm_fsxxxx_event_t

Event in the callback function