EMTime/libopencm3-examples
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[DOC] Updated README's for F0 and F4 examples to describe the needed board connections.

Browse Source
This commit is contained in:
Frantisek Burian
2014-01-03 13:28:57 +01:00
parent a265fd4d64
commit 022cc475bf
15 changed files with 82 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
examples/stm32/f0/stm32f0-discovery/adc/README
View File

@@ -2,10 +2,11 @@
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32F0DISCOVERY eval board. It should read from the
ADC_IN1 (PA1) pin its voltage and print it to the serial port on pin PA9 with
parameters (38400,8,N,1)
It's intended for the ST STM32F0DISCOVERY eval board. Measures voltage on the
ADC_IN1 input, and prints it to the serial port.
Board connections:
------------------
PA1 (ADC_IN1) Analog input
PA9 (USART1) TTL serial output (38400,8,N,1)

4
examples/stm32/f0/stm32f0-discovery/button/README
View File

@@ -6,3 +6,7 @@ This example blinks the green LED on the ST STM32F0DISCOVERY eval board.
When you press the 'USER' button, the blinking is slower.
Board connections:
------------------
<none required>

10
examples/stm32/f0/stm32f0-discovery/miniblink/README
View File

@@ -2,8 +2,12 @@
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3.
This is the smallest-possible example program using libopencm3 and ST
STM32F0DISCOVERY eval board.
It's intended for the ST STM32F0-DISCOVERY eval board. It should blink
the blue LED on the board.
It should blink the blue LED on the board.
Board connections:
------------------
<none required>

7
examples/stm32/f0/stm32f0-discovery/systick_blink/README
View File

@@ -5,5 +5,10 @@ README
This example is the same as fancy_blink except that it uses the systick timer
to generate time accurate delays. The blue LED flashes four times per second.
On pin PA9, there is MCO output of internal reference clock. This can be used
There is internal reference clock available on MCO output pin. This can be used
to debug the PLL clock setup by scope.
Board connections:
------------------
PA9 (MCO) Internal reference clock

10
examples/stm32/f0/stm32f0-discovery/usart/README
View File

@@ -2,10 +2,12 @@
README
------------------------------------------------------------------------------
This example program sends some characters on USART0 on the
ST STM32F0DISCOVERY eval board.
This example program sends repeating sequence of characters "0123456789" on
USART1 serial line of ST STM32F0DISCOVERY eval board.
The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way.
The sending is done in a blocking way in the code.
Board connections:
------------------
PA9 (USART1_TX) TTL serial output (38400,8,N,1)

10
examples/stm32/f0/stm32f0-discovery/usart_stdio/README
View File

@@ -2,10 +2,12 @@
README
------------------------------------------------------------------------------
This example program sends some characters on USART1 on the
ST STM32F0DISCOVERY eval board. PA9
This example program sends a message "Pass: n" with increasing number n
from 0 to 200 on USART1 serial line of ST STM32F0DISCOVERY eval board.
The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done using newlib-nano library in a blocking way.
The sending is done using newlib-nano library in a blocking way in the code.
Board connections:
------------------
PA9 (USART1_TX) TTL serial output (38400,8,N,1)

6
examples/stm32/f4/stm32f4-discovery/button/README
View File

@@ -2,7 +2,11 @@
README
------------------------------------------------------------------------------
This example blinks the green LED on the ST STM32F4DISCOVERY eval board.
This example blinks the GREEN LED on the ST STM32F4DISCOVERY eval board.
When you press the 'USER' button, the blinking is slower.
Board connections:
------------------
<none required>

4
examples/stm32/f4/stm32f4-discovery/fancyblink/README
View File

@@ -7,3 +7,7 @@ This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32F4DISCOVERY eval board. It should blink
the LEDs on the board.
Board connections:
------------------
<none required>

4
examples/stm32/f4/stm32f4-discovery/mandelbrot/README
View File

@@ -8,5 +8,7 @@ the ST STM32F4DISCOVERY eval board.
A mandelbrot fractal is calculated and sent as "ascii-art" image through
the USART2.
The terminal settings for the receiving device/PC are 38400 8n1.
Board connections:
------------------
PA2 (USART2_TX) TTL serial output (38400,8,N,1)

6
examples/stm32/f4/stm32f4-discovery/miniblink/README
View File

@@ -5,5 +5,9 @@ README
This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32F4DISCOVERY eval board. It should blink
the blue LED on the board.
the GREEN LED on the board.
Board connections:
------------------
<none required>

9
examples/stm32/f4/stm32f4-discovery/random/README
View File

@@ -2,4 +2,11 @@
README
------------------------------------------------------------------------------
This example randomly blinks the green LED on the ST STM32F4DISCOVERY eval board.
This example randomly blinks the GREEN LED on the ST STM32F4DISCOVERY eval
board.
Board connections:
------------------
<none required>

8
examples/stm32/f4/stm32f4-discovery/tick_blink/README
View File

@@ -1,8 +1,14 @@
------------------------------------------------------------------------------
README
------
------------------------------------------------------------------------------
This example is the same as fancy_blink except that it uses the
systick timer to generate time accurate delays. Shows how to set
up the systick timer to create an interrupt every millisecond and
how to write a delay routine (msleep) that can then delay for a
specific number of milliseconds.
Board connections:
------------------
<none required>

10
examples/stm32/f4/stm32f4-discovery/usart/README
View File

@@ -2,10 +2,12 @@
README
------------------------------------------------------------------------------
This example program sends some characters on USART2 on the
ST STM32F4DISCOVERY eval board.
This example program sends repeating sequence of characters "0123456789" on
USART2 on the ST STM32F4DISCOVERY eval board.
The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way.
The sending is done in a blocking way in the code.
Board connections:
------------------
PA2 (USART2_TX) TTL serial output (38400,8,N,1)

10
examples/stm32/f4/stm32f4-discovery/usart_irq/README
View File

@@ -5,10 +5,10 @@ README
This example program echoes data sent in on USART2 on the
ST STM32F4DISCOVERY eval board. Uses interrupts for that purpose.
Connect your TTL RX device line to PA2 on the discovery board.
Connect your TTL TX device line to PA3 on the discovery board.
The sending is done in a nonblocking way.
The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code.
Board connections:
------------------
PA2 (USART2_TX) TTL serial output (38400,8,N,1)
PA3 (USART2_RX) TTL serial input (38400,8,N,1)

4
examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README
View File

@@ -5,3 +5,7 @@ README
This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack.
Board connections:
------------------
CN5 (USB_OTG_FS) USB acting as device, connect to computer