FS_OPEN_FILE

Abrir um arquivo de dados no sistema de arquivos do SDCARD, e obter um identificador (FD) para o arquivo aberto.

Nota

Antes de utilizar este bloco de função, consulte no manual do controlador utilizado se o mesmo possui suporte para sistema de arquivos no SDCARD.

Bloco

                             FS_OPEN_FILE
                           +--------------+
                  BOOL ----|START     DONE|---- BOOL
                           |              |
                STRING ----|MODE    RESULT|---- INT
                           |              |
                           |            FD|---- INT
                           |              |
HILS.FS_OPEN_FILE_MODE ----|NAME -------- |----
                           +--------------+

Parâmetros

Nome	Classe	Tipo	Dim.	V. Ini.	Descrição
START	Entrada	BOOL		FALSE	Ativação da função
NAME	Entrada/Saída	STRING			Caminho completo com o nome do arquivo a ser aberto
MODE	Entrada	HILS.FS_OPEN_FILE_MODE		0	Modo de abertura do arquivo
DONE	Saída	BOOL		FALSE	Puilso de fim de execução da função
RESULT	Saída	INT		0	Código de retorno da execução da função
FD	Saída	INT		0	Descritor do arquivo aberto (File Descriptor)

Detalhamento dos Parâmetros

Parâmetro	Descrição
START	Deve ser colocado em “TRUE” para iniciar a execução. Caso seu valor seja alterado para “FALSE” antes do fim da operação, o bloco irá ser resetado.
MODE	O modo de abertura do arquivo deve ser do tipo “OPEN_FILE_MODE” com as seguites opções: OPEN_FILE_READ [1] = Abre arquivo para leitura de dados tipo binário OPEN_FILE_WRITE [2] = Abre arquivo para escrita de dados tipo binário OPEN_FILE_APPEND [3] = Abre arquivo para adicionar dados tipo binário ao arquivo OPEN_FILE_WRITE_TXT [5] = Abre arquivo para escrita de dados tipo texto OPEN_FILE_APPEND_TXT [6] = Abre arquivo para adicionar dados tipo texto ao arquivo
NAME	Este parâmetro deve ser especificado com o caminho completo para o nome do arquivo a ser aberto. O diretório raiz é identificado pelo caractere ‘/’, e desta forma este parâmetro deve sempre iniciar com este caractere. Exemplo de arquivo: ‘/Dados.dat’, ‘/Pasta_1/Dados.dat’, ‘/PASTA_1/PASTA_2/Receita.cfg’ O tamanho máximo permitido para o caminho do nome atual do arquivo é de 64 caracteres.
DONE	Pulso para indicar o término da execução da função. Após este pulso (fica ativo por apenas um ciclo de scan), o resultado da execução da função deve ser consultado no parâmetro de saída “RESULT”.
RESULT	Código de retorno associado a execução da função, onde: Se for igual a 0: Função executada com sucesso, código HILS.SUCCESS Se for diferente de 0: Falha na execução da função [3]

Segue alguns exemplos de códigos de retorno:

RESULT	LABEL [4]	Descrição
0	HILS.SUCCESS	Função executada com sucesso.
5	HILS.GL_INV_PAR	Parâmetro(s) inválido(s).
7	HILS.GL_UNA_CMD	Comando não disponivel ou nao implementado.
8	HILS.GL_INV_STT	Estado corrente inválido.
10	HILS.GL_CMD_TMO	Timeout na execução do comando.
11	HILS.GL_CMD_CAN	Comando cancelado.
16	HILS.GL_CMD_PEND	Tratamento do comando pendente.
24	HILS.RE_NOT_AVA	Sem suporte para o sistema de arquivos ou SDCARD não detectado.
25	HILS.RE_INV_LEN	Tamanho especificado no parâmetro “NAME” inválido.
27	HILS.RE_RES_EMP	Buffer do recurso vazio.
31	HILS.RE_READ_ERR	Falha no processo de leitura do recurso.
32	HILS.RE_WRITE_ERR	Falha no processo de escrita do recurso.
33	HILS.RE_NOT_INIT	Recurso não inicializado.
167	HILS.RC_FS_CORRUPT	Sistema de arquivo pode estar corrompido.
168	HILS.RC_FS_INV_OPER_MODE	Modo de operação incompátivel com estado do arquivo.
170	HILS.RC_FS_WRITE_LOCK	Arquivo já está aberto para escrita.
173	HILS.RC_FS_INVALIDNAME	Texto especificado no parâmetro “NAME” inválido.
174	HILS.RC_FS_NOTFOUND	O arquivo não foi encontrado.
175	HILS.RC_FS_DUPLICATED	O arquivo já existe.
176	HILS.RC_FS_OPEN_LIMIT	Numero máximo de arquivos abertos.
178	HILS.RC_FS_INVALID_DIR	O diretório não existe.

Recomendações para nomes de arquivos e diretórios:

Apesar do sistema de arquivos aceitar qualquer caracter para definição de um nome de arquivo ou diretório, recomenda-se utilizar apenas os tipos:

Caracteres alfabéticos de A-Z ou a-z

Caracteres numéricos de 0 - 9

Caracteres especiais . (ponto decimal) ou _ (underline)

O tamanho máximo permitido para nome do arquivo ou diretório é de 64 caracteres.

Apesar de permitir caracteres em minúscula e maiúscula na nomenclatura, o sistema não é “case sensitive”, ou seja, os nomes ‘DADOS.DAT’, ‘Dados.Dat’ e ‘dados.dat’ referem-se ao mesmo arquivo.

Essa recomendação é sugerida, pois quando o arquivo for eventualmente transferido para o computador, o arquivo/diretório deve obedecer as regras de nomeação do sistema operacional do PC.

Exemplos de nomes recomendados:

‘PASTA’

‘/Pasta_1/Pasta_2’

‘dados.dat’

‘abc_123.txt’

Exemplos de nomes não recomendados:

‘teste abc’

‘áãç’

‘abc’ e ‘ABC’ (considerados como o mesmo arquivo pelo sistema operacional windows)

Instruções de acesso para arquivos e diretórios:

O diretório inicial default do sistema de arquivo é o diretório raiz.

Para acessar diretamente o diretório raiz, utilizar ‘/’ antes do nome do arquivo ou diretório.

Exemplos de caminho completo para diretórios:

‘/’ : Diretório raiz do sistema de arquivo
‘/PASTA_1’ : Diretório “PASTA_1” localizado na raiz do sistema de arquivo
‘/PASTA_1/PASTA_2’ : Caminho completo para diretório “PASTA_2” a partir da “PASTA_1” localizado na raiz do sistema de arquivo
‘/p1/p2/p3’ : Caminho completo para diretório “p3” a partir dos diretórios “/p1/p2”

Exemplos de caminho completo para arquivos:

‘/dados.dat’ : Arquivo “dados.dat” localizado na raiz do sistema de arquivo
‘/PASTA_1/Log.dat’ : Arquivo “Log.dat” localizado dentro do diretório “/PASTA_1”
‘/DADOS/Jan/Dados.bak’ : Arquivo “Dados.bak” localizado dentro dos diretórios “/DADOS/Jan”
‘/P1/P2/P3/SETUP.CFG’ : Arquivo “SETUP.CFG” localizado dentro dos diretórios “/P1/P2/P3”

Exemplo

Declaração de variáveis

Nome	Tipo	Valor Inicial	Opções	Descrição
FILE_DADOS	STRING	‘/DADOS.DAT’	Const	Constante string com o nome do arquivo a ser aberto, no diretório raiz
MY_START	BOOL	FALSE		Ativação da função
OPEN_MODE	FS_OPEN_FILE_MODE			Modo de abertura do arquivo
FILE_NAME	STRING			Nome do arquivo a ser aberto, limitado a 64 caracteres
OPEN_FILE	FS_OPEN_FILE			Instancia do bloco “FS_OPEN_FILE”

Clique aqui para baixar a tabela de variáveis

Código ST

//============================================================================
// Exemplo de parametrização 1 : Abertura no modo OPEN_FILE_READ
//============================================================================
// Abertura de um arquivo para leitura.
// OBS: É possível abrir um arquivo várias vezes, realizando operações de
// leitura a partir de diferentes FD (File Descriptor)

// Preenche parâmetros para a chamada do bloco de função
FILE_NAME := FILE_DADOS;            // Nome do arquivo '/DADOS.DAT'
OPEN_MODE := HILS.OPEN_FILE_READ;   // Modo de abertura do arquivo

(* ... *)

//============================================================================
// Exemplo de parametrização 2 : Abertura no modo OPEN_FILE_WRITE
//============================================================================
// Abre arquivo para escrever dados.
// OBS: Ao abrir um arquivo nesse modo, os valores começam a ser
// escritos a partir do início do arquivo. Caso o arquivo
// já tenha dados, seus valores podem ser rescritos.
// Para reposicionar o local onde os dados serão escritos utilizar a função
// FS_SEEK_FILE.

// Preenche parâmetros para a chamada do bloco de função
FILE_NAME := '/Pasta_1/Dados.dat';  // Nome do arquivo 'Dados.Dat' dentro do diretório "/Pasta_1"
OPEN_MODE := HILS.OPEN_FILE_WRITE;  // Modo de abertura do arquivo

(* ... *)

//============================================================================
// Exemplo de parametrização 3 : Abertura no modo OPEN_FILE_APPEND
//============================================================================
// Abre arquivo para adicionar dados.
// OBS: Ao abrir um arquivo nesse modo, os valores serão
// escritos a partir da última posição dos dados no arquivo.

// Preenche parâmetros para a chamada do bloco de função
FILE_NAME := '/P1/P2/P3/Setup.cfg'; // Nome do arquivo 'Setup.cfg' dentro do diretório "/P1/P2/P3"
OPEN_MODE := HILS.OPEN_FILE_APPEND; // Modo de abertura do arquivo

(* ... *)

//============================================================================
// Trata função FS_OPEN_FILE
//============================================================================

// Preenche parâmetros para a chamada do bloco de função
MY_START := TRUE;        // Ativação do bloco da função
(* ... *)

// Exemplo de ativação do bloco de função FS_OPEN_FILE
OPEN_FILE(
  START := MY_START,  // [BOOL] Ativação da função
  NAME  := FILE_NAME, // [STRING] Path com o nome do arquivo a ser aberto
  MODE  := OPEN_MODE  // [INT] Mode de abertura do arquivo
  );

// Aguarda término da execução da função do sistema de arquivos
if (OPEN_FILE.DONE) then

  MY_START := FALSE;     // reseta ativação da função

  // Testa código de retorno da execução da função
  if (OPEN_FILE.RESULT = HILS.SUCCESS) then
    // ... Função executada com sucesso
  else
    // ... Erro na execução da função
  end_if;

end_if;

(* ... *)