Перейти к содержанию

Python

Руководство по установке на Windows

Для загрузки установочного пакета Python необходимо перейти на официальный портал и нажать на гиперссылку после слов "Or get the standalone installer for.."

После загрузки следует запустить установочный файл, активировать флаг напротив пункта "Add python.exe to PATH" и нажать "Install Now".

После завершения установки нажать кнопку "Close".

Создание окружения

Для выполнения произвольных скриптов необходимо запустить PowerShell в ОС Windows с правами администратора и выполнить команду:

Set-ExecutionPolicy RemoteSigned

Службы ОС предупредят об изменении политики выполнения. Для подтверждения изменений необходимо согласиться, нажатием клавиш Y и Enter.

Важно

После выполнения данной команды в терминале не должно быть ошибок исполнения.

Далее необходимо создать каталог, в котором будут храниться скрипты проекта на языке Python, необходимые для работы с API. В данном примере каталог располагается в корне диска C.

Открыть редактор исходного кода (в данном примере используется VS Code) и добавить созданный каталог со скриптами в рабочую область редактора.

В меню управления терминалом редактора выбрать пункт "New Terminal".

Замечание

Нет строгой необходимости использовать оболочку PowerShell в среде VS Code. Все операции также можно выполнять через классическое окно оболочки в ОС Windows.

Затем необходимо удостовериться, что в качестве оболочки используется именно PowerShell.

Если все выполнено правильно, то в начале строки приглашения должен быть указан префикс "PS". Затем необходимо перейти в созданный каталог для скриптов "python_scripts".

Выполнить 3 команды:

python -m venv .venv           # чтобы создать виртуальное окружение в текущем каталоге

.\.venv\Scripts\Activate.ps1   # для активации созданного виртуального окружения

pip install sl5api             # для установки библиотеки работы с API

Важно

При каждом обращении к API необходимо активировать окружение. При работе из окружения в начале пригласительной строки должен быть указан префикс (.venv).

Пример работы с API

Пример:
С помощью скрипта на языке Python необходимо получить значение Тег_1 с сервера, инкрементировать его и записать результат в Тег_2.

Для этого потребуется создать новый проект, выбрать лицензию Standard или Enterprise и добавить 2 виртуальных тега в список активных:

  • Тег_1 с значением по умолчанию, например, 12.
  • Тег_2 с настройками по умолчанию.

Активировать фреймворк gRPC в среде разработки и скопировать "Токен доступа".

В каталоге со скриптами создать файл main.py и из листинга ниже скопировать код. В коде указать IP-адрес или hostname сервера Симплайт 5, порт и токен, который был скопирован на предыдущем шаге.

  • hostname: 127.0.0.1
  • port: 23505
  • token: скопированный токен из настроек gRPC
import asyncio
from sl5api import Client, Config

cfg = Config("<hostname>:<port>", "<token>") 

async def main():
  var = Client(cfg)

  # здесь вызываются методы, доступные в объекте переменной var

  tag_value = await var.read_value("Тег_1")            # tag_value получает значение Тег_1
  await var.write_value("Тег_2", tag_value + 1, 0xC0)  # запись рассчитанного значения в Тег_2 c хорошим качеством 0xC0

if __name__ == "__main__":
  asyncio.run(main())

Если развернуть проект, то в тесте тегов у Тег_2 значение будет с плохим качеством. Чтобы тег получил значение необходимо выполнить скрипт.

Команда для запуска скрипта:

python main.py

После запуска Тег_2 получит инкрементированное значение с хорошим качеством.