Ganter Lab
Entrar Baixar

As ferramentas, área por área

O que cada ferramenta que um agente pode chamar faz, agrupada pelo interruptor de capacidade que a anuncia.

Ver como Markdown

Os nomes de ferramenta são identificadores estáveis em snake_case. Os erros são estruturados e acionáveis: uma chamada que falha devolve o que deu errado mais uma dica nomeando a ferramenta ou o passo que resolve, para que um agente se corrija sozinho em vez de adivinhar. Quando a área Backups (gerenciar) está ligada, o servidor também instrui os agentes a criar um backup de configuração antes de fazer mudanças de configuração. Qual dessas listas um agente de fato vê está em o que cada área libera.

Connector: leitura

Ferramenta O que faz
connector_browse Lista a árvore configurada com a saúde ao vivo: o Modbus RTU como driver, linha serial, dispositivo, tag; todo outro driver como driver, dispositivo, tag, com a pasta de cada dispositivo ao lado. Revela os apelidos de tag (Driver.Folders….Device.Tag) que o tag_read, o tag_write e as expressões da Logic usam. Os apelidos são nulos enquanto o servidor embutido está parado.
tag_read Lê os valores ao vivo de uma tag pelo apelido: o valor bruto no nível do dispositivo, o valor de engenharia depois da cadeia de conversão, a qualidade e os dois carimbos de tempo.

Connector: configuração

Ferramenta O que faz
driver_capabilities Lista todo driver que a aplicação consegue atender, com os campos de conexão de que um dispositivo precisa, o modelo de endereçamento de tag (endereço em texto livre e/ou campos tipados), o suporte e os parâmetros de descoberta, as faixas de tempo e os tipos de valor suportados. O mapa que um agente lê antes do device_upsert ou do tag_upsert.
serial_line_list Lista toda linha serial Modbus RTU persistida, incluídas as desabilitadas e as vazias, com o id estável dela e os valores de tempo configurado, automático e efetivo.
serial_line_upsert Cria uma linha Modbus RTU ou atualiza uma pelo id estável. O nome e o estado de habilitação mudam a qualquer momento; o intervalo mínimo entre transações também muda com a linha habilitada; porta serial, velocidade em baud, formato serial e timeout de resposta só mudam enquanto a linha persistida está desabilitada.
serial_line_delete Exclui uma linha pelo id estável. Uma linha que ainda contém dispositivos é recusada, a menos que a chamada autorize explicitamente excluir todo dispositivo filho e as tags deles.
device_upsert Cria ou atualiza um dispositivo por driver + nome (o driver é imutável depois da criação). Só os parâmetros fornecidos mudam; os campos de conexão são por driver; mover um dispositivo para uma pasta reescreve toda referência aos endereços antigos das tags dele. A mudança é reconciliada no servidor em execução na hora.
device_delete Exclui um dispositivo e todas as tags dele; reconciliado no servidor em execução na hora.
tag_upsert Cria ou atualiza uma tag num dispositivo. O endereçamento é específico do driver (endereço em texto livre e/ou campos tipados); a resposta ecoa o endereço de barramento montado e o apelido para o tag_read. Inclui os estágios de leitura inválida (ação de NaN e apresentação de falha de leitura) em tags numéricas.
tag_delete Exclui uma tag; reconciliado na hora.

Logic: leitura

Ferramenta O que faz
logic_browse Navega o espaço de endereços enraizado da Logic, a mesma árvore com pontos que toda expressão lê: System, Server, Connector, Variables, Alarms, Process e Assets. As pastas do operador são níveis de endereço de verdade; os pontos filhos incluem o valor ao vivo e a qualidade deles.
logic_read Lê um ponto pelo endereço com pontos dele (por exemplo Variables.Setpoint) e devolve o valor ao vivo e a qualidade.

Logic: configuração

As inserções e atualizações são parciais (os parâmetros omitidos mantêm o valor deles) e todo rascunho fundido passa pela mesma validação que os editores da Logic aplicam; um rascunho inválido é rejeitado e nada fica aplicado pela metade.

Ferramenta O que faz
variable_upsert Cria ou atualiza uma variável: Expressão (uma única expressão JavaScript somente leitura sobre o espaço de endereços) ou Memória (um valor gravável, opcionalmente retentivo). O nome é a chave e, higienizado, o endereço; o parâmetro de pasta a arquiva, reescrevendo toda referência ao endereço antigo.
variable_delete Exclui uma variável pelo caminho, com o valor retido dela. Os canais vinculados a ela perdem a origem.
action_upsert Cria ou atualiza uma ação: um bloco de instruções JavaScript com exatamente dois verbos de escrita, a atribuição a variável de memória e a escrita de tag em valor de engenharia. Validada estaticamente, nunca executada no momento de salvar.
action_delete Exclui uma ação pelo nome. Os gatilhos ligados a ela ficam ociosos.
trigger_upsert Cria ou atualiza um gatilho de intervalo: a cada intervalMs (mínimo 100) a ação ligada dispara na fila da lógica; um disparo durante uma execução pendente é pulado. A ligação com a ação é frouxa e por nome.
trigger_delete Exclui um gatilho; a ação ligada fica intocada.
alarm_upsert Cria ou atualiza um alarme: uma expressão de condição booleana, a prioridade (Crítica/Alta/Média/Baixa), os atrasos de liga e de desliga, se o reconhecimento é exigido, e o estilo de anunciação. Salvar uma condição ou um tempo alterado repõe a máquina de estados em execução.
alarm_delete Exclui um alarme pelo caminho; uma anunciação ativa é encerrada primeiro.
logic_folder_upsert Cria, renomeia ou rearquiva uma pasta organizadora de uma seção (Variables, Alarms, Actions, Triggers; no máximo três níveis). Em Variables e Alarms, o caminho da pasta faz parte do endereço, então renomeações e movimentações reescrevem toda expressão, script, condição e vínculo de dashboard abaixo dela.
logic_folder_delete Exclui uma pasta. Nada do que ela continha é destruído: itens e subpastas são rearquivados um nível acima e as referências são reescritas; uma colisão de nome no destino recusa a exclusão.

Logic: operação

Todas estas pegam a fila de lógica única e são registradas com a origem MCP.

Ferramenta O que faz
variable_write Escreve um valor numa variável de Memória (convertido para o tipo de saída dela, retido quando ela é retentiva). Variáveis de expressão são calculadas e recusam escritas.
tag_write Escreve um valor de engenharia numa tag gravável: revertido pela cadeia de conversão da tag, convertido para o tipo do dispositivo e escrito no equipamento. Tags somente leitura e drivers somente leitura são recusados com o motivo.
action_run Executa uma ação na fila da lógica e devolve o resultado e a duração dela. Uma ação desabilitada falha sem rodar.
alarm_ack Reconhece um alarme, a resposta do operador; não faz nada quando nada está pendente.
alarm_ack_all Reconhece todo alarme que aguarda uma resposta, como um item só da fila da lógica, com cada transição registrada.

Servidor: leitura

Ferramenta O que faz
server_status Relata a saúde do servidor OPC UA embutido: estado de execução, tempo no ar, URL do endpoint, sessões de cliente conectadas e o tamanho do espaço de endereços configurado.

Servidor: operação

Ferramenta O que faz
server_start Inicia o servidor OPC UA embutido, materializando a configuração atual. Não faz nada quando ele já está rodando.
server_stop Para o servidor com elegância. A comunicação com dispositivos, as leituras de tag e o espaço de endereços ao vivo da Logic param até ele iniciar de novo.
server_restart Parar e então iniciar, rematerializando a configuração; a recarga completa depois de um lote de mudanças.
connector_refresh Reconcilia incrementalmente o servidor em execução com os dispositivos configurados (acrescenta, remove, recria) sem um reinício completo; o jeito mais leve de aplicar mudanças.
device_discover Roda a varredura de descoberta de dispositivos de um driver e devolve candidatos com as tags deles, sem persistir nada. Só participam drivers cujo protocolo suporta uma varredura de verdade; candidatos que já existem são marcados como tal.

Logs: leitura

Ferramenta O que faz
logs_read Lê o feed de log ao vivo de todo o programa (o mesmo do Console de Eventos), filtrado por severidade mínima (Debug/Information/Warning/Error, padrão Information), área (App/Server/Connector/Logic/Process/Dashboard/Agent/Licensing), componente e um trecho de texto contextual; devolve os acertos mais novos (padrão 100, no máximo 500). As ações de agente são registradas sob a área Agent.
event_history_read Lê a linha do tempo persistente de eventos operacionais, que sobrevive a reinícios: transições de alarme, de ocorrência e de intertravamento. Filtre por tipo (Alarm/Occurrence/Interlock), por um período UTC inclusivo e por um nível (prioridade de alarme, severidade de ocorrência ou transição de intertravamento); do mais novo para o mais velho, padrão 100, no máximo 500. Estritamente somente leitura: nada consegue limpar nem excluir entradas do diário.

Process: leitura

Ferramenta O que faz
process_models Lista os modelos do Process por inteiro: canais, grupos compartilhados, unidades com a ligação resolvida e o estado de execução, procedimentos, painéis, receitas, avaliações, ocorrências, mais a biblioteca global de modelos de documento de relatório. O mapa que um agente lê antes de iniciar qualquer coisa.
process_runs Lista execuções, da mais recente para a mais antiga: id, nome, estado, veredito, o que rodou, quem a iniciou (Estação/Usuário/Automação/Agente), tempos e progresso de ciclos. Pode ser restrita às execuções ativas e limitada (padrão 50).
process_run Lê o registro congelado completo de uma execução pelo id: instantâneo, metadados, critérios julgados com contagens de amostras, episódios e eventos de ocorrência, escritas de receita como executadas, comentários, e os artefatos congelados de relatório e etiqueta com as tentativas de impressão deles. Opcionalmente calcula a contagem de linhas e a faixa de tempo do datalog.
unit_status Relata o estado ao vivo de uma unidade: se ela está em execução (com a execução ativa) e o valor de engenharia atual atrás de cada canal, lido sem gravar.

Process: configuração

Ferramenta O que faz
process_view_configure Configura exatamente um painel de um modelo: o ícone desenhado ao lado dele e se ele fica na página View. Nada mais do agregado do Process é gravável por MCP; o resto é editado na página Process.

Process: operação

Execuções iniciadas, encerradas ou comentadas por um agente gravam Agente como o autor, nunca o operador que por acaso está autenticado na bancada.

Ferramenta O que faz
process_snapshot Captura uma linha de datalog numa unidade fora de um procedimento. Toda chamada cria uma execução Instantânea nova e já concluída nos Históricos, sem avaliação (veredito None).
process_evaluate Captura uma linha de datalog e a julga com uma avaliação; cria uma execução Instantânea concluída e devolve o veredito dela.
process_recipe_apply Aplica uma receita Instantânea uma vez numa unidade, pelo funil de escrita e pelas travas de origem do Process. Comanda equipamento; não cria execução (as escritas são registradas). Receitas temporizadas são recusadas.
process_start Inicia uma execução de procedimento numa unidade, com um objeto JSON para os campos de metadados do procedimento. Metadados obrigatórios ausentes ou inválidos, uma unidade já em execução, ou um conflito de trava de canal compartilhado recusam a partida. Devolve o id da execução nova.
process_stop Encerra uma execução em andamento: bloco de finalização, instantâneo congelado no histórico, veredito calculado.
process_hold Pausa o perfil temporizado de uma execução no último setpoint; o datalog continua gravando.
process_resume Retoma o perfil temporizado de uma execução pausada.
process_abort Aborta uma execução a partir de Em execução ou Pausada: a finalização roda, o instantâneo é escrito, o estado vira Abortada e o veredito, NOK.
process_comment Acrescenta um comentário com carimbo de tempo no arquivo de uma execução: uma nota na linha do tempo enquanto ela está ativa, uma nota pós-execução depois.
process_report Gera (ou regera) o relatório em PDF de uma execução terminada e devolve o caminho do arquivo dele. Um modelo de documento nomeado, vindo da biblioteca global, prevalece sobre o configurado no procedimento; sem nenhum dos dois, vale o layout padrão com todas as seções. Recusada enquanto a execução está ativa.
process_run_delete Exclui permanentemente uma execução gravada: o ponteiro dela no índice do histórico e o arquivo de banco por execução. Recusada enquanto ela está ativa; a configuração fica intocada.

Dashboard: configuração

Ferramenta O que faz
dashboard_list Lista dashboards (ou, nomeando um modelo, as telas daquele modelo): tamanho da grade, pasta, ícone, sinalizador de inicialização, visibilidade por papel e todo componente com a posição, a camada e o JSON de propriedades dele, mais toda rede de ligações persistida. Também devolve o catálogo de tipos de componente, com o tamanho padrão e o conjunto de propriedades padrão de cada tipo.
dashboard_upsert Cria ou atualiza um dashboard pelo nome: tamanho da grade (um encolhimento que deixaria um componente órfão é rejeitado), pasta e ícone na lista de Visualização, sinalizador de inicialização, visibilidade da barra de status em tela cheia, e visibilidade por papel. Nomear um modelo endereça as telas daquele modelo em vez disso. As páginas de dashboard abertas refletem a mudança ao vivo.
dashboard_delete Exclui um dashboard e os componentes dele pelo nome; nomear um modelo exclui a tela daquele modelo em vez disso.
component_upsert Acrescenta um componente por tipo (colocado na primeira célula livre, com o tamanho padrão do tipo, salvo instrução em contrário) ou atualiza um pelo id. A colocação precisa ficar dentro da grade; a sobreposição é permitida, com a camada z decidindo a ordem de desenho; o JSON de propriedades é o conjunto tipado do tipo. Nomear um modelo endereça as telas daquele modelo em vez disso, então uma tela criada lá pode ser diagramada aqui.
component_delete Remove um componente pelo id; nomear um modelo endereça as telas daquele modelo em vez disso.
connection_upsert Liga dois terminais de Símbolo com uma rede de ligações tipada, resolvendo tipo, papel e direção pelo catálogo de símbolos exatamente como o editor de canvas faz. Pontas que resolvem para tipos diferentes falham, a menos que uma ligação indefinida seja explicitamente permitida; um ancoradouro que já carrega uma ligação é rejeitado. Nomear um modelo endereça as telas daquele modelo em vez disso.
connection_delete Remove uma rede de ligações pelo id e pela revisão esperada, então uma exclusão desatualizada é rejeitada em vez de atropelar uma edição mais nova; nomear um modelo endereça as telas daquele modelo em vez disso.

Interface: automatizar

Estas ferramentas conduzem a janela real da aplicação; elas existem para que um agente consiga verificar a interface que o operador vê, e não uma simulação dela. As interações são despachadas ao shell ao vivo, então a conduta pretendida é seguir cada gesto com um ui_screenshot e observar o efeito, e acertos ambíguos voltam como listas de candidatos, em vez de um clique adivinhado.

Ferramenta O que faz
ui_state Relata o estado do shell: página ativa, páginas disponíveis, tema, tamanho e visibilidade da janela, e o endereço de loopback em que esta instância serve a interface dela. A chamada de orientação, antes de qualquer outra coisa.
ui_navigate Ativa uma página do shell pelo nome estável dela, que é inglês em toda estação: View, Process, Logic, Connector, Users, Validation, Events, Agent, Settings, Account. O rótulo que o trilho de navegação desenha na língua da estação também é aceito.
ui_screenshot Captura a janela como ela aparece na tela num arquivo PNG e devolve o caminho absoluto dele; restaura a janela primeiro quando ela está escondida na área de notificação. Pode capturar uma região de tela nomeada (uma área data-doc-region única e visível) em vez da janela inteira, e uma região ausente, escondida ou ambígua falha listando as regiões visíveis, em vez de cair em silêncio para uma captura completa.
ui_scroll Rola a região de rolagem principal da página ativa até o topo, até o fim ou por páginas de viewport, devolvendo os deslocamentos, para que uma página longa possa ser varrida.
ui_set_theme Aplica o tema (Sistema, Claro ou Escuro). Isso persiste exatamente como o menu de tema da barra de título, então um agente bem-comportado restaura o valor original ao terminar.
ui_resize Redimensiona a janela restaurada em unidades independentes de dispositivo, aparada no mínimo da janela; útil para auditar layouts compactos.
ui_click Clica no botão, hiperlink, caixa de seleção ou interruptor visível cujo texto casa; caixas de seleção e interruptores são achados pelo rótulo do campo deles, e o resultado relata o estado em que ficaram. A ambiguidade devolve os candidatos, em vez de escolher um.
ui_set_text Escreve um valor numa caixa de texto identificada pelo rótulo do campo dela, confirmando o vínculo como digitar faria.
ui_select Seleciona um item pelo texto visível: um caminho separado por barras percorre uma árvore, expandindo pelo caminho; um segmento único também casa com itens de lista, de aba e de lista suspensa e com linhas de grade da página atual.

Backups: gerenciar

Ferramenta O que faz
backup_create Cria um instantâneo online do banco de configuração na pasta de backups, com uma nota opcional. As execuções gravadas vivem fora da configuração e nunca são tocadas por backup nem por restauração.
backup_list Lista os backups de configuração (nome do arquivo, hora de criação, tamanho, nota) mais qualquer restauração já agendada.

Deliberadamente não existe ferramenta de excluir backup: a retenção é só do operador, na página Backups.

Backups: restaurar

Ferramenta O que faz
backup_restore Agenda um backup para substituir a configuração atual no próximo início da aplicação. Nada muda na aplicação em execução e a ferramenta nunca a reinicia; a configuração que será substituída recebe um instantâneo automático antes, e o operador pode cancelar a restauração pendente pelas Configurações até o reinício. Recusada enquanto uma gravação está ativa.

Configurações: gerenciar

Ferramenta O que faz
settings_read Lê as preferências de exibição e de ciclo de vida da estação: formatos de data, hora e número, casas decimais, tema, e os sinalizadores de fechar para a área de notificação e de relatório de falha.
localization_set Atualiza as preferências de exibição (parcial: os parâmetros omitidos ficam). Só exibição: o armazenamento, a entrada e saída dos drivers e as gravações usam sempre o formato invariante.
asset_list Lista os ativos do usuário (imagens, ícones, cores) com ids, valores e caminhos.
asset_import Importa um PNG ou JPG de um caminho de arquivo local para a biblioteca de ativos que a aplicação é dona e devolve o id do ativo novo. Os bytes são copiados, então o arquivo de origem pode ser movido depois.
symbol_validate Valida conteúdo de símbolo em linha (SVG cru ou um pacote v2) sem persistir nada: uma execução em seco da importação exata, devolvendo erros, avisos do higienizador e um resumo do que foi reconhecido. A descrição da ferramenta carrega o contrato de símbolo portátil completo.
symbol_import Importa conteúdo de símbolo em linha como um ativo de símbolo de usuário novo e devolve o id dele e a referência user:<guid>. Sempre cria um ativo novo; um nome que colide recebe sufixo automático.