IfxGpt12_IncrEnc.h File Reference

GPT12 INCRENC details. More...

#include "StdIf/IfxStdIf_Pos.h"
#include "SysSe/Math/Ifx_LowPassPt1.h"
#include "Gpt12/Std/IfxGpt12.h"
#include "string.h"

Go to the source code of this file.

Data Structures
struct	IfxGpt12_IncrEnc
	Incremental encoder object. More...
struct	IfxGpt12_IncrEnc_Config
	Configuration structure for GPT12. More...

Typedefs
typedef IfxStdIf_Pos_Update	IfxGpt12_IncrEnc_Update

Functions
IFX_EXTERN boolean	IfxGpt12_IncrEnc_init (IfxGpt12_IncrEnc *driver, const IfxGpt12_IncrEnc_Config *config)
	Initialises the Incremental interface. More...
IFX_EXTERN void	IfxGpt12_IncrEnc_initConfig (IfxGpt12_IncrEnc_Config *config, Ifx_GPT12 *gpt12)
	Initializes the configuration structure to default. More...
IFX_EXTERN float32	IfxGpt12_IncrEnc_getAbsolutePosition (IfxGpt12_IncrEnc *driver)
IFX_EXTERN IfxStdIf_Pos_Dir	IfxGpt12_IncrEnc_getDirection (IfxGpt12_IncrEnc *driver)
IFX_EXTERN IfxStdIf_Pos_Status	IfxGpt12_IncrEnc_getFault (IfxGpt12_IncrEnc *driver)
IFX_EXTERN sint32	IfxGpt12_IncrEnc_getOffset (IfxGpt12_IncrEnc *driver)
IFX_EXTERN uint16	IfxGpt12_IncrEnc_getPeriodPerRotation (IfxGpt12_IncrEnc *driver)
IFX_EXTERN float32	IfxGpt12_IncrEnc_getPosition (IfxGpt12_IncrEnc *driver)
IFX_EXTERN sint32	IfxGpt12_IncrEnc_getRawPosition (IfxGpt12_IncrEnc *driver)
IFX_EXTERN float32	IfxGpt12_IncrEnc_getRefreshPeriod (IfxGpt12_IncrEnc *driver)
IFX_EXTERN sint32	IfxGpt12_IncrEnc_getResolution (IfxGpt12_IncrEnc *driver)
IFX_EXTERN IfxStdIf_Pos_SensorType	IfxGpt12_IncrEnc_getSensorType (IfxGpt12_IncrEnc *driver)
IFX_EXTERN float32	IfxGpt12_IncrEnc_getSpeed (IfxGpt12_IncrEnc *driver)
IFX_EXTERN sint32	IfxGpt12_IncrEnc_getTurn (IfxGpt12_IncrEnc *driver)
IFX_EXTERN void	IfxGpt12_IncrEnc_onZeroIrq (IfxGpt12_IncrEnc *driver)
IFX_EXTERN void	IfxGpt12_IncrEnc_reset (IfxGpt12_IncrEnc *driver)
IFX_EXTERN void	IfxGpt12_IncrEnc_resetFaults (IfxGpt12_IncrEnc *driver)
IFX_EXTERN void	IfxGpt12_IncrEnc_setOffset (IfxGpt12_IncrEnc *driver, sint32 offset)
IFX_EXTERN void	IfxGpt12_IncrEnc_setRefreshPeriod (IfxGpt12_IncrEnc *driver, float32 updatePeriod)
IFX_EXTERN void	IfxGpt12_IncrEnc_update (IfxGpt12_IncrEnc *driver)
IFX_EXTERN boolean	IfxGpt12_IncrEnc_stdIfPosInit (IfxStdIf_Pos *stdif, IfxGpt12_IncrEnc *driver)
	Initializes the standard interface "Pos". More...

Detailed Description

GPT12 INCRENC details.

Version

iLLD_1_0_0_11_0

Copyright

Copyright (c) 2013 Infineon Technologies AG. All rights reserved.

                            IMPORTANT NOTICE

Infineon Technologies AG (Infineon) is supplying this file for use exclusively with Infineon's microcontroller products. This file can be freely distributed within development tools that are supporting such microcontroller products.

THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. INFINEON SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

Definition in file IfxGpt12_IncrEnc.h.

Typedef Documentation

typedef IfxStdIf_Pos_Update IfxGpt12_IncrEnc_Update

Definition at line 183 of file IfxGpt12_IncrEnc.h.

Function Documentation

IFX_EXTERN boolean IfxGpt12_IncrEnc_stdIfPosInit	(	IfxStdIf_Pos *	stdif,
		IfxGpt12_IncrEnc *	driver
	)

Initializes the standard interface "Pos".

Parameters

stdif	Standard interface position object
driver	incremental encoder interface Handle

Returns

TRUE on success else FALSE

Definition at line 352 of file IfxGpt12_IncrEnc.c.