FTP Client#

rsi_ftp_connect#

int32_t rsi_ftp_connect (uint16_t flags, int8_t * server_ip, int8_t * username, int8_t * password, uint32_t server_port)

Create FTP objects and connect to the FTP server on the given server port. This should be the first command for accessing FTP server.
This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• FTP server port is also configurable on a non-standard port

• Refer to Error Codes for the description of above error codes.

rsi_ftp_disconnect#

int32_t rsi_ftp_disconnect (void )

Disconnect from the FTP server and destroy the FTP objects. Once the FTP objects are destroyed, FTP server cannot be accessed.
For further accessing, FTP objects should be created again. This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_file_write#

int32_t rsi_ftp_file_write (int8_t * file_name)

Open a file in the specified path on the FTP server. This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_file_write_content#

int32_t rsi_ftp_file_write_content (uint16_t flags, int8_t * file_content, int16_t content_length, uint8_t end_of_file)

Write the content into the file that was opened using rsi_ftp_file_write() API. This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• This API can be called multiple times to append data into the same file.
  

• File content length should not exceed 1344 bytes in case of IPV4 and 1324 bytes in case of IPV6.
  
  If exceeded, this API will break the file content and send it in multiple packets.
  
  

• Refer to Error Codes for the description of above error codes.

rsi_ftp_file_read_aysnc#

int32_t rsi_ftp_file_read_aysnc (int8_t * file_name, void(*)(uint16_t status, uint8_t *file_content, uint16_t content_length, uint8_t end_of_file) call_back_handler_ptr, status, file_content, content_length, end_of_file)

Read the content from the specified file on the FTP server. This is a non-blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_file_delete#

int32_t rsi_ftp_file_delete (int8_t * file_name)

Delete the file that is present in the specified path on the FTP server. This is a blocking API.

• rsi_config_ipaddress() API needs to be called before this API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_file_rename#

int32_t rsi_ftp_file_rename (int8_t * old_file_name, int8_t * new_file_name)

Rename the file with a new name on the FTP server. This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_directory_create#

int32_t rsi_ftp_directory_create (int8_t * directory_name)

Create a directory on the FTP server. This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_directory_delete#

int32_t rsi_ftp_directory_delete (int8_t * directory_name)

Delete the directory on the FTP server. This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_directory_set#

int32_t rsi_ftp_directory_set (int8_t * directory_path)

Change the current working directory to the specified directory path on the FTP server. This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_directory_list_async#

int32_t rsi_ftp_directory_list_async (int8_t * directory_path, void(*)(uint16_t status, uint8_t *directory_list, uint16_t length, uint8_t end_of_list) call_back_handler_ptr, status, directory_list, length, end_of_list)

Get the list of directories present in the specified directory on the FTP server. This is a non-blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_mode_set#

int32_t rsi_ftp_mode_set (uint8_t mode)

Set the FTP client mode - either in Passive mode or Active Mode.
In active mode, FTP client establishes the command channel, and the server establishes the data channel.
In passive mode, both the command channel and the data channel are established by the client.
This is a blocking API.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• Refer to Error Codes for the description of above error codes.

rsi_ftp_file_size_set#

int32_t rsi_ftp_file_size_set (uint32_t file_size)

Set the file size.

Returns

• 0 - Success
  

• Non Zero Value - Failure (Possible Error Codes - 0xfffffffd, 0xfffffffc, 0x0021, 0x002C, 0x0015)
  
  

Note

• Precondition - rsi_config_ipaddress() API needs to be called before this API.

• This API is supported only in 9117

• This API should called before every rsi_ftp_file_write_content() when the Block transfer mode is in use

• Refer to Error Codes for the description of above error codes.