diff libs/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/CAN/Networking/readme.txt @ 0:c59513fd84fb

Initial commit of STM32 test code.
author Daniel O'Connor <darius@dons.net.au>
date Mon, 03 Oct 2011 21:19:15 +1030
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libs/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/CAN/Networking/readme.txt	Mon Oct 03 21:19:15 2011 +1030
@@ -0,0 +1,152 @@
+/**
+  @page CAN_Networking CAN Networking example
+  
+  @verbatim
+  ******************** (C) COPYRIGHT 2011 STMicroelectronics *******************
+  * @file    CAN/Networking/readme.txt 
+  * @author  MCD Application Team
+  * @version V3.5.0
+  * @date    08-April-2011
+  * @brief   Description of the CAN Networking 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 example shows how to configure the CAN peripheral to send and receive 
+CAN frames in normal mode. The sent frames are used to control Leds by pressing  
+key push button.
+	
+The CAN serial communication link is a bus to which a number of units may be
+connected. This number has no theoretical limit. Practically the total number
+of units will be limited by delay times and/or electrical loads on the bus line.
+
+This program behaves as follows:
+  - After reset LED1 is ON
+  - By Pressing on KEY Button : LED2 turns ON and all other Leds are OFF, on the N
+    eval boards connected to the bus. 
+  - Press on KEY Button again to send CAN Frame to command LEDn+1 ON, all other Leds 
+    are OFF on the N eval boards.
+    
+@note This example is tested with a bus of 3 units. The same program example is 
+      loaded in all units to send and receive frames.
+@note Any unit in the CAN bus may play the role of sender (by pressing KEY button)
+      or receiver.
+	
+	The CAN is configured as follow:
+    - Bit Rate   = 1 Mbit/s  
+    - CAN Clock  = external clock (HSE)
+		- ID Filter  = All identifiers are allowed
+		- RTR = Data
+		- DLC = 1 byte
+		- Data: Led number that should be turned ON
+
+
+User can select CAN1 or CAN2 cell using the private defines in main.c :
+
+@code
+#define __CAN1_USED__
+/* #define __CAN2_USED__*/
+@endcode
+   
+@note When using CAN2, please check that you device is Connectivity line.
+
+
+@par Directory contents 
+
+  - CAN/Networking/platform_config.h    Hardware configuration header file
+  - CAN/Networking/stm32f10x_conf.h     Library Configuration file
+  - CAN/Networking/stm32f10x_it.c       Interrupt handlers
+  - CAN/Networking/stm32f10x_it.h       Interrupt handlers header file
+  - CAN/Networking/main.c               Main program
+  - CAN/Networking/system_stm32f10x.c   STM32F10x system source file
+  
+  
+@par Hardware and Software environment 
+
+  - This example runs on STM32F10x Connectivity line, High-Density, Medium-Density, 
+    XL-Density and Low-Density Devices.
+  
+  - This example has been tested with STMicroelectronics STM3210C-EVAL (Connectivity line),
+    STM3210E-EVAL (High-Density and XL-Density) and STM3210B-EVAL (Medium-Density)
+    evaluation boards and can be easily tailored to any other supported device and
+    development board.
+    To select the STMicroelectronics evaluation board used to run the example, 
+    uncomment the corresponding line in CAN/Networking/platform_config.h or stm32_eval.h file  
+
+  - STM3210C-EVAL Set-up 
+    - Use LED1, LED2, LED3 and LED4 connected respectively to PD.07, PD.13, PF.03
+      and PD.04 pins
+    - Use Key Push Button connected to PB9
+    - Connect a female/female CAN cable between at least 2 EVAL CAN connectors 
+      (on STM3210E-EVAL (CN2)/ STM3210C-EVAL (CN3 or CN4) boards)
+       - Connector 1 DB9_PIN2 to Connector 2 DB9_PIN2  (CAN_L)
+		   - Connector 1 DB9_PIN5 to Connector 2 DB9_PIN5  ( GND )
+		   - Connector 1 DB9_PIN7 to Connector 2 DB9_PIN7  (CAN_H) 
+		  @note JP6 or JP5 must be fitted.
+       
+  - STM3210E-EVAL Set-up 
+    - Use LED1, LD2, LED3 and LED4 leds connected respectively to PF.06, PF0.7, PF.08
+      and PF.09 pins
+    - Use Key Push Button connected to PG8
+    - Connect a female/female CAN cable between at least 2 EVAL CAN connectors 
+      (on STM3210B-EVAL (CN2)/ STM3210E-EVAL (CN4) boards)
+       - Connector 1 DB9_PIN2 to Connector 2 DB9_PIN2  (CAN_L)
+		   - Connector 1 DB9_PIN5 to Connector 2 DB9_PIN5  ( GND )
+		   - Connector 1 DB9_PIN7 to Connector 2 DB9_PIN7  (CAN_H) 
+		  @note JP6 must be fitted.
+		  
+  - STM3210B-EVAL Set-up  
+    - Use LED1, LED2, LED3 and LED4 leds connected respectively to PC.06, PC.07, PC.08
+      and PC.09 pins
+    - Use Key Push Button connected to PB9      
+    - Connect a female/female CAN cable between at least 2 EVAL CAN connectors 
+      (on STM3210B-EVAL (CN2)/ STM3210E-EVAL (CN4) boards) 
+      - Connector 1 DB9_PIN2 to Connector 2 DB9_PIN2  (CAN_L)
+		  - Connector 1 DB9_PIN5 to Connector 2 DB9_PIN5  ( GND )
+		  - Connector 1 DB9_PIN7 to Connector 2 DB9_PIN7  (CAN_H) 
+		  @note JP3 must be fitted.
+		  
+@note Any unit in the CAN bus may play the role of sender (by pressing on the 
+      key) or receiver.
+      
+@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 
+ - In the first time the all leds are OFF.
+ - By Pressing on Key Button : LED1 turn ON and all other Leds are OFF, on the N
+   eval-boards connected to the bus. 
+ - Press on Key Button again to send CAN Frame to command LEDn+1 ON, all other Leds 
+   are OFF on the N eval-boards.
+
+@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>&copy; COPYRIGHT 2011 STMicroelectronics</center></h3>
+ */