FS_WRITE_DATA_FILE

Realizar a escrita 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_WRITE ou OPEN_FILE_APPEND.

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_WRITE_DATA_FILE
         +-------------------+
BOOL ----|START          DONE|---- BOOL
         |                   |
 INT ----|FD           RESULT|---- INT
         |                   |
 INT ----|DATA_LEN           |
         |                   |
     ----|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 escrita de dados
DATA_LEN	Entrada	INT		0	Tamanho de dados a serem escritos no arquivo (bytes)
DATA_VALUE	Entrada/Saída	ANY			Estrutura com os dados a serem escritos no arquivo
DONE	Saída	BOOL		FALSE	Pulso de fim de execução da função
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. Pode ser obtido no resultado da função FS_OPEN_FILE.
DATA_VALUE	Estrutura com os dados a serem escritos no 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]

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.
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.
177	HILS.RC_FS_INVALID_HANDLE	Handle de arquivo aberto inválido.

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			Variável tipo REAL
ACIONAMENTO	INT	[0..3]		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 escrita de dados
WRITE_FILE	FS_WRITE_DATA_FILE			Instância do bloco “FS_WRITE_DATA_FILE”

Clique aqui para baixar a tabela de variáveis

Código ST

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

   // Preenche parâmetro a ser salvo no arquivo
   TEMPERATURA := 25.5; // [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_WRITE_DATA_FILE
   WRITE_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/ obter os dados a serem salvos no arquivo
     );

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

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

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

   end_if;

   (* ... *)

   //======================================================
   // Exemplo de escrita de um vetor de INT
   //======================================================

   // Preenche parâmetro a ser salvo no arquivo
   //
   // OBS.: Este vetor possui um tamanho de 8 bytes

   ACIONAMENTO[0] := 100; // [INT]
   ACIONAMENTO[1] := 200; // [INT]
   ACIONAMENTO[2] := 300; // [INT]
   ACIONAMENTO[3] := 400; // [INT]

   // OBS: Todos os valores dentro da estrutura são escritos no arquivo

   (* ... *)

   // 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_WRITE_DATA_FILE
   WRITE_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/ obter os dados a serem salvos no arquivo
     );

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

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

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

   end_if;

   (* ... *)

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

   // Preenche parâmetros a serem salvos no arquivo
   //
   // OBS.: Esta estrutura possui um tamanho de 32 bytes

   DATA_USER.ALARME          := TRUE   // [BOOL]
   DATA_USER.RUN             := TRUE   // [BOOL]
   DATA_USER.MODO_OPERACAO   := 1      // [INT]
   DATA_USER.CICLO_CORRENTE  := 1      // [INT]
   DATA_USER.CICLO_TOTAL     := 1      // [INT]
   DATA_USER.ORDEM_SERVICO   := 10     // [UINT]
   DATA_USER.CODIGO_PRODUTO  := 10     // [UINT]
   DATA_USER.TEMPERATURA     := 1.11   // [REAL]
   DATA_USER.UMIDADE         := 1.11   // [REAL]
   DATA_USER.PRESSAO         := 1.11   // [REAL]
   DATA_USER.VAZAO           := 1.11   // [REAL]
   DATA_USER.VELOCIDADE      := 1.11   // [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_WRITE_DATA_FILE
   WRITE_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/ obter os dados a serem salvos no arquivo
     );

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

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

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

   end_if;

   (* ... *)

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

   // Preenche parâmetros a serem salvos no arquivo
   //
   // OBS.: Cada estrutura possui um tamanho de 32 bytes, e portanto um vetor
   //       de 4 estrutura possui tamanho total de 128 bytes

   VET_USER[0].ALARME          := TRUE   // [BOOL]
   VET_USER[0].RUN             := TRUE   // [BOOL]
   VET_USER[0].MODO_OPERACAO   := 1      // [INT]
   VET_USER[0].CICLO_CORRENTE  := 1      // [INT]
   VET_USER[0].CICLO_TOTAL     := 1      // [INT]
   VET_USER[0].ORDEM_SERVICO   := 10     // [UINT]
   VET_USER[0].CODIGO_PRODUTO  := 10     // [UINT]
   VET_USER[0].TEMPERATURA     := 1.11   // [REAL]
   VET_USER[0].UMIDADE         := 1.11   // [REAL]
   VET_USER[0].PRESSAO         := 1.11   // [REAL]
   VET_USER[0].VAZAO           := 1.11   // [REAL]
   VET_USER[0].VELOCIDADE      := 1.11   // [REAL]

   VET_USER[1].ALARME          := TRUE   // [BOOL]
   VET_USER[1].RUN             := TRUE   // [BOOL]
   VET_USER[1].MODO_OPERACAO   := 2      // [INT]
   VET_USER[1].CICLO_CORRENTE  := 2      // [INT]
   VET_USER[1].CICLO_TOTAL     := 2      // [INT]
   VET_USER[1].ORDEM_SERVICO   := 20     // [UINT]
   VET_USER[1].CODIGO_PRODUTO  := 20     // [UINT]
   VET_USER[1].TEMPERATURA     := 2.22   // [REAL]
   VET_USER[1].UMIDADE         := 2.22   // [REAL]
   VET_USER[1].PRESSAO         := 2.22   // [REAL]
   VET_USER[1].VAZAO           := 2.22   // [REAL]
   VET_USER[1].VELOCIDADE      := 2.22   // [REAL]

   VET_USER[2].ALARME          := TRUE   // [BOOL]
   VET_USER[2].RUN             := TRUE   // [BOOL]
   VET_USER[2].MODO_OPERACAO   := 3      // [INT]
   VET_USER[2].CICLO_CORRENTE  := 3      // [INT]
   VET_USER[2].CICLO_TOTAL     := 3      // [INT]
   VET_USER[2].ORDEM_SERVICO   := 30     // [UINT]
   VET_USER[2].CODIGO_PRODUTO  := 30     // [UINT]
   VET_USER[2].TEMPERATURA     := 3.33   // [REAL]
   VET_USER[2].UMIDADE         := 3.33   // [REAL]
   VET_USER[2].PRESSAO         := 3.33   // [REAL]
   VET_USER[2].VAZAO           := 3.33   // [REAL]
   VET_USER[2].VELOCIDADE      := 3.33   // [REAL]

   VET_USER[3].ALARME          := TRUE   // [BOOL]
   VET_USER[3].RUN             := TRUE   // [BOOL]
   VET_USER[3].MODO_OPERACAO   := 4      // [INT]
   VET_USER[3].CICLO_CORRENTE  := 4      // [INT]
   VET_USER[3].CICLO_TOTAL     := 4      // [INT]
   VET_USER[3].ORDEM_SERVICO   := 40     // [UINT]
   VET_USER[3].CODIGO_PRODUTO  := 40     // [UINT]
   VET_USER[3].TEMPERATURA     := 4.44   // [REAL]
   VET_USER[3].UMIDADE         := 4.44   // [REAL]
   VET_USER[3].PRESSAO         := 4.44   // [REAL]
   VET_USER[3].VAZAO           := 4.44   // [REAL]
   VET_USER[3].VELOCIDADE      := 4.44   // [REAL]

   // OBS: Todos os valores dentro da estrutura são escritos no arquivo

   (* ... *)

   // 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_WRITE_DATA_FILE
   WRITE_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/ obter os dados a serem salvos no arquivo
     );

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

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

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

   end_if;

   (* ... *)