FS_CREATE_FILE

Cria um arquivo de dados vazio no sistema de arquivos do SDCARD, a partir do caminho completo informado em NAME; exige que o controlador tenha suporte a sistema de arquivos. É um bloco de função (mantém estado entre scans; requer instância).

Biblioteca: HI_STD · Namespace: HILS · Tipo: bloco de função

Bloco de função

            FS_CREATE_FILE
           +--------------+
  BOOL ----|START     DONE|---- BOOL
           |              |
           |        RESULT|---- INT
           |              |
STRING ----|NAME -------- |----
           +--------------+

Ao colocar START em TRUE, o bloco inicia a criação do arquivo cujo caminho completo é dado em NAME. Ao término, DONE gera um pulso de um único ciclo de scan e RESULT passa a conter o código de retorno da operação. Se START retornar a FALSE antes do fim da operação, o bloco é resetado.

O parâmetro NAME deve conter o caminho completo do arquivo, sempre iniciando pelo caractere / que identifica o diretório raiz (ex.: /Dados.dat, /Pasta_1/Dados.dat, /PASTA_1/PASTA_2/Receita.cfg). O tamanho máximo do caminho é de 64 caracteres.

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.

Parâmetros

Nome	Direção	Tipo	Padrão	Faixa / Unidade	Descrição
START	IN	BOOL	FALSE	—	Ativação da função. Em TRUE inicia a execução; em FALSE antes do término reseta o bloco.
NAME	IN_OUT	STRING	—	até 64 caracteres	Caminho completo (iniciado por `/`) com o nome do arquivo a ser criado.
DONE	OUT	BOOL	FALSE	—	Pulso de um ciclo de scan indicando o término da execução.
RESULT	OUT	INT	0	RET_CODE	Código de retorno da execução (ver Códigos de retorno).

Códigos de retorno

RESULT é do tipo RET_CODE. Use os identificadores com o namespace HILS (ex.: HILS.RC_FS_DUPLICATED). Códigos mais comuns deste bloco:

Código	Identificador	Significado
0	SUCCESS	Arquivo criado com sucesso.
5	GL_INV_PAR	Parâmetro(s) inválido(s).
10	GL_CMD_TMO	Timeout na execução do comando.
24	RE_NOT_AVA	Sem suporte para o sistema de arquivos ou SDCARD não detectado.
25	RE_INV_LEN	Tamanho especificado no parâmetro `NAME` inválido.
32	RE_WRITE_ERR	Falha no processo de escrita do recurso.
33	RE_NOT_INIT	Recurso não inicializado.
167	FS_CORRUPT	Sistema de arquivos pode estar corrompido.
173	FS_INVALIDNAME	Texto especificado no parâmetro `NAME` inválido.
175	FS_DUPLICATED	O arquivo já existe.
178	FS_INVALID_DIR	Diretório inválido ou inexistente.

Lista completa: RET_CODE - Códigos de retorno do firmware G5.

Pré-condições

O controlador deve possuir suporte a sistema de arquivos no SDCARD (consulte o manual do controlador utilizado).
NAME deve iniciar por / e não exceder 64 caracteres.
O diretório de destino informado em NAME deve existir.

Observações

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”

Ver também

FS_CREATE_DIR, FS_OPEN_FILE, FS_WRITE_DATA_FILE, FS_DELETE_FILE_DIR

Exemplo

Clique aqui para baixar a tabela de variáveis

Código ST

VAR
    FILE_DADOS  : STRING := '/DADOS.DAT'; (* Constante string com o nome do arquivo a ser criado na raiz *)
    MY_START    : BOOL := FALSE;          (* Ativação da função *)
    STR_X       : STRING;                 (* Nome do arquivo a ser criado, até 64 caracteres *)
    CREATE_FILE : HILS.FS_CREATE_FILE;    (* Instancia do bloco "FS_CREATE_FILE" *)
END_VAR

//============================================================================
// Exemplo de parametrização 1: Criar arquivo no diretório raiz
//============================================================================

// Preenche parâmetros para a chamada do bloco de função
STR_X    := FILE_DADOS;   // Nome do arquivo '/DADOS.DAT' na raiz

(* ... *)

//============================================================================
// Exemplo de parametrização 2: Criar arquivo dentro de um diretório
//============================================================================
// Cria o arquivo "Setup.cfg" dentro da pasta "/P1"

// Preenche parâmetros para a chamada do bloco de função
STR_X    := '/P1/Setup.cfg';   // Caminho do arquivo a ser criado

(* ... *)

//============================================================================
// Exemplo de parametrização 3: Criar arquivo dentro de diretórios
//============================================================================
// Cria o arquivo "Log.txt" dentro da pasta "/Info/LOG"

// Preenche parâmetros para a chamada do bloco de função
STR_X    := '/Info/LOG/Log.txt';   // Caminho do arquivo a ser criado

(* ... *)

//============================================================================
// Trata função FS_CREATE_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_CREATE_FILE
CREATE_FILE(
  START := MY_START,       // [BOOL] Ativação da função
  NAME  := STR_X           // [STRING] Caminho do arquivo a ser criado
  );

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

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

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

end_if;

(* ... *)