RESTORE_COMM

Restaura, a partir da flash, as configurações salvas de um canal de comunicação especificado; exige uma transição de subida em START para executar. É 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

             RESTORE_COMM
          +----------------+
 BOOL ----|START   COMPLETE|---- BOOL
          |                |
USINT ----|CHANN     RESULT|---- UINT
          +----------------+

O bloco necessita de uma transição de subida em START para executar o comando. A saída COMPLETE sinaliza o fim da execução; nesse instante RESULT indica o resultado da operação (SUCCESS = 0 quando a configuração foi restaurada com sucesso).

O canal de comunicação é especificado em CHANN por um identificador (valor numérico) do tipo COMM_CHAN_ID (namespace HILS). Cada equipamento suporta apenas um subconjunto — consulte o manual do equipamento.

Identificador	Ident.	Descrição
`HILS.COM1_PORT_ID` .. `COM8_PORT_ID`	0 .. 7	Canais seriais COM1 a COM8.
`HILS.SOCK0_PORT_ID` .. `SOCK7_PORT_ID`	8 .. 15	Controlador Ethernet 1: sockets 0 a 7.
`HILS.ETH2_SOCK0_PORT_ID` .. `ETH2_SOCK7_PORT_ID`	16 .. 23	Controlador Ethernet 2: sockets 0 a 7.

Parâmetros

Nome	Direção	Tipo	Padrão	Faixa / Unidade	Descrição
START	IN	BOOL	FALSE	—	Transição de subida inicia a restauração da configuração salva em flash.
CHANN	IN	USINT	0	0 .. 23 (COMM_CHAN_ID)	Identificador do canal de comunicação a ser restaurado.
COMPLETE	OUT	BOOL	FALSE	—	Indica o fim da execução do comando.
RESULT	OUT	UINT	0	RET_CODE	Código de retorno da operação (ver Códigos de retorno).

Códigos de retorno

RESULT é do tipo RET_CODE. A fonte documenta o valor de forma genérica:

0 ( HILS.SUCCESS ): configuração restaurada com sucesso.
? 0: falha na execução, o valor corresponde ao respectivo código de erro.

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

Pré-condições

O canal indicado em CHANN deve existir no equipamento (ver a tabela de identificadores acima, cada equipamento expõe apenas um subconjunto).
Deve existir uma configuração previamente salva em flash para o canal.

Observações

O comando só é disparado por transição de subida em START, mantê-lo em TRUE não reexecuta a restauração.
RESULT só é válido quando COMPLETE estiver ativo.

Ver também

CONFIG_SERIAL

Exemplo

Clique aqui para baixar a tabela de variáveis

Código ST

VAR
    CFG_RESTORE   : HILS.RESTORE_COMM; (* Instancia para restaurar a configuracao em flash do canal *)
    START_RESTORE : BOOL := FALSE;
    RET_REST      : UINT := 0;
    COUNT_REST    : USINT := 0;
END_VAR

(* Recupera valores salvos na flash para um dado canal *)
CFG_RESTORE(
  START  := START_RESTORE,
  CHANN  := HILS.COM1_PORT_ID
  );

(* Aguarda o fim da restauracao *)
IF (CFG_RESTORE.COMPLETE) THEN
  RET_REST := CFG_RESTORE.RESULT;
  COUNT_REST := COUNT_REST + 1;
  START_RESTORE := FALSE;
END_IF;