Skip to content

API reference

The public HELM API is imported from the helm package:

from helm import (
    Button,
    Controller,
    Effector,
    IMU,
    ImuReading,
    Joystick,
    Phase,
    RadioBeacon,
    RadioBeaconReading,
    Reading,
    Robot,
    Sensor,
    Servo,
    Tag,
    Thruster,
)

Reference pages

Area Public symbols
Robot Robot
Controller input Controller, Joystick, Button
Sensors and readings Sensor, Reading, IMU, ImuReading, RadioBeacon, RadioBeaconReading
Effectors Effector, Thruster, Servo
Enums Phase, Tag

Classes from modules whose names begin with an underscore are implementation details. They support extension communication, state caching, command encoding, and phase dispatch, but are not student-facing API.

Normal entry point

Most programs need only Robot, the configured sensor and effector type tokens, and optionally Phase. Base classes, direct arming, and Tag are advanced parts of the public surface.