Python#
VEX CTE Python API-referensen förklarar vad varje kommando, metod och funktion gör, vilka indata den använder, vad den returnerar och hur den kan användas i ett projekt.
Använd den här referensen när du vill förstå ett kommando innan du lägger till det i ett projekt, kontrollera vilka värden det accepterar eller returnerar, eller jämföra relaterade kommandon i en kategori.
Python-kommandon används i VEXcode Python-projekt. Blocks-projekt använder istället Blocks API-sektionen.
Hur man läser en metodpost#
De flesta Python-poster innehåller följande delar:
Kommandonamn - Det officiella namnet på kommandot, metoden eller funktionen.
Beskrivning - Förklarar vad kommandot gör och när det är användbart.
Användning - Visar syntaxen som används för att skriva kommandot i kod.
Parametrar - Listar de indata som kommandot accepterar och förklarar vad var och en gör.
Returvärde - Förklarar vad kommandot rapporterar tillbaka om det returnerar ett värde.
Exempelkod - Visar ett sätt som kommandot kan användas i ett projekt.
Vanliga Python API-element#
Element |
Vad det betyder |
|---|---|
Metod |
Ett kommando som anropas på ett objekt som |
Fungera |
Ett kommando som anropas direkt, såsom |
Parameter |
Ett värde som matas in i en metod eller funktion för att styra vad den gör. |
Valfri parameter |
En parameter som kan utelämnas så att standardbeteendet används. |
Returvärde |
Ett värde som ett kommando rapporterar tillbaka, till exempel ett tal, en text eller ett booleskt värde. |
Grundläggande Python-vokabulär#
Kalla |
Vad det betyder |
|---|---|
Variabel |
Ett namn som lagrar ett värde, till exempel |
Sträng |
Text inom citattecken, till exempel |
Heltal |
Ett positivt eller negativt tal, till exempel |
Flyta |
Ett tal med ett decimaltal, till exempel |
Boolesk |
Ett värde som antingen är |
Argument |
Ett värde som matas in i ett metod- eller funktionsanrop, till exempel |
Exempel på metodinmatning#
move_inc#
move_inc flyttar 6-axlig arm ett angivet avstånd längs x-, y- och z-axlarna.
Den här metoden returnerar ett booleskt värde som anger om 6-axlig arm har nått den begärda positionen:
True- 6-axlig arm har nått den begärda positionen.False- 6-axlig arm kan inte nå den begärda positionen.
Usage:
arm.move_inc(x, y, z, wait)
Parameter |
Beskrivning |
|---|---|
x |
Avståndet som ska förflyttas längs x-axeln i millimeter. |
y |
Avståndet att förflytta sig längs y-axeln i millimeter. |
z |
Avståndet som ska förflyttas längs z-axeln i millimeter. |
|
Valfritt.
|
# Move the Arm +100 millimeters on the y-axis
arm.move_inc(0, 100, 0)