forked

Embed: (wiki syntax)

« Back to documentation index

Drivers

Data Structures

class  AnalogIn
 An analog input, used for reading the voltage on a pin. More...
class  AnalogOut
 An analog output, used for setting the voltage on a pin. More...
class  BusIn
 A digital input bus, used for reading the state of a collection of pins. More...
class  BusInOut
 A digital input output bus, used for setting the state of a collection of pins. More...
class  BusOut
 A digital output bus, used for setting the state of a collection of pins. More...
class  CANMessage
 CANMessage class. More...
class  CAN
 A can bus client, used for communicating with can devices. More...
class  DigitalIn
 A digital input, used for reading the state of a pin. More...
class  DigitalInOut
 A digital input/output, used for setting or reading a bi-directional pin. More...
class  DigitalOut
 A digital output, used for setting the state of a pin. More...
class  Ethernet
 An ethernet interface, to use with the ethernet pins. More...
class  FlashIAP
 Flash IAP driver. More...
class  I2C
 An I2C Master, used for communicating with I2C slave devices. More...
class  I2CSlave
 An I2C Slave, used for communicating with an I2C Master device. More...
class  InterruptIn
 A digital interrupt input, used to call a function on a rising or falling edge. More...
class  InterruptManager
 Use this singleton if you need to chain interrupt handlers. More...
class  LowPowerTicker
 Low Power Ticker. More...
class  LowPowerTimeout
 Low Power Timout. More...
class  LowPowerTimer
 Low power timer. More...
class  PortIn
 A multiple pin digital input. More...
class  PortInOut
 A multiple pin digital in/out used to set/read multiple bi-directional pins. More...
class  PortOut
 A multiple pin digital out. More...
class  PwmOut
 A pulse-width modulation digital output. More...
class  RawSerial
 A serial port (UART) for communication with other serial devices This is a variation of the Serial class that doesn't use streams, thus making it safe to use in interrupt handlers with the RTOS. More...
class  Serial
 A serial port (UART) for communication with other serial devices. More...
class  SerialBase
 A base class for serial port implementations Can't be instantiated directly (use Serial or RawSerial) More...
class  SPI
 A SPI Master, used for communicating with SPI slave devices. More...
class  SPISlave
 A SPI slave, used for communicating with a SPI Master device. More...
class  Ticker
 A Ticker is used to call a function at a recurring interval. More...
class  Timeout
 A Timeout is used to call a function at a point in the future. More...
class  Timer
 A general purpose timer. More...
class  TimerEvent
 Base abstraction for timer interrupts. More...
class  FileSystemHandle
 A filesystem-like object is one that can be used to open file-like objects though it by fopen("/name/filename", mode) More...

Functions

virtual int open (FileHandle **file, const char *filename, int flags)=0
 Open a file on the filesystem.
virtual int open (DirHandle **dir, const char *path)
 Open a directory on the filesystem.
virtual int remove (const char *path)
 Remove a file from the filesystem.
virtual int rename (const char *path, const char *newpath)
 Rename a file in the filesystem.
virtual int stat (const char *path, struct stat *st)
 Store information about the file in a stat structure.
virtual int mkdir (const char *path, mode_t mode)
 Create a directory in the filesystem.

Function Documentation

virtual int mkdir ( const char *  path,
mode_t  mode 
) [virtual, inherited]

Create a directory in the filesystem.

Parameters:
pathThe name of the directory to create.
modeThe permissions with which to create the directory
Returns:
0 on success, negative error code on failure
virtual int open ( DirHandle **  dir,
const char *  path 
) [virtual, inherited]

Open a directory on the filesystem.

Parameters:
dirDestination for the handle to the directory
pathName of the directory to open
Returns:
0 on success, negative error code on failure

Reimplemented in LocalFileSystem.

virtual int open ( FileHandle **  file,
const char *  filename,
int  flags 
) [pure virtual, inherited]

Open a file on the filesystem.

Parameters:
fileDestination for the handle to a newly created file
filenameThe name of the file to open
flagsThe flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR, bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
Returns:
0 on success, negative error code on failure

Implemented in LocalFileSystem.

virtual int remove ( const char *  path ) [virtual, inherited]

Remove a file from the filesystem.

Parameters:
pathThe name of the file to remove.
Returns:
0 on success, negative error code on failure

Reimplemented in LocalFileSystem.

virtual int rename ( const char *  path,
const char *  newpath 
) [virtual, inherited]

Rename a file in the filesystem.

Parameters:
pathThe name of the file to rename.
newpathThe name to rename it to
Returns:
0 on success, negative error code on failure
virtual int stat ( const char *  path,
struct stat *  st 
) [virtual, inherited]

Store information about the file in a stat structure.

Parameters:
pathThe name of the file to find information about
stThe stat buffer to write to
Returns:
0 on success, negative error code on failure