7f42b00161
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@423 05563f52-14a8-4384-a975-3d1654cca0fa
120 lines
3.4 KiB
C
120 lines
3.4 KiB
C
// -----------------------------------------------------------------------------
|
|
/// @file CoverSolenoid.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
|
|
// -----------------------------------------------------------------------------
|
|
|
|
#ifndef SOLENOID_H_
|
|
#define SOLENOID_H_
|
|
|
|
/**
|
|
* CoverSolenoid implementation
|
|
* \defgroup CoverSolenoid CoverSolenoid
|
|
* \ingroup HAL
|
|
* @{
|
|
*/
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// Include files
|
|
// -----------------------------------------------------------------------------
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include "stm32f10x.h"
|
|
|
|
#include "platform.h"
|
|
#include "gpio.h"
|
|
// -----------------------------------------------------------------------------
|
|
// Constant and macro definitions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// Type definitions.
|
|
// -----------------------------------------------------------------------------
|
|
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// Function declarations
|
|
// -----------------------------------------------------------------------------
|
|
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* CoverSolenoid_construct
|
|
* Constructor for the CoverSolenoid
|
|
*
|
|
* @param solenoidGpio The GPIO to use
|
|
|
|
* @return ErrorStatus
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern ErrorStatus CoverSolenoid_construct(struct Gpio* solenoidGpio);
|
|
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* CoverSolenoid_destruct
|
|
* Destructor for a CoverSolenoid
|
|
|
|
* @return void
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern void CoverSolenoid_destruct(void);
|
|
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* CoverSolenoid_unlock
|
|
* Opens the CoverSolenoid
|
|
*
|
|
* @return ErrorStatus
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern ErrorStatus CoverSolenoid_unlock(void);
|
|
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* CoverSolenoid_lock
|
|
* Closes the CoverSolenoid
|
|
*
|
|
* @return ErrorStatus
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern ErrorStatus CoverSolenoid_lock(void);
|
|
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* CoverSolenoid_getGpio
|
|
* returns the GPIO that is used as CoverSolenoid
|
|
*
|
|
* @return struct Gpio*
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern struct Gpio* CoverSolenoid_getGpio(void);
|
|
|
|
#endif /* SOLENOID_H_ */
|
|
|
|
/** @} */
|