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

[README] Coarse sweep to use markup in READMEs.

Browse Source 
This should improve online readability of the readme files.
This commit is contained in:
Piotr Esden-Tempski
2015-01-19 19:20:12 -08:00
parent ab7efee88e
commit 1c4ae95729
121 changed files with 411 additions and 609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
examples/lpc/lpc13xx/lpc-p1343/miniblink/README.md
View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the NXP LPC1343-based Olimex LPC-1343 eval board (see It's intended for the NXP LPC1343-based
http://olimex.com/dev/lpc-p1343.html for details). It should blink [Olimex LPC-1343 eval board](http://olimex.com/dev/lpc-p1343.html for details).
a LED on the board. It should blink a LED on the board.

10
examples/lpc/lpc17xx/blueboard-lpc1768-h/miniblink/README.md
View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the NXP LPC1768-based NGX Blueboard-LPC1768-H eval board (see It's intended for the NXP LPC1768-based
http://shop.ngxtechnologies.com/product_info.php?cPath=21&products_id=65). It should blink [NGX Blueboard-LPC1768-H eval board](http://shop.ngxtechnologies.com/product_info.php?cPath=21&products_id=65).
a LED on the board. It should blink a LED on the board.

5
examples/lpc/lpc43xx/diolan-lpc-4350-db1/README.md
View File

@@ -1,3 +1,4 @@
These example programs are written for the Diolan LPC-4350-DB1: # README
http://www.diolan.com/lpc4350-features.html These example programs are written for the
[Diolan LPC-4350-DB1](http://www.diolan.com/lpc4350-features.html)

8
examples/lpc/lpc43xx/diolan-lpc-4350-db1/miniblink/README.md
View File

@@ -1,11 +1,7 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the Diolan LPC-4350-DB1: It's intended for the [Diolan LPC-4350-DB1](http://www.diolan.com/lpc4350-features.html).
http://www.diolan.com/lpc4350-features.html
It should blink D2 on the board. It should blink D2 on the board.

6
examples/lpc/lpc43xx/hackrf-jellybean/README.md
View File

@@ -1,4 +1,4 @@
These example programs are written for the Jellybean development board from the # README
HackRF project:
https://github.com/mossmann/hackrf These example programs are written for the Jellybean development board from the
[HackRF project](https://github.com/mossmann/hackrf)

14
examples/lpc/lpc43xx/hackrf-jellybean/i2c/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This program exercises the I2C peripheral on Jellybean's LPC43xx. You can This program exercises the I2C peripheral on Jellybean's LPC43xx. You can
scope SCL on P6 pin 3 and SDA on P6 pin 5. If Lemondrop is connected, LED1 scope SCL on P6 pin 3 and SDA on P6 pin 5. If Lemondrop is connected, LED1
@@ -8,8 +6,8 @@ will illuminate if I2C communication to the Si5351C on Lemondrop is successful.
Required Lemondrop -> Jellybean connections: Required Lemondrop -> Jellybean connections:
SCL: Lemondrop P7 pin 3 -> Jellybean P6 pin 3 SCL: Lemondrop P7 pin 3 -> Jellybean P6 pin 3
SDA: Lemondrop P7 pin 5 -> Jellybean P6 pin 5 SDA: Lemondrop P7 pin 5 -> Jellybean P6 pin 5
VCC: Lemondrop P4 pin 2, 4, or 6 -> Jellybean P17 pin 2, 4, or 6 VCC: Lemondrop P4 pin 2, 4, or 6 -> Jellybean P17 pin 2, 4, or 6
1V8: Lemondrop P11 pin 2, 4, or 6 -> Jellybean P16 pin 2, 4, or 6 1V8: Lemondrop P11 pin 2, 4, or 6 -> Jellybean P16 pin 2, 4, or 6
GND: Lemondrop P5 -> Jellybean P13 GND: Lemondrop P5 -> Jellybean P13

9
examples/lpc/lpc43xx/hackrf-jellybean/miniblink/README.md
View File

@@ -1,11 +1,8 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the Jellybean development board from the HackRF project: It's intended for the Jellybean development board from the
[HackRF project](https://github.com/mossmann/hackrf)
https://github.com/mossmann/hackrf
It should blink LED1 on the board. It should blink LED1 on the board.

9
examples/lpc/lpc43xx/hackrf-jellybean/miniblink_rom_to_ram/README.md
View File

@@ -1,12 +1,9 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the Jellybean development board from the HackRF project: It's intended for the Jellybean development board from the
[HackRF project](https://github.com/mossmann/hackrf)
https://github.com/mossmann/hackrf
It should blink LED1 on the board. It should blink LED1 on the board.
This example copy the Code from ROM to RAM and execute code from RAM. This example copy the Code from ROM to RAM and execute code from RAM.

56
examples/lpc/lpc43xx/hackrf-jellybean/ssp/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This program exercises the SSP1 peripheral on Jellybean's LPC43xx. This program exercises the SSP1 peripheral on Jellybean's LPC43xx.
@@ -13,36 +11,36 @@ This program exercises the SSP1 peripheral on Jellybean's LPC43xx.
||------|----------| ||------|----------|
|-------| |-------|
SSP1_MISO: Jellybean P9 SPI Pin6 SSP1_MISO: Jellybean P9 SPI Pin6
SSP1_MOSI: Jellybean P9 SPI Pin4 SSP1_MOSI: Jellybean P9 SPI Pin4
SSP1_SCK: Jellybean P9 SPI Pin2 SSP1_SCK: Jellybean P9 SPI Pin2
SSP1_SSEL: Jellybean P9 SPI Pin3 SSP1_SSEL: Jellybean P9 SPI Pin3
GND: Can be connected to P12 SD Pin1 GND: Can be connected to P12 SD Pin1
PCLK clock source is PLL1 288MHz (from IRC 96MHz boot from SPIFI) PCLK clock source is PLL1 288MHz (from IRC 96MHz boot from SPIFI)
Freq = PCLK / (CPSDVSR * [SCR+1]). Freq = PCLK / (CPSDVSR * [SCR+1]).
By default (CPSDVSR=0 => Means MAX Divisor) By default (CPSDVSR=0 => Means MAX Divisor)
SSP1->CR0->SCR = 0x00 => CLK Freq 1.126MHz SSP1->CR0->SCR = 0x00 => CLK Freq 1.126MHz
SSP1->CR0->SCR = 0x01 => MOSI Freq 566.9KHz SSP1->CR0->SCR = 0x01 => MOSI Freq 566.9KHz
... ...
Test Oscilloscpe: _Test Oscilloscpe_:
SCR=0, CPSDVSR=32 => CLK 9.025MHz SCR=0, CPSDVSR=32 => CLK 9.025MHz
SCR=1, CPSDVSR=2 => CLK 73MHz SCR=1, CPSDVSR=2 => CLK 73MHz
SCR=2, CPSDVSR=2 => CLK 49MHz SCR=2, CPSDVSR=2 => CLK 49MHz
SCR=4, CPSDVSR=2 => CLK 29MHz SCR=4, CPSDVSR=2 => CLK 29MHz
SCR=8, CPSDVSR=2 => CLK 16MHz SCR=8, CPSDVSR=2 => CLK 16MHz
SCR=16, CPSDVSR=2 => CLK 8.5MHz SCR=16, CPSDVSR=2 => CLK 8.5MHz
SCR=32, CPSDVSR=2 => CLK 4.386MHz SCR=32, CPSDVSR=2 => CLK 4.386MHz
SCR=64, CPSDVSR=2 => CLK 2.227MHz SCR=64, CPSDVSR=2 => CLK 2.227MHz
SCR=1, CPSDVSR=64 => CLK 2.262MHz SCR=1, CPSDVSR=64 => CLK 2.262MHz
Theory: _Theory_:
SCR=0, CPSDVSR=32 => 288MHz / (32*(0+1) = 9MHz SCR=0, CPSDVSR=32 => 288MHz / (32*(0+1) = 9MHz
SCR=1, CPSDVSR=2 => 288MHz / (2*(1+1) = 72MHz SCR=1, CPSDVSR=2 => 288MHz / (2*(1+1) = 72MHz
SCR=4, CPSDVSR=2 => 288MHz / (2*(4+1) = 28.8MHz SCR=4, CPSDVSR=2 => 288MHz / (2*(4+1) = 28.8MHz
SCR=32, CPSDVSR=2 => 288MHz / (2*(32+1) = 4.364MHz SCR=32, CPSDVSR=2 => 288MHz / (2*(32+1) = 4.364MHz
SCR=64, CPSDVSR=2 => 288MHz / (2*(64+1)) = 2.2154MHz SCR=64, CPSDVSR=2 => 288MHz / (2*(64+1)) = 2.2154MHz
SCR=128, CPSDVSR=2 => 288MHz / (2*(128+1)) = 1.116MHz SCR=128, CPSDVSR=2 => 288MHz / (2*(128+1)) = 1.116MHz
SCR=1, CPSDVSR=64 => 288MHz / (64*(1+1)) = 2.25MHz SCR=1, CPSDVSR=64 => 288MHz / (64*(1+1)) = 2.25MHz

4
examples/lpc/lpc43xx/hackrf-jellybean/systick/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This program exercises the SysTick Interrupt of ARM CortexM4 on Jellybean's LPC43xx. This program exercises the SysTick Interrupt of ARM CortexM4 on Jellybean's LPC43xx.
It also enable Cycle Counter to be used for accurate delay independant from Clock Frequency. It also enable Cycle Counter to be used for accurate delay independant from Clock Frequency.

15
examples/stm32/f0/stm32f0-discovery/adc/README.md
View File

@@ -1,12 +1,11 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
It's intended for the ST STM32F0DISCOVERY eval board. Measures voltage on the It's intended for the ST STM32F0DISCOVERY eval board. Measures voltage on the
ADC_IN1 input, and prints it to the serial port. ADC\_IN1 input, and prints it to the serial port.
Board connections: ## Board connections
------------------
PA1 (ADC_IN1) Analog input | Port | Function | Description |
PA9 (USART1) TTL serial output (38400,8,N,1) | ----- | ----------- | --------------------------------- |
| `PA1` | `(ADC_IN1)` | Analog input |
| `PA9` | `(USART1)` | TTL serial output `(38400,8,N,1)` |

9
examples/stm32/f0/stm32f0-discovery/button/README.md
View File

@@ -1,12 +1,9 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example blinks the green LED on the ST STM32F0DISCOVERY eval board. This example blinks the green LED on the ST STM32F0DISCOVERY eval board.
When you press the 'USER' button, the blinking is slower. When you press the 'USER' button, the blinking is slower.
Board connections: ## Board connections:
------------------
<none required> *none required*

9
examples/stm32/f0/stm32f0-discovery/miniblink/README.md
View File

@@ -1,13 +1,10 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3 and ST This is the smallest-possible example program using libopencm3 and ST
STM32F0DISCOVERY eval board. STM32F0DISCOVERY eval board.
It should blink the blue LED on the board. It should blink the blue LED on the board.
Board connections: ## Board connections
------------------
<none required> *none required*

13
examples/stm32/f0/stm32f0-discovery/systick_blink/README.md
View File

@@ -1,14 +1,13 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example is the same as fancy_blink except that it uses the systick timer 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. to generate time accurate delays. The blue LED flashes four times per second.
There is internal reference clock available on MCO output pin. 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. to debug the PLL clock setup by scope.
Board connections: ## Board connections
------------------
PA9 (MCO) Internal reference clock | Port | Function | Description |
| ----- | -------- | ------------------------ |
| `PA9` | `(MCO)` | Internal reference clock |

11
examples/stm32/f0/stm32f0-discovery/usart/README.md
View File

@@ -1,13 +1,12 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends repeating sequence of characters "0123456789" on This example program sends repeating sequence of characters "0123456789" on
USART1 serial line of ST STM32F0DISCOVERY eval board. USART1 serial line of ST STM32F0DISCOVERY eval board.
The sending is done in a blocking way. The sending is done in a blocking way.
Board connections: ## Board connections
------------------
PA9 (USART1_TX) TTL serial output (38400,8,N,1) | Port | Function | Description |
| ----- | ------------- | --------------------------------- |
| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` |

11
examples/stm32/f0/stm32f0-discovery/usart_stdio/README.md
View File

@@ -1,13 +1,12 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends a message "Pass: n" with increasing number n 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. from 0 to 200 on USART1 serial line of ST STM32F0DISCOVERY eval board.
The sending is done using newlib library in a blocking way. The sending is done using newlib library in a blocking way.
Board connections: ## Board connections
------------------
PA9 (USART1_TX) TTL serial output (38400,8,N,1) | Port | Function | Description |
| ----- | ------------- | --------------------------------- |
| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` |

2
examples/stm32/f1/lisa-m-1/can/README.md
View File

@@ -1,3 +1,5 @@
# README
This test sets up the CAN interface on Lisa/M and transmits 8 bites every This test sets up the CAN interface on Lisa/M and transmits 8 bites every
100ms. The first byte is being incremented in each cycle. The demo also 100ms. The first byte is being incremented in each cycle. The demo also
receives messages and is displaing the first 4 bits of the first byte on the receives messages and is displaing the first 4 bits of the first byte on the

4
examples/stm32/f1/lisa-m-1/usb_cdcacm/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB CDC-ACM device (aka Virtual Serial Port) This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f1/lisa-m-1/usb_dfu/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB Device Firmware Upgrade (DFU) bootloader This example implements a USB Device Firmware Upgrade (DFU) bootloader
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f1/lisa-m-1/usb_hid/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB Human Interface Device (HID) This example implements a USB Human Interface Device (HID)
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f1/lisa-m-2/adc_injec/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a simple polling example that sends the value read out from the This is a simple polling example that sends the value read out from the
temperature sensor ADC channel of the STM32 to the USART2. temperature sensor ADC channel of the STM32 to the USART2.

4
examples/stm32/f1/lisa-m-2/adc_injec_timtrig/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a simple example that sends the value read out from the This is a simple example that sends the value read out from the
temperature sensor ADC channel of the STM32 to the USART2. temperature sensor ADC channel of the STM32 to the USART2.

4
examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a simple example that sends the value read out from the This is a simple example that sends the value read out from the
temperature sensor ADC channel of the STM32 to the USART2. temperature sensor ADC channel of the STM32 to the USART2.

4
examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq_4ch/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a simple example that sends the values read out from four ADC This is a simple example that sends the values read out from four ADC
channels of the STM32 to the USART2. channels of the STM32 to the USART2.

4
examples/stm32/f1/lisa-m-2/adc_regular/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a simple polling example that sends the value read out from the This is a simple polling example that sends the value read out from the
temperature sensor ADC channel of the STM32 to the USART2. temperature sensor ADC channel of the STM32 to the USART2.

2
examples/stm32/f1/lisa-m-2/can/README.md
View File

@@ -1,3 +1,5 @@
# README
This test sets up the CAN interface on Lisa/M and transmits 8 bites every This test sets up the CAN interface on Lisa/M and transmits 8 bites every
100ms. The first byte is being incremented in each cycle. The demo also 100ms. The first byte is being incremented in each cycle. The demo also
receives messages and is displaing the first 4 bits of the first byte on the receives messages and is displaing the first 4 bits of the first byte on the

8
examples/stm32/f1/lisa-m-2/spi/README.md
View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program demonstrates simple SPI transceive on Lisa/M 2.0 board This example program demonstrates simple SPI transceive on
(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). [Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
The terminal settings for the receiving device/PC are 9600 8n1. The terminal settings for the receiving device/PC are 9600 8n1.

8
examples/stm32/f1/lisa-m-2/spi_dma/README.md
View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program demonstrates SPI transceive with DMA on Lisa/M 2.0 board This example program demonstrates SPI transceive with DMA on
(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). [Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
The terminal settings for the receiving device/PC are 9600 8n1. The terminal settings for the receiving device/PC are 9600 8n1.

8
examples/stm32/f1/lisa-m-2/spi_dma_adv/README.md
View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program demonstrates SPI transceive with DMA on Lisa/M 2.0 board This example program demonstrates SPI transceive with DMA on
(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). [Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
The terminal settings for the receiving device/PC are 9600 8n1. The terminal settings for the receiving device/PC are 9600 8n1.

10
examples/stm32/f1/lisa-m-2/usart/README.md
View File

@@ -1,12 +1,10 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends some characters on USART2 on Lisa/M 2.0 board This example program sends some characters on USART2 on
(see http://paparazzi.enac.fr/wiki/LisaM for details). [Lisa/M 2.0 board](see http://paparazzi.enac.fr/wiki/LisaM for details).
The terminal settings for the receiving device/PC are 38400 8n1. The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code, see the usart_irq example The sending is done in a blocking way in the code, see the usart\_irq example
for a more elaborate USART example. for a more elaborate USART example.

8
examples/stm32/f1/mb525/fancyblink/README.md
View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a blink example program using libopencm3. This is a blink example program using libopencm3.
It's intended for the ST STM32-based MB525 eval board (see It's intended for the ST STM32-based
http://www.st.com/stonline/products/literature/um/13472.htm for details). [MB525 eval board](http://www.st.com/stonline/products/literature/um/13472.htm for details).
It should blink the LEDs on the board. It should blink the LEDs on the board.

8
examples/stm32/f1/mb525/pwmleds/README.md
View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a PWM based LED fading example using libopencm3. This is a PWM based LED fading example using libopencm3.
It's intended for the ST STM32-based MB525 eval board (see It's intended for the ST STM32-based
http://www.st.com/stonline/products/literature/um/13472.htm for details). [MB525 eval board](http://www.st.com/stonline/products/literature/um/13472.htm for details).

2
examples/stm32/f1/obldc-strip/can/README.md
View File

@@ -1,3 +1,5 @@
# README
This test sets up the CAN interface on Lisa/M and transmits 8 bites every This test sets up the CAN interface on Lisa/M and transmits 8 bites every
100ms. The first byte is being incremented in each cycle. The demo also 100ms. The first byte is being incremented in each cycle. The demo also
receives messages and is displaing the first 4 bits of the first byte on the receives messages and is displaing the first 4 bits of the first byte on the

4
examples/stm32/f1/other/adc_temperature_sensor/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends some characters on USART1. This example program sends some characters on USART1.
Afterwards it read out the internal temperature sensor of the STM32 and Afterwards it read out the internal temperature sensor of the STM32 and

4
examples/stm32/f1/other/dma_mem2mem/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This program demonstrates a little DMA MEM2MEM transfer. A string is sent out This program demonstrates a little DMA MEM2MEM transfer. A string is sent out
to USART1 and afterwards copied by DMA to another memory location. To check to USART1 and afterwards copied by DMA to another memory location. To check

4
examples/stm32/f1/other/dogm128/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program writes some text on an DOGM128 LCD display connected This example program writes some text on an DOGM128 LCD display connected
to SPI2. to SPI2.

4
examples/stm32/f1/other/i2c_stts75_sensor/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends some characters on USART1. This example program sends some characters on USART1.
Afterwards it connects to an STTS75 sensor (ST LM75 compatible) Afterwards it connects to an STTS75 sensor (ST LM75 compatible)

4
examples/stm32/f1/other/rtc/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a small RTC example project. This is a small RTC example project.

4
examples/stm32/f1/other/systick/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program blinks a LED on PortB Pin 6. 1 second on / 1 second off. This example program blinks a LED on PortB Pin 6. 1 second on / 1 second off.
Blinking is done via the systick timer interrupt. Blinking is done via the systick timer interrupt.

4
examples/stm32/f1/other/timer_interrupt/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program blinks a LED on PortB Pin 6. 1 second on / 1 second off. This example program blinks a LED on PortB Pin 6. 1 second on / 1 second off.
Blinking is made only with the timer interrupt of the TIM2 timer. Blinking is made only with the timer interrupt of the TIM2 timer.

4
examples/stm32/f1/other/usb_cdcacm/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB CDC-ACM device (aka Virtual Serial Port) This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f1/other/usb_dfu/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB Device Firmware Upgrade (DFU) bootloader This example implements a USB Device Firmware Upgrade (DFU) bootloader
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f1/other/usb_hid/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB Human Interface Device (HID) This example implements a USB Human Interface Device (HID)
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

10
examples/stm32/f1/stm32-h103/fancyblink/README.md
View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is small LED blinking example program using libopencm3. This is small LED blinking example program using libopencm3.
It's intended for the ST STM32-based Olimex STM32-H103 eval board (see It's intended for the ST STM32-based
http://olimex.com/dev/stm32-h103.html for details). It should blink [Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
the LED on the board. It should blink the LED on the board.

10
examples/stm32/f1/stm32-h103/miniblink/README.md
View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32-based Olimex STM32-H103 eval board (see It's intended for the ST STM32-based
http://olimex.com/dev/stm32-h103.html for details). It should blink [Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
the LED on the board. It should blink the LED on the board.

7
examples/stm32/f1/stm32-h103/spi/README.md
View File

@@ -1,8 +1,5 @@
------------------------------------------------------------------------------- # README
README
-------------------------------------------------------------------------------
This example program repeatedly sends characters on SPI1 on the ST STM32-based This example program repeatedly sends characters on SPI1 on the ST STM32-based
Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html [Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
for details).

4
examples/stm32/f1/stm32-h103/traceswo/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This experimental program sends some characters on the TRACESWO pin using This experimental program sends some characters on the TRACESWO pin using
the Instrumentation Trace Macrocell (ITM) and Trace Port Interface Unit (TPIU). the Instrumentation Trace Macrocell (ITM) and Trace Port Interface Unit (TPIU).

9
examples/stm32/f1/stm32-h103/usart/README.md
View File

@@ -1,13 +1,10 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends some characters on USART3 on the ST STM32-based This example program sends some characters on USART3 on the ST STM32-based
Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html [Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
for details).
The terminal settings for the receiving device/PC are 38400 8n1. The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code, see the usart_irq example The sending is done in a blocking way in the code, see the usart\_irq example
for a more elaborate USART example. for a more elaborate USART example.

4
examples/stm32/f1/stm32-h103/usb_cdcacm/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB CDC-ACM device (aka Virtual Serial Port) This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f1/stm32-h103/usb_dfu/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB Device Firmware Upgrade (DFU) bootloader This example implements a USB Device Firmware Upgrade (DFU) bootloader
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f1/stm32-h103/usb_hid/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB Human Interface Device (HID) This example implements a USB Human Interface Device (HID)
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f1/stm32-h103/usb_iap/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB bootloader for the Paparazzi project. This example implements a USB bootloader for the Paparazzi project.

10
examples/stm32/f1/stm32-h107/fancyblink/README.md
View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is small LED blinking example program using libopencm3. This is small LED blinking example program using libopencm3.
It's intended for the ST STM32-based Olimex STM32-H107 eval board (see It's intended for the ST STM32-based
http://olimex.com/dev/stm32-h107.html for details). It should blink [Olimex STM32-H107 eval board](http://olimex.com/dev/stm32-h107.html).
the LED on the board. It should blink the LED on the board.

13
examples/stm32/f1/stm32-h107/flash_rw_example/README.md
View File

@@ -1,8 +1,9 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This small example program operates on internal FLASH memory by using libopencm3. This small example program operates on internal FLASH memory by using
libopencm3.
It's intended for all devboards with STM32f107 microcontrollers. To use this example it is essential to use USART1 port. It's intended for all devboards with STM32f107 microcontrollers. To use this
It writes text string entered via serial port terminal (ex. teraterm) into internal FLASH memory and then it reads it. example it is essential to use USART1 port. It writes text string entered via
serial port terminal (ex. teraterm) into internal FLASH memory and then it
reads it.

10
examples/stm32/f1/stm32-h107/usb_simple/README.md
View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is small USB controlled LED blinking example program using libopencm3. This is small USB controlled LED blinking example program using libopencm3.
It's intended for the ST STM32-based Olimex STM32-H107 eval board (see It's intended for the ST STM32-based
http://olimex.com/dev/stm32-h107.html for details). The usbtest.py [Olimex STM32-H107 eval board](http://olimex.com/dev/stm32-h107.html).
script in this directory maybe used to control the LED. The usbtest.py script in this directory maybe used to control the LED.

10
examples/stm32/f1/stm32-maple/miniblink/README.md
View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32-based Leaf Labs Maple board (see It's intended for the ST STM32-based
http://leaflabs.com for details). It should blink the LED on the board. [Leaf Labs Maple board](http://leaflabs.com).
It should blink the LED on the board.

9
examples/stm32/f1/stm32-maple/usart/README.md
View File

@@ -1,13 +1,10 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends some characters on USART3 on the ST STM32-based This example program sends some characters on USART3 on the ST STM32-based
Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html [Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
for details).
The terminal settings for the receiving device/PC are 38400 8n1. The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code, see the usart_irq example The sending is done in a blocking way in the code, see the usart\_irq example
for a more elaborate USART example. for a more elaborate USART example.

8
examples/stm32/f1/stm32-maple/usb_cdcacm/README.md
View File

@@ -1,7 +1,5 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB CDC-ACM device (aka Virtual Serial Port) This example implements a USB CDC-ACM device (aka Virtual Serial Port) to
to demonstrate the use of the USB device stack. demonstrate the use of the USB device stack.

25
examples/stm32/f1/stm32vl-discovery/adc-dac-printf/README.md
View File

@@ -1,17 +1,20 @@
Console on PA2 (tx only) 115200@8n1 # README
* Prints the ADC value on PA0 (adc channel 0) on the console Console on `PA2` (tx only) 115200@8n1
* Prints the ADC value on `PA0` (adc channel 0) on the console
* Echos half that ADC value out to DAC channel 2 on PA5 * Echos half that ADC value out to DAC channel 2 on PA5
* Prints the ADC value of PA1 (adc channel 1) to the console. * Prints the ADC value of `PA1` (adc channel 1) to the console.
Recommended wiring: Recommended wiring:
* pot or any resistor ladder to PA0 * pot or any resistor ladder to `PA0`
* jumper from PA5 to PA1 * jumper from `PA5` to `PA1`
example output: example output:
...
tick: 228: adc0= 3950, target adc1=1975, adc1=1979 ...
tick: 229: adc0= 3949, target adc1=1974, adc1=1978 tick: 228: adc0= 3950, target adc1=1975, adc1=1979
tick: 230: adc0= 3950, target adc1=1975, adc1=1979 tick: 229: adc0= 3949, target adc1=1974, adc1=1978
tick: 231: adc0= 3949, target adc1=1974, adc1=1978 tick: 230: adc0= 3950, target adc1=1975, adc1=1979
... tick: 231: adc0= 3949, target adc1=1974, adc1=1978
...

4
examples/stm32/f1/stm32vl-discovery/button/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example blinks the green LED on the ST STM32VLDISCOVERY eval board. This example blinks the green LED on the ST STM32VLDISCOVERY eval board.

4
examples/stm32/f1/stm32vl-discovery/fancyblink/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.

4
examples/stm32/f1/stm32vl-discovery/miniblink/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.

4
examples/stm32/f1/stm32vl-discovery/rtc/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is a small RTC example project. This is a small RTC example project.

4
examples/stm32/f1/stm32vl-discovery/spi/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program demonstrates simple SPI transceive on stm32vl discovery board. This example program demonstrates simple SPI transceive on stm32vl discovery board.

6
examples/stm32/f1/stm32vl-discovery/usart/README.md
View File

@@ -1,12 +1,10 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends some characters on USART1 on the This example program sends some characters on USART1 on the
ST STM32VLDISCOVERY eval board. ST STM32VLDISCOVERY eval board.
The terminal settings for the receiving device/PC are 38400 8n1. The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code, see the usart_irq example The sending is done in a blocking way in the code, see the usart\_irq example
for a more elaborate USART example. for a more elaborate USART example.

4
examples/stm32/f1/waveshare-open103r/button/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example blinks LED1 on the WaveShare Open103R eval board. This example blinks LED1 on the WaveShare Open103R eval board.

4
examples/stm32/f1/waveshare-open103r/fancyblink/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This program will interleave the blinking of two sets of LEDs. LED1 This program will interleave the blinking of two sets of LEDs. LED1
and LED3 will blink at the same time and LED2 and LED4 will blink at and LED3 will blink at the same time and LED2 and LED4 will blink at

4
examples/stm32/f1/waveshare-open103r/joystick/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example uses the joystick to control the four LEDs on the This example uses the joystick to control the four LEDs on the
WaveShare Open103R eval board. Joystick directions referenced here are WaveShare Open103R eval board. Joystick directions referenced here are

4
examples/stm32/f1/waveshare-open103r/miniblink/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.

4
examples/stm32/f1/waveshare-open103r/usbserial/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example uses the USB port as a serial port and implements a This example uses the USB port as a serial port and implements a
loopback interface that immediately echos back whatever it receives. After flashing the evaluation board with the usbserial program and connecting it to a host computer with a USB cable, you can run the echo.py command as follows: loopback interface that immediately echos back whatever it receives. After flashing the evaluation board with the usbserial program and connecting it to a host computer with a USB cable, you can run the echo.py command as follows:

4
examples/stm32/f2/jobygps/miniblink/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.

7
examples/stm32/f3/stm32f3-discovery/adc/README.md
View File

@@ -1,9 +1,8 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32F3DISCOVERY eval board. It should read from the ADC1_IN1 (PA0) pin its voltage and print it in the LEDs. It's intended for the ST STM32F3DISCOVERY eval board. It should read from the
`ADC1_IN1 (PA0)` pin its voltage and print it in the LEDs.

4
examples/stm32/f3/stm32f3-discovery/button/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example blinks the green LED on the ST STM32F3DISCOVERY eval board. This example blinks the green LED on the ST STM32F3DISCOVERY eval board.

4
examples/stm32/f3/stm32f3-discovery/fancyblink/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.

4
examples/stm32/f3/stm32f3-discovery/i2c/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
I2C example reading from the stm32f3discovery accelerometer. I2C example reading from the stm32f3discovery accelerometer.

4
examples/stm32/f3/stm32f3-discovery/miniblink/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.

4
examples/stm32/f3/stm32f3-discovery/spi/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
SPI example reading from the stm32f3discovery gyroscope. SPI example reading from the stm32f3discovery gyroscope.

4
examples/stm32/f3/stm32f3-discovery/usb_cdcacm/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB CDC-ACM device (aka Virtual Serial Port) This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

4
examples/stm32/f4/other/crypto-basic/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program is for demonstrating of use Crypto Controller on STM32F417 This example program is for demonstrating of use Crypto Controller on STM32F417
board. board.

2
examples/stm32/f4/stm32f4-discovery/README.md
View File

@@ -1,3 +1,5 @@
# README
This directory contains examples for the _original_ stm32f4 discovery. This directory contains examples for the _original_ stm32f4 discovery.
The PCB should be labelled either MB997A or MB997B, and contains a user USB The PCB should be labelled either MB997A or MB997B, and contains a user USB
port, and an audio dac on board, along with a MEMs microphone and an port, and an audio dac on board, along with a MEMs microphone and an

14
examples/stm32/f4/stm32f4-discovery/adc-dac-printf/README.md
View File

@@ -1,3 +1,5 @@
# README
Console on PA2 (tx only) 115200@8n1 Console on PA2 (tx only) 115200@8n1
* Prints the ADC value on PA0 (adc channel 0) on the console * Prints the ADC value on PA0 (adc channel 0) on the console
@@ -9,9 +11,9 @@ Recommended wiring:
* jumper from PA5 to PA1 * jumper from PA5 to PA1
example output: example output:
... ...
tick: 228: adc0= 3950, target adc1=1975, adc1=1979 tick: 228: adc0= 3950, target adc1=1975, adc1=1979
tick: 229: adc0= 3949, target adc1=1974, adc1=1978 tick: 229: adc0= 3949, target adc1=1974, adc1=1978
tick: 230: adc0= 3950, target adc1=1975, adc1=1979 tick: 230: adc0= 3950, target adc1=1975, adc1=1979
tick: 231: adc0= 3949, target adc1=1974, adc1=1978 tick: 231: adc0= 3949, target adc1=1974, adc1=1978
... ...

9
examples/stm32/f4/stm32f4-discovery/button/README.md
View File

@@ -1,12 +1,9 @@
------------------------------------------------------------------------------ # README
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. When you press the 'USER' button, the blinking is slower.
Board connections: ## Board connections
------------------
<none required> *none required*

2
examples/stm32/f4/stm32f4-discovery/dac-dma/README.md
View File

@@ -1,3 +1,5 @@
# README
DAC test with DMA and timer 2 trigger DAC test with DMA and timer 2 trigger
Timer 2 is setup to provide a trigger signal on OC1, with a period of 142 Hz Timer 2 is setup to provide a trigger signal on OC1, with a period of 142 Hz

9
examples/stm32/f4/stm32f4-discovery/fancyblink/README.md
View File

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

11
examples/stm32/f4/stm32f4-discovery/mandelbrot/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program demonstrates the floating point coprocessor usage on This example program demonstrates the floating point coprocessor usage on
the ST STM32F4DISCOVERY eval board. the ST STM32F4DISCOVERY eval board.
@@ -8,7 +6,8 @@ the ST STM32F4DISCOVERY eval board.
A mandelbrot fractal is calculated and sent as "ascii-art" image through A mandelbrot fractal is calculated and sent as "ascii-art" image through
the USART2. the USART2.
Board connections: ## Board connections
------------------
PA2 (USART2_TX) TTL serial output (38400,8,N,1) | Port | Function | Description |
| ----- | ------------- | --------------------------------- |
| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` |

9
examples/stm32/f4/stm32f4-discovery/miniblink/README.md
View File

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

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

@@ -1,12 +1,9 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example randomly blinks the GREEN LED on the ST STM32F4DISCOVERY eval This example randomly blinks the GREEN LED on the ST STM32F4DISCOVERY eval
board. board.
Board connections: ## Board connections
------------------
<none required> *none required*

11
examples/stm32/f4/stm32f4-discovery/tick_blink/README.md
View File

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

11
examples/stm32/f4/stm32f4-discovery/usart/README.md
View File

@@ -1,13 +1,12 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program sends repeating sequence of characters "0123456789" on This example program sends repeating sequence of characters "0123456789" on
USART2 on the ST STM32F4DISCOVERY eval board. USART2 on the ST STM32F4DISCOVERY eval board.
The sending is done in a blocking way. The sending is done in a blocking way.
Board connections: ## Board connections
------------------
PA2 (USART2_TX) TTL serial output (38400,8,N,1) | Port | Function | Description |
| ----- | ------------- | --------------------------------- |
| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` |

13
examples/stm32/f4/stm32f4-discovery/usart_irq/README.md
View File

@@ -1,14 +1,13 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program echoes data sent in on USART2 on the This example program echoes data sent in on USART2 on the
ST STM32F4DISCOVERY eval board. Uses interrupts for that purpose. ST STM32F4DISCOVERY eval board. Uses interrupts for that purpose.
The sending is done in a nonblocking way. The sending is done in a nonblocking way.
Board connections: ## Board connections
------------------
PA2 (USART2_TX) TTL serial output (38400,8,N,1) | Port | Function | Description |
PA3 (USART2_RX) TTL serial input (38400,8,N,1) | ----- | ------------- | --------------------------------- |
| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` |
| `PA3` | `(USART2_RX)` | TTL serial input `(38400,8,N,1)` |

11
examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README.md
View File

@@ -1,11 +1,10 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB CDC-ACM device (aka Virtual Serial Port) This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.
Board connections: ## Board connections
------------------
CN5 (USB_OTG_FS) USB acting as device, connect to computer | Port | Function | Description |
| ----- | -------------- | ----------------------------------------- |
| `CN5` | `(USB_OTG_FS)` | USB acting as device, connect to computer |

16
examples/stm32/f4/stm32f4-discovery/usb_midi/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB MIDI device to demonstrate the use of the This example implements a USB MIDI device to demonstrate the use of the
USB device stack. It implements the device configuration found in Appendix USB device stack. It implements the device configuration found in Appendix
@@ -11,13 +9,13 @@ The 'USER' button sends note on/note off messages.
The board will also react to identity request (or any other data sent to The board will also react to identity request (or any other data sent to
the board) by transmitting an identity message in reply. the board) by transmitting an identity message in reply.
Board connections: ## Board connections
------------------
CN5 (USB_OTG_FS) USB acting as device, connect to computer | Port | Function | Description |
| ----- | -------------- | ----------------------------------------- |
| `CN5` | `(USB_OTG_FS)` | USB acting as device, connect to computer |
Testing ## Testing
-------
To list midi devices, which should include this demo device To list midi devices, which should include this demo device
@@ -37,7 +35,7 @@ To record events, while pushing the user button
12 bytes read 12 bytes read
$ $
To query the system identity, note this dump matches sysex_identity[] in the To query the system identity, note this dump matches sysex\_identity[] in the
source. source.
$ amidi -d -p hw:2,0,0 -s Sysexdump.syx $ amidi -d -p hw:2,0,0 -s Sysexdump.syx

4
examples/stm32/f4/stm32f4-discovery/usb_msc/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example implements a USB Mass Storage Class (MSC) device This example implements a USB Mass Storage Class (MSC) device
to demonstrate the use of the USB device stack. to demonstrate the use of the USB device stack.

2
examples/stm32/f4/stm32f429i-discovery/README.md
View File

@@ -1,3 +1,5 @@
# README
This directory contains examples for the stm32f429i discovery board. This directory contains examples for the stm32f429i discovery board.
The PCB should be labelled either MB1075B, and contains a user USB The PCB should be labelled either MB1075B, and contains a user USB
port, 2.4" QVGA TFT LCD display, 64Mbits external SDRAM and ST MEMS gyroscope. port, 2.4" QVGA TFT LCD display, 64Mbits external SDRAM and ST MEMS gyroscope.

14
examples/stm32/f4/stm32f429i-discovery/adc-dac-printf/README.md
View File

@@ -1,3 +1,5 @@
# README
Console on PA9 (tx only) 115200@8n1 Console on PA9 (tx only) 115200@8n1
* Prints the ADC value on PA0 (adc channel 0) on the console * Prints the ADC value on PA0 (adc channel 0) on the console
@@ -9,9 +11,9 @@ Recommended wiring:
* jumper from PA5 to PA1 * jumper from PA5 to PA1
example output: example output:
... ...
tick: 228: adc0= 3950, target adc1=1975, adc1=1979 tick: 228: adc0= 3950, target adc1=1975, adc1=1979
tick: 229: adc0= 3949, target adc1=1974, adc1=1978 tick: 229: adc0= 3949, target adc1=1974, adc1=1978
tick: 230: adc0= 3950, target adc1=1975, adc1=1979 tick: 230: adc0= 3950, target adc1=1975, adc1=1979
tick: 231: adc0= 3949, target adc1=1974, adc1=1978 tick: 231: adc0= 3949, target adc1=1974, adc1=1978
... ...

9
examples/stm32/f4/stm32f429i-discovery/button/README.md
View File

@@ -1,12 +1,9 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example blinks the GREEN LED on the ST STM32F429IDISCOVERY eval board. This example blinks the GREEN LED on the ST STM32F429IDISCOVERY eval board.
When you press the 'USER' button, the blinking is slower. When you press the 'USER' button, the blinking is slower.
Board connections: ## Board connections
------------------
<none required> *none required*

2
examples/stm32/f4/stm32f429i-discovery/dac-dma/README.md
View File

@@ -1,3 +1,5 @@
# README
DAC test with DMA and timer 2 trigger DAC test with DMA and timer 2 trigger
Timer 2 is setup to provide a trigger signal on OC1, with a period of 142 Hz Timer 2 is setup to provide a trigger signal on OC1, with a period of 142 Hz

9
examples/stm32/f4/stm32f429i-discovery/fancyblink/README.md
View File

@@ -1,13 +1,10 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32F429IDISCOVERY eval board. It should blink It's intended for the ST STM32F429IDISCOVERY eval board. It should blink
the LEDs on the board. the LEDs on the board.
Board connections: ## Board connections
------------------
<none required> *none required*

11
examples/stm32/f4/stm32f429i-discovery/mandelbrot/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This example program demonstrates the floating point coprocessor usage on This example program demonstrates the floating point coprocessor usage on
the ST STM32F429IDISCOVERY eval board. the ST STM32F429IDISCOVERY eval board.
@@ -8,7 +6,8 @@ the ST STM32F429IDISCOVERY eval board.
A mandelbrot fractal is calculated and sent as "ascii-art" image through A mandelbrot fractal is calculated and sent as "ascii-art" image through
the USART1. the USART1.
Board connections: ## Board connections
------------------
PA9 (USART1_TX) TTL serial output (38400,8,N,1) | Port | Function | Description |
| ----- | ------------- | --------------------------------- |
| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` |

9
examples/stm32/f4/stm32f429i-discovery/miniblink/README.md
View File

@@ -1,13 +1,10 @@
------------------------------------------------------------------------------ # README
README
------------------------------------------------------------------------------
This is the smallest-possible example program using libopencm3. This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32F429IDISCOVERY eval board. It should blink It's intended for the ST STM32F429IDISCOVERY eval board. It should blink
the GREEN LED on the board. the GREEN LED on the board.
Board connections: ## Board connections
------------------
<none required> *none required*

Some files were not shown because too many files have changed in this diff Show More