Python#

У довіднику з API Python VEX CTE пояснюється, що робить кожна команда, метод і функція, які вхідні дані вона використовує, що повертає та як її можна використовувати в проєкті.

Використовуйте цей посібник, коли хочете зрозуміти команду перед її додаванням до проєкту, перевірити, які значення вона приймає або повертає, або порівняти пов’язані команди в категорії.

Команди Python використовуються в проектах VEXcode Python. Проекти Blocks використовують розділ Blocks API.

Як читати запис методу#

Більшість записів Python містять такі частини:

Назва команди – офіційна назва команди, методу або функції.
Опис – пояснює, що робить команда та коли вона корисна.
Використання – показує синтаксис, який використовується для запису команди в коді.
Параметри – Перелічує вхідні дані, які приймає команда, та пояснює, що робить кожен з них.
Повернене значення – пояснює, що повертає команда, якщо вона повертає значення.
Приклад коду – Показано один із способів використання команди в проєкті.

Загальні елементи API Python#

Елемент	Що це означає
Метод	Команда, що викликається для об’єкта, наприклад, `arm.move_inc(…)`.
Функція	Команда, що викликається безпосередньо, наприклад, `wait(…)` або `print(…)`.
Параметр	Значення, що передається в метод або функцію для керування її діями.
Необов’язковий параметр	Параметр, який можна пропустити, щоб використовувати поведінку за замовчуванням.
Повернене значення	Значення, яке повертає команда, наприклад, число, текст або логічне значення.

Базовий словник Python#

Термін	Що це означає
Змінна	Ім’я, яке зберігає значення, наприклад, `x_target = 120`.
Рядок	Текст у лапках, наприклад, `“Hello”`.
Ціле число	Додатне або від’ємне число, наприклад, `90`.
Поплавок	Число з десятковим дробом, наприклад, `25.5`.
Логічне значення	Значення, яке дорівнює `True` або `False`.
Суперечка	Значення, що передається у виклик методу або функції, наприклад, `100` in `arm.move_inc(0, 100, 0)`.

Приклад введення методу#

move_inc#

move_inc переміщує 6-осьовий маніпулятор на задану відстань вздовж осей x, y та z.

Цей метод поверне логічне значення, яке вказує, чи досягла 6-осьова рука запитуваної позиції:

True - 6-осьовий маніпулятор досяг заданого положення.
False - 6-осьова рукоятка не може досягти потрібного положення.

Usage:
arm.move_inc(x, y, z, wait)

Параметр	Опис
х	Відстань, на яку потрібно переміститися вздовж осі x, у міліметрах.
у	Відстань, на яку потрібно переміститися вздовж осі Y, у міліметрах.
з	Відстань, на яку потрібно переміститися вздовж осі z, у міліметрах.
`wait`	Необов’язково. `wait=True` (за замовчуванням) - Проєкт очікує завершення `move_inc` перед виконанням наступного рядка коду. `wait=False` - Проєкт починає дію та одразу переходить до наступного рядка коду, не чекаючи завершення `move_inc`

# Move the Arm +100 millimeters on the y-axis
arm.move_inc(0, 100, 0)