MotorWare f2806x Module API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Typedefs | Functions
float/offset.h File Reference

Contains the public interface to the offset (OFFSET) module routines. More...

`#include "sw/modules/types/src/types.h"`
`#include "sw/modules/filter/src/float/filter_fo.h"`

Go to the source code of this file.

## Data Structures
struct | _OFFSET_
| Defines the offset (OFFSET) object. More...

## Typedefs
typedef struct _OFFSET_ | OFFSET_Obj
| Defines the offset (OFFSET) object. More...
typedef struct _OFFSET_Obj_ * | OFFSET_Handle
| Defines the OFFSET handle. More...

## Functions
_iq | OFFSET_getBeta (OFFSET_Handle handle)
| Gets the beta offset filter coefficient. More...
static float_t | OFFSET_getOffset (OFFSET_Handle handle)
| Gets the offset value. More...
OFFSET_Handle | OFFSET_init (void *pMemory, const size_t numBytes)
| Initializes the offset. More...
static void | OFFSET_run (OFFSET_Handle handle, const float_t inputValue)
| Runs an offset filter of the form y[n] = beta*x[n] + (1 - beta)*y[n-1] y -> The DC offset x -> The ADC measurement. More...
void | OFFSET_setBeta (OFFSET_Handle handle, const float_t beta_rad)
| Sets the beta offset filter coefficient. More...
void | OFFSET_setInitCond (OFFSET_Handle handle, const float_t initCond)
| Set the initial condition of the integrator or the value of y[n-1]. More...
void | OFFSET_setOffset (OFFSET_Handle handle, float_t offsetValue)
| Sets the offset value. More...

## Detailed Description

Contains the public interface to the offset (OFFSET) module routines.

(C) Copyright 2013, Texas Instruments, Inc.

Definition in file float/offset.h.

## Function Documentation

static float_t OFFSET_getOffset | ( | OFFSET_Handle | handle | ) |
| inline static

Gets the offset value.

Parameters

  [in] | handle | The offset handle

Returns
  The offset value

Definition at line 103 of file float/offset.h.

References _OFFSET_::value.