StartPing

> [HTML Version](startping.html)

**Синтаксис**

````
procedure StartPing(AHost: string; ATimeout: Integer; const ASender: TObject = nil);

````
**Описание**

Запускает пинг хоста AHost. ATimeout - максимальное время ожидания ответа от хоста в миллисекундах. ASender - необязательный параметр, с помощью которого можно привязать к пингу какой-либо объект. Указанный хост будет пинговаться до тех пор, пока проект активен на сервере (при остановке проекта пинг прекратится). Результат пинга можно получить в скрипте с типом события "[Изменился пинг](changed-ping.md)".

**Примеры скриптов**

**(./images/tog_code_1.png) 1. Простой пинг с проверкой результата [(./images/link.png)](https://simple-scada.com/help/script/startping.html?anchor=ping1)**

Сначала пинг нужно запустить, например при старте проекта. [Создадим скрипт](via-script-editor.md) с типом события "[Запуск проекта](launch-project.md)" и кодом:

````
begin  
  // запускаем пинг хоста "192.168.1.1" с максимальным  
  // ожиданием ответа не более 3 сек.   
  StartPing('192.168.1.1', 3000);  
end.

````
Теперь [создадим скрипт](via-script-editor.md) с типом события "Изменился пинг", в котором будем отображать состояние пинга:

````
begin  
  // выводим результат пинга в компонент "Text1"  
  if PingData.Result then   
    Text1.Text := 'Хост ' + PingData.Host + ' доступен\!'  
  else  
    Text1.Text := 'Хост ' + PingData.Host + ' не доступен\!'  
end.
````

````
**(./images/tog_code_1.png) 2. Пинг нескольких устройств с привязкой к объектам одного типа [(./images/link.png)](https://simple-scada.com/help/script/startping.html?anchor=ping2)**

Пусть в проекте есть три фигуры "Shape1", "Shape2" и "Shape3" и нам нужно выполнять пинг трех разных устройств. Результат каждого пинга нужно отобразить на соответствующей фигуре, меняя ее цвет на зеленый, если пинг прошел успешно и на красный, если пинг не удался. Сначала [создадим скрипт](via-script-editor.md) с типом события "Запуск проекта", в котором запустим пинг трех устройств. Причем, каждый пинг свяжем со своей фигурой:

````
begin  
  // запускаем три пинга. Каждый пинг связываем с соответствующей фигурой  
  StartPing('192.168.1.1', 3000, Shape1);  
  StartPing('192.168.1.2', 3000, Shape2);  
  StartPing('192.168.1.3', 3000, Shape3);  
end.

````


Далее, [создадим скрипт](via-script-editor.md) с типом события "Изменился пинг" и реализуем смену цвета в зависимости от результатов пинга:

````
begin  
  // прерываем выполнение если пинг не связан с объектом  
  if PingData.Sender = nil then Exit;  
  // прерываем выполнение если пинг связан НЕ с объектом фигура (TM\_Shape)  
  if not (PingData.Sender is TM\_Shape) then Exit;  
  
  // далее работаем с "PingData.Sender" как с фигурой  
  with PingData.Sender as TM\_Shape do  
    if PingData.Result then   // если пинг прошел удачно  
      Color := clGreen        // меняем цвет фигуры на зеленый  
    else                      // если пинг не удался  
      Color := clRed;         // меняем цвет фигуры на красный  
end.

````
В этом коде мы сначала убедились что пинг связан с каким-то объектом. Затем убедились, что этот объект является фигурой. Наконец, начали работать с объектом как с фигурой. Эти проверки обязательны, так как допускается связывание пинга с объектами любых типов. Поэтому, перед работой с объектом пинга мы должны проверить тип объекта и только после этого работать с ним.

**(./images/tog_code_1.png) 3. Пинг нескольких устройств с привязкой к объектам разного типа [(./images/link.png)](https://simple-scada.com/help/script/startping.html?anchor=ping3)**

В предыдущем примере мы связали несколько пингов с тремя фигурами. В этом примере назначим пингам объекты разного типа. Первому - текст, второму - фигуру, третьему - изображение. Как и в предыдущем примере, сначала [создадим скрипт](via-script-editor.md) с типом события "Запуск проекта", в котором запустим пинг трех устройств, связывая каждый пинг с соответствующим объектом:

````
begin  
  // запускаем три пинга. Каждый пинг связываем с соответствующим объектом  
  StartPing('192.168.1.1', 3000, Text1);  
  StartPing('192.168.1.2', 3000, Shape1);  
  StartPing('192.168.1.3', 3000, Image1);  
end.

````


Далее, [создадим скрипт](via-script-editor.md) с типом события "Изменился пинг" и опишем реакцию на результат пинга в зависимости от того, с каким объектом связан пинг. Если пинг связан с объектом "Текст", то выводим результат в виде текста "Пинг прошел\!"/ "Пинг не удался\!". Если пинг связан с объектом "Фигура", то меняем ее цвет на зеленый, либо красный. Если пинг связан с объектом "Изображение", то меняем кадр изображения на 2 или 1 в зависимости от результатов пинга:

````
begin  
  // прерываем выполнение если пинг не связан с объектом  
  if PingData.Sender = nil then Exit;  
    
  // если пинг связан с объектом типа Текст  
  if PingData.Sender is TM\_Text then  
    // далее работаем с "PingData.Sender" как с текстом  
    with PingData.Sender as TM\_Text do  
      if PingData.Result then      // если пинг прошел удачно  
        Text := 'Пинг прошел\!'     // меняем текст на "Пинг прошел\!"  
      else                         // если пинг не удался  
        Text := 'Пинг не удался\!'; // меняем текст на "Пинг не удался\!"  
  
  // если пинг связан с объектом типа Фигура  
  if PingData.Sender is TM\_Shape then  
    // далее работаем с "PingData.Sender" как с фигурой  
    with PingData.Sender as TM\_Shape do  
      if PingData.Result then   // если пинг прошел удачно  
        Color := clGreen        // меняем цвет фигуры на зеленый  
      else                      // если пинг не удался  
        Color := clRed;         // меняем цвет фигуры на красный  
    
  // если пинг связан с объектом типа Изображение  
  if PingData.Sender is TM\_Image then  
    // далее работаем с "PingData.Sender" как с изображением  
    with PingData.Sender as TM\_Image do  
      if PingData.Result then  // если пинг прошел удачно  
        Frame := 2             // меняем кадр изображения на второй  
      else                     // если пинг не удался  
        Frame := 1;            // меняем кадр изображения на первый  
end.
````

````
**(./images/tog_code_1.png) 4. Пинг нескольких устройств с привязкой к множеству объектов [(./images/link.png)](https://simple-scada.com/help/script/startping.html?anchor=ping4)**

Пусть в проекте имеется шесть изображений "Image1", "Image2"... "Image6" и нам требуется выполнять пинг двух разных устройств. Результат пинга первого устройства нужно отобразить на изображениях "Image1" ... "Image3", меняя их цвет на зеленый, если пинг прошел успешно и на красный, если пинг не удался. Результат пинга второго устройства нужно отобразить на изображениях "Image4" ... "Image6". Для решения задачи необходимо создать две внутренние переменные(по одной для каждого пинга) с типом данных Boolean, в которые будет записываться True если пинг прошел успешно и False, если пинг не удался. Допустим, они будут иметь имена "vrPing1" и "vrPing2". Тогда, переменную "vrPing1" свяжем с основной переменной изображений "Image1" ... "Image3", а переменную "vrPing2" с основной переменной изображений "Image4" ... "Image6". 

Далее, [создадим скрипт](via-script-editor.md) с типом события "Запуск проекта", в котором запустим пинг устройств. Пинг первого устройства свяжем с переменной "vrPing1", пинг второго устройства свяжем с переменной "vrPing2":

````
begin  
  StartPing('192.168.1.56', 2000, vrPing1);  
  StartPing('192.168.1.89', 2000, vrPing2);  
end.

````


[Создадим скрипт](via-script-editor.md) с типом события "Изменился пинг", в котором будем записывать в переменную связанную с пингом True если пинг прошел успешно и False, если пинг не удался:

````
begin  
  // прерываем выполнение если пинг не связан с объектом  
  if PingData.Sender = nil then Exit;  
  // прерываем выполнение если пинг связан НЕ с объектом TM\_Variable  
  if not (PingData.Sender is TM\_Variable) then Exit;  
  
  // далее работаем с "PingData.Sender" как с TM\_Variable  
  with PingData.Sender as TM\_Variable do  
    if PingData.Result then   // если пинг прошел удачно  
      Value := True           // записываем в переменную True  
    else                      // если пинг не удался  
      Value := False;         // записываем в переменную False  
end.

````


Далее, [создадим скрипт](via-script-editor.md) с типом события "[Универсальный скрипт](universal-event.md)", в котором реализуем смену цвета в зависимости от значения переменной связанной с изображением:

````
begin  
  if Sender is TM\_Object then   // проверяем, что Sender это объект  
    with Sender as TM\_Object do // приводим Sender к типу "TM\_Object"  
      if AsInt = 1 then         // если значение переменной объекта равно 1, то  
        Color := clGreen        // изменить цвет объекта на зеленый  
      else                      // иначе  
        Color := clRed;         // изменить цвет объекта на красный  
end.

````
, и [назначим этот скрипт на событие OnDataChange](by-obj-event.md) всех изображений "Image1" ... "Image6". Теперь, при изменении пинга первого устройства будет меняться цвет изображений "Image1" ... "Image3", а при изменении второго пинга цвет изображений "Image4" ... "Image6".

