Zephyr API Documentation 4.5.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
File Transfer Profile (FTP)

File Transfer Profile (FTP). More...

Topics

 FTP Client
 FTP Server

Files

file  ftp.h
 Bluetooth File Transfer Profile handling.

Macros

#define BT_FTP_UUID
 FTP service target UUID (F9EC7BC4-953C-11D2-984E-525400DC9E09).
#define BT_FTP_FOLDER_LISTING_TYPE   "x-obex/folder-listing"
 OBEX type header for folder listing operation.

Enumerations

enum  bt_ftp_set_folder_flags { BT_FTP_SET_FOLDER_FLAGS_ROOT = BT_OBEX_SETPATH_FLAG_NO_CREATE , BT_FTP_SET_FOLDER_FLAGS_DOWN = BT_OBEX_SETPATH_FLAG_NO_CREATE , BT_FTP_SET_FOLDER_FLAGS_UP = BT_OBEX_SETPATH_FLAG_BACKUP | BT_OBEX_SETPATH_FLAG_NO_CREATE , BT_FTP_SET_FOLDER_FLAGS_NEW = 0 }
 FTP set folder operation flags. More...
enum  bt_ftp_rsp_code {
  BT_FTP_RSP_CODE_CONTINUE = BT_OBEX_RSP_CODE_CONTINUE , BT_FTP_RSP_CODE_SUCCESS = BT_OBEX_RSP_CODE_SUCCESS , BT_FTP_RSP_CODE_BAD_REQ = BT_OBEX_RSP_CODE_BAD_REQ , BT_FTP_RSP_CODE_UNAUTH = BT_OBEX_RSP_CODE_UNAUTH ,
  BT_FTP_RSP_CODE_FORBIDDEN = BT_OBEX_RSP_CODE_FORBIDDEN , BT_FTP_RSP_CODE_NOT_FOUND = BT_OBEX_RSP_CODE_NOT_FOUND , BT_FTP_RSP_CODE_NOT_ACCEPT = BT_OBEX_RSP_CODE_NOT_ACCEPT , BT_FTP_RSP_CODE_PRECON_FAIL = BT_OBEX_RSP_CODE_PRECON_FAIL ,
  BT_FTP_RSP_CODE_NOT_IMPL = BT_OBEX_RSP_CODE_NOT_IMPL , BT_FTP_RSP_CODE_UNAVAIL = BT_OBEX_RSP_CODE_UNAVAIL
}
 FTP response codes. More...

Detailed Description

File Transfer Profile (FTP).

Since
4.6
Version
0.1.0

Macro Definition Documentation

◆ BT_FTP_FOLDER_LISTING_TYPE

#define BT_FTP_FOLDER_LISTING_TYPE   "x-obex/folder-listing"

#include <zephyr/bluetooth/classic/ftp.h>

OBEX type header for folder listing operation.

◆ BT_FTP_UUID

#define BT_FTP_UUID

#include <zephyr/bluetooth/classic/ftp.h>

Value:
(const struct bt_uuid_128 *)BT_UUID_DECLARE_128( \
BT_UUID_128_ENCODE(0xf9ec7bc4, 0x953c, 0x11d2, 0x984e, 0x525400dc9e09))
#define BT_UUID_128_ENCODE(w32, w1, w2, w3, w48)
Encode 128 bit UUID into array values in little-endian format.
Definition uuid.h:195
#define BT_UUID_DECLARE_128(value...)
Helper to declare a 128-bit UUID inline.
Definition uuid.h:150
Definition uuid.h:70

FTP service target UUID (F9EC7BC4-953C-11D2-984E-525400DC9E09).

128-bit UUID used to identify the FTP service during OBEX connection establishment.

Enumeration Type Documentation

◆ bt_ftp_rsp_code

#include <zephyr/bluetooth/classic/ftp.h>

FTP response codes.

Response codes used in FTP operations, mapped from OBEX response codes.

Enumerator
BT_FTP_RSP_CODE_CONTINUE 

Continue - more data to follow.

BT_FTP_RSP_CODE_SUCCESS 

Success.

BT_FTP_RSP_CODE_BAD_REQ 

Bad request.

BT_FTP_RSP_CODE_UNAUTH 

Unauthorized.

BT_FTP_RSP_CODE_FORBIDDEN 

Forbidden - operation understood but refused.

BT_FTP_RSP_CODE_NOT_FOUND 

Not found.

BT_FTP_RSP_CODE_NOT_ACCEPT 

Not acceptable.

BT_FTP_RSP_CODE_PRECON_FAIL 

Precondition failed.

BT_FTP_RSP_CODE_NOT_IMPL 

Not implemented.

BT_FTP_RSP_CODE_UNAVAIL 

Service unavailable.

◆ bt_ftp_set_folder_flags

#include <zephyr/bluetooth/classic/ftp.h>

FTP set folder operation flags.

Flags controlling folder navigation behavior in SetFolder operations.

Enumerator
BT_FTP_SET_FOLDER_FLAGS_ROOT 

Navigate to root folder.

BT_FTP_SET_FOLDER_FLAGS_DOWN 

Navigate down to child folder.

BT_FTP_SET_FOLDER_FLAGS_UP 

Navigate up to parent folder.

BT_FTP_SET_FOLDER_FLAGS_NEW 

Create a new folder.