Python#
Справочник по API VEX CTE для Python объясняет, что делает каждая команда, метод и функция, какие входные данные они используют, что возвращают и как их можно использовать в проекте.
Используйте этот справочник, если хотите понять, что представляет собой команда, прежде чем добавлять её в проект, проверить, какие значения она принимает или возвращает, или сравнить связанные команды в категории.
В проектах VEXcode на Python используются команды Python. В проектах Blocks вместо этого используется раздел API Blocks.
Как читать описание метода ввода#
Большинство статей по Python содержат следующие части:
Имя команды — Официальное название команды, метода или функции.
Описание - Объясняет, что делает команда и когда она полезна.
Использование - Отображает синтаксис, используемый для написания команды в коде.
Параметры — Список входных параметров, принимаемых командой, и объяснение назначения каждого из них.
Возвращаемое значение — поясняет, что команда возвращает, если она возвращает какое-либо значение.
Пример кода — демонстрирует один из способов использования команды в проекте.
Общие элементы API Python#
Элемент |
Что это значит |
|---|---|
Метод |
Команда, вызываемая для объекта, например, |
Функция |
Команда, вызываемая напрямую, например, |
Параметр |
Значение, передаваемое в метод или функцию для управления их действием. |
Необязательный параметр |
Параметр, который можно опустить, чтобы использовалось поведение по умолчанию. |
Возвращаемое значение |
Значение, которое возвращает команда, например, число, текст или логическое значение. |
Базовый словарь Python#
Срок |
Что это значит |
|---|---|
Переменная |
Имя, хранящее значение, например, |
Нить |
Текст внутри кавычек, например |
Целое число |
Положительное или отрицательное число, например |
Плавать |
Число с десятичной запятой, например, |
Логическое значение |
Значение, равное либо |
Аргумент |
Значение, передаваемое в вызов метода или функции, например, |
Пример ввода метода#
move_inc#
move_inc перемещает 6-осевой манипулятор на заданное расстояние вдоль осей x, y и z.
Этот метод вернет логическое значение, указывающее, достигла ли 6-осевая манипуляторная стойка запрошенного положения:
True- 6-осевой манипулятор достиг запрошенного положения.False- 6-осевой манипулятор не может достичь запрошенного положения.
Usage:
arm.move_inc(x, y, z, wait)
Параметр |
Описание |
|---|---|
х |
Расстояние перемещения вдоль оси X в миллиметрах. |
й |
Расстояние перемещения вдоль оси Y в миллиметрах. |
з |
Расстояние перемещения вдоль оси Z в миллиметрах. |
|
Необязательно.
|
# Move the Arm +100 millimeters on the y-axis
arm.move_inc(0, 100, 0)