FS_FORMAT

Formata o sistema de arquivos do SDCARD do controlador; uma vez iniciada, a formatação não pode ser interrompida e conclui sempre no controlador. É 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_FORMAT
         +--------------+
BOOL ----|START     DONE|---- BOOL
         |              |
         |        RESULT|---- INT
         +--------------+

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.

A entrada START deve ser colocada em TRUE para iniciar a execução; se voltar a FALSE antes da conclusão, o bloco é resetado — porém, uma vez iniciada, a formatação é sempre concluída pelo controlador. A saída DONE gera um pulso de um único ciclo de scan ao término; nesse instante consulte RESULT para o código de retorno da operação.

Importante

A formatação pode demorar de alguns segundos até unidades de minutos, conforme a capacidade do cartão de memória do SDCARD. Enquanto executa, o código de retorno é HILS.GL_CMD_PEND (RESULT = 16), indicando comando pendente na fila de processamento da CPU.

Parâmetros

Nome

Direção

Tipo

Padrão

Faixa / Unidade

Descrição

START

IN

BOOL

FALSE

—

Ativa a execução da função. Alterado para FALSE antes do fim, reseta o bloco.

DONE

OUT

BOOL

FALSE

—

Pulso de término (ativo por um único ciclo de scan). Consulte RESULT após o pulso.

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.RE_NOT_AVA). Códigos mais comuns deste bloco:

Código

Identificador

Significado

0

SUCCESS

Função executada com sucesso.

5

GL_INV_PAR

Parâmetro(s) inválido(s).

7

GL_UNA_CMD

Comando não disponível ou não implementado.

8

GL_INV_STT

Estado corrente inválido.

11

GL_CMD_CAN

Comando cancelado.

16

GL_CMD_PEND

Tratamento do comando pendente (formatação em andamento).

24

RE_NOT_AVA

Sem suporte para o sistema de arquivos ou SDCARD não detectado.

33

RE_NOT_INIT

Recurso não inicializado.

34

RE_BUSY

Recurso ocupado (em processamento).

167

FS_CORRUPT

Sistema de arquivo pode estar corrompido.

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

Pré-condições

  • O controlador deve ter suporte a sistema de arquivos no SDCARD (consulte o manual do controlador utilizado).

  • Um SDCARD deve estar presente e detectado.

Observações

  • Uma vez ativada, a formatação é sempre executada e concluída pelo controlador, mesmo que START seja colocado em FALSE antes da conclusão. Não é possível interromper uma formatação já iniciada.

  • Durante a execução, RESULT permanece em HILS.GL_CMD_PEND (16).

Ver também

FS_GET_INFO, FS_GET_SPACE, FS_CREATE_FILE

Exemplo

Clique aqui para baixar a tabela de variáveis

Código ST

VAR
    MY_START : BOOL := FALSE;   (* Ativação da função *)
    FORMAT   : HILS.FS_FORMAT;  (* Instância do bloco "FS_FORMAT" *)
END_VAR

// 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_FORMAT
FORMAT(
  START := MY_START      // [BOOL] Ativação da função
  );

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

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

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

end_if;