buttons.h

Go to the documentation of this file.

/*
Copyright (c) 2023 Eindhoven University of Technology
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#ifndef BUTTONS_H
#define BUTTONS_H
 
#include <gpio.h>
 
#define BUTTON_NOT_PUSHED 0
#define BUTTON_PUSHED 1
#define SWITCH_OFF 0
#define SWITCH_ON 1
 
typedef enum { BUTTON0, BUTTON1, BUTTON2, BUTTON3, NUM_BUTTONS } button_index_t;
 
typedef enum { SWITCH0, SWITCH1, NUM_SWITCHES } switches_index_t;
 
extern void switches_init(void);
 
extern void switches_destroy(void);
 
extern void buttons_init(void);
 
extern void buttons_destroy(void);
 
extern int get_button_state(const int button);
 
extern int wait_until_button_state(const int button, const int state);
 
extern int sleep_msec_button_pushed(const int button, const int msec);
 
extern void sleep_msec_buttons_pushed(int button_states[], const int ms);
 
extern int wait_until_button_pushed(const int button);
 
extern int wait_until_button_released(const int button);
 
extern int wait_until_any_button_pushed(void);
 
extern int wait_until_any_button_released(void);
 
extern int get_switch_state(const int switch_num);
 
#endif