diff options
Diffstat (limited to 'tmp/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/I2C/IOExpander/readme.txt')
| -rw-r--r-- | tmp/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/I2C/IOExpander/readme.txt | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/tmp/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/I2C/IOExpander/readme.txt b/tmp/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/I2C/IOExpander/readme.txt new file mode 100644 index 0000000..9a187de --- /dev/null +++ b/tmp/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/I2C/IOExpander/readme.txt @@ -0,0 +1,134 @@ +/** + @page IOExpander_Example I2C and STMPE811 IO Expander communication example + + @verbatim + ******************** (C) COPYRIGHT 2011 STMicroelectronics ******************* + * @file I2C/IOExpander/readme.txt + * @author MCD Application Team + * @version V3.5.0 + * @date 08-April-2011 + * @brief Description of the I2C and STMPE811 IO Expander communication + * example. + ****************************************************************************** + * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS + * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE + * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY + * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING + * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE + * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS. + ****************************************************************************** + @endverbatim + +@par Example Description + +This firmware provides an example of configuring and using the IO Expander STMPE811 +in order to control input Joystick IOs, output IOs and the Touch Screen feature. +This example provides the elementary steps to control the following modules and +use them in an application: +The IO pins are used for: + - Getting Joystick pins status (Polling and interrupt) only for STM3210C-EVAL. + - The Touch Screen controller is used to get the Touched area detection information + in a single point mode (Polling and interrupt). + +The input information can be used either in Polling mode (uncomment the define +#define IOE_POLLING_MODE) or in Interrupt mode (uncomment the define #define +IOE_INTERRUPT_MODE). These defines are in main.h file. + +After configuring the IO Expander modules and Interrupts (if needed), the output +IOs are set to their default state. These operations are done by the functions: +IOE_Config() and IOE_ITConfig(). If the IO Expander is not operational (or the +I2C pins are not in the correct level) the IOE_Config() function returns a value +different from 0 and a message is displayed on the LCD screen. + +To get the status of an input: + - IOE_JoyStickGetState() function is used for Joystick and returns a JOY_State_TypeDef + value indicating the currently pressed key. This information is used to update + the LCD display (the Joystick pressed key name is displayed) (only for STM3210C-EVAL). + - IOE_TS_GetState() function is used for Touch Screen and returns a pointer to + a structure holding the Touch Screen status (did a Touch Detection happened, + X, Y, and Z positions). Only detection into the drawn rectangles areas is + considered and used to update the LEDs status and LCD display (corresponding + LED turned ON when its rectangle is touched, and the LED name is displayed on + the LCD screen). + +Besides, the examples checks the status of the other Push-Buttons implemented on +the board (Key, Tamper and WakeUp push-buttons). They are checked in parallel +with the IO Expander IOs and the LCD display and LEDs are updated according to +the push buttons state. + + +@par Directory contents + + - I2C/IOExpander/stm32f10x_conf.h Library Configuration file + - I2C/IOExpander/stm32f10x_it.c Interrupt handlers + - I2C/IOExpander/stm32f10x_it.h Header for stm32f10x_it.c + - I2C/IOExpander/main.c Main program + - I2C/IOExpander/main.h Header for main.c + - I2C/IOExpander/system_stm32f10x.c STM32F10x system source file + + +@par Hardware and Software environment + + - This example runs on STM32F10x Connectivity line, High-Density, High-Density + Value line, Medium-Density, XL-Density, High-Density Value line, Medium-Density + Value line, Low-Density and Low-Density Value line Devices. + + - This example has been tested with STMicroelectronics STM32100E-EVAL (High-Density + Value line) and STM3210C-EVAL (Connectivity line) evaluation boards + and can be easily tailored to any other supported device and development + board. + + - STM32100E-EVAL Set-up + - Use two IO Expanders connected to I2C2 SCL and SDA pins PB10 and PB11 and + interrupt output pin connected to PA12 (EXTI mode). IO Expander 1 address + pins is connected to Gnd (address is 0x82). + - Use LED1, LED2, LED3 and LED4 connected respectively to PF.06, PF.07, PF.08 + and PF.09 pins + - Use LCD connected to SPI3 remapped pins SCK, MISO and MOSI: PC10, PC11, + PC12 and the CS pin PB2. + - Use LCD Touch Screen module connected to IO Expander 1 pins IO_Pin_1, + IO_Pin_2, IO_Pin_3 and IO_Pin_4 (respectively Y-, X-, Y+, X+ lines). + + - STM3210C-EVAL Set-up + - Use two IO Expanders connected to I2C1 SCL and SDA pins PB6 and PB7 and + interrupt output pin connected to PB14 (EXTI mode). IO Expander 1 address + pins is connected to Gnd (address is 0x82) and IO Expander 2 address pins + is connected to Vcc (address is 0x88). + - Use LED1, LED2, LED3 and LED4 connected respectively to PD.07, PD.13, PF.03 + and PD.04 pins + - Use LCD connected to SPI3 remapped pins SCK, MISO and MOSI: PC10, PC11, + PC12 and the CS pin PB2. + - Use LCD Touch Screen module connected to IO Expander 1 pins IO_Pin_1, + IO_Pin_2, IO_Pin_3 and IO_Pin_4 (respectively Y-, X-, Y+, X+ lines). + - Use Joystick module connected to IO Expander 2 pins IO_Pin_3, IO_Pin_4, + IO_Pin_5, IO_Pin_6 and IO_Pin_7 (respectively UP, Right, Left, Down and Center) + + +@par How to use it ? + +In order to make the program work, you must do the following : + - Copy all source files from this example folder to the template folder under + Project\STM32F10x_StdPeriph_Template + - Open your preferred toolchain + - Rebuild all files and load your image into target memory + - Run the example + +@note + - Low-density Value line devices are STM32F100xx microcontrollers where the + Flash memory density ranges between 16 and 32 Kbytes. + - Low-density devices are STM32F101xx, STM32F102xx and STM32F103xx + microcontrollers where the Flash memory density ranges between 16 and 32 Kbytes. + - Medium-density Value line devices are STM32F100xx microcontrollers where + the Flash memory density ranges between 64 and 128 Kbytes. + - Medium-density devices are STM32F101xx, STM32F102xx and STM32F103xx + microcontrollers where the Flash memory density ranges between 64 and 128 Kbytes. + - High-density Value line devices are STM32F100xx microcontrollers where + the Flash memory density ranges between 256 and 512 Kbytes. + - High-density devices are STM32F101xx and STM32F103xx microcontrollers where + the Flash memory density ranges between 256 and 512 Kbytes. + - XL-density devices are STM32F101xx and STM32F103xx microcontrollers where + the Flash memory density ranges between 512 and 1024 Kbytes. + - Connectivity line devices are STM32F105xx and STM32F107xx microcontrollers. + + * <h3><center>© COPYRIGHT 2011 STMicroelectronics</center></h3> + */ |