FS_READ_DATA_FILE

Realizar a leitura de dados em um arquivo de dados no sistema de arquivos do SDCARD no formato Binário.

Para executar a função é necessário que o arquivo esteja aberto no modo OPEN_FILE_READ.

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_READ_DATA_FILE
         +-------------------+
BOOL ----|START          DONE|---- BOOL
         |                   |
 INT ----|FD           READED|---- INT
         |                   |
 INT ----|DATA_LEN     RESULT|---- INT
         |                   |
     ----|DATA_VALUE --------|----
         +-------------------+

Parâmetros

Nome	Classe	Tipo	Dim.	V. Ini.	Descrição
START	Entrada	BOOL		FALSE	Ativação da função
FD	Entrada	INT		0	Descritor do arquivo a ser relizado a leitura de dados
DATA_LEN	Entrada	INT		0	Tamanho de dados a serem lidos do arquivo (bytes)
DATA_VALUE	Entrada/Saída	ANY			Estrutura para armazenar os dados lidos do arquivo
DONE	Saída	BOOL		FALSE	Pulso de fim de execução da função
READED	Saída	INT		0	Quantidade de dados efetivamente lidos do arquivo
RESULT	Saída	INT		0	Código de retorno da execução da função

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.
FD	Descritor do arquivo a ser relizado a leitura de dados.
DATA_VALUE	Estrutura para armazenar os dados lidos do arquivo.
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]

[3] Para consultar a lista completa dos códigos de retorno acesse: RET_CODE - Códigos de retorno do firmware G5.

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.
27	HILS.RE_RES_EMP	Buffer do recurso vazio, indicando fim de arquivo.
31	HILS.RE_READ_ERR	Falha no processo de leitura 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.
177	HILS.RC_FS_INVALID_HANDLE	Handle de arquivo aberto inválido.

[4] Este LABEL pode ser utilizado no código fonte pois está definido no tipo RET_CODE disponível na biblioteca HI_STD

Exemplo

Declaração de Tipos de Dados

Exemplo de declaração de uma estrutura de dados definida pelo usuário, a ser utilizada para especificar os registros de dados a serem lidos/escritos no arquivo de dados no SDCARD.

Tipos de Dados	Derivação	Nome	Tipo	Dimensão	Valor Inicial	Descrição
REG_DATA	Estrutura					Estrutura criada pelo usuário
		ALARME	BOOL		FALSE
		RUN	BOOL		FALSE
		MODO_OPERACAO	INT		0
		CICLO_CORRENTE	INT		0
		CICLO_TOTAL	INT		0
		ORDEM_SERVICO	UINT		0
		CODIGO_PRODUTO	UINT		0
		TEMPERATURA	REAL		0
		UMIDADE	REAL		0
		PRESSAO	REAL		0
		VAZAO	REAL		0
		VELOCIDADE	REAL		0

Declaração de variáveis

Nome	Tipo	Dimensão	Valor Inicial	Descrição
TEMPERATURA	REAL		0	Variável tipo REAL
ACIONAMENTO	INT	[0..3]	0	Vetor de INT
DATA_USER	REG_DATA			Estrutura criada pelo usuário
VET_USER	REG_DATA	[0..3]		Vetor de uma estrutura criada pelo usuário
MY_START	BOOL		FALSE	Ativação da função
FILE_FD	INT			Descritor do arquivo a ser realizado a leitura de dados
READ_FILE	FS_READ_DATA_FILE			Instancia do bloco “FS_READ_DATA_FILE”

Clique aqui para baixar a tabela de variáveis

Código ST

//======================================================
// Exemplo de leitura de uma variável REAL
//======================================================

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

// Exemplo de ativação do bloco de função FS_READ_DATA_FILE
READ_FILE(
  START      := my_START,       // [BOOL] Ativação da função
  FD         := File_FD,        // [INT] Descritor do arquivo
  DATA_LEN   := 4,              // [INT] Tamanho de dados a serem escritos no arquivo (bytes)
  DATA_VALUE := TEMPERATURA     // [ANY] Base de dados p/ armazenar os dados lidos do arquivo
  );

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

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

  // Testa código de retorno da execução da função
  if (READ_FILE.RESULT = HILS.SUCCESS) then
    // ... Função executada com sucesso
    // ... Leitura completa, variável atualizada
  else
    // ... Erro na execução da função
  end_if;

end_if;

(* ... *)

//======================================================
// Exemplo de leitura de um vetor de INT
//======================================================

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

// Exemplo de ativação do bloco de função FS_READ_DATA_FILE
READ_FILE(
  START      := my_START,       // [BOOL] Ativação da função
  FD         := File_FD,        // [INT] Descritor do arquivo
  DATA_LEN   := 8,              // [INT] Tamanho de dados a serem escritos no arquivo (bytes)
  DATA_VALUE := ACIONAMENTO     // [ANY] Base de dados p/ armazenar os dados lidos do arquivo
  );

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

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

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

end_if;

(* ... *)

//===========================================================
// Exemplo de leitura de uma estrutura criada pelo usuário
//===========================================================

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

// Exemplo de ativação do bloco de função FS_READ_DATA_FILE
READ_FILE(
  START      := my_START,       // [BOOL] Ativação da função
  FD         := File_FD,        // [INT] Descritor do arquivo
  DATA_LEN   := 32,             // [INT] Tamanho de dados a serem escritos no arquivo (bytes)
  DATA_VALUE := DATA_USER       // [ANY] Base de dados p/ armazenar os dados lidos do arquivo
  );

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

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

  // Testa código de retorno da execução da função
  if (READ_FILE.RESULT = HILS.SUCCESS) then
    // ... Função executada com sucesso
    // ... Leitura completa, estrutura atualizada
    (* ... *)
  else
    // ... Erro na execução da função
  end_if;

end_if;

(* ... *)

//======================================================================
// Exemplo de leitura de um vetor de uma estrutura criada pelo usuário
//======================================================================

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

// Exemplo de ativação do bloco de função FS_READ_DATA_FILE
READ_FILE(
  START      := my_START,       // [BOOL] Ativação da função
  FD         := File_FD,        // [INT] Descritor do arquivo
  DATA_LEN   := 128,            // [INT] Tamanho de dados a serem escritos no arquivo (bytes)
  DATA_VALUE := VET_USER        // [ANY] Base de dados p/ armazenar os dados lidos do arquivo
  );

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

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

  // Testa código de retorno da execução da função
  if (READ_FILE.RESULT = HILS.SUCCESS) then
    // ... Função executada com sucesso
    // ... Leitura completa, vetor de estrutura atualizado
    (* ... *)
  else
    // ... Erro na execução da função
  end_if;

end_if;

(* ... *)