CircuitPython RaspberryPi_BuildHAT Library
1.0
Introduction
Compatibility
Device compatibility
Examples
List all connected devices
Active motor
Color sensor
Color + distance sensor
Ultrasonic distance sensor
3x3 Color Light matrix
API Reference
Hat
Devices
Motors
Enums
Related Products
RaspberryPi Build HAT
Other Links
Download from GitHub
Download Library Bundle
CircuitPython Reference Documentation
CircuitPython Support Forum
Discord Chat
Adafruit Learning System
Adafruit Blog
Adafruit Store
CircuitPython RaspberryPi_BuildHAT Library
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
A
ActiveDevice (class in buildhat.activedevice)
ActiveMotor (class in buildhat.motors.activemotor)
actual_absolute_position (buildhat.motors.activemotor.ActiveMotor property)
actual_position (buildhat.motors.activemotor.ActiveMotor property)
actual_speed (buildhat.motors.activemotor.ActiveMotor property)
(buildhat.motors.passivemotor.PassiveMotor property)
B
baudrate (buildhat.activedevice.ActiveDevice property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
BLACK (buildhat.devices.color.Color attribute)
(buildhat.devices.matrixcolor.MatrixColor attribute)
BLUE (buildhat.devices.color.Color attribute)
(buildhat.devices.matrixcolor.MatrixColor attribute)
BROWN (buildhat.devices.matrixcolor.MatrixColor attribute)
buildhat.hat
module
buildhat.models.devicetype
module
BUTTON_OR_TOUCH_SENSOR (buildhat.models.devicetype.DeviceType attribute)
C
clear_faults() (buildhat.hat.Hat method)
coast() (buildhat.motors.activemotor.ActiveMotor method)
Color (class in buildhat.devices.color)
COLOR_AND_DISTANCE_SENSOR (buildhat.models.devicetype.DeviceType attribute)
ColorDistanceSensor (class in buildhat.devices.colordistancesensor)
ColorSensor (class in buildhat.devices.colorsensor)
CYAN (buildhat.devices.color.Color attribute)
(buildhat.devices.matrixcolor.MatrixColor attribute)
D
data_update_interval (buildhat.activedevice.ActiveDevice property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
default_speed (buildhat.motors.passivemotor.PassiveMotor property)
deinit() (buildhat.hat.Hat method)
(buildhat.motors.activemotor.ActiveMotor method)
Device (class in buildhat.device)
DeviceType (class in buildhat.models.devicetype)
DGS (buildhat.motors.speedunit.SpeedUnit attribute)
display_level_bar() (buildhat.devices.lightmatrix.LightMatrix method)
display_pixels() (buildhat.devices.lightmatrix.LightMatrix method)
display_single_color() (buildhat.devices.lightmatrix.LightMatrix method)
distance (buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
E
ensure_connected() (buildhat.activedevice.ActiveDevice method)
(buildhat.device.Device method)
(buildhat.devices.colordistancesensor.ColorDistanceSensor method)
(buildhat.devices.colorsensor.ColorSensor method)
(buildhat.devices.lightmatrix.LightMatrix method)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor method)
(buildhat.motors.activemotor.ActiveMotor method)
(buildhat.motors.passivemotor.PassiveMotor method)
eyes() (buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor method)
F
FADE_IN_OUT (buildhat.devices.matrixtransition.MatrixTransition attribute)
fill_pixels() (buildhat.devices.lightmatrix.LightMatrix method)
float() (buildhat.motors.activemotor.ActiveMotor method)
FUTURE_LIGHTS_1 (buildhat.models.devicetype.DeviceType attribute)
FUTURE_LIGHTS_2 (buildhat.models.devicetype.DeviceType attribute)
G
GENERAL_PWM (buildhat.models.devicetype.DeviceType attribute)
get_ambient_light() (buildhat.devices.colordistancesensor.ColorDistanceSensor method)
(buildhat.devices.colorsensor.ColorSensor method)
get_color() (buildhat.devices.colordistancesensor.ColorDistanceSensor method)
(buildhat.devices.colorsensor.ColorSensor method)
get_color_from_rgb() (buildhat.devices.color.Color method)
get_color_hsv() (buildhat.devices.colorsensor.ColorSensor method)
get_color_rgb() (buildhat.devices.colordistancesensor.ColorDistanceSensor method)
get_color_rgbi() (buildhat.devices.colorsensor.ColorSensor method)
get_counter() (buildhat.devices.colordistancesensor.ColorDistanceSensor method)
get_device() (buildhat.hat.Hat method)
get_distance() (buildhat.devices.colordistancesensor.ColorDistanceSensor method)
get_name() (buildhat.models.devicetype.DeviceType method)
get_reflected_light() (buildhat.devices.colordistancesensor.ColorDistanceSensor method)
(buildhat.devices.colorsensor.ColorSensor method)
GREEN (buildhat.devices.color.Color attribute)
(buildhat.devices.matrixcolor.MatrixColor attribute)
H
hardware_version (buildhat.activedevice.ActiveDevice property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
has_absolute_position (buildhat.motors.activemotor.ActiveMotor property)
hat (buildhat.activedevice.ActiveDevice property)
(buildhat.device.Device property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
(buildhat.motors.passivemotor.PassiveMotor property)
Hat (class in buildhat.hat)
I
is_connected (buildhat.activedevice.ActiveDevice property)
(buildhat.device.Device property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
(buildhat.motors.passivemotor.PassiveMotor property)
is_motor() (buildhat.models.devicetype.DeviceType method)
L
led_mode (buildhat.hat.Hat property)
LightMatrix (class in buildhat.devices.lightmatrix)
M
MAGENTA (buildhat.devices.matrixcolor.MatrixColor attribute)
MatrixColor (class in buildhat.devices.matrixcolor)
MatrixTransition (class in buildhat.devices.matrixtransition)
MEDIUM_LINEAR_MOTOR (buildhat.models.devicetype.DeviceType attribute)
module
buildhat.hat
buildhat.models.devicetype
N
name (buildhat.activedevice.ActiveDevice property)
(buildhat.device.Device property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
(buildhat.motors.passivemotor.PassiveMotor property)
NONE (buildhat.devices.matrixtransition.MatrixTransition attribute)
(buildhat.models.devicetype.DeviceType attribute)
num_read_average (buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
O
off() (buildhat.activedevice.ActiveDevice method)
(buildhat.device.Device method)
(buildhat.devices.colordistancesensor.ColorDistanceSensor method)
(buildhat.devices.colorsensor.ColorSensor method)
(buildhat.devices.lightmatrix.LightMatrix method)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor method)
(buildhat.motors.activemotor.ActiveMotor method)
(buildhat.motors.passivemotor.PassiveMotor method)
on() (buildhat.activedevice.ActiveDevice method)
(buildhat.device.Device method)
(buildhat.devices.colordistancesensor.ColorDistanceSensor method)
(buildhat.devices.colorsensor.ColorSensor method)
(buildhat.devices.lightmatrix.LightMatrix method)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor method)
(buildhat.motors.activemotor.ActiveMotor method)
(buildhat.motors.passivemotor.PassiveMotor method)
ORANGE (buildhat.devices.matrixcolor.MatrixColor attribute)
P
PALE_GREEN (buildhat.devices.matrixcolor.MatrixColor attribute)
PassiveMotor (class in buildhat.motors.passivemotor)
port (buildhat.activedevice.ActiveDevice property)
(buildhat.device.Device property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
(buildhat.motors.passivemotor.PassiveMotor property)
position_pid (buildhat.motors.activemotor.ActiveMotor property)
power_limit (buildhat.motors.activemotor.ActiveMotor property)
(buildhat.motors.passivemotor.PassiveMotor property)
pwm() (buildhat.motors.activemotor.ActiveMotor method)
pwmparams() (buildhat.motors.activemotor.ActiveMotor method)
(buildhat.motors.passivemotor.PassiveMotor method)
R
readline() (buildhat.hat.Hat method)
RED (buildhat.devices.color.Color attribute)
(buildhat.devices.matrixcolor.MatrixColor attribute)
release_after_run (buildhat.motors.activemotor.ActiveMotor property)
reverse_direction (buildhat.motors.activemotor.ActiveMotor property)
RPM (buildhat.motors.speedunit.SpeedUnit attribute)
run_command_default_speed (buildhat.motors.activemotor.ActiveMotor property)
run_command_position_tolerance (buildhat.motors.activemotor.ActiveMotor property)
run_command_speed_unit (buildhat.motors.activemotor.ActiveMotor property)
run_for_degrees() (buildhat.motors.activemotor.ActiveMotor method)
run_for_rotations() (buildhat.motors.activemotor.ActiveMotor method)
run_for_seconds() (buildhat.motors.activemotor.ActiveMotor method)
(buildhat.motors.passivemotor.PassiveMotor method)
run_to_absolute_angle() (buildhat.motors.activemotor.ActiveMotor method)
run_to_position() (buildhat.motors.activemotor.ActiveMotor method)
S
select_read_mode() (buildhat.activedevice.ActiveDevice method)
(buildhat.devices.colordistancesensor.ColorDistanceSensor method)
(buildhat.devices.colorsensor.ColorSensor method)
(buildhat.devices.lightmatrix.LightMatrix method)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor method)
(buildhat.motors.activemotor.ActiveMotor method)
serial (buildhat.hat.Hat property)
set_color() (buildhat.devices.colordistancesensor.ColorDistanceSensor method)
set_display_image_transition() (buildhat.devices.lightmatrix.LightMatrix method)
set_pixel() (buildhat.devices.lightmatrix.LightMatrix method)
SIMPLE_LIGHTS (buildhat.models.devicetype.DeviceType attribute)
software_version (buildhat.activedevice.ActiveDevice property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
speed_pid (buildhat.motors.activemotor.ActiveMotor property)
SpeedUnit (class in buildhat.motors.speedunit)
SPIKE_3X3_COLOR_LIGHT_MATRIX (buildhat.models.devicetype.DeviceType attribute)
SPIKE_COLOR_SENSOR (buildhat.models.devicetype.DeviceType attribute)
SPIKE_FORCE_SENSOR (buildhat.models.devicetype.DeviceType attribute)
SPIKE_LARGE_ANGULAR_MOTOR (buildhat.models.devicetype.DeviceType attribute)
SPIKE_MEDIUM_ANGULAR_MOTOR (buildhat.models.devicetype.DeviceType attribute)
SPIKE_SMALL_ANGULAR_MOTOR (buildhat.models.devicetype.DeviceType attribute)
SPIKE_ULTRASONIC_DISTANCE_SENSOR (buildhat.models.devicetype.DeviceType attribute)
start() (buildhat.motors.activemotor.ActiveMotor method)
(buildhat.motors.passivemotor.PassiveMotor method)
stop() (buildhat.motors.activemotor.ActiveMotor method)
(buildhat.motors.passivemotor.PassiveMotor method)
stop_all_devices() (buildhat.hat.Hat method)
SWIPE_RTL (buildhat.devices.matrixtransition.MatrixTransition attribute)
SYSTEM_FUTURE_ACTUATOR (buildhat.models.devicetype.DeviceType attribute)
SYSTEM_MEDIUM_MOTOR (buildhat.models.devicetype.DeviceType attribute)
SYSTEM_TRAIN_MOTOR (buildhat.models.devicetype.DeviceType attribute)
SYSTEM_TURNABLE_MOTOR (buildhat.models.devicetype.DeviceType attribute)
T
TECHNIC_LARGE_ANGULAR_MOTOR (buildhat.models.devicetype.DeviceType attribute)
TECHNIC_LARGE_MOTOR (buildhat.models.devicetype.DeviceType attribute)
TECHNIC_MEDIUM_ANGULAR_MOTOR (buildhat.models.devicetype.DeviceType attribute)
TECHNIC_XL_MOTOR (buildhat.models.devicetype.DeviceType attribute)
type (buildhat.activedevice.ActiveDevice property)
(buildhat.device.Device property)
(buildhat.devices.colordistancesensor.ColorDistanceSensor property)
(buildhat.devices.colorsensor.ColorSensor property)
(buildhat.devices.lightmatrix.LightMatrix property)
(buildhat.devices.ultrasonicdistancesensor.UltrasonicDistanceSensor property)
(buildhat.motors.activemotor.ActiveMotor property)
(buildhat.motors.passivemotor.PassiveMotor property)
U
UltrasonicDistanceSensor (class in buildhat.devices.ultrasonicdistancesensor)
update() (buildhat.hat.Hat method)
V
vin() (buildhat.hat.Hat method)
VIOLET (buildhat.devices.color.Color attribute)
W
WEDO_MOTION_SENSOR (buildhat.models.devicetype.DeviceType attribute)
WEDO_TILT_SENSOR (buildhat.models.devicetype.DeviceType attribute)
WHITE (buildhat.devices.color.Color attribute)
(buildhat.devices.matrixcolor.MatrixColor attribute)
Y
YELLOW (buildhat.devices.color.Color attribute)
(buildhat.devices.matrixcolor.MatrixColor attribute)