API Basics

One page, two jobs: just-enough Python syntax + a map of the SPIKE 3 modules. With Word Blocks experience, you've met every concept already.

Python crash course (Word Blocks side by side)

Word Blocks	Python
set [speed] to [50]	speed = 50
change [speed] by [10]	speed += 10
if <...> then / else	if ...: / else:
repeat [10] times	for i in range(10):
forever	while True:
repeat until <cond>	while not cond:
<A> and <B> / <A> or <B>	A and B / A or B
wait [1] seconds	await runloop.sleep_ms(1000)
wait until <cond>	await runloop.until(cond_function)
My Block definition	def / async def

Python uses indentation (4 spaces) for "contained inside", like blocks wrapping blocks:

for i in range(3):
    print(i)        # indented = inside the loop
print("done")       # not indented = after the loop

Functions can return values - the thing My Blocks can't do:

def is_black(port_id):
    return color_sensor.reflection(port_id) < 35

if is_black(port.C):
    ...

SPIKE 3 module map

Module	Owns	Typical call
motor	single motors	motor.run_for_degrees(port.A, 360, 500)
motor_pair	the drive base	motor_pair.move_for_degrees(...)
color_sensor	color sensor	color_sensor.reflection(port.C)
distance_sensor	distance sensor	distance_sensor.distance(port.D)
force_sensor	force sensor	force_sensor.pressed(port.B)
hub package	the hub itself	from hub import port, motion_sensor, light_matrix, button, sound
color	color constants	color.BLACK, color.RED
runloop	async runtime	runloop.run(), runloop.sleep_ms(), runloop.until()

Ports are written port.A through port.F (from from hub import port).

Unit conversion table (the biggest trap)

Python API units differ from what Word Blocks display:

Quantity	Word Blocks	Python
Motor speed	% (0-100)	degrees/second (large motor tops out ~1050)
Distance	cm	mm, -1 when no target
Yaw angle	degrees	decidegrees (900 = 90°)
Force	% or N	decinewtons (0-100)
Time	seconds	milliseconds

Full example: drive to the black line

import runloop, motor_pair, color_sensor
from hub import port

motor_pair.pair(motor_pair.PAIR_1, port.A, port.E)   # left A, right E

def on_black():
    return color_sensor.reflection(port.C) < 35

async def main():
    motor_pair.move(motor_pair.PAIR_1, 0, velocity=300)   # start driving (non-blocking)
    await runloop.until(on_black)                          # wait for the condition
    motor_pair.stop(motor_pair.PAIR_1)                     # stop

runloop.run(main())

Compare with the Word Blocks version (start moving → wait until → stop moving): identical structure.

Note runloop.until() takes the function itself (on_black, no parentheses), not its result - runloop calls it repeatedly until it returns True. It also accepts a timeout in ms as a second argument (0 = wait forever); add one to any condition that might never become true so the robot doesn't stand there waiting.

Exercises

1. Translate the Word Blocks "count 3 lines and stop" program into Python (hint: while + two runloop.until).
2. Write read_black_white(): record the black value on the left button press, white on the right, print the suggested threshold.

Next lesson: the complete Motors & Sensors API.