Files
dvl 15ab232e82 Doxygen update
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@427 05563f52-14a8-4384-a975-3d1654cca0fa
2018-01-15 11:04:24 +00:00

133 lines
3.7 KiB
C

// -----------------------------------------------------------------------------
/// @file DeviceParameters.h
/// @brief File description
// -----------------------------------------------------------------------------
// Micro-Key bv
// Industrieweg 28, 9804 TG Noordhorn
// Postbus 92, 9800 AB Zuidhorn
// The Netherlands
// Tel: +31 594 503020
// Fax: +31 594 505825
// Email: support@microkey.nl
// Web: www.microkey.nl
// -----------------------------------------------------------------------------
/// $Revision$
/// $Author$
/// $Date$
// (c) 2015 Micro-Key bv
// -----------------------------------------------------------------------------
/**
* %DeviceParameters implementation
* \defgroup DeviceParameters Package DeviceParameters
* \ingroup hsb-mrts
* @{
*/
#ifndef DEVICEPARAMETERS_H_
#define DEVICEPARAMETERS_H_
// -----------------------------------------------------------------------------
// Include files
// -----------------------------------------------------------------------------
#include "stm32f10x.h"
#include "PIDParameters.h"
#include "PIN.h"
#include "MemoryDevice.h"
// -----------------------------------------------------------------------------
// Constant and macro definitions
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
// Type definitions.
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
// Function declarations
// -----------------------------------------------------------------------------
/** ----------------------------------------------------------------------------
* RepairPresets_construct
* Constructor for repair presets
*
* @return ErrorStatus
*
* @todo
* -----------------------------------------------------------------------------
*/
extern ErrorStatus DeviceParameters_construct(struct MemoryDevice* memoryDevice);
/** ----------------------------------------------------------------------------
* DeviceParameters_destruct
* Description of function
*
* @param para1_name
* @param para2_name
* @return void
*
* @todo
* -----------------------------------------------------------------------------
*/
extern void DeviceParameters_destruct(void);
/** ----------------------------------------------------------------------------
* DeviceParameters_getPIDParameters
* Description of function
*
* @param para1_name
* @param para2_name
* @return struct PIDParameters*
*
* @todo
* -----------------------------------------------------------------------------
*/
extern struct PIDParameters* DeviceParameters_getPIDParameters(void);
/** ----------------------------------------------------------------------------
* DeviceParameters_getPIN
* Description of function
*
* @param para1_name
* @param para2_name
* @return struct PIN*
*
* @todo
* -----------------------------------------------------------------------------
*/
extern struct PIN* DeviceParameters_getPIN(void);
/** ----------------------------------------------------------------------------
* DeviceParameters_saveParameters
* Description of function
*
* @return void
*
* @todo
* -----------------------------------------------------------------------------
*/
extern void DeviceParameters_saveParameters(void);
ErrorStatus DeviceParameters_writePIDParameters(struct PIDParameters* parameters);
ErrorStatus DeviceParameters_writePIN(struct PIN* pin);
#endif /* DEVICEPARAMETERS_H_ */
/** @} */