j5
v0.5.0
Contents:
Installation
Quick Start Guide
Concepts
Supported Hardware
Development
API Reference
Index
j5
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
U
|
V
|
W
A
A6 (j5.components.piezo.Note attribute)
A7 (j5.components.piezo.Note attribute)
ANALOGUE_INPUT (j5.components.gpio_pin.GPIOPinMode attribute)
(j5.components.GPIOPinMode attribute)
ANALOGUE_OUTPUT (j5.components.gpio_pin.GPIOPinMode attribute)
(j5.components.GPIOPinMode attribute)
analogue_value (j5.components.gpio_pin.GPIOPin attribute)
(j5.components.GPIOPin attribute)
B
B6 (j5.components.piezo.Note attribute)
B7 (j5.components.piezo.Note attribute)
Backend (class in j5.backends)
(class in j5.backends.backend)
backend_class (j5.BoardGroup attribute)
(j5.boards.BoardGroup attribute)
(j5.boards.board.BoardGroup attribute)
BackendMeta (class in j5.backends)
(class in j5.backends.backend)
BadGPIOPinModeError
BaseRobot (class in j5)
(class in j5.base_robot)
battery_sensor (j5.boards.sr.v4.power_board.PowerBoard attribute)
(j5.boards.sr.v4.PowerBoard attribute)
BatterySensor (class in j5.components)
(class in j5.components.battery_sensor)
BatterySensorInterface (class in j5.components)
(class in j5.components.battery_sensor)
Board (class in j5.boards)
(class in j5.boards.board)
board (j5.backends.Backend attribute)
(j5.backends.backend.Backend attribute)
BoardGroup (class in j5)
(class in j5.boards)
(class in j5.boards.board)
boards (j5.BoardGroup attribute)
BOARDS (j5.boards.Board attribute)
(j5.boards.board.Board attribute)
boards (j5.boards.board.BoardGroup attribute)
(j5.boards.BoardGroup attribute)
BRAKE (j5.components.motor.MotorSpecialState attribute)
(j5.components.MotorSpecialState attribute)
Button (class in j5.components)
(class in j5.components.button)
ButtonInterface (class in j5.components)
(class in j5.components.button)
buzz() (j5.components.Piezo method)
(j5.components.PiezoInterface method)
(j5.components.piezo.Piezo method)
(j5.components.piezo.PiezoInterface method)
C
C6 (j5.components.piezo.Note attribute)
C7 (j5.components.piezo.Note attribute)
C8 (j5.components.piezo.Note attribute)
COAST (j5.components.motor.MotorSpecialState attribute)
(j5.components.MotorSpecialState attribute)
CommunicationError
,
[1]
Component (class in j5.components)
(class in j5.components.component)
current (j5.components.battery_sensor.BatterySensor attribute)
(j5.components.BatterySensor attribute)
(j5.components.PowerOutput attribute)
(j5.components.power_output.PowerOutput attribute)
D
D6 (j5.components.piezo.Note attribute)
D7 (j5.components.piezo.Note attribute)
DerivedComponent (class in j5.components)
(class in j5.components.component)
DIGITAL_INPUT (j5.components.gpio_pin.GPIOPinMode attribute)
(j5.components.GPIOPinMode attribute)
DIGITAL_INPUT_PULLDOWN (j5.components.gpio_pin.GPIOPinMode attribute)
(j5.components.GPIOPinMode attribute)
DIGITAL_INPUT_PULLUP (j5.components.gpio_pin.GPIOPinMode attribute)
(j5.components.GPIOPinMode attribute)
DIGITAL_OUTPUT (j5.components.gpio_pin.GPIOPinMode attribute)
(j5.components.GPIOPinMode attribute)
digital_state (j5.components.gpio_pin.GPIOPin attribute)
(j5.components.GPIOPin attribute)
discover() (j5.backends.Backend class method)
(j5.backends.backend.Backend class method)
E
E6 (j5.components.piezo.Note attribute)
E7 (j5.components.piezo.Note attribute)
Environment (class in j5.backends)
(class in j5.backends.backend)
environment (j5.backends.Backend attribute)
(j5.backends.backend.Backend attribute)
F
F6 (j5.components.piezo.Note attribute)
F7 (j5.components.piezo.Note attribute)
firmware_modes (j5.components.gpio_pin.GPIOPin attribute)
(j5.components.GPIOPin attribute)
firmware_version (j5.backends.Backend attribute)
(j5.backends.backend.Backend attribute)
(j5.boards.Board attribute)
(j5.boards.board.Board attribute)
(j5.boards.sr.v4.MotorBoard attribute)
(j5.boards.sr.v4.PowerBoard attribute)
(j5.boards.sr.v4.ServoBoard attribute)
(j5.boards.sr.v4.power_board.PowerBoard attribute)
G
G6 (j5.components.piezo.Note attribute)
G7 (j5.components.piezo.Note attribute)
get_backend() (j5.backends.backend.Environment method)
(j5.backends.Environment method)
get_battery_sensor_current() (j5.components.battery_sensor.BatterySensorInterface method)
(j5.components.BatterySensorInterface method)
get_battery_sensor_voltage() (j5.components.battery_sensor.BatterySensorInterface method)
(j5.components.BatterySensorInterface method)
get_button_state() (j5.components.button.ButtonInterface method)
(j5.components.ButtonInterface method)
get_gpio_pin_digital_state() (j5.components.gpio_pin.GPIOPinInterface method)
(j5.components.GPIOPinInterface method)
get_gpio_pin_mode() (j5.components.gpio_pin.GPIOPinInterface method)
(j5.components.GPIOPinInterface method)
get_led_state() (j5.components.led.LEDInterface method)
(j5.components.LEDInterface method)
get_motor_state() (j5.components.motor.MotorInterface method)
(j5.components.MotorInterface method)
get_power_output_current() (j5.components.power_output.PowerOutputInterface method)
(j5.components.PowerOutputInterface method)
get_power_output_enabled() (j5.components.power_output.PowerOutputInterface method)
(j5.components.PowerOutputInterface method)
get_servo_position() (j5.components.servo.ServoInterface method)
(j5.components.ServoInterface method)
GPIOPin (class in j5.components)
(class in j5.components.gpio_pin)
GPIOPinInterface (class in j5.components)
(class in j5.components.gpio_pin)
GPIOPinMode (class in j5.components)
(class in j5.components.gpio_pin)
H
H0 (j5.boards.sr.v4.power_board.PowerOutputPosition attribute)
(j5.boards.sr.v4.PowerOutputPosition attribute)
H1 (j5.boards.sr.v4.power_board.PowerOutputPosition attribute)
(j5.boards.sr.v4.PowerOutputPosition attribute)
I
identifier (j5.components.battery_sensor.BatterySensor attribute)
(j5.components.BatterySensor attribute)
(j5.components.Button attribute)
(j5.components.Component attribute)
(j5.components.DerivedComponent attribute)
(j5.components.GPIOPin attribute)
(j5.components.LED attribute)
(j5.components.Motor attribute)
(j5.components.Piezo attribute)
(j5.components.PowerOutput attribute)
(j5.components.Servo attribute)
(j5.components.button.Button attribute)
(j5.components.component.Component attribute)
(j5.components.component.DerivedComponent attribute)
(j5.components.gpio_pin.GPIOPin attribute)
(j5.components.led.LED attribute)
(j5.components.motor.Motor attribute)
(j5.components.piezo.Piezo attribute)
(j5.components.power_output.PowerOutput attribute)
(j5.components.servo.Servo attribute)
Interface (class in j5.components)
(class in j5.components.component)
interface_class() (j5.components.battery_sensor.BatterySensor static method)
(j5.components.BatterySensor static method)
(j5.components.Button static method)
(j5.components.Component static method)
(j5.components.DerivedComponent static method)
(j5.components.GPIOPin static method)
(j5.components.LED static method)
(j5.components.Motor static method)
(j5.components.Piezo static method)
(j5.components.PowerOutput static method)
(j5.components.Servo static method)
(j5.components.button.Button static method)
(j5.components.component.Component static method)
(j5.components.component.DerivedComponent static method)
(j5.components.gpio_pin.GPIOPin static method)
(j5.components.led.LED static method)
(j5.components.motor.Motor static method)
(j5.components.piezo.Piezo static method)
(j5.components.power_output.PowerOutput static method)
(j5.components.servo.Servo static method)
is_enabled (j5.components.power_output.PowerOutput attribute)
(j5.components.PowerOutput attribute)
is_pressed (j5.components.Button attribute)
(j5.components.button.Button attribute)
J
j5 (module)
j5.backends (module)
j5.backends.backend (module)
j5.backends.hardware (module)
j5.backends.hardware.env (module)
j5.backends.hardware.sr (module)
j5.base_robot (module)
j5.boards (module)
j5.boards.board (module)
j5.boards.sr (module)
j5.boards.sr.v4 (module)
j5.boards.sr.v4.power_board (module)
j5.components (module)
j5.components.battery_sensor (module)
j5.components.button (module)
j5.components.component (module)
j5.components.gpio_pin (module)
j5.components.led (module)
j5.components.motor (module)
j5.components.piezo (module)
j5.components.power_output (module)
j5.components.servo (module)
L
L0 (j5.boards.sr.v4.power_board.PowerOutputPosition attribute)
(j5.boards.sr.v4.PowerOutputPosition attribute)
L1 (j5.boards.sr.v4.power_board.PowerOutputPosition attribute)
(j5.boards.sr.v4.PowerOutputPosition attribute)
L2 (j5.boards.sr.v4.power_board.PowerOutputPosition attribute)
(j5.boards.sr.v4.PowerOutputPosition attribute)
L3 (j5.boards.sr.v4.power_board.PowerOutputPosition attribute)
(j5.boards.sr.v4.PowerOutputPosition attribute)
LED (class in j5.components)
(class in j5.components.led)
LEDInterface (class in j5.components)
(class in j5.components.led)
M
make_all_safe() (j5.boards.Board static method)
(j5.boards.board.Board static method)
make_safe() (j5.base_robot.BaseRobot method)
(j5.BaseRobot method)
(j5.BoardGroup method)
(j5.boards.Board method)
(j5.boards.BoardGroup method)
(j5.boards.board.Board method)
(j5.boards.board.BoardGroup method)
(j5.boards.sr.v4.MotorBoard method)
(j5.boards.sr.v4.PowerBoard method)
(j5.boards.sr.v4.ServoBoard method)
(j5.boards.sr.v4.power_board.PowerBoard method)
mode (j5.components.gpio_pin.GPIOPin attribute)
(j5.components.GPIOPin attribute)
Motor (class in j5.components)
(class in j5.components.motor)
MotorBoard (class in j5.boards.sr.v4)
MotorInterface (class in j5.components)
(class in j5.components.motor)
motors (j5.boards.sr.v4.MotorBoard attribute)
MotorSpecialState (class in j5.components)
(class in j5.components.motor)
N
name (j5.boards.Board attribute)
(j5.boards.board.Board attribute)
(j5.boards.sr.v4.MotorBoard attribute)
(j5.boards.sr.v4.PowerBoard attribute)
(j5.boards.sr.v4.ServoBoard attribute)
(j5.boards.sr.v4.power_board.PowerBoard attribute)
Note (class in j5.components.piezo)
NotSupportedByComponentError
,
[1]
NotSupportedByHardwareError
,
[1]
O
outputs (j5.boards.sr.v4.power_board.PowerBoard attribute)
(j5.boards.sr.v4.PowerBoard attribute)
P
Piezo (class in j5.components)
(class in j5.components.piezo)
piezo (j5.boards.sr.v4.power_board.PowerBoard attribute)
(j5.boards.sr.v4.PowerBoard attribute)
PiezoInterface (class in j5.components)
(class in j5.components.piezo)
position (j5.components.Servo attribute)
(j5.components.servo.Servo attribute)
power_off() (j5.boards.sr.v4.PowerOutputGroup method)
(j5.components.PowerOutputGroup method)
(j5.components.power_output.PowerOutputGroup method)
power_on() (j5.boards.sr.v4.PowerOutputGroup method)
(j5.components.PowerOutputGroup method)
(j5.components.power_output.PowerOutputGroup method)
PowerBoard (class in j5.boards.sr.v4)
(class in j5.boards.sr.v4.power_board)
PowerOutput (class in j5.components)
(class in j5.components.power_output)
PowerOutputGroup (class in j5.boards.sr.v4)
(class in j5.components)
(class in j5.components.power_output)
PowerOutputInterface (class in j5.components)
(class in j5.components.power_output)
PowerOutputPosition (class in j5.boards.sr.v4)
(class in j5.boards.sr.v4.power_board)
PWM_OUTPUT (j5.components.gpio_pin.GPIOPinMode attribute)
(j5.components.GPIOPinMode attribute)
R
read_gpio_pin_analogue_value() (j5.components.gpio_pin.GPIOPinInterface method)
(j5.components.GPIOPinInterface method)
read_gpio_pin_digital_state() (j5.components.gpio_pin.GPIOPinInterface method)
(j5.components.GPIOPinInterface method)
register_backend() (j5.backends.backend.Environment method)
(j5.backends.Environment method)
S
serial (j5.boards.Board attribute)
(j5.boards.board.Board attribute)
(j5.boards.sr.v4.MotorBoard attribute)
(j5.boards.sr.v4.PowerBoard attribute)
(j5.boards.sr.v4.ServoBoard attribute)
(j5.boards.sr.v4.power_board.PowerBoard attribute)
Servo (class in j5.components)
(class in j5.components.servo)
ServoBoard (class in j5.boards.sr.v4)
ServoInterface (class in j5.components)
(class in j5.components.servo)
servos (j5.boards.sr.v4.ServoBoard attribute)
set_gpio_pin_mode() (j5.components.gpio_pin.GPIOPinInterface method)
(j5.components.GPIOPinInterface method)
set_led_state() (j5.components.led.LEDInterface method)
(j5.components.LEDInterface method)
set_motor_state() (j5.components.motor.MotorInterface method)
(j5.components.MotorInterface method)
set_power_output_enabled() (j5.components.power_output.PowerOutputInterface method)
(j5.components.PowerOutputInterface method)
set_servo_position() (j5.components.servo.ServoInterface method)
(j5.components.ServoInterface method)
singular() (j5.BoardGroup method)
(j5.boards.BoardGroup method)
(j5.boards.board.BoardGroup method)
start_button (j5.boards.sr.v4.power_board.PowerBoard attribute)
(j5.boards.sr.v4.PowerBoard attribute)
state (j5.components.LED attribute)
(j5.components.Motor attribute)
(j5.components.led.LED attribute)
(j5.components.motor.Motor attribute)
supported_boards (j5.backends.backend.Environment attribute)
(j5.backends.Environment attribute)
supported_components() (j5.boards.Board static method)
(j5.boards.board.Board static method)
(j5.boards.sr.v4.MotorBoard static method)
(j5.boards.sr.v4.PowerBoard static method)
(j5.boards.sr.v4.ServoBoard static method)
(j5.boards.sr.v4.power_board.PowerBoard static method)
U
UnableToObtainLock
update_boards() (j5.BoardGroup method)
(j5.boards.BoardGroup method)
(j5.boards.board.BoardGroup method)
V
verify_duration() (j5.components.Piezo static method)
(j5.components.piezo.Piezo static method)
verify_pitch() (j5.components.Piezo static method)
(j5.components.piezo.Piezo static method)
voltage (j5.components.battery_sensor.BatterySensor attribute)
(j5.components.BatterySensor attribute)
W
wait_for_start_flash() (j5.boards.sr.v4.power_board.PowerBoard method)
(j5.boards.sr.v4.PowerBoard method)
wait_until_button_pressed() (j5.components.button.ButtonInterface method)
(j5.components.ButtonInterface method)
wait_until_pressed() (j5.components.Button method)
(j5.components.button.Button method)
write_gpio_pin_dac_value() (j5.components.gpio_pin.GPIOPinInterface method)
(j5.components.GPIOPinInterface method)
write_gpio_pin_digital_state() (j5.components.gpio_pin.GPIOPinInterface method)
(j5.components.GPIOPinInterface method)
write_gpio_pin_pwm_value() (j5.components.gpio_pin.GPIOPinInterface method)
(j5.components.GPIOPinInterface method)
Read the Docs
v: v0.5.0
Versions
stable
v0.5.0
v0.4.0
v0.3.0
v0.2.0
v0.1.0
master
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.