Bridge - Clase FileIO

FileIO es la clase base para la escritura y la lectura de una tarjeta SD montada en el Yun. Es parte de Bridge. No se llama directamente, sino que invoca cada vez que se utiliza una función que depende de él.

Para preparar su tarjeta SD para la escritura y la lectura, crear una carpeta vacía en la raíz SD llamada "Arduino". Esto asegurará que el Yun creará un enlace a la SD en la ruta "/ mnt / sd".

FUNCIONES

FileSystem.begin()

Descripción:

Inicializa la tarjeta SD y la clase File IO. Esta se comunica con la distribución de Linux a través de Bridge. Aunque funcionalmente es similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

FileSystem.begin()

Parámetros:

Ninguno

Retornos:

boolean: true cuando finaliza correctamente; false en caso de fallo

________________________________________________________________________

FileSystem.open()

Descripción:

Abre un archivo en la tarjeta SD. Si se abre el archivo para escritura, se creará si no existe ya (pero ya debe existir el directorio que lo contiene).

Esta se comunica con la distribución de Linux a través de Bridge. Aunque funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Nota: sólo un archivo puede ser abierto a la vez.

Sintaxis:

FileSystem.open(filename)

FileSystem.open(filename, mode)

Parámetros:

filename: el nombre del archivo para abrir, lo que puede: incluir directorios (delimitados por barras inclinadas, /) - Char

mode (opcional): el modo en que se abre el archivo, por defecto FILE_READ. Puede ser cualquiera de los dos:

      - FILE_READ: abrir el archivo para lectura, empezando por el principio del archivo.

      - FILE_WRITE: abrir el archivo para leer y escribir, a partir del final del archivo.

Retornos:

Un objeto File que hace referencia al archivo abierto; si no se pudo abrir el archivo, este objeto se evaluará como false en un contexto booleano, es decir, que se puede comprobar el valor de retorno con "if (f)".

________________________________________________________________________

exists()

Descripción:

Comprueba si existe un archivo o directorio en la tarjeta SD.

Este se comunica con la distribución de Linux a través de Bridge. Aunque funcionalmente similar a la biblioteca SD, el código y hardware conexiones subyacentes son diferentes.

Sintaxis:

FileSystem.exists(filename)

Parámetros:

filename: el nombre del archivo para comprobar si existe, que puede incluir directorios (delimitados por barras inclinadas, /)

Retornos:

boolean: true si existe el archivo o directorio, false si no existe.

________________________________________________________________________

mkdir()

Descripción:

Un contenedor para el comando mkdir con la bandera -p, FileSystem.mkdir () crea un directorio con nombre en una tarjeta SD.

Esta se comunica con la distribución de Linux a través de Bridge.

Sintaxis:

FileSystem.mkdir(directory)

Parámetros:

directory: el nombre del directorio a crear. Se pueden crear directorios anidados  con una barra inclinada /.

Retornos:

boolean: true si existe el archivo o directorio, false si no existe.

________________________________________________________________________

rmdir()

Descripción:

Un contenedor para el comando rmdir,  FileSystem.rmdir () elimina un directorio vacío de una tarjeta SD. Antes de quitar un directorio que contenga algún archivo en él, debe llamar a FileSystem.remove ().

Esto se comunica con la distribución de Linux a través de Bridge.

Sintaxis:

FileSystem.rmdir(directory)

Parámetros:

directory: el nombre del directorio a eliminar.

Retornos:

boolean: true si es correcto, false si no lo es

________________________________________________________________________

remove()

Descripción:

Un contenedor para el comando rm, FileSystem.remove () elimina un archivo o directorio de una tarjeta SD.

Esto se comunica con la distribución de Linux a través de Bridge.

Sintaxis:

FileSystem.remove(file)

directory: el nombre del directorio a eliminar.

Retornos:

boolean: true si es correcto, false si no lo es

________________________________________________________________________

close()

Descripción:

Cierra un archivo abierto, y se asegura que los datos grabados en el se guardan físicamente en la tarjeta SD.

Esto se comunica con la distribución de Linux a través de Bridge. Aunque es funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

'file'.close(file)

Parámetros:

file: una instancia de la clase File (Archivo devuelto por IO.open ())

Retornos:

Ninguno

________________________________________________________________________

rewindDirectory()

Descripción:

rewindDirectory () le llevará de vuelta al primer archivo en el directorio en una tarjeta SD. Utilizado conjuntamente con openNextFile ().

Esto se comunica con la distribución de Linux a través de Bridge. Aunque es funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.rewindDirectory()

Parámetros:

file: una instancia de la clase File (Archivo devuelto por IO.open ())

Retornos:

Ninguno

________________________________________________________________________

openNextFile()

Descripción:

Informa del siguiente archivo o carpeta en un directorio.

Esto se comunica con la distribución de Linux a través de Bridge. Aunque es funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.openNextFile()

Parámetros:

Ninguno

Retornos:

char: el archivo o carpeta siguiente en la ruta

________________________________________________________________________

seek()

Descripción:

Busca una nueva posición en el archivo, la cual debe estar entre 0 y el tamaño del archivo (ambos inclusive).

Esto se comunica con la distribución de Linux a través de Bridge. Aunque es funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.seek(pos)

Parámetros:

file: una instancia de la clase File (devuelto por FileIO.open ())

pos: la posición en la cual debe buscar (long sin signo)

Retornos:

boolean: true para el éxito, false para el fallo

________________________________________________________________________

position()

Descripción:

Obtiene la posición actual dentro del archivo (es decir, la ubicación en la que el siguiente byte se lee o se escribe).

Esto se comunica con la distribución de Linux a través de Bridge. Aunque es funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.position()

Parámetros:

file: una instancia de la clase File (Archivo devuelto por IO.open ())

Retornos:

long sin signo: la posición dentro del archivo

________________________________________________________________________

size()

Descripción:

Obtiene el tamaño del archivo actual.


Esto se comunica con la distribución de Linux a través de Bridge. Aunque es funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.size()

Parámetros:

file: una instancia de la clase File (Archivo devuelto por IO.open ())

Retornos:

long sin signo: el tamaño del archivo en bytes

________________________________________________________________________

available()

Descripción:

Comprueba si hay bytes disponibles para leer en el archivo.

Esto se comunica con la distribución de Linux a través de Bridge. Aunque funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.available()

Parámetros:

file: una instancia de la clase File (Archivo devuelto por IO.open ())

Retornos:

int: el número de bytes disponibles

________________________________________________________________________

read()

Descripción:

Lee un byte del archivo.

Esto se comunica con la distribución de Linux a través de Bridge. Aunque funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.read()

Parámetros:

file: una instancia de la clase File (Archivo devuelto por IO.open ())

Retornos:

El siguiente byte (o carácter), o -1 si no hay ninguno disponible.

________________________________________________________________________

write()

Descripción:

Escribe un byte del archivo.

Esto se comunica con la distribución de Linux a través de Bridge. Aunque funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.write(data)

file.write(buf, len)

Parámetros:

file: una instancia de la clase File (devuelto por FileIO.open ())
data: el byte, char, o una string (char *) aescribir
buf: un conjunto de caracteres o bytes

len: el número de elementos en buf

Retornos:

byte: write() devolverá el número de bytes escritos. La lectura de ese número es opcional

________________________________________________________________________

peek()

Descripción:

Lee un byte del archivo sin avanzar a la siguiente pòsición. Llamadas sucesivas a peek () devolverá el mismo valor, como si fuese la siguiente llamada a read ().

Esto se comunica con la distribución de Linux a través de Bridge. Aunque funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.peek()

Parámetros:

file: una instancia de la clase File (Archivo devuelto por IO.open ())

Retornos:

El siguiente byte (o carácter), o -1 si no hay ninguno disponible.

________________________________________________________________________

flush()

Descripción:

flush () limpia el buffer una vez que todos los caracteres salientes han sido enviados.

Esto se comunica con la distribución de Linux a través de Bridge. Aunque funcionalmente similar a la biblioteca SD, el código subyacente y las conexiones son diferentes.

Sintaxis:

file.flush()

Parámetros:

file: una instancia de la clase File (Archivo devuelto por IO.open ())

Retornos:

Ninguno