key.h

Go to the documentation of this file.
00001 /*
00002  *  Copyright (c) 2008  Swedish Institute of Computer Science
00003  *  All rights reserved.
00004  *
00005  *  Redistribution and use in source and binary forms, with or without
00006  *  modification, are permitted provided that the following conditions are met:
00007  *
00008  *  * Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  *  * Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in
00012  *    the documentation and/or other materials provided with the
00013  *    distribution.
00014  *  * Neither the name of the copyright holders nor the names of
00015  *    contributors may be used to endorse or promote products derived
00016  *    from this software without specific prior written permission.
00017  *
00018  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00019  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00020  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00021  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00022  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00023  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00024  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00025  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00026  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00027  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00028  * POSSIBILITY OF SUCH DAMAGE.
00029  */
00030 /**
00031  * \file
00032  *
00033  * \brief
00034  *      This file provides joystick operations. Combined with ADC functions.
00035  *
00036  * \author
00037  *      Mike Vidales mavida404@gmail.com
00038  *
00039  */
00040 
00041 #ifndef __KEY_H__
00042 #define __KEY_H__
00043 
00044 #include <stdint.h>
00045 #include <avr/io.h>
00046 #include <avr/pgmspace.h>
00047 
00048 
00049 
00050 /** \name Port definition for reading the joystick input. */
00051 /** \{ */
00052 #define KEY_PORT      PINF
00053 #define KEY_PUR       PORTF
00054 #define KEY_DDR       DDRF
00055 #define KEY_PIN       PINF1
00056 /** \} */
00057 
00058 /** \name Port defininition for the joystick Enter button. */
00059 /** \{ */
00060 #define ENTER_PORT      PINE
00061 #define ENTER_PUR       PORTE
00062 #define ENTER_DDR       DDRE
00063 #define ENTER_PIN       PINE2
00064 /** \} */
00065 
00066 /** \name Valid Key States. */
00067 /** \{ */
00068 #define KEY_STATE_UP        0x01
00069 #define KEY_STATE_DOWN      0x02
00070 #define KEY_STATE_LEFT      0x04
00071 #define KEY_STATE_RIGHT     0x08
00072 #define KEY_STATE_ENTER     0x10
00073 #define KEY_STATE_NO_KEY    0x00
00074 #define KEY_STATE_DONE      0x20
00075 /** \} */
00076 
00077 typedef enum {
00078     KEY_UP      = 0x01,
00079     KEY_DOWN    = 0x02,
00080     KEY_LEFT    = 0x04,
00081     KEY_RIGHT   = 0x08,
00082     KEY_ENTER   = 0x10,
00083     KEY_NO_KEY  = 0x00
00084 }key_state_t;
00085 
00086 extern key_state_t button;
00087 
00088 /* Initialize the joystick */
00089 void key_init(void);
00090 void key_deinit(void);
00091 key_state_t key_task(void);
00092 key_state_t key_state_get(void);
00093 uint8_t is_button(void);
00094 uint8_t get_button(void);
00095 
00096 #endif /* __KEY_H__ */

Generated on Mon Apr 11 14:23:42 2011 for Contiki 2.5 by  doxygen 1.6.1