STM32CubeF1

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/**
  @page LwIP_TCP_Echo_Client LwIP TCP Echo Client example
  
  @verbatim
  ******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
  * @file    LwIP/LwIP_TCP_Echo_Client/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the LwIP TCP Echo Client example.
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
  * All rights reserved.</center></h2>
  *
  * This software component is licensed by ST under BSD 3-Clause license,
  * the "License"; You may not use this file except in compliance with the
  * License. You may obtain a copy of the License at:
  *                        opensource.org/licenses/BSD-3-Clause
  *
  ******************************************************************************
  @endverbatim

@par Application Description 

This application shows how to run TCP Echo Client
application based on Raw API of LwIP TCP/IP stack.

To run this application, On the remote PC, open a command prompt window.
(In Windows, select Start > All Programs > Accessories > Command Prompt.)
At the command prompt, enter:
    C:\>echotool /p tcp /s
where:
    – /p transport layer protocol used for communication (TCP)
    – /s is the actual mode of connection (Server mode)
    
Each time the user pushes the KEY button of the STM3210C-EVAL board, an echo 
request is sent to the server

If the LCD is used (#define USE_LCD in main.h), log messages will be displayed 
to inform user about ethernet cable status and the IP address value, else this 
will be ensured by LEDs:
  + LED1: ethernet cable is connected.
  + LED2: ethernet cable is not connected.

If a DHCP server is available, a dynamic IP address can be allocated by enabling 
the DHCP process (#define USE_DHCP in main.h)

If DHCP is used, user should define its PC Host IP address ( DEST_IP_ADDR0 [0..3] in main.h file.

@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
      based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
      a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
      than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
      To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
      
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
      to have correct HAL operation.
      
For more details about this application, refer to UM1713 "STM32Cube interfacing with LwIP and applications"


@par Directory contents 

  - LwIP/LwIP_TCP_Echo_Client/Inc/app_ethernet.h          header of app_ethernet.c file
  - LwIP/LwIP_TCP_Echo_Client/Inc/ethernetif.h            header for ethernetif.c file
  - LwIP/LwIP_TCP_Echo_Client/Inc/lcd_log_conf.h          LCD Log configuration file
  - LwIP/LwIP_TCP_Echo_Client/Inc/stm32f1xx_hal_conf.h    HAL configuration file
  - LwIP/LwIP_TCP_Echo_Client/Inc/stm32f1xx_it.h          STM32 interrupt handlers header file
  - LwIP/LwIP_TCP_Echo_Client/Inc/main.h                  Main program header file
  - LwIP/LwIP_TCP_Echo_Client/Inc/lwipopts.h              LwIP stack configuration options
  - LwIP/LwIP_TCP_Echo_Client/Inc/tcp_echoclient.h        Header for tcp echoclient application
  - LwIP/LwIP_TCP_Echo_Client/Src/app_ethernet.c          Ethernet specific module
  - LwIP/LwIP_TCP_Echo_Client/Src/stm32f1xx_it.c          STM32 interrupt handlers
  - LwIP/LwIP_TCP_Echo_Client/Src/main.c                  Main program
  - LwIP/LwIP_TCP_Echo_Client/Src/system_stm32f1xx.c      STM32F1xx system clock configuration file
  - LwIP/LwIP_TCP_Echo_Client/Src/ethernetif.c            Interfacing LwIP to ETH driver
  - LwIP/LwIP_TCP_Echo_Client/Src/tcp_echoclient.c        tcp echoclient application

@par Hardware and Software environment

  - This application runs on STM32F107xx Devices.
    
  - This application has been tested with the following environments:
     - STM3210C-EVAL board   
     - echotool: (http://bansky.net/echotool/) is used as echo server that sends
       back every incoming data.   
      
  - STM3210C-EVAL RevC Set-up
    - Make sure that the following jumpers: JP3 JP4 JP11 JP12 JP13 JP14 are on the position 2-3
    - Connect the eval board to remote PC (through a crossover ethernet cable)
      or to your local network (through a straight ethernet cable)
  
  - Remote PC Set-up
    - Configure a static IP address for your remote PC 
      this address must be 192.168.0.11 


@par How to use it ? 

In order to make the program work, you must do the following :
 - Open your preferred toolchain 
 - Rebuild all files and load your image into target memory
 - Run the application
       
 * <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */

readme.txt Unescape Escape

readme.txt