Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The µC/FTPc module has to be configured according to your specific needs. A template configuration file (ftp-c_cfg.h) is included in the module package (see section Directories and Files), and this configuration should be copied into your application directory and included to your project. Here is the list of the values and description of each of the configuration variable. However, keep in mind that future releases of this module might include more configuration options.

Control Connection Configuration (Ctrl)

ConstantDescriptionPossible Values
FTPc_CFG_CTRL_MAX_CONN_TIMEOUT_MS

This value define the timeout value (in milliseconds) for

control and data transfer sockets.

the control socket connection operation.
If the server doesn’t reply back in this amount of time after a SYN request, the

request

connection will be aborted.

Unsigned Integer
Default Value: 5000

FTPc_CFG_CTRL_MAX_RX_TIMEOUT_MS This value define the timeout value (in milliseconds) for the control socket reception operation.

Unsigned Integer

Default Value: 5000
FTPc_CFG_CTRL_MAX_TX_TIMEOUT_MS This value define the timeout value (in milliseconds) for the control socket transmission operation.

Unsigned Integer

Default Value: 5000
FTPc_CFG_CTRL_MAX_TX_RETRYThis value define the maximum number of transmission retries when a request fails before returning an error to the application.

Unsigned Integer
Default Value: 3

FTPc_CFG_CTRL_MAX_RX_DLY_MSThis value define the delay between each reception retry.

Unsigned Integer

Default Value: 100
FTPc_CFG_CTRL_MAX_TX_DLY_MSThis value define the delay between each transmission retry.

Unsigned Integer

Default Value: 100

 

Data Connection Configuration (DTP)

ConstantDescriptionPossible Values
FTPc_CFG_DTP_MAX_CONN_TIMEOUT_MSThis value define the timeout value (in milliseconds) for control and the data transfer socketssocket connection operation.
If the server doesn’t reply back in this amount of time after a SYN request, the request connection will be aborted.

Unsigned Integer

Default Value: 5000
FTPc_CFG_DTP_MAX_RX_TIMEOUT_MS This value define the timeout value (in milliseconds) for the data transfer socket reception operation.

Unsigned Integer

Default Value: 5000
FTPc_CFG_DTP_MAX_TX_TIMEOUT_MS This value define the timeout value (in milliseconds) for the data transfer socket transmission operation.

Unsigned Integer

Default Value: 5000
FTPc_CFG_DTP_MAX_TX_RETRYThis value define the maximum number of transmission retries when a request fails before returning an error to the application.

Unsigned Integer

Default Value: 3
FTPc_CFG_DTP_MAX_TX_DLY_MSThis value define the delay between each transmission retry.

Unsigned Integer

Default Value: 100

...


File System Configuration

ConstantDescriptionPossible Values
FTPc_CFG_USE_FS

...

This value controls the integration between µC/FTPc and

...

a FS. If value is

...

DEF_ENABLED, functions using

...

the FS Abstraction Layer Interface functions are compiled and enabled. If value is

...

DEF_DISABLED, no File System functions are available to the application.

#define FTPc_CFG_COMMON_NAME_MAX_LEN 256

...

DEF_ENABLED or DEF_DISABLED