FS_FILE_INFO
Obter informações de um arquivo no sistema de arquivos do SDCARD do controlador.
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_FILE_INFO
+-----------------+
BOOL ----|START DONE|---- BOOL
| |
| RESULT|---- INT
| |
| ATR|---- WORD
| |
| RD_ACCESS|---- INT
| |
| WR_ACCESS|---- INT
| |
STRING ----|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 obter informações |
||
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 |
|
ATR |
Saída |
WORD |
0 |
Atributos do arquivo existente |
|
RD_ACCESS |
Saída |
INT |
0 |
Número total de acessos atualmente abertos para leitura |
|
WR_ACCESS |
Saída |
INT |
0 |
Número total de acessos atualmente abertos para escrita |
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. |
NAME |
Este parâmetro deve ser especificado com o caminho completo para o nome do arquivo a obter informações. 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 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 [4] |
ATR |
Atributos do arquivo existente [6] |
RD_ACCESS |
Número total de acessos atualmente abertos para leitura |
WR_ACCESS |
Número total de acessos atualmente abertos para escrita |
Segue alguns exemplos de códigos de retorno:
RESULT |
LABEL [5] |
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. |
33 |
HILS.RE_NOT_INIT |
Recurso não inicializado. |
167 |
HILS.RC_FS_CORRUPT |
Sistema de arquivo pode estar corrompido. |
174 |
HILS.RC_FS_NOTFOUND |
O arquivo não foi encontrado ou foi especificado um diretório. |
Este LABEL pode ser utilizado no código fonte pois está definido no tipo RET_CODE disponível na biblioteca HI_STD |
Os atributos retornados estão descritos abaixo.
Atributos no sistema de arquivos G5
Os atributos são mapeados em bits onde o significado de cada bit é descrito na tabela a seguir.
BIT |
Descrição do Atributo |
0 |
Arquivo oculto. |
1 |
Arquivo com acesso apenas de leitura. |
3 |
Arquivo de sistema. Gerenciado pelo HIstudio. |
5 |
Arquivo de projeto do HIstudio. |
7 |
Arquivo de dados gerênciado pela aplicação do PLC. |
10 |
Atributo de diretório. |
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 obter informações no raiz |
MY_START |
BOOL |
FALSE |
Ativação da função |
|
FILE_NAME |
STRING |
Nome do arquivo a ser obtido as informações, limitado a 64 caracteres |
||
FILE_INFO |
FS_FILE_INFO |
Instancia do bloco “FS_FILE_INFO” |
Código ST
//==========================================================
// Exemplo de parametrização 1: Obter informações de arquivo no diretório raiz
//==========================================================
// Preenche parâmetros para a chamada do bloco de função
FILE_NAME := FILE_DADOS; // Nome do arquivo '/DADOS.DAT' no raiz do sistema de arquivo
(* ... *)
//==========================================================
// Exemplo de parametrização 2: Obter informações de arquivo dentro de um diretório
//==========================================================
// Informações do arquivo "Setup.cfg" dentro da pasta "/P1"
// Preenche parâmetros para a chamada do bloco de função
FILE_NAME := ´/P1/Setup.cfg'; // Caminho completo com o nome do arquivo a obter informações
(* ... *)
//==========================================================
// Exemplo de parametrização 3: Obter informações de arquivo dentro de diretórios
//==========================================================
// Informações do arquivo "Log.txt" dentro das pastas "/Info/LOG"
// Preenche parâmetros para a chamada do bloco de função
FILE_NAME := ´/Info/LOG/Log.txt'; // Caminho completo com o nome do arquivo a obter informações
(* ... *)
//============================================================================
// Trata função FS_FILE_INFO
//============================================================================
// 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_FILE_INFO
FILE_INFO(
START := MY_START, // [BOOL] Ativação da função
NAME := FILE_NAME // [STRING] Caminho completo com o nome do arquivo a obter informações
);
// Aguarda término da execução da função do sistema de arquivos
if (FILE_INFO.DONE) then
MY_START := FALSE; // Reseta ativação da função
// Testa código de retorno da execução da função
if (FILE_INFO.RESULT = HILS.SUCCESS) then
// ... Função executada com sucesso
// Informações do arquivo disponíveis em :
//
// FILE_INFO.ATR Atributos do arquivo existente
// FILE_INFO.RD_ACCESS Número total de acessos atualmente abertos para leitura
// FILE_INFO.WR_ACCESS Número total de acessos atualmente abertos para escrita
else
// ... Erro na execução da função
end_if;
end_if;
(* ... *)