intelino-trainlib-py
stable
QUICK START
1. Library Installation
1.1. Global Installation
1.2. Local Environment Installation
1.3. Requirements and Dependencies
1.4. Local Development and Testing
2. Library Verification
3. Usage and Examples
API REFERENCE GUIDE
trainlib vs trainlib_async
Python API
1. TrainScanner
2. Train
3. Enums (constants)
4. Messages (from the train)
4.1. Base classes
4.2. Response messages
4.3. Event messages
4.4. Error messages
4.5. Union classes
5. Exceptions
6. Other noteworthy APIs
OTHER
Issues and Requests
Intelino Public License
intelino-trainlib-py
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
W
|
Y
_
__eq__() (trainlib.messages.SnapCommand method)
__init__() (trainlib.TrainScanner method)
A
add_back_color_change_listener() (trainlib.Train method)
add_button_press_listener() (trainlib.Train method)
add_front_color_change_listener() (trainlib.Train method)
add_low_battery_listener() (trainlib.Train method)
add_movement_direction_change_listener() (trainlib.Train method)
add_snap_command_detection_listener() (trainlib.Train method)
add_snap_command_execution_listener() (trainlib.Train method)
add_split_decision_listener() (trainlib.Train method)
alias (trainlib.Train property)
ALL (trainlib.enums.SteeringDecision attribute)
B
BACK (trainlib.enums.ColorSensor attribute)
BACKWARD (trainlib.enums.MovementDirection attribute)
BLACK (trainlib.enums.SnapColorValue attribute)
ble_api_version (trainlib.messages.TrainMsgVersionDetail attribute)
BLUE (trainlib.enums.SnapColorValue attribute)
button_press_type (trainlib.messages.TrainMsgEventButtonPressDetected attribute)
ButtonPress (class in trainlib.enums)
C
clear_custom_snap_commands() (trainlib.Train method)
color (trainlib.messages.TrainMsgEventBackColorChanged attribute)
(trainlib.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib.messages.TrainMsgEventSensorColorChangedBase attribute)
colors (trainlib.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib.messages.TrainMsgEventSnapCommandExecuted attribute)
ColorSensor (class in trainlib.enums)
command_id (trainlib.messages.TrainMsgBase attribute)
(trainlib.messages.TrainMsgEventBackColorChanged attribute)
(trainlib.messages.TrainMsgEventBase attribute)
(trainlib.messages.TrainMsgEventButtonPressDetected attribute)
(trainlib.messages.TrainMsgEventChargingStateChanged attribute)
(trainlib.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib.messages.TrainMsgEventLowBattery attribute)
(trainlib.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib.messages.TrainMsgEventSensorColorChangedBase attribute)
(trainlib.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib.messages.TrainMsgEventSnapCommandExecuted attribute)
(trainlib.messages.TrainMsgEventSplitDecision attribute)
(trainlib.messages.TrainMsgEventUnknown attribute)
(trainlib.messages.TrainMsgMacAddress attribute)
(trainlib.messages.TrainMsgMalformed attribute)
(trainlib.messages.TrainMsgMovement attribute)
(trainlib.messages.TrainMsgStatsLifetimeOdometer attribute)
(trainlib.messages.TrainMsgTrainUuid attribute)
(trainlib.messages.TrainMsgUnknown attribute)
(trainlib.messages.TrainMsgVersionDetail attribute)
CURRENT (trainlib.enums.MovementDirection attribute)
CYAN (trainlib.enums.SnapColorValue attribute)
D
decision (trainlib.messages.TrainMsgEventSplitDecision attribute)
decouple_wagon() (trainlib.Train method)
desired_speed_cmps (trainlib.messages.TrainMsgMovement attribute)
direction (trainlib.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib.messages.TrainMsgMovement attribute)
(trainlib.Train property)
disconnect() (trainlib.Train method)
distance_cm (trainlib.Train property)
drive_at_speed() (trainlib.Train method)
drive_at_speed_level() (trainlib.Train method)
E
END_ROUTE (trainlib.enums.StopDrivingFeedbackType attribute)
event_id (trainlib.messages.TrainMsgEventBackColorChanged attribute)
(trainlib.messages.TrainMsgEventBase attribute)
(trainlib.messages.TrainMsgEventButtonPressDetected attribute)
(trainlib.messages.TrainMsgEventChargingStateChanged attribute)
(trainlib.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib.messages.TrainMsgEventLowBattery attribute)
(trainlib.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib.messages.TrainMsgEventSensorColorChangedBase attribute)
(trainlib.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib.messages.TrainMsgEventSnapCommandExecuted attribute)
(trainlib.messages.TrainMsgEventSplitDecision attribute)
(trainlib.messages.TrainMsgEventUnknown attribute)
F
FORWARD (trainlib.enums.MovementDirection attribute)
FRONT (trainlib.enums.ColorSensor attribute)
fw_version (trainlib.messages.TrainMsgVersionDetail attribute)
G
get_train() (trainlib.TrainScanner method)
get_trains() (trainlib.TrainScanner method)
GREEN (trainlib.enums.SnapColorValue attribute)
I
id (trainlib.Train property)
INVERT (trainlib.enums.MovementDirection attribute)
is_charging (trainlib.messages.TrainMsgEventChargingStateChanged attribute)
is_connected (trainlib.Train property)
L
LEFT (trainlib.enums.SteeringDecision attribute)
LEVEL1 (trainlib.enums.SpeedLevel attribute)
LEVEL2 (trainlib.enums.SpeedLevel attribute)
LEVEL3 (trainlib.enums.SpeedLevel attribute)
lifetime_odometer_meters (trainlib.messages.TrainMsgMovement attribute)
(trainlib.messages.TrainMsgStatsLifetimeOdometer attribute)
LONG (trainlib.enums.ButtonPress attribute)
M
mac_address (trainlib.messages.TrainMsgMacAddress attribute)
MAGENTA (trainlib.enums.SnapColorValue attribute)
major (trainlib.messages.TrainMsgVersionDetail.Version attribute)
minor (trainlib.messages.TrainMsgVersionDetail.Version attribute)
module
trainlib
trainlib.enums
trainlib.exc
MOVEMENT_STOP (trainlib.enums.StopDrivingFeedbackType attribute)
MovementDirection (class in trainlib.enums)
N
name (trainlib.Train property)
next_split_decision (trainlib.messages.TrainMsgMovement attribute)
(trainlib.Train property)
NONE (trainlib.enums.SteeringDecision attribute)
(trainlib.enums.StopDrivingFeedbackType attribute)
P
patch (trainlib.messages.TrainMsgVersionDetail.Version attribute)
pause_time_ms (trainlib.messages.TrainMsgMovement attribute)
pwm (trainlib.messages.TrainMsgMovement attribute)
R
random() (trainlib.enums.SnapColorValue class method)
raw_packet (trainlib.messages.TrainMsgBase attribute)
(trainlib.messages.TrainMsgEventBackColorChanged attribute)
(trainlib.messages.TrainMsgEventBase attribute)
(trainlib.messages.TrainMsgEventButtonPressDetected attribute)
(trainlib.messages.TrainMsgEventChargingStateChanged attribute)
(trainlib.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib.messages.TrainMsgEventLowBattery attribute)
(trainlib.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib.messages.TrainMsgEventSensorColorChangedBase attribute)
(trainlib.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib.messages.TrainMsgEventSnapCommandExecuted attribute)
(trainlib.messages.TrainMsgEventSplitDecision attribute)
(trainlib.messages.TrainMsgEventUnknown attribute)
(trainlib.messages.TrainMsgMacAddress attribute)
(trainlib.messages.TrainMsgMalformed attribute)
(trainlib.messages.TrainMsgMovement attribute)
(trainlib.messages.TrainMsgStatsLifetimeOdometer attribute)
(trainlib.messages.TrainMsgTrainUuid attribute)
(trainlib.messages.TrainMsgUnknown attribute)
(trainlib.messages.TrainMsgVersionDetail attribute)
RED (trainlib.enums.SnapColorValue attribute)
remove_back_color_change_listener() (trainlib.Train method)
remove_button_press_listener() (trainlib.Train method)
remove_front_color_change_listener() (trainlib.Train method)
remove_low_battery_listener() (trainlib.Train method)
remove_movement_direction_change_listener() (trainlib.Train method)
remove_snap_command_detection_listener() (trainlib.Train method)
remove_snap_command_execution_listener() (trainlib.Train method)
remove_split_decision_listener() (trainlib.Train method)
RIGHT (trainlib.enums.SteeringDecision attribute)
S
sensor (trainlib.messages.TrainMsgEventBackColorChanged attribute)
(trainlib.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib.messages.TrainMsgEventSensorColorChangedBase attribute)
set_headlight_color() (trainlib.Train method)
set_next_split_steering_decision() (trainlib.Train method)
set_snap_command_execution() (trainlib.Train method)
set_snap_command_feedback() (trainlib.Train method)
set_top_led_color() (trainlib.Train method)
SHORT (trainlib.enums.ButtonPress attribute)
snap_counter (trainlib.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib.messages.TrainMsgEventSnapCommandExecuted attribute)
SnapColorValue (class in trainlib.enums)
SnapCommand (class in trainlib.messages)
speed_cmps (trainlib.messages.TrainMsgMovement attribute)
(trainlib.Train property)
speed_control (trainlib.messages.TrainMsgMovement attribute)
SpeedLevel (class in trainlib.enums)
start_with() (trainlib.messages.SnapCommand method)
starts_with() (trainlib.messages.SnapCommand method)
STEER (trainlib.enums.SteeringDecision attribute)
SteeringDecision (class in trainlib.enums)
STOP (trainlib.enums.MovementDirection attribute)
(trainlib.enums.SpeedLevel attribute)
stop_driving() (trainlib.Train method)
StopDrivingFeedbackType (class in trainlib.enums)
STRAIGHT (trainlib.enums.SteeringDecision attribute)
T
timestamp_ms (trainlib.messages.TrainMsgEventBackColorChanged attribute)
(trainlib.messages.TrainMsgEventBase attribute)
(trainlib.messages.TrainMsgEventButtonPressDetected attribute)
(trainlib.messages.TrainMsgEventChargingStateChanged attribute)
(trainlib.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib.messages.TrainMsgEventLowBattery attribute)
(trainlib.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib.messages.TrainMsgEventSensorColorChangedBase attribute)
(trainlib.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib.messages.TrainMsgEventSnapCommandExecuted attribute)
(trainlib.messages.TrainMsgEventSplitDecision attribute)
(trainlib.messages.TrainMsgEventUnknown attribute)
to_rgb_bytes() (trainlib.enums.SnapColorValue method)
Train (class in trainlib)
TrainCommandError
trainlib
module
trainlib.enums
module
trainlib.exc
module
TrainlibError
TrainMessageInterpretationError
TrainMessageLengthError
TrainMessageTypeError
TrainMsg (in module trainlib.messages)
TrainMsgBase (class in trainlib.messages)
TrainMsgEvent (in module trainlib.messages)
TrainMsgEventBackColorChanged (class in trainlib.messages)
TrainMsgEventBase (class in trainlib.messages)
TrainMsgEventButtonPressDetected (class in trainlib.messages)
TrainMsgEventChargingStateChanged (class in trainlib.messages)
TrainMsgEventFrontColorChanged (class in trainlib.messages)
TrainMsgEventLowBattery (class in trainlib.messages)
TrainMsgEventMovementDirectionChanged (class in trainlib.messages)
TrainMsgEventSensorColorChanged (in module trainlib.messages)
TrainMsgEventSensorColorChangedBase (class in trainlib.messages)
TrainMsgEventSnapCommandDetected (class in trainlib.messages)
TrainMsgEventSnapCommandExecuted (class in trainlib.messages)
TrainMsgEventSplitDecision (class in trainlib.messages)
TrainMsgEventUnknown (class in trainlib.messages)
TrainMsgMacAddress (class in trainlib.messages)
TrainMsgMalformed (class in trainlib.messages)
TrainMsgMovement (class in trainlib.messages)
TrainMsgStatsLifetimeOdometer (class in trainlib.messages)
TrainMsgTrainUuid (class in trainlib.messages)
TrainMsgUnknown (class in trainlib.messages)
TrainMsgVersionDetail (class in trainlib.messages)
TrainMsgVersionDetail.Version (class in trainlib.messages)
TrainNotConnectedError
TrainNotFoundError
TrainScanner (class in trainlib)
U
UNKNOWN (trainlib.enums.SnapColorValue attribute)
uuid (trainlib.messages.TrainMsgTrainUuid attribute)
W
WHITE (trainlib.enums.SnapColorValue attribute)
Y
YELLOW (trainlib.enums.SnapColorValue attribute)
Read the Docs
v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds